est.core.process package

Subpackages

est.core.process.process module

module for process base class

class est.core.process.process.Process(name)

Bases: object

addCallback(callback)
property advancement
property callbacks
definition() → str

definition of the process

getConfiguration() → dict
Returns

configuration of the process

Return type

dict

static getXasObject(xas_obj) → est.core.types.xasobject.XASObject
property name
program_name() → str

Name of the program used for this processing

program_version() → str

version of the program used for this processing

register_process(xas_obj: est.core.types.xasobject.XASObject, data_keys: Iterable, plots: Iterable = ())

Store the current process in the linked h5 file if any, output data stored will be the one defined by the data_keys

Parameters

  • xas_obj – object for which we want to save the treatment

  • data_keys (tuple) – keys of the id to save

  • plots –

Type

XASObject

setConfiguration(configuration: dict)
stop()
update_properties(properties)

est.core.process.progress module

module for giving information on process progress

class est.core.process.progress.Progress(name)

Bases: object

Simple interface for defining advancement on a 100 percentage base

endProcess()
increaseAdvancement(i=1)
reset(max_=None)
setAdvancement(value)
setMaxSpectrum(n)
startProcess()

est.core.process.roi module

class est.core.process.roi.ROIProcess

Bases: est.core.process.process.Process

inputs = [_input_desc(name='xas_obj', type=<class 'est.core.types.xasobject.XASObject'>, handler='process', doc='')]
outputs = [_output_desc(name='xas_obj', type=<class 'est.core.types.xasobject.XASObject'>, doc='')]
process(xas_obj: Union[dict, est.core.types.xasobject.XASObject])
Parameters

xas_obj – object containing the configuration and spectra to process

Type

Union[XASObject, dict]

Returns

spectra dict

Return type

XASObject

setRoi(origin: Union[list, tuple], size: Union[list, tuple])
set_properties(properties: dict)
est.core.process.roi.xas_roi(xas_obj)

apply roi on the XASObject.spectra

Parameters

xas_obj – object containing the configuration and spectra to process

Type

Union[XASObject, dict]

Returns

spectra dict

Return type

XASObject

est.core.process.setup module

est.core.process.setup.configuration(parent_package='', top_path=None)

Module contents