Ewoks Tasks#
MeshSingleScanSingleDetector#
Test data of one XRF mesh with one detector
- Identifier:
ewoksfluo.tasks.example_data.tasks.MeshSingleScanSingleDetector- Task type:
- class
- Inputs:
- output_filename* :
str Bliss dataset HDF5 file name.
Examples:- '/data/dataset.h5'
- emission_line_groups :
List[str] - energy :
float= 12.0 - shape :
Tuple[int, int]= (50, 60) - interrupt_fraction :
float | None= None - expo_time :
float= 0.1 - flux :
float= 10000000.0 - counting_noise :
bool= True - rois :
List[Tuple[int, int]] - integral_type :
bool= True
- output_filename* :
- Outputs:
- filename :
str Bliss dataset HDF5 file name.
Examples:- '/data/dataset.h5'
- scan_number :
int Scan number.
Examples:- 1
- 2
- config :
str - expo_time :
float - monitor_name :
str - monitor_normalization_template :
str - detector_name :
str - detector_normalization_template :
str
- filename :
MeshSingleScanMultiDetector#
Test data of one XRF mesh with multiple detectors
- Identifier:
ewoksfluo.tasks.example_data.tasks.MeshSingleScanMultiDetector- Task type:
- class
- Inputs:
- output_filename* :
str Bliss dataset HDF5 file name.
Examples:- '/data/dataset.h5'
- emission_line_groups :
List[str] - energy :
float= 12.0 - shape :
Tuple[int, int]= (50, 60) - interrupt_fraction :
float | None= None - expo_time :
float= 0.1 - ndetectors :
int= 2 - flux :
float= 10000000.0 - counting_noise :
bool= True - rois :
List[Tuple[int, int]] - integral_type :
bool= True
- output_filename* :
- Outputs:
- filename :
str Bliss dataset HDF5 file name.
Examples:- '/data/dataset.h5'
- scan_number :
int Scan number.
Examples:- 1
- 2
- config :
str - configs :
List[str] - expo_time :
float - monitor_name :
str - monitor_normalization_template :
str - detector_names :
List[str] - detector_normalization_template :
str
- filename :
MeshSingleScanMultiDetectorGroups#
Test data of one XRF mesh with multiple detector groups
- Identifier:
ewoksfluo.tasks.example_data.tasks.MeshSingleScanMultiDetectorGroups- Task type:
- class
- Inputs:
- output_filename* :
str Bliss dataset HDF5 file name.
Examples:- '/data/dataset.h5'
- emission_line_groups :
List[str] - energy :
float= 12.0 - shape :
Tuple[int, int]= (50, 60) - interrupt_fraction :
float | None= None - expo_time :
float= 0.1 - ngroups :
int= 2 - ndetectors :
int= 2 - flux :
float= 10000000.0 - counting_noise :
bool= True - rois :
List[Tuple[int, int]] - integral_type :
bool= True
- output_filename* :
- Outputs:
- filename :
str Bliss dataset HDF5 file name.
Examples:- '/data/dataset.h5'
- scan_number :
int Scan number.
Examples:- 1
- 2
- config :
str - configs :
List[str] - expo_time :
float - monitor_name :
str - monitor_normalization_template :
str - detector_groups :
Dict[str, List[str]] - detector_normalization_template :
str
- filename :
MosaicMeshSingleDetector#
Test data of a mosaic XRF mesh with one detector
- Identifier:
ewoksfluo.tasks.example_data.tasks.MosaicMeshSingleDetector- Task type:
- class
- Inputs:
- output_filename* :
str Bliss dataset HDF5 file name.
Examples:- '/data/dataset.h5'
- emission_line_groups :
List[str] - energy :
float= 12.0 - shape :
Tuple[int, int]= (50, 60) - mosaic :
Tuple[int, int]= (2, 3) - interrupt_fraction :
float | None= None - expo_time :
float= 0.1 - ndetectors :
int= 1 - flux :
float= 10000000.0 - counting_noise :
bool= True - rois :
List[Tuple[int, int]] - integral_type :
bool= True
- output_filename* :
- Outputs:
- filenames :
List[str] - scan_ranges :
List[Tuple[int, int]] - config :
str - expo_time :
float - monitor_name :
str - monitor_normalization_template :
str - detector_name :
str - detector_normalization_template :
str
- filenames :
MosaicMeshMultiDetector#
Test data of a mosaic XRF mesh with multiple detectors
- Identifier:
ewoksfluo.tasks.example_data.tasks.MosaicMeshMultiDetector- Task type:
- class
- Inputs:
- output_filename* :
str Bliss dataset HDF5 file name.
Examples:- '/data/dataset.h5'
- emission_line_groups :
List[str] - energy :
float= 12.0 - shape :
Tuple[int, int]= (50, 60) - mosaic :
Tuple[int, int]= (2, 3) - interrupt_fraction :
float | None= None - expo_time :
float= 0.1 - ndetectors :
int= 2 - flux :
float= 10000000.0 - counting_noise :
bool= True - rois :
List[Tuple[int, int]] - integral_type :
bool= True
- output_filename* :
- Outputs:
- filenames :
List[str] - scan_ranges :
List[Tuple[int, int]] - configs :
List[str] - config :
str - expo_time :
float - monitor_name :
str - monitor_normalization_template :
str - detector_names :
List[str] - detector_normalization_template :
str
- filenames :
MosaicMeshMultiDetectorGroups#
Test data of a mosaic XRF mesh with multiple detector groups
- Identifier:
ewoksfluo.tasks.example_data.tasks.MosaicMeshMultiDetectorGroups- Task type:
- class
- Inputs:
- output_filename* :
str Bliss dataset HDF5 file name.
Examples:- '/data/dataset.h5'
- emission_line_groups :
List[str] - energy :
float= 12.0 - shape :
Tuple[int, int]= (50, 60) - mosaic :
Tuple[int, int]= (2, 3) - interrupt_fraction :
float | None= None - expo_time :
float= 0.1 - ngroups :
int= 2 - ndetectors :
int= 2 - flux :
float= 10000000.0 - counting_noise :
bool= True - rois :
List[Tuple[int, int]] - integral_type :
bool= True
- output_filename* :
- Outputs:
- filenames :
List[str] - scan_ranges :
List[Tuple[int, int]] - configs :
List[str] - config :
str - expo_time :
float - monitor_name :
str - monitor_normalization_template :
str - detector_groups :
Dict[str, List[str]] - detector_normalization_template :
str
- filenames :
MeshStackSingleDetector#
Test data of a stack of XRF meshes with one detector
- Identifier:
ewoksfluo.tasks.example_data.tasks.MeshStackSingleDetector- Task type:
- class
- Inputs:
- output_filename* :
str Bliss dataset HDF5 file name.
Examples:- '/data/dataset.h5'
- nscans :
int= 3 - emission_line_groups :
List[str] - energy :
float= 12.0 - shape :
Tuple[int, int]= (50, 60) - interrupt_fraction :
float | None= None - expo_time :
float= 0.1 - flux :
float= 10000000.0 - counting_noise :
bool= True - rois :
List[Tuple[int, int]] - integral_type :
bool= True
- output_filename* :
- Outputs:
- filenames :
List[str] Bliss dataset HDF5 file name.
Examples:- ['/data/dataset1.h5', '/data/dataset2.h5']
- scan_ranges :
List[Tuple[int, int]] - config :
str - expo_time :
float - monitor_name :
str - monitor_normalization_template :
str - detector_name :
str - detector_normalization_template :
str
- filenames :
MeshStackMultiDetector#
Test data of a stack of XRF meshes with multiple detectors
- Identifier:
ewoksfluo.tasks.example_data.tasks.MeshStackMultiDetector- Task type:
- class
- Inputs:
- output_filename* :
str Bliss dataset HDF5 file name.
Examples:- '/data/dataset.h5'
- nscans :
int= 3 - emission_line_groups :
List[str] - energy :
float= 12.0 - shape :
Tuple[int, int]= (50, 60) - interrupt_fraction :
float | None= None - expo_time :
float= 0.1 - ndetectors :
int= 2 - flux :
float= 10000000.0 - counting_noise :
bool= True - rois :
List[Tuple[int, int]] - integral_type :
bool= True
- output_filename* :
- Outputs:
- filenames :
List[str] Bliss dataset HDF5 file name.
Examples:- ['/data/dataset1.h5', '/data/dataset2.h5']
- scan_ranges :
List[Tuple[int, int]] - configs :
List[str] - config :
str - expo_time :
float - monitor_name :
str - monitor_normalization_template :
str - detector_names :
List[str] - detector_normalization_template :
str
- filenames :
MosaicMeshStackSingleDetector#
Test data of a stack of mosaic XRF meshes with one detector
- Identifier:
ewoksfluo.tasks.example_data.tasks.MosaicMeshStackSingleDetector- Task type:
- class
- Inputs:
- output_filename* :
str Bliss dataset HDF5 file name.
Examples:- '/data/dataset.h5'
- nscans :
int= 4 - emission_line_groups :
List[str] - energy :
float= 12.0 - shape :
Tuple[int, int]= (50, 60) - mosaic :
Tuple[int, int]= (2, 3) - interrupt_fraction :
float | None= None - expo_time :
float= 0.1 - flux :
float= 10000000.0 - counting_noise :
bool= True - rois :
List[Tuple[int, int]] - integral_type :
bool= True
- output_filename* :
- Outputs:
- filenames :
List[List[str]] Bliss dataset HDF5 file name.
Examples:- [['/data/dataset.h5'], ['/data/dataset.h5']]
- scan_ranges :
List[List[Tuple[int, int]]] - config :
str - expo_time :
float - monitor_name :
str - monitor_normalization_template :
str - detector_name :
str - detector_normalization_template :
str
- filenames :
MosaicMeshStackMultiDetector#
Test data of a stack of mosaic XRF meshes with multiple detectors
- Identifier:
ewoksfluo.tasks.example_data.tasks.MosaicMeshStackMultiDetector- Task type:
- class
- Inputs:
- output_filename* :
str Bliss dataset HDF5 file name.
Examples:- '/data/dataset.h5'
- nscans :
int= 4 - emission_line_groups :
List[str] - energy :
float= 12.0 - shape :
Tuple[int, int]= (50, 60) - mosaic :
Tuple[int, int]= (2, 3) - interrupt_fraction :
float | None= None - expo_time :
float= 0.1 - ndetectors :
int= 2 - flux :
float= 10000000.0 - counting_noise :
bool= True - rois :
List[Tuple[int, int]] - integral_type :
bool= True
- output_filename* :
- Outputs:
- filenames :
List[List[str]] Bliss dataset HDF5 file name.
Examples:- [['/data/dataset.h5'], ['/data/dataset.h5']]
- scan_ranges :
List[List[Tuple[int, int]]] - configs :
List[str] - config :
str - expo_time :
float - monitor_name :
str - monitor_normalization_template :
str - detector_names :
List[str] - detector_normalization_template :
str
- filenames :
FitSingleScanSingleDetector#
XRF fit of one scan with one detector
- Identifier:
ewoksfluo.tasks.fit.tasks.FitSingleScanSingleDetector- Task type:
- class
- Inputs:
- bliss_scan_uri* :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- detector_name* :
str NXdetector group name.
Examples:- 'fx_nano_det0'
- output_root_uri* :
str Target HDF5 file URI with optional data path.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- output_root_group :
str | None= None Optional group underneath
output_root_uri.- config* :
str | ewoksfluo.xrffit.pymca_config.model.PyMcaXrfConfiguration PyMca configuration
Examples:- '/config/configuration.cfg'
- {'peaks': {}, 'fit': {}}
- xrf_spectra_uri_template :
str= instrument/{}/data HDF5 group URI template of an XRF detector relative to bliss_scan_uri.
- process_uri_template :
str= None DEPRECATED
- energy_name :
str | None= None - energy_uri_template :
str= instrument/positioners_start/{} - quantification :
Dict[str, float] | bool | None= None - energy_multiplier :
float | None= None - fast_fitting :
bool= True - diagnostics :
bool= False - figuresofmerit :
bool | None= None
- bliss_scan_uri* :
- Outputs:
- bliss_scan_uri :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- output_root_uri :
str Original output root URI received as input.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- output_root_group :
str | None Original output root group received as input.
- xrf_results_uri :
str Output NXprocess results URI.
Examples:- '/results/dataset.h5::/1.1/fit/mca0/results'
- detector_name :
str Name of the fitted detector.
- bliss_scan_uri :
FitSingleScanMultiDetector#
XRF fit of one scan with multiple detectors
- Identifier:
ewoksfluo.tasks.fit.tasks.FitSingleScanMultiDetector- Task type:
- class
- Inputs:
- bliss_scan_uri* :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- detector_names* :
List[str] NXdetector group name.
Examples:- ['fx_nano_det0', 'fx_nano_det1']
- output_root_uri* :
str Target HDF5 file URI with optional data path.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- '/results/dataset.h5::/1.1/fit'
- output_root_group :
str | None= None Optional group underneath
output_root_uri.- configs* :
List[str | ewoksfluo.xrffit.pymca_config.model.PyMcaXrfConfiguration] PyMca configuration
Examples:- ['/config/det0.cfg', '/config/det1.cfg']
- [{'peaks': {}, 'fit': {}}, {'peaks': {}, 'fit': {}}]
- xrf_spectra_uri_template :
str= instrument/{}/data HDF5 group URI template of an XRF detector relative to bliss_scan_uri.
- process_uri_template :
str= None DEPRECATED
- energy_name :
str | None= None - energy_uri_template :
str= instrument/positioners_start/{} - quantification :
Dict[str, float] | bool | None= None - energy_multiplier :
float | None= None - fast_fitting :
bool= True - diagnostics :
bool= False - figuresofmerit :
bool | None= None
- bliss_scan_uri* :
- Outputs:
- bliss_scan_uri :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- output_root_uri :
str Original output root URI received as input.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- output_root_group :
str | None Original output root group received as input.
- xrf_results_uris :
List[str] Output NXprocess results URI.
Examples:- '/results/dataset.h5::/1.1/fit/fx_nano_det0/results'
- '/results/dataset.h5::/1.1/fit/fx_nano_det1/results'
- detector_names :
List[str] Names of the fitted detectors.
- bliss_scan_uri :
FitStackSingleDetector#
XRF fit of a stack of identical scan with one detector
- Identifier:
ewoksfluo.tasks.fit.tasks.FitStackSingleDetector- Task type:
- class
- Inputs:
- bliss_scan_uris* :
List[str] Bliss scan URI’s.
Examples:- ['/data/dataset.h5::/1.1', '/data/dataset.h5::/2.1']
- detector_name* :
str NXdetector group name.
Examples:- 'fx_nano_det0'
- output_root_uri* :
str Target HDF5 file URI with optional data path.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- '/results/dataset.h5::/1.1/fit'
- output_root_group :
str | None= None Optional group underneath
output_root_uri.- config* :
str | ewoksfluo.xrffit.pymca_config.model.PyMcaXrfConfiguration PyMca configuration
Examples:- '/config/configuration.cfg'
- {'peaks': {}, 'fit': {}}
- xrf_spectra_uri_template :
str= instrument/{}/data HDF5 group URI template of an XRF detector relative to bliss_scan_uri.
- process_uri_template :
str= None DEPRECATED
- energy_name :
str | None= None - energy_uri_template :
str= instrument/positioners_start/{} - quantification :
Dict[str, float] | bool | None= None - energy_multiplier :
float | None= None - fast_fitting :
bool= True - diagnostics :
bool= False - figuresofmerit :
bool | None= None
- bliss_scan_uris* :
- Outputs:
- bliss_scan_uris :
List[str] Bliss scan URI’s.
Examples:- ['/data/dataset.h5::/1.1', '/data/dataset.h5::/2.1']
- output_root_uri :
str Original output root URI received as input.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- output_root_group :
str | None Original output root group received as input.
- xrf_results_uri :
str Output NXprocess results URI.
Examples:- '/results/dataset.h5::/1.1/fit/fx_nano_det0/results'
- detector_name :
str Name of the fitted detector.
- bliss_scan_uris :
FitStackMultiDetector#
XRF fit of a stack of identical scan with multiple detectors
- Identifier:
ewoksfluo.tasks.fit.tasks.FitStackMultiDetector- Task type:
- class
- Inputs:
- bliss_scan_uris* :
List[str] Bliss scan URI’s.
Examples:- ['/data/dataset.h5::/1.1', '/data/dataset.h5::/2.1']
- detector_names* :
List[str] NXdetector group name.
Examples:- ['fx_nano_det0', 'fx_nano_det1']
- output_root_uri* :
str Target HDF5 file URI with optional data path.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- '/results/dataset.h5::/1.1/fit'
- output_root_group :
str | None= None Optional group underneath
output_root_uri.- configs* :
List[str | ewoksfluo.xrffit.pymca_config.model.PyMcaXrfConfiguration] PyMca configuration
Examples:- ['/config/det0.cfg', '/config/det1.cfg']
- [{'peaks': {}, 'fit': {}}, {'peaks': {}, 'fit': {}}]
- xrf_spectra_uri_template :
str= instrument/{}/data HDF5 group URI template of an XRF detector relative to bliss_scan_uri.
- process_uri_template :
str= None DEPRECATED
- energy_name :
str | None= None - energy_uri_template :
str= instrument/positioners_start/{} - quantification :
Dict[str, float] | bool | None= None - energy_multiplier :
float | None= None - fast_fitting :
bool= True - diagnostics :
bool= False - figuresofmerit :
bool | None= None
- bliss_scan_uris* :
- Outputs:
- bliss_scan_uris :
List[str] Bliss scan URI’s.
Examples:- ['/data/dataset.h5::/1.1', '/data/dataset.h5::/2.1']
- output_root_uri :
str Original output root URI received as input.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- output_root_group :
str | None Original output root group received as input.
- xrf_results_uris :
List[str] Output NXprocess results URI.
Examples:- '/results/dataset.h5::/1.1/fit/fx_nano_det0/results'
- '/results/dataset.h5::/1.1/fit/fx_nano_det1/results'
- detector_names :
List[str] Names of the fitted detectors.
- bliss_scan_uris :
SpecToBliss#
Convert SPEC master file to BLISS dataset HDF5 file.
- Identifier:
ewoksfluo.tasks.input.spec_to_bliss.SpecToBliss- Task type:
- class
- Inputs:
- input_filename* :
str SPEC master file name.
Examples:- '/data/specfile.dat'
- output_filename* :
str Bliss dataset HDF5 file name.
Examples:- '/results/dataset.h5'
- scan_numbers :
int | List[int] | None= None Scan numbers.
Examples:- 1
- [1, 2, 3]
- subscan_numbers :
int | List[int] | None= None Subscan numbers.
Examples:- 1
- [1, 2]
- input_filename* :
- Outputs:
- output_filename :
str Bliss dataset HDF5 file name.
Examples:- '/results/dataset.h5'
- output_filename :
ConcatBliss#
Concatenate Bliss scans.
- Identifier:
ewoksfluo.tasks.input.concat_bliss.ConcatBliss- Task type:
- class
- Inputs:
- bliss_scan_uris* :
List[str] List of Bliss scan URI’s to concatenate.
Examples:- ['/data/dataset1.h5::/2.1', '/data/dataset1.h5::/4.1', '/data/dataset2.h5::/100.1', '/data/dataset2.h5::/101.1']
- bliss_scan_uri* :
str Concatenated Bliss scan URI to save.
Examples:- '/result/concatenated.h5'
- '/result/concatenated.h5::/2.1'
- virtual_axes :
Dict[str, str] Virtual positioners which are typically the sum of scalar and moving motor positions.
Examples:- {'sy': '<nsy>+<nspy>', 'sz': '<nsz>+<nspz>'}
- axes_units :
Dict[str, str] Axes units to be used when missing.
Examples:- {'nsy': 'mm', 'nsz': 'mm', 'nspy': 'um', 'nspz': 'um'}
- bliss_scan_uris* :
- Outputs:
- bliss_scan_uri :
str Bliss scan URI.
Examples:- '/result/concatenated.h5::/2.1'
- bliss_scan_uri :
ConcatBlissScanGroups#
Concatenate multiple groups of Bliss scans.
- Identifier:
ewoksfluo.tasks.input.concat_bliss_groups.ConcatBlissScanGroups- Task type:
- class
- Inputs:
- bliss_scan_uris* :
List[List[str]] Several list of Bliss scan URI’s to concatenate.
Examples:- [['/data/dataset1.h5::/2.1', '/data/dataset2.h5::/2.1'], ['/data/dataset1.h5::/3.1', '/data/dataset2.h5::/3.1']]
- output_root_uri* :
str Target HDF5 file URI with optional data path.
Examples:- '/result/concatenated.h5'
- virtual_axes :
Dict[str, str] Virtual positioners which are typically the sum of scalar and moving motor positions.
Examples:- {'sy': '<nsy>+<nspy>', 'sz': '<nsz>+<nspz>'}
- axes_units :
Dict[str, str] Axes units to be used when missing.
Examples:- {'nsy': 'mm', 'nsz': 'mm', 'nspy': 'um', 'nspz': 'um'}
- bliss_scan_uris* :
- Outputs:
- bliss_scan_uris :
List[str] Bliss scan URIs.
Examples:- '/result/concatenated.h5::/2.1'
- '/result/concatenated.h5::/3.1'
- bliss_scan_uris :
PickScan#
Select a single Bliss scan.
- Identifier:
ewoksfluo.tasks.input.pick_scan.PickScan- Task type:
- class
- Inputs:
- filename* :
str Bliss dataset HDF5 file name.
Examples:- '/data/dataset.h5'
- scan_number* :
int Scan number.
Examples:- 1
- 2
- retry_timeout :
float | None= 20 Timeout in seconds when waiting for the scan to be fully written. None means wait forever. Negative means do not wait.
- retry_period :
float= 0.5 Retry period in seconds when waiting for the scan to be fully written.
- filename* :
- Outputs:
- bliss_scan_uri :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- bliss_scan_uri :
PickScanGroups#
Select groups of Bliss scans from multiple groups of files. Groups are not required to match in terms of number of files or number is scans.
- Identifier:
ewoksfluo.tasks.input.pick_scan_groups.PickScanGroups- Task type:
- class
- Inputs:
- filenames* :
List[List[str]] Groups of Bliss dataset HDF5 file names.
Examples:- [['/data/dataset1.h5', '/data/dataset2.h5'], ['/data/dataset3.h5', '/data/dataset4.h5']]
- scan_ranges* :
List[List[Tuple[int, int]]] Ranges of scan numbers for each group.
Examples:- [[(1, 4), (100, 101)], [(1, 4), (100, 101)]]
- exclude_scans :
List[List[List[int]]] Scan numbers to exclude for each range.
Examples:- [[[1, 3], [1]], [[1, 3], [1]]]
- group_by_index :
bool= False If False, preserve the input grouping. If True, regroup scans by scan index across input groups.
- retry_timeout :
float | None= 20 Timeout in seconds when waiting for the scan to be fully written. None means wait forever. Negative means do not wait.
- retry_period :
float= 0.5 Retry period in seconds when waiting for the scan to be fully written.
- filenames* :
- Outputs:
- bliss_scan_uris :
List[List[str]] Several lists of Bliss scan URI’s. Use group_by_index=True to get the transpose.
Examples:- ['/data/dataset1.h5::/2.1', '/data/dataset2.h5::/2.1']
- ['/data/dataset1.h5::/3.1', '/data/dataset2.h5::/3.1']
- bliss_scan_uris :
PickScans#
Select a multiple Bliss scan from multiple files.
- Identifier:
ewoksfluo.tasks.input.pick_scans.PickScans- Task type:
- class
- Inputs:
- filenames* :
List[str] Bliss dataset HDF5 file names.
Examples:- ['/data/dataset1.h5', '/data/dataset2.h5']
- scan_ranges* :
List[Tuple[int, int]] Ranges of scan numbers.
Examples:- [(1, 4), (100, 101)]
- exclude_scans :
List[List[int]] Scan numbers to exclude for each range.
Examples:- [[1, 3], [1]]
- retry_timeout :
float | None= 20 Timeout in seconds when waiting for the scan to be fully written. None means wait forever. Negative means do not wait.
- retry_period :
float= 0.5 Retry period in seconds when waiting for the scan to be fully written.
- filenames* :
- Outputs:
- bliss_scan_uris :
List[str] Bliss scan URI’s.
Examples:- ['/data/dataset1.h5::/2.1', '/data/dataset1.h5::/4.1', '/data/dataset2.h5::/100.1', '/data/dataset2.h5::/101.1']
- bliss_scan_uris :
NormalizeXrfResults#
Normalize XRF results with raw scan counters.
Typical normalizers are beam monitors and measurement (live) time.
- Identifier:
ewoksfluo.tasks.normalization.norm_results.NormalizeXrfResults- Task type:
- class
- Inputs:
- bliss_scan_uri* :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- output_root_uri* :
str Target HDF5 file URI with optional data path.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- '/results/dataset.h5::/1.1/norm'
- output_root_group :
str | None= None Optional group underneath
output_root_uri.- xrf_results_uri* :
str Previous XRF NXprocess URI to normalize.
Examples:- '/results/dataset.h5::/1.1/sum/results'
- normalization_expression :
str | None= None Arithmetic expression to be used for normalization.
- counter_normalization_template :
str | None= np.nanmean(<instrument/{}/data>)/<instrument/{}/data> Arithmetic expression to be used for normalization. HDF5 URI’s <…> are relative to
bliss_scan_uris.- counter_name :
str | None= None To be used in
counter_normalization_template.- detector_normalization_template :
str | None= 1./<instrument/{}/live_time> Arithmetic expression to be used for normalization. HDF5 URI’s <…> are relative to
bliss_scan_uris.- detector_name :
str | None= None To be used in
detector_normalization_template.
- bliss_scan_uri* :
- Outputs:
- bliss_scan_uri :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- output_root_uri :
str Original output root URI received as input.
Examples:- '/results/dataset.h5::/1.1'
- output_root_group :
str | None Original output root group received as input.
- xrf_results_uri :
str Output NXprocess results URI.
Examples:- '/results/dataset.h5::/1.1/norm/results'
- bliss_scan_uri :
NormalizeXrfResultsStack#
Normalize XRF stack results with raw scan counters.
Typical normalizers are beam monitors and measurement (live) time.
- Identifier:
ewoksfluo.tasks.normalization.norm_results_stack.NormalizeXrfResultsStack- Task type:
- class
- Inputs:
- bliss_scan_uris* :
List[str] Bliss scan URI’s.
Examples:- ['/data/dataset.h5::/1.1', '/data/dataset.h5::/2.1']
- output_root_uri* :
str Target HDF5 file URI with optional data path.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- '/results/dataset.h5::/1.1/norm'
- output_root_group :
str | None= None Optional group underneath
output_root_uri.- xrf_results_uri* :
str Previous XRF NXprocess URI to normalize.
Examples:- '/results/dataset.h5::/1.1/sum/results'
- normalization_expression :
str | None= None Arithmetic expression to be used for normalization.
- counter_normalization_template :
str | None= np.nanmean(<instrument/{}/data>)/<instrument/{}/data> Arithmetic expression to be used for normalization. HDF5 URI’s <…> are relative to
bliss_scan_uris.- counter_name :
str | None= None To be used in
counter_normalization_template.- detector_normalization_template :
str | None= 1./<instrument/{}/live_time> Arithmetic expression to be used for normalization. HDF5 URI’s <…> are relative to
bliss_scan_uris.- detector_name :
str | None= None To be used in
detector_normalization_template.
- bliss_scan_uris* :
- Outputs:
- bliss_scan_uris :
List[str] Bliss scan URI’s.
Examples:- ['/data/dataset.h5::/1.1', '/data/dataset.h5::/2.1']
- output_root_uri :
str Original output root URI received as input.
Examples:- '/results/dataset.h5::/1.1'
- output_root_group :
str | None Original output root group received as input.
- xrf_results_uri :
str Output NXprocess results URI.
Examples:- '/results/dataset.h5::/1.1/norm/results'
- bliss_scan_uris :
ExtractRawCounters#
Extract raw single-scan counters and save them like XRF results.
- Identifier:
ewoksfluo.tasks.raw_counters.extract_counters.ExtractRawCounters- Task type:
- class
- Inputs:
- bliss_scan_uri* :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- output_root_uri* :
str Target HDF5 file URI with optional data path.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- '/results/dataset.h5::/1.1/merge'
- output_root_group :
str | None= None Optional group underneath
output_root_uri.- xrf_results_uri :
str | None= None Previous XRF NXprocess URI to merge the raw Bliss counters with.
Examples:- '/results/dataset.h5::/1.1/sum/results'
- bliss_scan_uri* :
- Outputs:
- bliss_scan_uri :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- output_root_uri :
str Original output root URI received as input.
Examples:- '/results/dataset.h5::/1.1'
- output_root_group :
str | None Original output root group received as input.
- xrf_results_uri :
str Output NXprocess results URI.
Examples:- '/results/dataset.h5::/1.1/merge/results'
- bliss_scan_uri :
ExtractRawCountersStack#
Extract raw stack counters and save them like XRF results.
- Identifier:
ewoksfluo.tasks.raw_counters.extract_counters_stack.ExtractRawCountersStack- Task type:
- class
- Inputs:
- bliss_scan_uris* :
List[str] Bliss scan URI.
Examples:- ['/data/dataset.h5::/1.1', '/data/dataset.h5::/2.1']
- output_root_uri* :
str Target HDF5 file URI with optional data path.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- '/results/dataset.h5::/1.1/merge'
- output_root_group :
str | None= None Optional group underneath
output_root_uri.- xrf_results_uri :
str | None= None Previous XRF NXprocess URI to merge the raw Bliss counters with.
Examples:- '/results/dataset.h5::/1.1/sum/results'
- bliss_scan_uris* :
- Outputs:
- bliss_scan_uris :
List[str] Bliss scan URI.
Examples:- ['/data/dataset.h5::/1.1', '/data/dataset.h5::/2.1']
- output_root_uri :
str Original output root URI received as input.
Examples:- '/results/dataset.h5::/1.1'
- output_root_group :
str | None Original output root group received as input.
- xrf_results_uri :
str Output NXprocess results URI.
Examples:- '/results/dataset.h5::/1.1/merge/results'
- bliss_scan_uris :
RegridXrfResults#
Regrid single-scan XRF results on a regular grid by interpolation.
- Identifier:
ewoksfluo.tasks.regrid.regrid.RegridXrfResults- Task type:
- class
- Inputs:
- bliss_scan_uri* :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- output_root_uri* :
str Target HDF5 file URI with optional data path.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- '/results/dataset.h5::/1.1/regrid'
- output_root_group :
str | None= None Optional group underneath
output_root_uri.- xrf_results_uri* :
str Previous XRF NXprocess URI to regrid.
Examples:- '/results/dataset.h5::/1.1/norm/results'
- positioners :
List[str] | str | None= None - positioner_uri_template :
str= measurement/{} - ignore_positioners :
List[str] | None= None - interpolate :
Literal['none', 'nearest', 'linear', 'cubic']= nearest - resolution :
dict | None= None - axes_units :
Dict[str, str] Axes units to be used when missing.
Examples:- {'nsy': 'mm', 'nsz': 'mm', 'nspy': 'um', 'nspz': 'um'}
- bliss_scan_uri* :
- Outputs:
- bliss_scan_uri :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- output_root_uri :
str Original output root URI received as input.
Examples:- '/results/dataset.h5::/1.1'
- output_root_group :
str | None Original output root group received as input.
- xrf_results_uri :
str Output NXprocess results URI.
Examples:- '/results/dataset.h5::/1.1/regrid/results'
- bliss_scan_uri :
RegridXrfResultsStack#
Regrid XRF stack results on a regular grid by interpolation.
- Identifier:
ewoksfluo.tasks.regrid.regrid_stack.RegridXrfResultsStack- Task type:
- class
- Inputs:
- bliss_scan_uris* :
List[str] Bliss scan URI’s.
Examples:- ['/data/dataset.h5::/1.1', '/data/dataset.h5::/2.1']
- output_root_uri* :
str Target HDF5 file URI with optional data path.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- '/results/dataset.h5::/1.1/regrid'
- output_root_group :
str | None= None Optional group underneath
output_root_uri.- xrf_results_uri* :
str Previous XRF NXprocess URI to regrid.
Examples:- '/results/dataset.h5::/1.1/regrid/results'
- stack_positioner :
str | None= None - positioners :
List[str] | str | None= None - positioner_uri_template :
str= measurement/{} - ignore_positioners :
List[str] | None= None - interpolate :
Literal['nearest', 'linear', 'cubic']= nearest - resolution :
dict | None= None - axes_units :
Dict[str, str] Axes units to be used when missing.
Examples:- {'nsy': 'mm', 'nsz': 'mm', 'nspy': 'um', 'nspz': 'um'}
- bliss_scan_uris* :
- Outputs:
- bliss_scan_uris :
List[str] Bliss scan URI’s.
Examples:- ['/data/dataset.h5::/1.1', '/data/dataset.h5::/2.1']
- output_root_uri :
str Original output root URI received as input.
Examples:- '/results/dataset.h5::/1.1'
- output_root_group :
str | None Original output root group received as input.
- xrf_results_uri :
str Output NXprocess results URI.
Examples:- '/results/dataset.h5::/1.1/regrid/results'
- bliss_scan_uris :
SumXrfResults#
Add single-scan XRF results of multiple detectors.
- Identifier:
ewoksfluo.tasks.sum_detectors.sum_results.SumXrfResults- Task type:
- class
- Inputs:
- bliss_scan_uri* :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- detector_names* :
List[str] NXdetector group name.
Examples:- ['fx_nano_det0', 'fx_nano_det1']
- output_root_uri* :
str Target HDF5 file URI with optional data path.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- '/results/dataset.h5::/1.1/sum'
- output_root_group :
str | None= None Optional group underneath
output_root_uri.- xrf_results_uris* :
List[str] Output NXprocess results URIs.
Examples:- ['/results/dataset.h5::/1.1/fit/mca1/results', '/results/dataset.h5::/1.1/fit/mca2/results']
- detector_normalization_template :
str | None= 1./<instrument/{}/live_time> Expression to evaluate and multiply each spectrum with before summing. HDF5 URI’s <…> are relative to
bliss_scan_uris.
- bliss_scan_uri* :
- Outputs:
- bliss_scan_uri :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- output_root_uri :
str Original output root URI received as input.
Examples:- '/results/dataset.h5::/1.1'
- output_root_group :
str | None Original output root group received as input.
- xrf_results_uri :
str Output NXprocess results URI.
Examples:- '/results/dataset.h5::/1.1/sum/results'
- bliss_scan_uri :
SumXrfResultsStack#
Add XRF stack results of multiple detectors
- Identifier:
ewoksfluo.tasks.sum_detectors.sum_results_stack.SumXrfResultsStack- Task type:
- class
- Inputs:
- bliss_scan_uris* :
List[str] Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- '/data/dataset.h5::/2.1'
- detector_names* :
List[str] NXdetector group name.
Examples:- ['fx_nano_det0', 'fx_nano_det1']
- output_root_uri* :
str Target HDF5 file URI with optional data path.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- '/results/dataset.h5::/1.1/sum'
- output_root_group :
str | None= None Optional group underneath
output_root_uri.- xrf_results_uris* :
List[str] Output NXprocess results URIs.
Examples:- ['/results/dataset.h5::/1.1/fit/mca1/results', '/results/dataset.h5::/1.1/fit/mca2/results']
- detector_normalization_template :
str | None= 1./<instrument/{}/live_time> Expression to evaluate and multiply each spectrum with before summing. HDF5 URI’s <…> are relative to
bliss_scan_uris.
- bliss_scan_uris* :
- Outputs:
- bliss_scan_uris :
List[str] Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- '/data/dataset.h5::/2.1'
- output_root_uri :
str Original output root URI received as input.
Examples:- '/results/dataset.h5::/1.1'
- output_root_group :
str | None Original output root group received as input.
- xrf_results_uri :
str Output NXprocess results URI.
Examples:- '/results/dataset.h5::/1.1/sum/results'
- bliss_scan_uris :
SumXrfSpectra#
Add single-scan XRF spectra from multiple detectors.
- Identifier:
ewoksfluo.tasks.sum_detectors.sum_spectra.SumXrfSpectra- Task type:
- class
- Inputs:
- bliss_scan_uri* :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- detector_names* :
List[str] NXdetector group name.
Examples:- ['fx_nano_det0', 'fx_nano_det1']
- output_root_uri* :
str Target HDF5 file URI with optional data path.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- '/results/dataset.h5::/1.1/sumspectra'
- output_root_group :
str | None= None Optional group underneath
output_root_uri.- xrf_spectra_uri_template :
str= instrument/{}/data HDF5 group URI template of an XRF detector relative to bliss_scan_uri.
- detector_normalization_template :
str | None= 1./<instrument/{}/live_time> Expression to evaluate and multiply each spectrum with before summing. HDF5 URI’s <…> are relative to
bliss_scan_uris.- output_detector_name :
str= mcasum
- bliss_scan_uri* :
- Outputs:
- bliss_scan_uri :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- output_root_uri :
str Original output root URI received as input.
Examples:- '/results/dataset.h5::/1.1'
- output_root_group :
str | None Original output root group received as input.
- detector_name :
str Name of the detector containing the summed XRF spectra.
- xrf_spectra_uri_template :
str HDF5 group URI template of an XRF detector relative to output_root_uri.
- bliss_scan_uri :
PartialSumXrfSpectra#
Add single-scan XRF spectra from multiple detector groups.
- Identifier:
ewoksfluo.tasks.sum_detectors.sum_spectra_partial.PartialSumXrfSpectra- Task type:
- class
- Inputs:
- bliss_scan_uri* :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- detector_groups* :
Dict[str, List[str]] Mapping of output detector name to list of detector names.
Examples:- {'mcasum1': ['fx_nano_det0', 'fx_nano_det1'], 'mcasum2': ['fx_nano_det3', 'fx_nano_det4']}
- output_root_uri* :
str Target HDF5 file URI with optional data path.
Examples:- '/results/dataset.h5'
- '/results/dataset.h5::/1.1'
- '/results/dataset.h5::/1.1/sumspectra'
- output_root_group :
str | None= None Optional group underneath
output_root_uri.- xrf_spectra_uri_template :
str= instrument/{}/data HDF5 group URI template of an XRF detector relative to bliss_scan_uri.
- detector_normalization_template :
str | None= 1./<instrument/{}/live_time> Expression to evaluate and multiply each spectrum with before summing. HDF5 URI’s <…> are relative to
bliss_scan_uris.
- bliss_scan_uri* :
- Outputs:
- bliss_scan_uri :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- output_root_uri :
str Original output root URI received as input.
Examples:- '/results/dataset.h5::/1.1'
- output_root_group :
str | None Original output root group received as input.
- detector_names :
List[str] Name of the detectors containing the summed XRF spectra.
- xrf_spectra_uri_template :
str HDF5 group URI template of an XRF detector relative to output_root_uri.
- bliss_scan_uri :
Additional models#
PyMcaXrfConfiguration#
- Fields:
- peaks :
Dict[str, str | List[str]] - fit :
ewoksfluo.xrffit.pymca_config.model.Fit - concentrations :
ewoksfluo.xrffit.pymca_config.model.Concentrations - detector :
ewoksfluo.xrffit.pymca_config.model.Detector - peakshape :
ewoksfluo.xrffit.pymca_config.model.PeakShape - materials :
Dict[str, ewoksfluo.xrffit.pymca_config.model.Material] - attenuators :
Dict[str, List[Any]] - multilayer :
Dict[str, List[Any]] - userattenuators :
Dict[str, ewoksfluo.xrffit.pymca_config.model.UserAttenuator] - tube :
ewoksfluo.xrffit.pymca_config.model.Tube | None= None - xrfmc :
ewoksfluo.xrffit.pymca_config.model.XRFMC | None= None - fisx :
ewoksfluo.xrffit.pymca_config.model.Fisx | None= None
- peaks :
Fit#
- Fields:
- deltaonepeak :
float | None= None - strategy :
str | None= None - strategyflag :
int | None= None - fitfunction :
int | None= None - continuum :
int | None= None - fitweight :
int | None= None - stripalgorithm :
int | None= None 0: STRIP, 1: SNIP
- linpolorder :
int | None= None - exppolorder :
int | None= None - stripconstant :
float | None= None - snipwidth :
int | None= None - stripiterations :
int | None= None - stripwidth :
int | None= None - stripfilterwidth :
int | None= None - stripanchorsflag :
int | None= None - maxiter :
int | None= None - deltachi :
float | None= None - xmin :
int | None= None - xmax :
int | None= None - linearfitflag :
int | None= None - use_limit :
int | None= None - stripflag :
int | None= None - escapeflag :
int | None= None - sumflag :
int | None= None - scatterflag :
int | None= None - hypermetflag :
int | None= None - stripanchorslist :
List[int] - energy :
List[float | None | Literal['None', 'NONE']] | float | None | Literal['None', 'NONE'] - energyweight :
List[float] | float - energyflag :
List[int] | int - energyscatter :
List[int] | int
- deltaonepeak :
Concentrations#
- Fields:
- usematrix :
int | None= None - useattenuators :
int | None= None - usemultilayersecondary :
int | None= None - usexrfmc :
int | None= None - mmolarflag :
int | None= None - flux :
float | None= None - time :
float | None= None - area :
float | None= None - distance :
float | None= None - reference :
str | None= None - useautotime :
int | None= None
- usematrix :
Detector#
- Fields:
- detele* :
str - nthreshold* :
int - zero* :
float - deltazero* :
float - fixedzero* :
int - gain* :
float - deltagain* :
float - fixedgain* :
int - noise* :
float - deltanoise* :
float - fixednoise* :
int - fano* :
float - deltafano* :
float - fixedfano* :
int - sum* :
float - deltasum* :
float - fixedsum* :
int - ignoreinputcalibration :
int | None= None - ethreshold :
float | None= None - ithreshold :
float | None= None
- detele* :
PeakShape#
- Fields:
- st_arearatio* :
float - deltast_arearatio* :
float - fixedst_arearatio* :
int - st_sloperatio* :
float - deltast_sloperatio* :
float - fixedst_sloperatio* :
int - lt_arearatio* :
float - deltalt_arearatio* :
float - fixedlt_arearatio* :
int - lt_sloperatio* :
float - deltalt_sloperatio* :
float - fixedlt_sloperatio* :
int - step_heightratio* :
float - deltastep_heightratio* :
float - fixedstep_heightratio* :
int - eta_factor :
float | None= None - deltaeta_factor :
float | None= None - fixedeta_factor :
int | None= None
- st_arearatio* :
Material#
- Fields:
- Comment :
str | None= None - Density* :
float - Thickness :
float | None= None - CompoundFraction* :
float | Literal[''] | List[float] - CompoundList* :
str | List[str] key in materials or chemical formula
- Comment :
UserAttenuator#
- Fields:
- use* :
int - name* :
str - comment* :
str | None - energy* :
float | List[float] - transmission* :
float | List[float]
- use* :
Tube#
- Fields:
- transmission* :
int - voltage* :
float - anode* :
str - anodethickness* :
float - anodedensity* :
float - window* :
str - windowthickness* :
float - windowdensity* :
float - filter1* :
str - filter1thickness* :
float - filter1density* :
float - alphax* :
float - alphae* :
float - deltaplotting* :
float
- transmission* :
XRFMC#
- Fields:
- program :
str | None= None - setup* :
ewoksfluo.xrffit.pymca_config.model.XRFMCSetup
- program :
XRFMCSetup#
- Fields:
- p_polarisation* :
float - source_sample_distance* :
float - slit_distance* :
float - slit_width_x* :
float - slit_width_y* :
float - source_size_x* :
float - source_size_y* :
float - source_diverg_x* :
float - source_diverg_y* :
float - nmax_interaction* :
int - layer* :
int - collimator_height* :
float - collimator_diameter* :
float - histories* :
int
- p_polarisation* :
Fisx#
PyMcaXrfConfiguration#
- Fields:
- peaks :
Dict[str, str | List[str]] - fit :
ewoksfluo.xrffit.pymca_config.model.Fit - concentrations :
ewoksfluo.xrffit.pymca_config.model.Concentrations - detector :
ewoksfluo.xrffit.pymca_config.model.Detector - peakshape :
ewoksfluo.xrffit.pymca_config.model.PeakShape - materials :
Dict[str, ewoksfluo.xrffit.pymca_config.model.Material] - attenuators :
Dict[str, List[Any]] - multilayer :
Dict[str, List[Any]] - userattenuators :
Dict[str, ewoksfluo.xrffit.pymca_config.model.UserAttenuator] - tube :
ewoksfluo.xrffit.pymca_config.model.Tube | None= None - xrfmc :
ewoksfluo.xrffit.pymca_config.model.XRFMC | None= None - fisx :
ewoksfluo.xrffit.pymca_config.model.Fisx | None= None
- peaks :
Fit#
- Fields:
- deltaonepeak :
float | None= None - strategy :
str | None= None - strategyflag :
int | None= None - fitfunction :
int | None= None - continuum :
int | None= None - fitweight :
int | None= None - stripalgorithm :
int | None= None 0: STRIP, 1: SNIP
- linpolorder :
int | None= None - exppolorder :
int | None= None - stripconstant :
float | None= None - snipwidth :
int | None= None - stripiterations :
int | None= None - stripwidth :
int | None= None - stripfilterwidth :
int | None= None - stripanchorsflag :
int | None= None - maxiter :
int | None= None - deltachi :
float | None= None - xmin :
int | None= None - xmax :
int | None= None - linearfitflag :
int | None= None - use_limit :
int | None= None - stripflag :
int | None= None - escapeflag :
int | None= None - sumflag :
int | None= None - scatterflag :
int | None= None - hypermetflag :
int | None= None - stripanchorslist :
List[int] - energy :
List[float | None | Literal['None', 'NONE']] | float | None | Literal['None', 'NONE'] - energyweight :
List[float] | float - energyflag :
List[int] | int - energyscatter :
List[int] | int
- deltaonepeak :
Concentrations#
- Fields:
- usematrix :
int | None= None - useattenuators :
int | None= None - usemultilayersecondary :
int | None= None - usexrfmc :
int | None= None - mmolarflag :
int | None= None - flux :
float | None= None - time :
float | None= None - area :
float | None= None - distance :
float | None= None - reference :
str | None= None - useautotime :
int | None= None
- usematrix :
Detector#
- Fields:
- detele* :
str - nthreshold* :
int - zero* :
float - deltazero* :
float - fixedzero* :
int - gain* :
float - deltagain* :
float - fixedgain* :
int - noise* :
float - deltanoise* :
float - fixednoise* :
int - fano* :
float - deltafano* :
float - fixedfano* :
int - sum* :
float - deltasum* :
float - fixedsum* :
int - ignoreinputcalibration :
int | None= None - ethreshold :
float | None= None - ithreshold :
float | None= None
- detele* :
PeakShape#
- Fields:
- st_arearatio* :
float - deltast_arearatio* :
float - fixedst_arearatio* :
int - st_sloperatio* :
float - deltast_sloperatio* :
float - fixedst_sloperatio* :
int - lt_arearatio* :
float - deltalt_arearatio* :
float - fixedlt_arearatio* :
int - lt_sloperatio* :
float - deltalt_sloperatio* :
float - fixedlt_sloperatio* :
int - step_heightratio* :
float - deltastep_heightratio* :
float - fixedstep_heightratio* :
int - eta_factor :
float | None= None - deltaeta_factor :
float | None= None - fixedeta_factor :
int | None= None
- st_arearatio* :
Material#
- Fields:
- Comment :
str | None= None - Density* :
float - Thickness :
float | None= None - CompoundFraction* :
float | Literal[''] | List[float] - CompoundList* :
str | List[str] key in materials or chemical formula
- Comment :
UserAttenuator#
- Fields:
- use* :
int - name* :
str - comment* :
str | None - energy* :
float | List[float] - transmission* :
float | List[float]
- use* :
Tube#
- Fields:
- transmission* :
int - voltage* :
float - anode* :
str - anodethickness* :
float - anodedensity* :
float - window* :
str - windowthickness* :
float - windowdensity* :
float - filter1* :
str - filter1thickness* :
float - filter1density* :
float - alphax* :
float - alphae* :
float - deltaplotting* :
float
- transmission* :
XRFMC#
- Fields:
- program :
str | None= None - setup* :
ewoksfluo.xrffit.pymca_config.model.XRFMCSetup
- program :
XRFMCSetup#
- Fields:
- p_polarisation* :
float - source_sample_distance* :
float - slit_distance* :
float - slit_width_x* :
float - slit_width_y* :
float - source_size_x* :
float - source_size_y* :
float - source_diverg_x* :
float - source_diverg_y* :
float - nmax_interaction* :
int - layer* :
int - collimator_height* :
float - collimator_diameter* :
float - histories* :
int
- p_polarisation* :
Fisx#
PyMcaXrfConfiguration#
- Fields:
- peaks :
Dict[str, str | List[str]] - fit :
ewoksfluo.xrffit.pymca_config.model.Fit - concentrations :
ewoksfluo.xrffit.pymca_config.model.Concentrations - detector :
ewoksfluo.xrffit.pymca_config.model.Detector - peakshape :
ewoksfluo.xrffit.pymca_config.model.PeakShape - materials :
Dict[str, ewoksfluo.xrffit.pymca_config.model.Material] - attenuators :
Dict[str, List[Any]] - multilayer :
Dict[str, List[Any]] - userattenuators :
Dict[str, ewoksfluo.xrffit.pymca_config.model.UserAttenuator] - tube :
ewoksfluo.xrffit.pymca_config.model.Tube | None= None - xrfmc :
ewoksfluo.xrffit.pymca_config.model.XRFMC | None= None - fisx :
ewoksfluo.xrffit.pymca_config.model.Fisx | None= None
- peaks :
Fit#
- Fields:
- deltaonepeak :
float | None= None - strategy :
str | None= None - strategyflag :
int | None= None - fitfunction :
int | None= None - continuum :
int | None= None - fitweight :
int | None= None - stripalgorithm :
int | None= None 0: STRIP, 1: SNIP
- linpolorder :
int | None= None - exppolorder :
int | None= None - stripconstant :
float | None= None - snipwidth :
int | None= None - stripiterations :
int | None= None - stripwidth :
int | None= None - stripfilterwidth :
int | None= None - stripanchorsflag :
int | None= None - maxiter :
int | None= None - deltachi :
float | None= None - xmin :
int | None= None - xmax :
int | None= None - linearfitflag :
int | None= None - use_limit :
int | None= None - stripflag :
int | None= None - escapeflag :
int | None= None - sumflag :
int | None= None - scatterflag :
int | None= None - hypermetflag :
int | None= None - stripanchorslist :
List[int] - energy :
List[float | None | Literal['None', 'NONE']] | float | None | Literal['None', 'NONE'] - energyweight :
List[float] | float - energyflag :
List[int] | int - energyscatter :
List[int] | int
- deltaonepeak :
Concentrations#
- Fields:
- usematrix :
int | None= None - useattenuators :
int | None= None - usemultilayersecondary :
int | None= None - usexrfmc :
int | None= None - mmolarflag :
int | None= None - flux :
float | None= None - time :
float | None= None - area :
float | None= None - distance :
float | None= None - reference :
str | None= None - useautotime :
int | None= None
- usematrix :
Detector#
- Fields:
- detele* :
str - nthreshold* :
int - zero* :
float - deltazero* :
float - fixedzero* :
int - gain* :
float - deltagain* :
float - fixedgain* :
int - noise* :
float - deltanoise* :
float - fixednoise* :
int - fano* :
float - deltafano* :
float - fixedfano* :
int - sum* :
float - deltasum* :
float - fixedsum* :
int - ignoreinputcalibration :
int | None= None - ethreshold :
float | None= None - ithreshold :
float | None= None
- detele* :
PeakShape#
- Fields:
- st_arearatio* :
float - deltast_arearatio* :
float - fixedst_arearatio* :
int - st_sloperatio* :
float - deltast_sloperatio* :
float - fixedst_sloperatio* :
int - lt_arearatio* :
float - deltalt_arearatio* :
float - fixedlt_arearatio* :
int - lt_sloperatio* :
float - deltalt_sloperatio* :
float - fixedlt_sloperatio* :
int - step_heightratio* :
float - deltastep_heightratio* :
float - fixedstep_heightratio* :
int - eta_factor :
float | None= None - deltaeta_factor :
float | None= None - fixedeta_factor :
int | None= None
- st_arearatio* :
Material#
- Fields:
- Comment :
str | None= None - Density* :
float - Thickness :
float | None= None - CompoundFraction* :
float | Literal[''] | List[float] - CompoundList* :
str | List[str] key in materials or chemical formula
- Comment :
UserAttenuator#
- Fields:
- use* :
int - name* :
str - comment* :
str | None - energy* :
float | List[float] - transmission* :
float | List[float]
- use* :
Tube#
- Fields:
- transmission* :
int - voltage* :
float - anode* :
str - anodethickness* :
float - anodedensity* :
float - window* :
str - windowthickness* :
float - windowdensity* :
float - filter1* :
str - filter1thickness* :
float - filter1density* :
float - alphax* :
float - alphae* :
float - deltaplotting* :
float
- transmission* :
XRFMC#
- Fields:
- program :
str | None= None - setup* :
ewoksfluo.xrffit.pymca_config.model.XRFMCSetup
- program :
XRFMCSetup#
- Fields:
- p_polarisation* :
float - source_sample_distance* :
float - slit_distance* :
float - slit_width_x* :
float - slit_width_y* :
float - source_size_x* :
float - source_size_y* :
float - source_diverg_x* :
float - source_diverg_y* :
float - nmax_interaction* :
int - layer* :
int - collimator_height* :
float - collimator_diameter* :
float - histories* :
int
- p_polarisation* :
Fisx#
PyMcaXrfConfiguration#
- Fields:
- peaks :
Dict[str, str | List[str]] - fit :
ewoksfluo.xrffit.pymca_config.model.Fit - concentrations :
ewoksfluo.xrffit.pymca_config.model.Concentrations - detector :
ewoksfluo.xrffit.pymca_config.model.Detector - peakshape :
ewoksfluo.xrffit.pymca_config.model.PeakShape - materials :
Dict[str, ewoksfluo.xrffit.pymca_config.model.Material] - attenuators :
Dict[str, List[Any]] - multilayer :
Dict[str, List[Any]] - userattenuators :
Dict[str, ewoksfluo.xrffit.pymca_config.model.UserAttenuator] - tube :
ewoksfluo.xrffit.pymca_config.model.Tube | None= None - xrfmc :
ewoksfluo.xrffit.pymca_config.model.XRFMC | None= None - fisx :
ewoksfluo.xrffit.pymca_config.model.Fisx | None= None
- peaks :
Fit#
- Fields:
- deltaonepeak :
float | None= None - strategy :
str | None= None - strategyflag :
int | None= None - fitfunction :
int | None= None - continuum :
int | None= None - fitweight :
int | None= None - stripalgorithm :
int | None= None 0: STRIP, 1: SNIP
- linpolorder :
int | None= None - exppolorder :
int | None= None - stripconstant :
float | None= None - snipwidth :
int | None= None - stripiterations :
int | None= None - stripwidth :
int | None= None - stripfilterwidth :
int | None= None - stripanchorsflag :
int | None= None - maxiter :
int | None= None - deltachi :
float | None= None - xmin :
int | None= None - xmax :
int | None= None - linearfitflag :
int | None= None - use_limit :
int | None= None - stripflag :
int | None= None - escapeflag :
int | None= None - sumflag :
int | None= None - scatterflag :
int | None= None - hypermetflag :
int | None= None - stripanchorslist :
List[int] - energy :
List[float | None | Literal['None', 'NONE']] | float | None | Literal['None', 'NONE'] - energyweight :
List[float] | float - energyflag :
List[int] | int - energyscatter :
List[int] | int
- deltaonepeak :
Concentrations#
- Fields:
- usematrix :
int | None= None - useattenuators :
int | None= None - usemultilayersecondary :
int | None= None - usexrfmc :
int | None= None - mmolarflag :
int | None= None - flux :
float | None= None - time :
float | None= None - area :
float | None= None - distance :
float | None= None - reference :
str | None= None - useautotime :
int | None= None
- usematrix :
Detector#
- Fields:
- detele* :
str - nthreshold* :
int - zero* :
float - deltazero* :
float - fixedzero* :
int - gain* :
float - deltagain* :
float - fixedgain* :
int - noise* :
float - deltanoise* :
float - fixednoise* :
int - fano* :
float - deltafano* :
float - fixedfano* :
int - sum* :
float - deltasum* :
float - fixedsum* :
int - ignoreinputcalibration :
int | None= None - ethreshold :
float | None= None - ithreshold :
float | None= None
- detele* :
PeakShape#
- Fields:
- st_arearatio* :
float - deltast_arearatio* :
float - fixedst_arearatio* :
int - st_sloperatio* :
float - deltast_sloperatio* :
float - fixedst_sloperatio* :
int - lt_arearatio* :
float - deltalt_arearatio* :
float - fixedlt_arearatio* :
int - lt_sloperatio* :
float - deltalt_sloperatio* :
float - fixedlt_sloperatio* :
int - step_heightratio* :
float - deltastep_heightratio* :
float - fixedstep_heightratio* :
int - eta_factor :
float | None= None - deltaeta_factor :
float | None= None - fixedeta_factor :
int | None= None
- st_arearatio* :
Material#
- Fields:
- Comment :
str | None= None - Density* :
float - Thickness :
float | None= None - CompoundFraction* :
float | Literal[''] | List[float] - CompoundList* :
str | List[str] key in materials or chemical formula
- Comment :
UserAttenuator#
- Fields:
- use* :
int - name* :
str - comment* :
str | None - energy* :
float | List[float] - transmission* :
float | List[float]
- use* :
Tube#
- Fields:
- transmission* :
int - voltage* :
float - anode* :
str - anodethickness* :
float - anodedensity* :
float - window* :
str - windowthickness* :
float - windowdensity* :
float - filter1* :
str - filter1thickness* :
float - filter1density* :
float - alphax* :
float - alphae* :
float - deltaplotting* :
float
- transmission* :
XRFMC#
- Fields:
- program :
str | None= None - setup* :
ewoksfluo.xrffit.pymca_config.model.XRFMCSetup
- program :
XRFMCSetup#
- Fields:
- p_polarisation* :
float - source_sample_distance* :
float - slit_distance* :
float - slit_width_x* :
float - slit_width_y* :
float - source_size_x* :
float - source_size_y* :
float - source_diverg_x* :
float - source_diverg_y* :
float - nmax_interaction* :
int - layer* :
int - collimator_height* :
float - collimator_diameter* :
float - histories* :
int
- p_polarisation* :