ComputeCorrelation< TYPE > Class Template Reference
Last update: 16.07.2025a struct which collects settings for computeCorrelation 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) | |
| computes the correlation of multiple sets of samples with another set of scalar samples If the selected designs for two correlated quantities are different, then the minimum common range of designs is detected and used for analysis. More... | |
| ComputeCorrelation (DataObjectContainer the_field_data, DataObjectContainer the_scalar_data) | |
| constructor which sets suitable defaults for all members More... | |
Static Public Member Functions | |
| static | compute (Structure database, DataObjectVector data, DataObjectVector scalar_data, string new_quantity_ident, string new_design_ident, bool overwrite_existing) |
| computes the correlation of a single set of samples with another set of scalar samples More... | |
Public Attributes | |
| DataObjectContainer | field_data |
| field samples | |
| DataObjectContainer::string_vector_type | field_quantity_idents |
| the feld quantities to be analyzed. If a quantity ident does not exist in field_data, no error appears. | |
| DataObjectContainer::string_vector_type | new_design_idents |
| the new design idents for each correlation object. The dimension and index space must fit the one of field_quantity_idents | |
| DataObjectContainer::string_vector_type | new_quantity_idents |
| the new quantity idents for each correlation object. The dimension and index space must fit the one of field_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 | scalar_data |
| scalar samples | |
| DataObjectContainer::string_vector_type | scalar_quantity_idents |
| the scalar quantities to be analyzed. If a quantity ident does not exist in field_data, no error appears. | |
Detailed Description
template<dataobject_types TYPE>
class ComputeCorrelation< TYPE >
a struct which collects settings for computeCorrelation
- Template Parameters
-
TYPE the field data type
Constructor & Destructor Documentation
◆ ComputeCorrelation()
| ComputeCorrelation | ( | DataObjectContainer | the_field_data, |
| DataObjectContainer | the_scalar_data | ||
| ) |
constructor which sets suitable defaults for all members
- Parameters
-
the_field_data the subset of field data to be token as input. the_scalar_data the subset of scalar data to be token as input. All quantity idents are extracted. Then all n field quantities is put into correlation with all m scalar quantities (n*m new objects will be computed!). As a default, the new correlation field objects are appended to the field data quantities as individual designs. The design name is "correlation[scalar_quantity_ident]".
Member Function Documentation
◆ check()
| 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.
- Parameters
-
database the SoS structure
◆ compute() [1/2]
|
static |
computes the correlation of a single set of samples with another set of scalar samples
- Parameters
-
database the output object is to be inserted in this object data a vector of field samples scalar_data a vector of scalar samples new_quantity_ident the quantity ident of the new object new_design_ident the design ident of the new object overwrite_existing defines if any result quantities may be overwritten
◆ compute() [2/2]
| compute | ( | Structure | database | ) |
computes the correlation of multiple sets of samples with another set of scalar samples If the selected designs for two correlated quantities are different, then the minimum common range of designs is detected and used for analysis.
- Parameters
-
database the output object where new objects are added to
