API Reference

Class Hierarchy

• • Namespace h5dispatch
    • Enum BoolEnum
    • Template Struct H5TypeTraits
    • Template Struct H5TypeTraits< BoolEnum >
    • Template Struct H5TypeTraits< double >
    • Template Struct H5TypeTraits< int >
    • Template Struct H5TypeTraits< int64_t >
    • Template Struct H5TypeTraits< uint64_t >
    • Template Struct type_list
    • Template Struct type_list_contains
    • Template Struct type_list_contains< T, type_list< Ts... > >
    • Template Struct type_tag_t
    • Template Struct variant_of
    • Template Struct variant_of< Wrap, type_list< Ts... > >
  • Namespace h5read_processed_utils
    • Struct GroupScanContext
    • Template Struct H5ArrayData
    • Struct TraverseData
  • Namespace h5utils
    • Template Struct H5Cleanup
    • Class H5ErrorSilencer
  • Namespace logic
    • Enum LogicalOp
  • Template Struct ColumnPredicate
  • Struct intersection
  • Template Struct TypedColumn
  • Class BeamBase
  • Class Crystal
  • Class Detector
  • Class Experiment
  • Class Goniometer
  • Class ImageSequence
  • Class MonochromaticBeam
  • Class MonoElectronBeam
  • Class MonoXrayBeam
  • Class Panel
  • Class PolychromaticBeam
  • Class ReflectionTable
    • Template Struct ReflectionTable::is_column_predicate
    • Template Struct ReflectionTable::is_column_predicate< ColumnPredicate< T > >
  • Class Scan

File Hierarchy

• • Directory dx2
    • Directory h5
      • File h5read_processed.cxx
      • File h5write.cxx
    • File beam.cxx
    • File beam_io.cxx
    • File beam_ops.cxx
    • File crystal.cxx
    • File detector.cxx
    • File detector_attenuations.cxx
    • File experiment.cxx
    • File goniometer.cxx
    • File imagesequence.cxx
    • File reflection.cxx
    • File scan.cxx
    • File utils.cxx
  • Directory include
    • Directory dx2
      • Directory h5
        • File h5dispatch.hpp
        • File h5read_processed.hpp
        • File h5utils.hpp
        • File h5write.hpp
      • File beam.hpp
      • File beam_io.hpp
      • File beam_ops.hpp
      • File crystal.hpp
      • File detector.hpp
      • File detector_attenuations.hpp
      • File dx2.hpp
      • File experiment.hpp
      • File goniometer.hpp
      • File imagesequence.hpp
      • File logging.hpp
      • File reflection.hpp
      • File scan.hpp
      • File utils.hpp

Full API

Namespaces

• Namespace beam_io
  • Functions

• Namespace beam_ops
  • Functions

• Namespace dx2_log
  • Functions

• Namespace h5dispatch
  • Classes
  • Enums
  • Functions
  • Typedefs
  • Variables

• Namespace h5read_processed_utils
  • Classes
  • Functions

• Namespace h5utils
  • Classes
  • Functions
  • Typedefs

• Namespace logic
  • Enums

• Namespace std

Classes and Structs

• Template Struct ColumnPredicate
  • Struct Documentation
    • ColumnPredicate
      • column_name
      • predicate

• Template Struct H5TypeTraits
  • Struct Documentation
    • h5dispatch::H5TypeTraits

• Template Struct H5TypeTraits< BoolEnum >
  • Struct Documentation
    • h5dispatch::H5TypeTraits< BoolEnum >
      • make()
      • h5_class
      • h5_sign

• Template Struct H5TypeTraits< double >
  • Struct Documentation
    • h5dispatch::H5TypeTraits< double >
      • make()
      • h5_class
      • h5_sign

• Template Struct H5TypeTraits< int >
  • Struct Documentation
    • h5dispatch::H5TypeTraits< int >
      • make()
      • h5_class
      • h5_sign

• Template Struct H5TypeTraits< int64_t >
  • Struct Documentation
    • h5dispatch::H5TypeTraits< int64_t >
      • make()
      • h5_class
      • h5_sign

• Template Struct H5TypeTraits< uint64_t >
  • Struct Documentation
    • h5dispatch::H5TypeTraits< uint64_t >
      • make()
      • h5_class
      • h5_sign

• Template Struct type_list
  • Struct Documentation
    • h5dispatch::type_list

• Template Struct type_list_contains
  • Struct Documentation
    • h5dispatch::type_list_contains

• Template Struct type_list_contains< T, type_list< Ts… > >
  • Inheritance Relationships
    • Base Type
  • Struct Documentation
    • h5dispatch::type_list_contains< T, type_list< Ts... > >

• Template Struct type_tag_t
  • Struct Documentation
    • h5dispatch::type_tag_t
      • type

• Template Struct variant_of
  • Struct Documentation
    • h5dispatch::variant_of

• Template Struct variant_of< Wrap, type_list< Ts… > >
  • Struct Documentation
    • h5dispatch::variant_of< Wrap, type_list< Ts... > >
      • type

• Struct GroupScanContext
  • Struct Documentation
    • h5read_processed_utils::GroupScanContext
      • group_name
      • datasets

• Template Struct H5ArrayData
  • Struct Documentation
    • h5read_processed_utils::H5ArrayData
      • data
      • shape

• Struct TraverseData
  • Struct Documentation
    • h5read_processed_utils::TraverseData
      • datasets
      • current_path
      • visited_groups

• Template Struct H5Cleanup
  • Struct Documentation
    • H5Cleanup()
    • H5Cleanup()
    • H5Cleanup()
    • H5Cleanup()
    • operator=()
    • ~H5Cleanup()
    • operator hid_t()
    • operator bool()
    • id

• Struct intersection
  • Struct Documentation
    • intersection
      • panel_id
      • xymm

• Template Struct ReflectionTable::is_column_predicate
  • Nested Relationships
  • Inheritance Relationships
    • Base Type
  • Struct Documentation
    • ReflectionTable::is_column_predicate

• Template Struct ReflectionTable::is_column_predicate< ColumnPredicate< T > >
  • Nested Relationships
  • Inheritance Relationships
    • Base Type
  • Struct Documentation
    • ReflectionTable::is_column_predicate< ColumnPredicate< T > >

• Template Struct TypedColumn
  • Struct Documentation
    • TypedColumn
      • value_type
      • TypedColumn()
      • rows()
      • cols()
      • span()
      • span()
      • filtered()
      • name
      • shape
      • data

• Class BeamBase
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • BeamBase
      • BeamBase()
      • BeamBase()
      • get_polarization_normal()
      • get_polarization_fraction()
      • get_sample_to_source_direction()
      • init_from_json()
      • add_to_json()
      • sample_to_source_direction_
      • divergence_
      • sigma_divergence_
      • polarization_normal_
      • polarization_fraction_
      • flux_
      • transmission_
      • sample_to_source_distance_

• Class Crystal
  • Class Documentation
    • Crystal
      • Crystal()
      • Crystal()
      • Crystal()
      • Crystal()
      • get_unit_cell()
      • get_space_group()
      • get_A_matrix()
      • get_U_matrix()
      • get_B_matrix()
      • niggli_reduce()
      • set_A_matrix()
      • to_json()
      • init_from_abc()
      • space_group_
      • unit_cell_
      • B_
      • A_
      • U_

• Class Detector
  • Class Documentation
    • Detector
      • Detector()
      • Detector()
      • Detector()
      • to_json()
      • panels()
      • get_ray_intersection()
      • update()
      • _panels

• Class Experiment
  • Class Documentation
    • Experiment
      • Experiment()
      • Experiment()
      • to_json()
      • beam()
      • beam()
      • identifier()
      • goniometer()
      • scan()
      • detector()
      • crystal()
      • imagesequence()
      • set_crystal()
      • set_beam()
      • set_scan()
      • set_detector()
      • set_goniometer()
      • set_imagesequence()
      • set_identifier()
      • generate_identifier()
      • _beam
      • _scan
      • _goniometer
      • _detector
      • _crystal
      • _imagesequence
      • _identifier

• Class Goniometer
  • Class Documentation
    • Goniometer
      • Goniometer()
      • Goniometer()
      • Goniometer()
      • Goniometer()
      • get_setting_rotation()
      • get_sample_rotation()
      • get_rotation_axis()
      • to_json()
      • init()
      • calculate_setting_rotation()
      • calculate_sample_rotation()
      • sample_rotation_
      • rotation_axis_
      • setting_rotation_
      • axes_
      • angles_
      • names_
      • scan_axis_

• Class H5ErrorSilencer
  • Class Documentation
    • h5utils::H5ErrorSilencer
      • H5ErrorSilencer()
      • ~H5ErrorSilencer()

• Class ImageSequence
  • Class Documentation
    • ImageSequence
      • ImageSequence()
      • ImageSequence()
      • ImageSequence()
      • ImageSequence()
      • to_json()
      • filename()
      • n_images_
      • filename_
      • single_file_indices_
      • imagesequence_data_

• Class MonochromaticBeam
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • MonochromaticBeam
      • MonochromaticBeam()
      • MonochromaticBeam()
      • MonochromaticBeam()
      • MonochromaticBeam()
      • MonochromaticBeam()
      • to_json()
      • to_json()
      • get_wavelength()
      • set_wavelength()
      • get_s0()
      • set_s0()
      • wavelength_

• Class MonoElectronBeam
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • MonoElectronBeam
      • to_json()

• Class MonoXrayBeam
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • MonoXrayBeam
      • to_json()

• Class Panel
  • Class Documentation
    • Panel
      • Panel()
      • Panel()
      • Panel()
      • get_d_matrix()
      • get_D_matrix()
      • px_to_mm()
      • mm_to_px()
      • get_lab_coord()
      • get_ray_intersection()
      • get_ray_intersection_unbounded()
      • get_pixel_size()
      • to_json()
      • get_origin()
      • get_fast_axis()
      • get_slow_axis()
      • get_normal()
      • get_image_size_mm()
      • get_directed_distance()
      • has_parallax_correction()
      • is_coord_valid_mm()
      • get_mu()
      • get_thickness()
      • get_resolution_at_pixel()
      • get_max_resolution_at_corners()
      • update()
      • set_correction_parameters()
      • origin_
      • fast_axis_
      • slow_axis_
      • normal_
      • d_
      • D_
      • pixel_size_
      • image_size_
      • image_size_mm_
      • trusted_range_
      • type_
      • name_
      • thickness_
      • mu_
      • raw_image_offset_
      • gain_
      • pedestal_
      • pixel_to_mm_strategy_
      • parallax_correction_

• Class PolychromaticBeam
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • PolychromaticBeam
      • PolychromaticBeam()
      • PolychromaticBeam()
      • PolychromaticBeam()
      • PolychromaticBeam()
      • PolychromaticBeam()
      • to_json()
      • to_json()
      • get_wavelength_range()
      • set_wavelength_range()
      • wavelength_range_

• Class ReflectionTable
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • ReflectionTable
      • BoolEnum
      • ReflectionTable()
      • ReflectionTable()
      • ReflectionTable()
      • get_experiment_ids()
      • set_experiment_ids()
      • get_identifiers()
      • set_identifiers()
      • generate_new_attributes()
      • get_column_names()
      • size()
      • column()
      • column()
      • find_rows()
      • find_rows()
      • select()
      • select()
      • add_column()
      • add_column()
      • add_column()
      • update_column()
      • update_column()
      • update_column()
      • write()

• Class Scan
  • Class Documentation
    • Scan
      • Scan()
      • Scan()
      • Scan()
      • get_image_range()
      • get_oscillation()
      • to_json()
      • image_range_
      • num_images_
      • oscillation_width_
      • oscillation_start_

Enums

• Enum BoolEnum
  • Enum Documentation
    • BoolEnum
      • FALSE
      • TRUE

• Enum LogicalOp
  • Enum Documentation
    • LogicalOp
      • Or
      • And

Functions

• Function angle_between_vectors_degrees(Vector3d, Vector3d)
  • Function Documentation
    • angle_between_vectors_degrees()

• Function angle_between_vectors_degrees(Vector3d, Vector3d)
  • Function Documentation
    • angle_between_vectors_degrees()

• Function angle_safe
  • Function Documentation
    • angle_safe()

• Function attenuation_length(double, double, Vector3d, Vector3d, Vector3d, Vector3d)
  • Function Documentation
    • attenuation_length()

• Function attenuation_length(double, double, Vector3d, Vector3d, Vector3d, Vector3d)
  • Function Documentation
    • attenuation_length()

• Function axis_and_angle_as_matrix(Vector3d, double, bool)
  • Function Documentation

• Function axis_and_angle_as_matrix(Vector3d, double, bool)
  • Function Documentation

• Function beam_io::from_json
  • Function Documentation
    • from_json()

• Function beam_io::to_json
  • Function Documentation
    • to_json()

• Function beam_ops::require_monochromatic(Beam&)
  • Function Documentation
    • require_monochromatic()

• Function beam_ops::require_monochromatic(const Beam&)
  • Function Documentation
    • require_monochromatic()

• Function beam_ops::require_polychromatic(Beam&)
  • Function Documentation
    • require_polychromatic()

• Function beam_ops::require_polychromatic(const Beam&)
  • Function Documentation
    • require_polychromatic()

• Function calculate_CdTe_mu_from_wavelength
  • Function Documentation
    • calculate_CdTe_mu_from_wavelength()

• Function calculate_mu_for_material_at_wavelength(const std::string&, double)
  • Function Documentation
    • calculate_mu_for_material_at_wavelength()

• Function calculate_mu_for_material_at_wavelength(const std::string&, double)
  • Function Documentation
    • calculate_mu_for_material_at_wavelength()

• Function calculate_silicon_mu_from_wavelength
  • Function Documentation
    • calculate_silicon_mu_from_wavelength()

• Template Function deduce_shape
  • Function Documentation
    • deduce_shape()

• Function dx2_log::debug(std::string_view)
  • Function Documentation
    • debug()

• Template Function dx2_log::debug(fmt::format_string<Args…>, Args&&…)
  • Function Documentation
    • debug()

• Function dx2_log::error
  • Function Documentation
    • error()

• Function dx2_log::info
  • Function Documentation
    • info()

• Function dx2_log::is_debug_enabled
  • Function Documentation
    • is_debug_enabled()

• Function dx2_log::warning
  • Function Documentation
    • warning()

• Function ersatz_uuid4()
  • Function Documentation
    • ersatz_uuid4()

• Function ersatz_uuid4()
  • Function Documentation
    • ersatz_uuid4()

• Template Function flatten
  • Function Documentation
    • flatten()

• Function get_dataset_name(std::string_view)
  • Function Documentation
    • get_dataset_name()

• Function get_dataset_name(std::string_view)
  • Function Documentation
    • get_dataset_name()

• Function get_datasets_in_group(std::string_view, std::string_view)
  • Function Documentation
    • get_datasets_in_group()

• Function get_datasets_in_group(std::string_view, std::string_view)
  • Function Documentation
    • get_datasets_in_group()

• Function get_datasets_in_group_recursive(std::string_view, std::string_view)
  • Function Documentation
    • get_datasets_in_group_recursive()

• Function get_datasets_in_group_recursive(std::string_view, std::string_view)
  • Function Documentation
    • get_datasets_in_group_recursive()

• Template Function h5dispatch::any_of_types
  • Function Documentation
    • any_of_types()

• Template Function h5dispatch::dispatch_h5_dataset_type
  • Function Documentation
    • dispatch_h5_dataset_type()

• Template Function h5dispatch::make_h5_type
  • Function Documentation
    • make_h5_type()

• Function h5read_processed_utils::group_iterator
  • Function Documentation
    • group_iterator()

• Function h5read_processed_utils::scan_group_callback
  • Function Documentation
    • scan_group_callback()

• Function h5read_processed_utils::traverse_hdf5
  • Function Documentation
    • traverse_hdf5()

• Function h5utils::make_v18_file_access_plist
  • Function Documentation
    • make_v18_file_access_plist()

• Function Matrix3d_from_gemmi_cb(gemmi::Op)
  • Function Documentation
    • Matrix3d_from_gemmi_cb()

• Function Matrix3d_from_gemmi_cb(gemmi::Op)
  • Function Documentation
    • Matrix3d_from_gemmi_cb()

• Template Function mu_rho_at_ev
  • Function Documentation
    • mu_rho_at_ev()

• Function parallax_correction(double, double, std::array<double, 2>, Vector3d, Vector3d, Vector3d)
  • Function Documentation
    • parallax_correction()

• Function parallax_correction(double, double, std::array<double, 2>, Vector3d, Vector3d, Vector3d)
  • Function Documentation
    • parallax_correction()

• Template Function read_array_from_h5_file
  • Function Documentation
    • read_array_from_h5_file()

• Template Function read_array_with_shape_from_h5_file
  • Function Documentation
    • read_array_with_shape_from_h5_file()

• Function read_experiment_metadata(hid_t, std::vector<uint64_t>&, std::vector<std::string>&)
  • Function Documentation
    • read_experiment_metadata()

• Function read_experiment_metadata(hid_t, std::vector<uint64_t>&, std::vector<std::string>&)
  • Function Documentation
    • read_experiment_metadata()

• Function traverse_or_create_groups(hid_t, const std::string&)
  • Function Documentation
    • traverse_or_create_groups()

• Function traverse_or_create_groups(hid_t, const std::string&)
  • Function Documentation
    • traverse_or_create_groups()

• Template Function write_data_to_h5_file
  • Function Documentation
    • write_data_to_h5_file()

• Function write_experiment_metadata(hid_t, const std::vector<uint64_t>&, const std::vector<std::string>&)
  • Function Documentation
    • write_experiment_metadata()

• Function write_experiment_metadata(hid_t, const std::vector<uint64_t>&, const std::vector<std::string>&)
  • Function Documentation
    • write_experiment_metadata()

• Template Function write_raw_data_to_h5_file
  • Function Documentation
    • write_raw_data_to_h5_file()

• Template Function write_raw_data_to_h5_group
  • Function Documentation
    • write_raw_data_to_h5_group()

Variables

• Variable axis_map
  • Variable Documentation
    • axis_map

• Variable CdTe_density
  • Variable Documentation
    • CdTe_density

• Variable CdTe_energy_data
  • Variable Documentation
    • CdTe_energy_data

• Variable CdTe_mu_rho_data
  • Variable Documentation
    • CdTe_mu_rho_data

• Variable factor_ev_angstrom
  • Variable Documentation
    • factor_ev_angstrom

• Variable factor_kev_angstrom
  • Variable Documentation
    • factor_kev_angstrom

• Variable h5dispatch::is_column_type_v
  • Variable Documentation
    • is_column_type_v

• Variable h5dispatch::type_tag
  • Variable Documentation
    • type_tag

• Variable silicon_density
  • Variable Documentation
    • silicon_density

• Variable silicon_energy_data
  • Variable Documentation
    • silicon_energy_data

• Variable silicon_mu_rho_data
  • Variable Documentation
    • silicon_mu_rho_data

• Variable valid_axes
  • Variable Documentation
    • valid_axes

Typedefs

• Typedef Beam
  • Typedef Documentation
    • Beam

• Typedef h5dispatch::ColumnTypes
  • Typedef Documentation
    • ColumnTypes

• Typedef h5dispatch::variant_of_t
  • Typedef Documentation
    • variant_of_t

• Typedef h5utils::H5Attr
  • Typedef Documentation
    • H5Attr

• Typedef h5utils::H5Dataset
  • Typedef Documentation
    • H5Dataset

• Typedef h5utils::H5File
  • Typedef Documentation
    • H5File

• Typedef h5utils::H5Group
  • Typedef Documentation
    • H5Group

• Typedef h5utils::H5Plist
  • Typedef Documentation
    • H5Plist

• Typedef h5utils::H5Space
  • Typedef Documentation
    • H5Space

• Typedef h5utils::H5Type
  • Typedef Documentation
    • H5Type

• Typedef json
  • Typedef Documentation
    • json

• Typedef json
  • Typedef Documentation
    • json

• Typedef json
  • Typedef Documentation
    • json

• Typedef json
  • Typedef Documentation
    • json

• Typedef json
  • Typedef Documentation
    • json

• Typedef json
  • Typedef Documentation
    • json

• Typedef json
  • Typedef Documentation
    • json

• Typedef json
  • Typedef Documentation
    • json

• Typedef json
  • Typedef Documentation
    • json

• Typedef mdspan_type
  • Typedef Documentation
    • mdspan_type

• Typedef storage_type
  • Typedef Documentation
    • storage_type