nxtomomill.converter.hdf5.acquisition.baseacquisition.BaseAcquisition#

class nxtomomill.converter.hdf5.acquisition.baseacquisition.BaseAcquisition(root_url, configuration, detector_sel_callback, start_index)[source]#

Bases: object

Util class to group several hdf5 group together and to write the data Nexus / NXtomo compliant

__init__(root_url, configuration, detector_sel_callback, start_index)[source]#

Methods

`__init__`(root_url, configuration, ...)
`get_axis_scale_types`()	Return axis display for the detector data to be used by silx view
`get_detector_roi`()
`get_expected_nx_tomo`()	Return the expected number of nxtomo created for this acquisition.
`get_translation_z_frm`(root_node, n_frame, ...)	rtype: `Quantity`
`is_different_sequence`(entry)	Can we have several entries 1.1, 1.2, 1.3.
`is_part_of_same_series`(other)	rtype: `bool`
`read_entry`()
`register_step`(url, entry_type, copy_frames)	Add a bliss entry to the acquisition :type url: `DataUrl` :param url: :param entry_type:
`to_NXtomos`(request_input, input_callback[, ...])	rtype: `tuple`
`write_as_nxtomo`(shift_entry, ...[, ...])	This function will dump the acquisition to disk as an NXtomo

Attributes

`TITLE_PATHS`
`configuration`
`raise_error_if_issue`	Should we raise an error if we encounter or an issue or should we just log an error message
`root_url`
`start_index`	rtype: `int`

get_axis_scale_types()[source]#: Return axis display for the detector data to be used by silx view

get_expected_nx_tomo()[source]#: Return the expected number of nxtomo created for this acquisition. This is required to get consistent entry and file name. At lest for automation

is_different_sequence(entry)[source]#: Can we have several entries 1.1, 1.2, 1.3… to consider.

property raise_error_if_issue#: Should we raise an error if we encounter or an issue or should we just log an error message

register_step(url, entry_type, copy_frames)[source]#

Add a bliss entry to the acquisition :type url: DataUrl :param url: :param entry_type:

Return type:: None

write_as_nxtomo(shift_entry, input_file_path, request_input, divide_into_sub_files, input_callback=None)[source]#

This function will dump the acquisition to disk as an NXtomo

Parameters:

shift_entry (int) – index of the entry to start saving new nxtomos.
input_file_path (str) – output file path
request_input (bool) – if True the conversion can ask user some missing metadata
divide_into_sub_files (bool) – if True then create one file per NXtomo
input_callback – function to call for users to provide missing metadata

Return type:

tuple