Ewoks Tasks#
MeshSingleScanSingleDetector#
XRF test data of one scan 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) - 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#
XRF test data of one scan 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) - 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 :
MosaicMeshSingleDetector#
XRF test data of a mosaic scan 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) - 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#
XRF test data of a mosaic scan 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) - 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 :
MeshStackSingleDetector#
XRF test data of a stack of identical scans 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) - 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#
XRF test data of a stack of identical scans 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) - 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 :
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 :
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
- filename* :
- Outputs:
- bliss_scan_uri :
str Bliss scan URI.
Examples:- '/data/dataset.h5::/1.1'
- bliss_scan_uri :
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], []]
- filenames* :
- Outputs:
- bliss_scan_uris :
List[str] Bliss scan URI.
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 :