Tracer families or addition (families / std)


This transform aggregates tracers from a given component into a single output tracer. This is basically done by summing up tracers.

Yaml arguments

The following arguments are used to configure the plugin. pyCIF will return an exception at the initialization if mandatory arguments are not specified, or if any argument does not fit accepted values or type:

Mandatory arguments

component: (mandatory)

Component of the input tracers to be aggregated

accepted type: str

parameters_in: (mandatory)

List of tracers to be aggregated.

accepted type: list

Optional arguments

parameter: (optional)

Parameter name on which the transform works on

accepted type: str

orig_parameter_plg: (optional)

Plugin object on which the transform works on

accepted type: Plugin

orig_component_plg: (optional)

Corresponding component object on which the transform works on

accepted type: Plugin

successor: (optional)

Name of the successor transform

accepted type: str

precursor: (optional)

Name of the precursor transform

accepted type: str

component_out: (optional)

Component of the output tracer, if different from the input component.

accepted type: str

parameter_out: (optional)

Name of the output tracer.

accepted type: str

Yaml template

Please find below a template for a Yaml configuration:

 2  plugin:
 3    name: families
 4    version: std
 5    type: transform
 7  # Mandatory arguments
 8  component: XXXXX  # str
 9  parameters_in: XXXXX  # list
11  # Optional arguments
12  parameter: XXXXX  # str
13  orig_parameter_plg: XXXXX  # Plugin
14  orig_component_plg: XXXXX  # Plugin
15  successor: XXXXX  # str
16  precursor: XXXXX  # str
17  component_out: XXXXX  # str
18  parameter_out: XXXXX  # str