tomwer.core.process.task.BaseProcessInfo#

class tomwer.core.process.task.BaseProcessInfo(inputs=None)#

Tomwer base process class

clear_output_values()#
static definition()#

definition of the process

get_configuration()#
Return type:

dict | None

Returns:

configuration of the process

static get_most_recent_process(root_node, process, version=None)#
Return type:

h5py.Group | None

get_output_value(key)#
Parameters:

key –

Returns:

static get_processes_frm_type(process_file, process_type, entry=None)#
Parameters:

  • process_file (str) – file to read

  • process_type – process type we are looking for

Return type:

list

Returns:

list of _process_desc(sequence_index, configuration, results)

static program_name()#

Name of the program used for this processing

static program_version()#

version of the program used for this processing

static properties_help()#
Returns:

display the list of all managed keys and possible values

register_output(key, value)#
Parameters:

  • key – name of the output

  • value – value of the output

register_process(process_file, entry, configuration, results, process_index, interpretations=None, overwrite=True)#

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

Parameters:

  • process_file (str) – where to store the processing information

  • entry (str) – entry process

  • configuration (dict | None) – configuration of the process

  • results (dict | None) – result of the processing

  • process_index (int) – index of the process

  • overwrite (bool) – if True then overwrite the process if already exists

Paramerpretations:

for each result we can add a flag ‘interpretation’

Return type:

None

set_configuration(configuration)#
Return type:

None