nxtomomill.io.config.edfconfig.TomoEDFConfig#

class nxtomomill.io.config.edfconfig.TomoEDFConfig[source]#

Bases: ConfigBase, ConfigSourceSection

Configuration class to provide to the convert from h5 to nx

__init__()[source]#

Methods

`__init__`()
`dict_to_cfg`(file_path, dict_)
`from_cfg_file`(file_path[, encoding])
`from_dict`(dict_)	Create a HDF5Config object and set it from values contained in the dictionary :type dict_: `dict` :param dict_: settings dictionary :return: HDF5Config
`get_comments`(key)
`load_detector_section`(dict_)	rtype: `None`
`load_flat_dark_section`(dict_)	rtype: `None`
`load_from_dict`(dict_)	Load the configuration from a dictionary
`load_general_section`(dict_)	rtype: `None`
`load_keys_section`(dict_)	rtype: `None`
`load_sample_section`(dict_)	rtype: `None`
`load_source_section`(dict_)	rtype: `None`
`load_unit_section`(dict_)	rtype: `None`
`to_cfg_file`(file_path)
`to_dict`([level])	convert the configuration to a dictionary

Attributes

`COMMENTS`
`COMMENTS_DARK_FLAT_SECTION`
`COMMENTS_DETECTOR_SECTION_DK`
`COMMENTS_GENERAL_SECTION`
`COMMENTS_KEYS_SECTION`
`COMMENTS_SAMPLE_SECTION_DK`
`COMMENTS_SOURCE_SECTION_DK`
`COMMENTS_UNIT_SECTION_DK`
`DARK_NAMES_DK`
`DATASET_BASENAME_DK`
`DATASET_FILE_INFO_DK`
`DELETE_EDF_SOURCE_FILES`
`DETECTOR_SECTION_DK`
`DISTANCE_EXPECTED_UNIT`
`DUPLICATE_DATA_DK`
`EDF_KEYS_SECTION_DK`
`ENERGY_EXPECTED_UNIT`
`EXTERNAL_LINK_RELATIVE_DK`
`FIELD_OF_VIEW_DK`
`FILE_EXTENSION_DK`
`FLAT_DARK_SECTION_DK`
`FLAT_NAMES_DK`
`FORCE_ANGLE_CALCULATION`
`FORCE_ANGLE_CALCULATION_ENDPOINT`
`FORCE_ANGLE_CALCULATION_REVERT_NEG_SCAN_RANGE`
`GENERAL_SECTION_DK`
`IGNORE_FILE_PATTERN_DK`
`INPUT_FOLDER_DK`
`INSTRUMENT_NAME_DK`
`LEVEL_DARK_FLAT_SECTION`
`LEVEL_DETECTOR_SECTION`
`LEVEL_GENERAL_SECTION`
`LEVEL_KEYS_SECTION`
`LEVEL_SAMPLE_SECTION`
`LEVEL_SOURCE_SECTION`
`LEVEL_UNIT_SECTION`
`LOG_LEVEL_DK`
`MACHINE_ELEC_CURRENT_EXPECTED_UNIT`
`MOTOR_MNE_KEY_DK`
`MOTOR_POSITION_KEY_DK`
`OUTPUT_CHECKS`
`OUTPUT_FILE_DK`
`OVERWRITE_DK`
`PIXEL_SIZE_EXPECTED_UNIT`
`ROT_ANGLE_KEY_DK`
`SAMPLE_NAME_DK`
`SAMPLE_SECTION_DK`
`SECTIONS_LEVEL`
`SOURCE_NAME_DK`
`SOURCE_PROBE_DK`
`SOURCE_SECTION_DK`
`SOURCE_TYPE_DK`
`TITLE_DK`
`UNIT_SECTION_DK`
`X_TRANS_EXPECTED_UNIT`
`X_TRANS_KEY_DK`
`Y_TRANS_EXPECTED_UNIT`
`Y_TRANS_KEY_DK`
`Z_TRANS_EXPECTED_UNIT`
`Z_TRANS_KEY_DK`
`angle_calculation_rev_neg_scan_range`	rtype: `bool`
`dark_names`	rtype: `tuple`
`dataset_basename`	rtype: str \| None
`dataset_info_file`	rtype: str \| None
`delete_edf_source_files`	rtype: `bool`
`distance_unit`	rtype: `MetricSystem`
`duplicate_data`	rtype: `bool`
`energy_unit`	rtype: `EnergySI`
`external_path_type`	rtype: `PathType`
`field_of_view`	rtype: FieldOfView \| None
`file_extension`	rtype: `FileExtension`
`flat_names`	rtype: `tuple`
`force_angle_calculation`	rtype: `bool`
`force_angle_calculation_endpoint`	rtype: `bool`
`ignore_file_patterns`	rtype: `tuple`
`input_folder`	rtype: str \| None
`instrument_name`	rtype: str \| None
`log_level`
`machine_elec_current_unit`	rtype: `ElectricCurrentSystem`
`machine_electric_current_keys`	rtype: `Iterable`
`motor_mne_keys`	rtype: `tuple`
`motor_position_keys`	rtype: `tuple`
`output_checks`	rtype: `tuple`
`output_file`	rtype: str \| None
`overwrite`	rtype: `bool`
`pixel_size_unit`	rtype: `MetricSystem`
`rotation_angle_keys`	rtype: `Iterable`
`sample_name`	rtype: str \| None
`source_name`	rtype: str \| None
`source_probe`	rtype: ProbeType \| None
`source_type`	rtype: SourceType \| None
`title`	rtype: str \| None
`translation_z_keys`	rtype: `Iterable`
`x_trans_keys`
`x_trans_unit`	rtype: `MetricSystem`
`y_trans_keys`
`y_trans_unit`	rtype: `MetricSystem`
`z_trans_keys`
`z_trans_unit`	rtype: `MetricSystem`

static from_dict(dict_)[source]#: Create a HDF5Config object and set it from values contained in the dictionary :type dict_: dict :param dict_: settings dictionary :return: HDF5Config

load_from_dict(dict_)[source]#

Load the configuration from a dictionary

Return type:: None

to_dict(level='advanced')[source]#

convert the configuration to a dictionary

Return type:: dict