## On this page

  

 

 # ComputeRelativeMaxima< TYPE > Class Template Reference

 Last update: 16.07.2025 

a struct which collects settings for *[ComputeRelativeMaxima](class_compute_relative_maxima.xhtml "a struct which collects settings for ComputeRelativeMaxima ")* [More...](class_compute_relative_maxima.xhtml#details)

## <a name="pub-types"></a>Public Types

typedef boost::function&lt; DataObject::ptr\_type(DataObject::ptr\_type input)&gt; [TAlgorithmFunction](class_compute_single_object_per_object.xhtml#afe5cfc4ea6277ec393adca68465c9a5e) defines a function object [More...](#afe5cfc4ea6277ec393adca68465c9a5e)  
 typedef boost::function&lt; DataObject::ptr\_type([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), DataObject::ptr\_type input)&gt; [TAlgorithmFunction2](class_compute_single_object_per_object.xhtml#adbff8fbbd061127936232ab5600cbe01) defines a function object [More...](#adbff8fbbd061127936232ab5600cbe01)  
 ## <a name="pub-methods"></a>Public Member Functions

 [check](class_compute_single_object_per_object.xhtml#a47c34ec1e578c2ce27cf1c5fcd0d1704) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) 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...](#a47c34ec1e578c2ce27cf1c5fcd0d1704)  
  [compute](class_compute_single_object_per_object.xhtml#a2ee6c389c27f8cb563b6b1aa31f6bf17) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), DataObject::ptr\_type [data](class_compute_single_object_per_object.xhtml#aff21fffab499ea652443206d66e1a9bb), string new\_quantity\_ident, string new\_design\_ident) performs the action for a single set of samples [More...](#a2ee6c389c27f8cb563b6b1aa31f6bf17)  
  [compute](class_compute_single_object_per_object.xhtml#ab08e112d95fe611e7eb25491c354d115) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) performs the action using the defined settings. [More...](#ab08e112d95fe611e7eb25491c354d115)  
 <a id="a8c81d6b32b4db0db41ee35538a5bd84e"></a> [ComputeRelativeMaxima](class_compute_relative_maxima.xhtml#a8c81d6b32b4db0db41ee35538a5bd84e) () default constructor   
  [ComputeRelativeMaxima](class_compute_relative_maxima.xhtml#a81135a56c885e65e87c5a7a0ce8a3f32) ([DataObjectContainer](class_data_object_container.xhtml) the\_data) constructor which sets suitable defaults for all members [More...](#a81135a56c885e65e87c5a7a0ce8a3f32)  
 ## <a name="pub-attribs"></a>Public Attributes

<a id="aff21fffab499ea652443206d66e1a9bb"></a>[DataObjectContainer](class_data_object_container.xhtml) [data](class_compute_single_object_per_object.xhtml#aff21fffab499ea652443206d66e1a9bb) the data set to be analyzed   
 <a id="a30b1bcf63b9bdc707fea30bd96d70447"></a>[DataObjectContainer::string\_vector\_type](class_data_object_container.xhtml#ac293ea0e5c280f69a497ea20f20c60b9) [new\_quantity\_idents](class_compute_single_object_per_object.xhtml#a30b1bcf63b9bdc707fea30bd96d70447) the new idents for each quantity. The dimension and index space must fit the one of *quantity\_idents*   
 <a id="ade25e60bd85c8b4abd4f5b416cae0eb9"></a>bool [overwrite\_existing](class_compute_single_object_per_object.xhtml#ade25e60bd85c8b4abd4f5b416cae0eb9) 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.   
 <a id="aced57c746ae1d69d2fd56872fa1768bf"></a>[DataObjectContainer::string\_vector\_type](class_data_object_container.xhtml#ac293ea0e5c280f69a497ea20f20c60b9) [quantity\_idents](class_compute_single_object_per_object.xhtml#aced57c746ae1d69d2fd56872fa1768bf) the quantities to be analyzed. If a quantity ident does not exist in *data*, no error appears.   
 <a id="a58029dbfd2cba8096e632ad4867572de"></a>bool [strict\_extrema](class_compute_relative_maxima.xhtml#a58029dbfd2cba8096e632ad4867572de) is true if only strict extrema are searched, else als weak extrema are searched.   
 <a id="details" name="details"></a>## Detailed Description

### template&lt;dataobject\_types TYPE&gt;  
class ComputeRelativeMaxima&lt; TYPE &gt;

a struct which collects settings for *[ComputeRelativeMaxima](class_compute_relative_maxima.xhtml "a struct which collects settings for ComputeRelativeMaxima ")*

Template Parameters TYPEthe field data type 

## Member Typedef Documentation

<a id="afe5cfc4ea6277ec393adca68465c9a5e"></a>## [◆ ](#afe5cfc4ea6277ec393adca68465c9a5e)TAlgorithmFunction

 typedef boost::function&lt;DataObject::ptr\_type ( DataObject::ptr\_type input)&gt; [TAlgorithmFunction](class_compute_single_object_per_object.xhtml#afe5cfc4ea6277ec393adca68465c9a5e)  inherited 

defines a function object

Parameters inputa single input object Returnsthe result of the operation 



<a id="adbff8fbbd061127936232ab5600cbe01"></a>## [◆ ](#adbff8fbbd061127936232ab5600cbe01)TAlgorithmFunction2

 typedef boost::function&lt;DataObject::ptr\_type ( [Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), DataObject::ptr\_type input)&gt; [TAlgorithmFunction2](class_compute_single_object_per_object.xhtml#adbff8fbbd061127936232ab5600cbe01)  inherited 

defines a function object

Parameters databasethe database we refer to inputa single input object Returnsthe result of the operation 



## Constructor &amp; Destructor Documentation

<a id="a81135a56c885e65e87c5a7a0ce8a3f32"></a>## [◆ ](#a81135a56c885e65e87c5a7a0ce8a3f32)ComputeRelativeMaxima()

 [ComputeRelativeMaxima](class_compute_relative_maxima.xhtml)  ( [DataObjectContainer](class_data_object_container.xhtml)  *the\_data*) 

constructor which sets suitable defaults for all members

Parameters the\_datathe 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. 



## Member Function Documentation

<a id="a47c34ec1e578c2ce27cf1c5fcd0d1704"></a>## [◆ ](#a47c34ec1e578c2ce27cf1c5fcd0d1704)check()

 check  ( [Structure](class_structure.xhtml)  *database*)   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 databasethe SoS structure 



<a id="a2ee6c389c27f8cb563b6b1aa31f6bf17"></a>## [◆ ](#a2ee6c389c27f8cb563b6b1aa31f6bf17)compute() \[1/2\]

 compute  ( [Structure](class_structure.xhtml)  *database*,    DataObject::ptr\_type  *data*,    string  *new\_quantity\_ident*,    string  *new\_design\_ident*   )   inherited 

performs the action for a single set of samples

Parameters databasethe output object is to be inserted in this object datathe input data object new\_quantity\_identthe quantity ident of the new object new\_design\_identthe design ident of the new object If the input object is active, then the output object will be active as well (or inactive, respectively). 



<a id="ab08e112d95fe611e7eb25491c354d115"></a>## [◆ ](#ab08e112d95fe611e7eb25491c354d115)compute() \[2/2\]

 compute  ( [Structure](class_structure.xhtml)  *database*)   inherited 

performs the action using the defined settings.

Parameters databasethe output object where new objects are added to