3.10.1.17.1.6. opengate.postprocessors.unitbase

3.10.1.17.1.6.1. Attributes

__run_group_prefix__

3.10.1.17.1.6.2. Classes

ProcessingUnitBase

This is the base class used for all objects that handle user input in GATE.

3.10.1.17.1.6.3. Functions

_setter_hook_yields_to(self, yields_to)

3.10.1.17.1.6.4. Module Contents

opengate.postprocessors.unitbase.__run_group_prefix__ = 'data_from_run'

opengate.postprocessors.unitbase._setter_hook_yields_to(self, yields_to)

class opengate.postprocessors.unitbase.ProcessingUnitBase(*args, processing_group=None, **kwargs)

Bases: opengate.base.GateObject, anytree.NodeMixin

This is the base class used for all objects that handle user input in GATE.

The class is assumed to be processed by process_cls(), either explicitly or via the metaclass MetaUserInfo, before any instances of the class are created. Some class attributes, e.g. inherited_user_info_defaults, are created as part of this processing.

user_info_defaults

processing_group

output_data_handles

input_data_handles

hdf5_group = None

property post_processor

property is_processing_unit

property can_be_initial_unit

Generally, processing units cannot be the initial units in a processing tree. Those units which can be initial units, e.g. data fetcher, should override this property.

property output_file_handle

property input_units

get_or_create_output_table(*args, **kwargs)

get_or_create_output_array(*args, **kwargs)

get_or_create_output_carray(*args, **kwargs)

get_or_create_output_earray(*args, **kwargs)

get_or_create_output_group(*args, **kwargs)

_get_or_create_output_structure(which, name, link_name=None, subgroup=None, external_file=False, **kwargs)

register_output_data_handle(output_data_handle)

output_data_handle should be a mode in the hdf5_group belonging to this unit.

get_unique_identifier_within_unit(node)

get_title_for_hdf5_node()

update_tree_node()

Internal method which retrieves the volume object from the volume manager based on the mother’s name stored as user info ‘mother’

_request_processing_unit_tree_update()

initialize_hdf5_group_in_output_file()

get_unit_output_group()

store_user_attributes()

close()

Dummy implementation for inherited classes which do not implement this method.

update_output()

do_your_job()

Implement this in the concrete class.