Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC add_reflection(h,k,l) will use current positions #219

Open
Tracked by #189
prjemian opened this issue Jun 11, 2022 · 0 comments
Open
Tracked by #189

DOC add_reflection(h,k,l) will use current positions #219

prjemian opened this issue Jun 11, 2022 · 0 comments
Labels
Milestone

Comments

@prjemian
Copy link
Contributor

Note in the documentation that add_reflection(h,k,l) will use the current positions if positions=None (the default):

hklpy/hkl/sample.py

Lines 301 to 320 in 906f00e

def add_reflection(self, h, k, l, position=None, detector=None, compute_ub=False):
"""Add a reflection, optionally specifying the detector to use
Parameters
----------
h : float
Reflection h
k : float
Reflection k
l : float
Reflection l
detector : Hkl.Detector, optional
The detector
position : tuple or namedtuple, optional
The physical motor position that this reflection corresponds to
If not specified, the current geometry of the calculation engine is
assumed.
compute_ub : bool, optional
Calculate the UB matrix with the last two reflections
"""

@prjemian prjemian added this to the v1.1 milestone Jun 11, 2022
@prjemian prjemian changed the title DOC note about add_reflection(h,k,l) will use current positions DOC note that add_reflection(h,k,l) will use current positions Jun 11, 2022
@prjemian prjemian changed the title DOC note that add_reflection(h,k,l) will use current positions DOC add_reflection(h,k,l) will use current positions Jun 11, 2022
@prjemian prjemian modified the milestones: v1.2, v2.0 Nov 1, 2023
@prjemian prjemian added the hklpy2 For hklpy2 label May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant