API

Caution

work-in-progress

Application-Programmer Interface - the source code.

Functional blocks in hklpy2.

• Configure
  • Source Code Documentation
    • Configuration
• Constraints
  • Source Code Documentation
    • ConstraintBase
    • LimitsConstraint
    • RealAxisConstraints
• Diffractometer
  • Source Code Documentation
    • DiffractometerBase
    • Inherited members, from ophyd.PseudoPositioner
• Diffractometer Geometries
  • Source Code Documentation
    • creator()
    • diffractometer_class_factory()
• Crystal Lattice
  • Source Code Documentation
    • CrystalSystem
    • Lattice
    • SI_LATTICE_PARAMETER
    • SI_LATTICE_PARAMETER_UNCERTAINTY
• Operations
  • Source Code Documentation
    • Operations
• Orientation Reflection
  • Source Code Documentation
    • Reflection
    • ReflectionsDict
    • UNUSED_REFLECTION
• Crystalline Sample
  • Source Code Documentation
    • Sample
• Solvers
  • How to select a Solver
  • How to write a new Solver
  • Source Code Documentation
• User Friendliness
• Wavelength
  • Source Code Documentation
    • A_KEV
    • ConstantMonochromaticWavelength
    • MonochromaticXrayWavelength
    • WavelengthBase
    • XRAY_ENERGY_EQUIVALENT_
• Miscellaneous Support
  • Source Code Documentation
    • ConfigurationError
    • ConfigurationRunWrapper
    • ConstraintsError
    • DiffractometerError
    • IDENTITY_MATRIX_3X3
    • LatticeError
    • OperationsError
    • ReflectionError
    • SOLVER_ENTRYPOINT_GROUP
    • SampleError
    • SolverError
    • WavelengthError
    • check_value_in_list()
    • compare_float_dicts()
    • dict_device_factory()
    • flatten_lists()
    • get_solver()
    • load_yaml()
    • load_yaml_file()
    • roundoff()
    • solver_factory()
    • solvers()
    • unique_name()
• License