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: <class ‘list’>
parameters_in: (mandatory)
List of tracers to be aggregated.
accepted type: <class ‘list’>
component_out: (mandatory)
Component of the output tracer.
accepted type: <class ‘str’>
parameter_out: (mandatory)
Name of the output tracer.
accepted type: <class ‘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
9 parameters_in: XXXXX
10 component_out: XXXXX
11 parameter_out: XXXXX