3.10.1.2.1.1. opengate.actors.actoroutput

3.10.1.2.1.1.1. Classes

BaseUserInterfaceToActorOutput
UserInterfaceToActorOutputUsingDataItemContainer
UserInterfaceToActorOutputImage
ActorOutputBase	This is the base class used for all objects that handle user input in GATE.
MergeableActorOutput	This is the base class used for all objects that handle user input in GATE.
ActorOutputUsingDataItemContainer	This is the base class used for all objects that handle user input in GATE.
ActorOutputImage	This is the base class used for all objects that handle user input in GATE.
ActorOutputSingleImage	This is the base class used for all objects that handle user input in GATE.
ActorOutputSingleMeanImage	This is the base class used for all objects that handle user input in GATE.
ActorOutputSingleImageWithVariance	This is the base class used for all objects that handle user input in GATE.
ActorOutputQuotientImage	This is the base class used for all objects that handle user input in GATE.
ActorOutputQuotientMeanImage	This is the base class used for all objects that handle user input in GATE.
ActorOutputRoot	This is the base class used for all objects that handle user input in GATE.

3.10.1.2.1.1.2. Functions

_setter_hook_belongs_to(self, belongs_to)
_setter_hook_active(self, active)

3.10.1.2.1.1.3. Module Contents

class opengate.actors.actoroutput.BaseUserInterfaceToActorOutput(belongs_to_actor, user_output_name, kwargs_for_interface_calls=None)

_known_attributes = ('__setstate__', '__getstate__', 'user_output_name', 'belongs_to_actor', '_kwargs_for_interface_calls')

user_output_name

belongs_to_actor

__getstate__()

For earlier python version (<3.11), __getstate__ may not be defined. We provide a simple workaround here to return a copy of the internal dict.

property _user_output

property active

get_output_path(**kwargs)

property write_to_disk

property output_filename

property item_suffix

__getattr__(item)

__setattr__(item, value)

class opengate.actors.actoroutput.UserInterfaceToActorOutputUsingDataItemContainer(*args, item=0, **kwargs)

Bases: BaseUserInterfaceToActorOutput

class opengate.actors.actoroutput.UserInterfaceToActorOutputImage(*args, item=0, **kwargs)

Bases: UserInterfaceToActorOutputUsingDataItemContainer

property image

opengate.actors.actoroutput._setter_hook_belongs_to(self, belongs_to)

opengate.actors.actoroutput._setter_hook_active(self, active)

class opengate.actors.actoroutput.ActorOutputBase(*args, **kwargs)

Bases: opengate.base.GateObject

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.

belongs_to: str

keep_data_in_memory: bool

_default_interface_class

default_suffix = None

user_info_defaults

classmethod get_default_interface_class()

data_per_run

merged_data = None

__can_be_deactivated__ = False

__len__()

abstract set_write_to_disk(value, **kwargs)

abstract get_write_to_disk(**kwargs)

abstract set_output_filename(value, **kwargs)

abstract get_output_filename(**kwargs)

abstract get_active(**kwargs)

abstract set_active(value, **kwargs)

get_item_suffix(**kwargs)

abstract set_item_suffix(value, **kwargs)

property belongs_to_actor

initialize()

_generate_auto_output_filename(**kwargs)

_compose_output_path(which, output_filename)

get_output_path(which='merged', **kwargs)

get_output_path_as_string(**kwargs)

close()

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

abstract get_data(**kwargs)

abstract store_data(*args, **kwargs)

abstract write_data(*args, **kwargs)

abstract write_data_if_requested(**kwargs)

abstract load_data(which)

class opengate.actors.actoroutput.MergeableActorOutput(*args, **kwargs)

Bases: ActorOutputBase

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.

merge_data_after_simulation: bool

keep_data_per_run: bool

user_info_defaults

merge_data_from_runs()

merge_into_merged_data(data)

end_of_run(run_index)

end_of_simulation(**kwargs)

class opengate.actors.actoroutput.ActorOutputUsingDataItemContainer(*args, **kwargs)

Bases: MergeableActorOutput

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.

data_item_config: box.Box | None

user_info_defaults

data_container_class = None

_default_interface_class

initialize_cpp_parameters()

_fatal_unknown_item(item)

set_write_to_disk(value, item=0)

get_write_to_disk(item=0)

set_active(value, item=0)

get_active(item=0)

set_output_filename(value, item=0)

get_output_filename(item=0)

get_item_suffix(item=0, **kwargs)

set_item_suffix(value, item=0, **kwargs)

_generate_auto_output_filename(item=0)

_insert_item_suffix(output_filename, item)

_collect_item_identifiers(item)

get_output_path(which='merged', item=0, always_return_dict=False, **kwargs)

get_data_container(which)

get_data(which='merged', item=0)

store_data(which, *data)

data can be either the user data to be wrapped into a DataContainer class or an already wrapped DataContainer class.

store_meta_data(which, **meta_data)

data can be either the user data to be wrapped into a DataContainer class or an already wrapped DataContainer class.

abstract load_data(which)

collect_data(which, return_identifier=False)

write_data(which='all', item='all', **kwargs)

write_data_if_requested(which='all', item='all', **kwargs)

end_of_simulation(item='all', **kwargs)

class opengate.actors.actoroutput.ActorOutputImage(*args, **kwargs)

Bases: ActorOutputUsingDataItemContainer

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.

_default_interface_class

default_suffix = 'mhd'

set_image_properties(which, **kwargs)

get_image_properties(which, item=0)

create_empty_image(run_index, size, spacing, origin=None, **kwargs)

class opengate.actors.actoroutput.ActorOutputSingleImage(*args, **kwargs)

Bases: ActorOutputImage

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.

data_container_class

class opengate.actors.actoroutput.ActorOutputSingleMeanImage(*args, **kwargs)

Bases: ActorOutputImage

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.

data_container_class

class opengate.actors.actoroutput.ActorOutputSingleImageWithVariance(*args, **kwargs)

Bases: ActorOutputImage

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.

data_container_class

class opengate.actors.actoroutput.ActorOutputQuotientImage(*args, **kwargs)

Bases: ActorOutputImage

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.

data_container_class

class opengate.actors.actoroutput.ActorOutputQuotientMeanImage(*args, **kwargs)

Bases: ActorOutputImage

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.

data_container_class

class opengate.actors.actoroutput.ActorOutputRoot(*args, **kwargs)

Bases: ActorOutputBase

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.

output_filename: str

write_to_disk: bool

keep_data_in_memory: bool

user_info_defaults

default_suffix = 'root'

get_output_path(*args, **kwargs)

initialize()

initialize_cpp_parameters()