Tracer families or addition (families / std)

Description

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

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: <class ‘str’>

parameters_in: (mandatory)

List of tracers to be aggregated.

accepted type: <class ‘list’>

Optional arguments

component_out: (optional)

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

accepted type: <class ‘str’>

parameter_out: (optional)

Name of the output tracer.

accepted type: <class ‘str’>

Yaml template

Please find below a template for a Yaml configuration:

 1transform:
 2  plugin:
 3    name: families
 4    version: std
 5    type: transform
 6
 7  # Mandatory arguments
 8  component: XXXXX
 9  parameters_in: XXXXX
10
11  # Optional arguments
12  component_out: XXXXX
13  parameter_out: XXXXX