ExtractAboveThreshold< TYPE > Class Template Reference
Last update: 16.07.2025a struct which collects settings for extractAboveThreshold More...
Public Types | |
| typedef boost::function< DataObject::ptr_type(DataObject::ptr_type input)> | TAlgorithmFunction |
| defines a function object More... | |
| typedef boost::function< DataObject::ptr_type(Structure database, DataObject::ptr_type input)> | TAlgorithmFunction2 |
| 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, DataObject::ptr_type data, string new_quantity_ident, string new_design_ident) | |
| performs the action for a single set of samples More... | |
| compute (Structure database) | |
| performs the action using the defined settings. More... | |
| ExtractAboveThreshold (number limit) | |
| default constructor More... | |
| ExtractAboveThreshold (DataObjectContainer the_data, number limit=0) | |
| constructor which sets suitable defaults for all members More... | |
Public Attributes | |
| DataObjectContainer | data |
| the data set to be analyzed | |
| 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. | |
| number | threshold |
| the threshold | |
Detailed Description
template<dataobject_types TYPE>
class ExtractAboveThreshold< TYPE >
a struct which collects settings for extractAboveThreshold
- Template Parameters
-
TYPE the field data type
Member Typedef Documentation
◆ TAlgorithmFunction
|
inherited |
defines a function object
- Parameters
-
input a single input object
- Returns
- the result of the operation
◆ TAlgorithmFunction2
|
inherited |
defines a function object
- Parameters
-
database the database we refer to input a single input object
- Returns
- the result of the operation
Constructor & Destructor Documentation
◆ ExtractAboveThreshold() [1/2]
| ExtractAboveThreshold | ( | number | limit | ) |
default constructor
- Parameters
-
limit the threshold (used to create defaults for the new quantity idents).
◆ ExtractAboveThreshold() [2/2]
| ExtractAboveThreshold | ( | DataObjectContainer | the_data, |
| number | limit = 0 |
||
| ) |
constructor which sets suitable defaults for all members
- Parameters
-
the_data the subset of field data to be token as input. limit the threshold (used to create defaults for the new quantity idents). All quantity idents are extracted. Then for each quantity a new result object will be created.
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 for a single set of samples
- Parameters
-
database the output object is to be inserted in this object data the input data object new_quantity_ident the quantity ident of the new object new_design_ident the design ident of the new object If the input object is active, then the output object will be active as well (or inactive, respectively).
◆ compute() [2/2]
|
inherited |
performs the action using the defined settings.
- Parameters
-
database the output object where new objects are added to
