spine.post.template

Post-processor module template.

Use this template as a basis to build your own post-processor. A post-processor takes the output of the reconstruction and either - Sets additional reconstruction attributes (e.g. direction estimates) - Adds entirely new data products (e.g. trigger time)

Classes

TemplateProcessor(arg0, arg1, obj_type, run_mode)

Description of what the post-processor is supposed to be doing.

class spine.post.template.TemplateProcessor(arg0, arg1, obj_type, run_mode)[source]

Description of what the post-processor is supposed to be doing.

Attributes:
dep_modes

Dictionary which makes the correspondance between the name of a true object deposition attribute with the underlying deposition array it points to.

keys

Dictionary of (key, necessity) pairs which determine which data keys are needed/optional for the post-processor to run.

point_modes

Dictionary which makes the correspondance between the name of a true object point attribute with the underlying point tensor it points to.

source_modes

Dictionary which makes the correspondance between the name of a true object source attribute with the underlying source tensor it points to.

Methods

__call__(data[, entry])

Calls the post processor on one entry.

check_units(obj)

Check that the point coordinates of an object are as expected.

get_depositions(obj)

Get a certain pre-defined deposition attribute of an object.

get_index(obj)

Get a certain pre-defined index attribute of an object.

get_pid(obj)

Get a certain pre-defined PID prediction of an object.

get_points(obj)

Get a certain pre-defined point attribute of an object.

get_sources(obj)

Get a certain pre-defined sources attribute of an object.

process(data)

Pass data products corresponding to one entry through the processor.

update_keys(update_dict)

Update the underlying set of keys and their necessity in place.

update_upstream(key)

Update the underlying set of required upstream modules in place.

name = 'template'
process(data)[source]

Pass data products corresponding to one entry through the processor.

Parameters:

data (dict) – Dictionary of data products