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: (mandatory)
List of components of the input tracers to be aggregated
accepted type: list
parameters_in: (mandatory)
List of tracers to be aggregated.
accepted type: list
component_out: (mandatory)
Component of the output tracer.
accepted type: str
parameter_out: (mandatory)
Name of the output tracer.
accepted type: str
Optional arguments¶
parameter: (optional)
Parameter name on which the transform works on
accepted type: str
component: (optional)
Component 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
Requirements¶
The current plugin requires the present plugins to run properly:
Requirement name |
Requirement type |
Explicit definition |
Any valid |
Default name |
Default version |
|---|---|---|---|---|---|
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
