3.10.1.17.1.1. opengate.postprocessors.base

3.10.1.17.1.1.1. Attributes

__run_group_prefix__

3.10.1.17.1.1.2. Classes

ProcessingGroupBase	This is the base class used for all objects that handle user input in GATE.
PostProcessor	This is the base class used for all objects that handle user input in GATE.
ManagedExternalLink	Variant of the ExternalLink class from PyTables.

3.10.1.17.1.1.3. Module Contents

opengate.postprocessors.base.__run_group_prefix__ = 'data_from_run'

class opengate.postprocessors.base.ProcessingGroupBase(*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.

processing_units

_need_tree_update = True

close()

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

to_dictionary()

property last_added_processing_unit

add_processing_unit(processing_unit, **kwargs)

get_processing_unit(name)

property all_processing_units

property is_post_processor

property tree_roots

get_output_groups()

update_processing_tree()

update_processing_tree_if_needed()

property processing_groups

class opengate.postprocessors.base.PostProcessor(*args, **kwargs)

Bases: ProcessingGroupBase

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_file_handle = None

extra_file_handles

initialize()

initialize_output_file()

property output_directory_external_files

property output_directory

get_extra_file_handle(identifier)

get_or_register_extra_file_handle(file_handle)

Register a handle if it is not known yet.

has_extra_file_handle(identifier)

create_external_link(where, name, target, createparents=False)

Create an external link.

Create an external link to a target node with the given name in where location. target can be a node object in another file or a path string in the form ‘file:/path/to/node’. If createparents is true, the intermediate groups required for reaching where are created (the default is not doing so).

The returned node is an ExternalLink instance.

release_file_handles()

close()

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

run()

property hdf5_group

initialize_hdf5_groups()

property all_initial_units

Get all

class opengate.postprocessors.base.ManagedExternalLink(post_processor, parentnode, name, target=None, _log=False)

Bases: tables.linkextension.ExternalLink, tables.link.Link

Variant of the ExternalLink class from PyTables.

_c_classid = 'MANAGEDEXTERNALLINK'

post_processor

The external file handler, if the link has been dereferenced. In case the link has not been dereferenced yet, its value is None.

property extfile

_get_filename_node()

Return the external filename and nodepath from self.target.

__call__(**kwargs)

Dereference self.target and return the object.

You can pass all the arguments supported by the open_file() function (except filename, of course) so as to open the referenced external file.

umount()

Safely unmount self.extfile, if opened.

__str__()

Return a short string representation of the link.