API reference

DXfile subclasses the h5py module for interacting with Data Exchange files.

DXFile Modules:

• dxfile
  • Entry
    • Entry._entry_definitions()
    • Entry._generate_classes()
    • Entry.acquisition
      • Entry.acquisition.docstring
      • Entry.acquisition.end_date
      • Entry.acquisition.entry_name
      • Entry.acquisition.image_date
      • Entry.acquisition.image_exposure_time
      • Entry.acquisition.image_is_complete
      • Entry.acquisition.image_number
      • Entry.acquisition.image_theta
      • Entry.acquisition.image_type
      • Entry.acquisition.root
      • Entry.acquisition.sample_image_shift_x
      • Entry.acquisition.sample_image_shift_y
      • Entry.acquisition.sample_position_x
      • Entry.acquisition.sample_position_y
      • Entry.acquisition.sample_position_z
      • Entry.acquisition.scan_date
      • Entry.acquisition.scan_index
      • Entry.acquisition.shutter
      • Entry.acquisition.start_date
      • Entry.acquisition.time_stamp
    • Entry.acquisition_setup
    • Entry.attenuator
      • Entry.attenuator.description
      • Entry.attenuator.docstring
      • Entry.attenuator.entry_name
      • Entry.attenuator.name
      • Entry.attenuator.root
      • Entry.attenuator.thickness
      • Entry.attenuator.transmission
    • Entry.data
    • Entry.detector
      • Entry.detector.actual_pixel_size_x
      • Entry.detector.actual_pixel_size_y
      • Entry.detector.basis_vectors
      • Entry.detector.binning_x
      • Entry.detector.binning_y
      • Entry.detector.bit_depth
      • Entry.detector.corner_position
      • Entry.detector.counts_per_joule
      • Entry.detector.delay_time
      • Entry.detector.description
      • Entry.detector.dimension_x
      • Entry.detector.dimension_y
      • Entry.detector.docstring
      • Entry.detector.entry_name
      • Entry.detector.exposure_time
      • Entry.detector.firmware_version
      • Entry.detector.frame_rate
      • Entry.detector.manufacturer
      • Entry.detector.model
      • Entry.detector.name
      • Entry.detector.operating_temperature
      • Entry.detector.output_data
      • Entry.detector.pixel_size_x
      • Entry.detector.pixel_size_y
      • Entry.detector.root
      • Entry.detector.serial_number
      • Entry.detector.shutter_mode
      • Entry.detector.software_version
      • Entry.detector.stabilization_time
    • Entry.exchange
    • Entry.experiment
      • Entry.experiment.activity
      • Entry.experiment.docstring
      • Entry.experiment.entry_name
      • Entry.experiment.proposal
      • Entry.experiment.root
      • Entry.experiment.safety
      • Entry.experiment.title
    • Entry.experimenter
      • Entry.experimenter.address
      • Entry.experimenter.affiliation
      • Entry.experimenter.docstring
      • Entry.experimenter.email
      • Entry.experimenter.entry_name
      • Entry.experimenter.facility_user_id
      • Entry.experimenter.name
      • Entry.experimenter.phone
      • Entry.experimenter.role
      • Entry.experimenter.root
    • Entry.instrument
      • Entry.instrument.comment
      • Entry.instrument.docstring
      • Entry.instrument.entry_name
      • Entry.instrument.name
      • Entry.instrument.root
    • Entry.interferometer
      • Entry.interferometer.description
      • Entry.interferometer.docstring
      • Entry.interferometer.entry_name
      • Entry.interferometer.name
      • Entry.interferometer.root
    • Entry.interferometer_setup
    • Entry.mirror
      • Entry.mirror.angle
      • Entry.mirror.description
      • Entry.mirror.docstring
      • Entry.mirror.entry_name
      • Entry.mirror.name
      • Entry.mirror.root
    • Entry.monochromator
      • Entry.monochromator.description
      • Entry.monochromator.docstring
      • Entry.monochromator.energy
      • Entry.monochromator.energy_error
      • Entry.monochromator.entry_name
      • Entry.monochromator.mono_stripe
      • Entry.monochromator.name
      • Entry.monochromator.root
    • Entry.objective
      • Entry.objective.description
      • Entry.objective.docstring
      • Entry.objective.entry_name
      • Entry.objective.magnification
      • Entry.objective.manufacturer
      • Entry.objective.model
      • Entry.objective.name
      • Entry.objective.numerical_aperture
      • Entry.objective.root
    • Entry.process
    • Entry.roi
      • Entry.roi.description
      • Entry.roi.docstring
      • Entry.roi.entry_name
      • Entry.roi.min_x
      • Entry.roi.min_y
      • Entry.roi.name
      • Entry.roi.root
      • Entry.roi.size_x
      • Entry.roi.size_y
    • Entry.sample
      • Entry.sample.chemical_formula
      • Entry.sample.comment
      • Entry.sample.concentration
      • Entry.sample.description
      • Entry.sample.docstring
      • Entry.sample.entry_name
      • Entry.sample.environment
      • Entry.sample.fatigue_cycle
      • Entry.sample.mass
      • Entry.sample.name
      • Entry.sample.preparation_date
      • Entry.sample.pressure
      • Entry.sample.root
      • Entry.sample.temperature
      • Entry.sample.temperature_set
      • Entry.sample.thickness
      • Entry.sample.tray
    • Entry.sample_stack
    • Entry.sample_stack_setup
    • Entry.scintillator
      • Entry.scintillator.description
      • Entry.scintillator.docstring
      • Entry.scintillator.entry_name
      • Entry.scintillator.manufacturer
      • Entry.scintillator.name
      • Entry.scintillator.root
      • Entry.scintillator.scintillating_thickness
      • Entry.scintillator.serial_number
      • Entry.scintillator.substrate_thickness
    • Entry.source
      • Entry.source.beam_intensity_incident
      • Entry.source.beam_intensity_transmitted
      • Entry.source.beamline
      • Entry.source.current
      • Entry.source.datetime
      • Entry.source.docstring
      • Entry.source.energy
      • Entry.source.entry_name
      • Entry.source.mode
      • Entry.source.name
      • Entry.source.pulse_energy
      • Entry.source.pulse_width
      • Entry.source.root
  • File
    • File.add_entry()
    • File.create_top_level_group()