ewoksbm29.tasks.read.ReadScanDataSlice#

class ewoksbm29.tasks.read.ReadScanDataSlice(inputs=None, varinfo=None, node_id=None, node_attrs=None, execinfo=None, profile_directory=None)[source]#

Bases: Task

Return a subset of IntegrateParameters for a SAXS scan index range covered by the lima file with index lima_file_index.

Optional inputs (online & offline): - lima_file_index (int): Lima file index that determines the scan slice. - dahu_to_counter_name (dict): Map counter names to IntegrateParameters keys. - storage_ring_current (float): Storage ring current in mA. - exposure_time (float): Scan point exposure time in s.

Optional inputs (online): - scan_key (str): Blissdata scan key (tries offline when fails). - retry_timeout (float): Timeout when trying to access the Lima image dataset or wait for the scan to be PREPARED. - retry_period (float): Period in retry loops.

Optional inputs (offline): - scan_file_path (str): Bliss scan file name. - scan_number (str): Bliss scan number.

Outputs: - scan_data_slice (dict): Subset of IntegrateParameters related to the scan data. - has_data (bool): scan_data_slice contains a non-empty scan data slice. - lima_file_index (int): The lime file index to which scan_data_slice belongs. - next_lima_file_index (int): The next Lima file index.

Parameters:

  • inputs (Optional[Mapping])

  • varinfo (Optional[dict])

  • node_id (Union[str, int, tuple, None])

  • node_attrs (Optional[dict])

  • execinfo (Optional[dict])

  • profile_directory (Optional[dict])

MISSING_DATA = <MISSING_DATA>#
assert_ready_to_execute()#
cancel()#

Function called when a task is cancelled. To be implemented by the derived classes

property cancelled: bool#

Return True if the task has been cancelled by the user

classmethod class_nonce()#
classmethod class_nonce_data()#
classmethod class_registry_name()#
Return type:

Optional[str]

cleanup_references()#

Removes all references to the inputs. Side effect: fixes the uhash of the task and outputs

property done#

Completed (with or without exception)

property exception#
execute(force_rerun=False, raise_on_error=True, cleanup_references=False)#
Parameters:

  • force_rerun (Optional[bool])

  • raise_on_error (Optional[bool])

  • cleanup_references (Optional[bool])

property failed#

Completed with exception

fix_uhash()#

Fix the uhash when it is derived from the uhash data.

get_input_uhashes()#
get_input_value(key, default=<MISSING_DATA>)#
Parameters:

default (Any)

get_input_values()#
get_named_input_values()#
get_output_transfer_data()#

The values are either DataUri or Variable

get_output_uhashes()#
get_output_value(key, default=<MISSING_DATA>)#
Parameters:

default (Any)

get_output_values()#
get_positional_input_values()#
classmethod get_subclass(registry_name, _second_attempt=False)#

Retrieving a derived class

classmethod get_subclass_names()#
Return type:

List[str]

classmethod get_subclasses()#
get_uhash_init(serialize=False)#
classmethod input_model()#
classmethod input_names()#
property input_uhashes#
property input_values#

DEPRECATED

property input_variables#
property inputs#
instance_nonce()#
classmethod instantiate(registry_name, **kw)#

Factory method for instantiating a derived class.

Parameters:

  • registry_name (str) – for example “tasklib.tasks.MyTask” or “MyTask”

  • **kw – Task constructor arguments

  • registry_name

Returns Task:

property is_ready_to_execute#
property job_id: str | None#
property label#
property missing_inputs#
property missing_outputs#
property n_positional_inputs#
classmethod n_required_positional_inputs()#
property named_input_values#

DEPRECATED

property node_id: str | int | tuple#
property npositional_inputs#

DEPRECATED

classmethod optional_input_names()#
property output_metadata: dict | None#
classmethod output_names()#
property output_transfer_data#

DEPRECATED

property output_uhashes#

DEPRECATED

property output_values#

DEPRECATED

property output_variables#
property outputs#
property positional_input_values#

DEPRECATED

classmethod required_input_names()#
reset_state()#
run()[source]#

To be implemented by the derived classes

set_uhash_init(pre_uhash=None, instance_nonce=None)#
Parameters:

  • pre_uhash (Union[str, bytes, UniversalHash, HasUhash, None])

  • instance_nonce (Optional[Any])

property succeeded#

Completed without exception and with output values

property uhash: UniversalHash | None#
uhash_randomize()#
undo_fix_uhash()#
undo_randomize()#
property workflow_id: str | None#
On this page

This Page