est.core.process.split.SplitBlissScan#

class est.core.process.split.SplitBlissScan(inputs: Mapping | None = None, varinfo: dict | None = None, node_id: str | int | tuple | None = None, node_attrs: dict | None = None, execinfo: dict | None = None, profile_directory: dict | None = None)[source]#

Bases: Task

Split a Bliss scan in subscans as determined by a channel which is monotonically increasing or descreasing in each subscan or determined by subscan size.

Parameters:

input_names

  • filename: HDF5 file name containing the Bliss scan.

  • scan_number: The Bliss scan number.

  • monotonic_channel: HDF5 path relative to the scan group.

  • out_filename: HDF5 file name to save subscans as a result of splitting the Bliss scan.

Parameters:

optional_input_names

  • subscan_size: Fix length subscan size.

  • trim_n_points: Trim N points from the start and end of each subscan.

  • wait_finished: Wait for the Bliss scan to be complete in HDF5.

  • retry_timeout: Timeout of waiting for the Bliss scan to be complete in HDF5.

  • retry_period: Check period of waiting for the Bliss scan to be complete in HDF5.

  • counter_group: Group of counters to check whether a subscan is fully complete.

Parameters:

output_names

  • out_urls: HDF5 URL’s of the subscans as a result of splitting the Bliss scan.

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() → str | None#
cleanup_references()#

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

property done: bool#

Completed (with or without exception)

property exception: Exception | None#
execute(force_rerun: bool | None = False, raise_on_error: bool | None = True, cleanup_references: bool | None = False)#
property failed: bool#

Completed with exception

fix_uhash()#

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

get_input_uhashes()#
get_input_value(key, default: ~typing.Any = <MISSING_DATA>) → 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: ~typing.Any = <MISSING_DATA>) → Any#
get_output_values()#
get_positional_input_values()#
classmethod get_subclass(registry_name, _second_attempt=False)#

Retrieving a derived class

classmethod get_subclass_names() → List[str]#
classmethod get_subclasses()#
get_uhash_init(serialize=False)#
classmethod input_model() → BaseInputModel | None#
classmethod input_names() → Set[str]#
property input_uhashes#
property input_values#

DEPRECATED

property input_variables: VariableContainer#
property inputs: ReadOnlyVariableContainerNamespace#
instance_nonce()#
classmethod instantiate(registry_name: str, **kw)#

Factory method for instantiating a derived class.

Parameters:

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

  • **kw – Task constructor arguments

Returns Task:

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

DEPRECATED

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

DEPRECATED

classmethod optional_input_names() → Set[str]#
property output_metadata: dict | None#
classmethod output_model() → BaseOutputModel | None#
classmethod output_names() → Set[str]#
property output_transfer_data#

DEPRECATED

property output_uhashes#

DEPRECATED

property output_values#

DEPRECATED

property output_variables: VariableContainer#
property outputs: VariableContainerNamespace#
property positional_input_values#

DEPRECATED

classmethod required_input_names() → Set[str]#
reset_state()#
run()[source]#

To be implemented by the derived classes

set_uhash_init(pre_uhash: str | bytes | UniversalHash | HasUhash | None = None, instance_nonce: Any | None = None)#
property succeeded: bool#

Completed without exception and with output values

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

This Page