Element-wise product product/std

Element-wise product product/std#

Description#

This transform computes an element-wise product of tracers from a given component.

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#

components_in : list, mandatory

List of components of the input tracers to be aggregated

parameters_in : list, mandatory

List of tracers to be aggregated.

component_out : str, mandatory

Component of the output tracer.

parameter_out : str, mandatory

Name of the output tracer.

Optional arguments#

parameter : str, optional

Parameter name on which the transform works on

component : str, optional

Component name on which the transform works on

orig_parameter_plg : Plugin, optional

Plugin object on which the transform works on

orig_component_plg : Plugin, optional

Corresponding component object on which the transform works on

successor : str, optional

Name of the successor transform

precursor : str, optional

Name of the precursor transform

Requirements#

The current plugin requires the present plugins to run properly:

Requirement name

Requirement type

Explicit definition

Any valid

Default name

Default version

model

Model

False

True

None

None

YAML template#

Please find below a template for a YAML configuration:

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