ComputeStddev< TYPE > Class Template Reference
Last update: 01.08.2023a struct which collects settings for ComputeStddev More...
Public Types | |
| typedef boost::function< DataObject::ptr_type(Structure database, DataObjectVector samples)> | TAlgorithmFunction |
| defines a function object More... | |
Public Member Functions | |
| check (Structure database) | |
| checks the settings on plausibility It throws an exception if there is a problem with the settings. Important: It tries to find out all problems with these settings and then exits the routine. More... | |
| compute (Structure database) | |
| performs the action using the defined settings. More... | |
| compute (Structure database, DataObjectVector data, string new_quantity_ident, string new_design_ident) | |
| performs the action for a single set of samples More... | |
| ComputeStddev () | |
| default constructor | |
| ComputeStddev (DataObjectContainer the_data) | |
| constructor which sets suitable defaults for all members More... | |
Public Attributes | |
| DataObjectContainer | data |
| the data set to be analyzed | |
| string | new_design_ident |
| the design ident of the new object | |
| DataObjectContainer::string_vector_type | new_quantity_idents |
| the new idents for each quantity. The dimension and index space must fit the one of quantity_idents | |
| bool | overwrite_existing |
| is true if already existing output data objects will be replaced. In this case, also all depending objects of the already existing one will be deleted. | |
| DataObjectContainer::string_vector_type | quantity_idents |
| the quantities to be analyzed. If a quantity ident does not exist in data, no error appears. | |
Detailed Description
template<dataobject_types TYPE>
class ComputeStddev< TYPE >
a struct which collects settings for ComputeStddev
- Template Parameters
-
TYPE the field data type
Member Typedef Documentation
◆ TAlgorithmFunction
|
inherited |
defines a function object
- Parameters
-
database the database where the data refer to samples the vector of samples to which the function is applied to.
- Returns
- the result of the operation
Constructor & Destructor Documentation
◆ ComputeStddev()
| ComputeStddev | ( | DataObjectContainer | the_data | ) |
constructor which sets suitable defaults for all members
- Parameters
-
the_data the subset of field data to be token as input. All quantity idents are extracted. Then for each quantity a new result object will be created with user specific design ident.
Member Function Documentation
◆ check()
|
inherited |
checks the settings on plausibility It throws an exception if there is a problem with the settings. Important: It tries to find out all problems with these settings and then exits the routine.
- Parameters
-
database the SoS structure
◆ compute() [1/2]
|
inherited |
performs the action using the defined settings.
- Parameters
-
database the output object where new objects are added to
◆ compute() [2/2]
|
inherited |
performs the action for a single set of samples
- Parameters
-
database the output object is to be inserted in this object data a vector of samples new_quantity_ident the quantity ident of the new object new_design_ident the design ident of the new object The output object is inactive.
