## On this page

  

 

 # ComputeProbabilitySigmaInterval< TYPE > Class Template Reference

 Last update: 16.07.2025 

a struct which collects settings for probability of sigma intervals, i.e. of P( mean + l\*sigma <= X < mean + u\*sigma) [More...](class_compute_probability_sigma_interval.xhtml#details)

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

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

 [check](class_compute_probability_sigma_interval.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_sample.xhtml#a919d852c00f29d479c628f0dc1a8387c) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), [DataObjectVector](class_data_object_vector.xhtml) [data](class_compute_single_object_per_sample.xhtml#aff21fffab499ea652443206d66e1a9bb), string new\_quantity\_ident, string [new\_design\_ident](class_compute_single_object_per_sample.xhtml#aef951e72e1c034e5e2c484edf1b7f5a8)) performs the action for a single set of samples [More...](#a919d852c00f29d479c628f0dc1a8387c)  
  [compute](class_compute_single_object_per_sample.xhtml#ab08e112d95fe611e7eb25491c354d115) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) performs the action using the defined settings. [More...](#ab08e112d95fe611e7eb25491c354d115)  
  [ComputeProbabilitySigmaInterval](class_compute_probability_sigma_interval.xhtml#ab2844002701b059ab54238d8caa8b66a) (number lower, number upper) default constructor [More...](#ab2844002701b059ab54238d8caa8b66a)  
  [ComputeProbabilitySigmaInterval](class_compute_probability_sigma_interval.xhtml#a07c76997cec0ddd51a94da1f91413948) ([DataObjectContainer](class_data_object_container.xhtml) the\_data, number lower, number upper) constructor which sets suitable defaults for all members [More...](#a07c76997cec0ddd51a94da1f91413948)  
 ## <a name="pub-attribs"></a>Public Attributes

<a id="aff21fffab499ea652443206d66e1a9bb"></a>[DataObjectContainer](class_data_object_container.xhtml) [data](class_compute_single_object_per_sample.xhtml#aff21fffab499ea652443206d66e1a9bb) the data set to be analyzed   
 <a id="a0b3699ba26cda7aa612712020c70a83b"></a>number [l](class_compute_probability_sigma_interval.xhtml#a0b3699ba26cda7aa612712020c70a83b) the lower threshold value of the interval defining the lower mean+l\*sigma value   
 <a id="aef951e72e1c034e5e2c484edf1b7f5a8"></a>string [new\_design\_ident](class_compute_single_object_per_sample.xhtml#aef951e72e1c034e5e2c484edf1b7f5a8) the design ident of the new object   
 <a id="a30b1bcf63b9bdc707fea30bd96d70447"></a>[DataObjectContainer::string\_vector\_type](class_data_object_container.xhtml#ac293ea0e5c280f69a497ea20f20c60b9) [new\_quantity\_idents](class_compute_single_object_per_sample.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_sample.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_sample.xhtml#aced57c746ae1d69d2fd56872fa1768bf) the quantities to be analyzed. If a quantity ident does not exist in *data*, no error appears.   
 <a id="a1b23f4e039500621015dcd3e6bb78d99"></a>number [u](class_compute_probability_sigma_interval.xhtml#a1b23f4e039500621015dcd3e6bb78d99) the upper threshold value of the interval defining the upper mean+u\*sigma value   
 <a id="details" name="details"></a>## Detailed Description

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

a struct which collects settings for probability of sigma intervals, i.e. of P( mean + l\*sigma &lt;= X &lt; mean + u\*sigma)

Template Parameters TYPEthe field data type 

## Member Typedef Documentation

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

 typedef boost::function&lt;DataObject::ptr\_type( [Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), [DataObjectVector](class_data_object_vector.xhtml) samples)&gt; [TAlgorithmFunction](class_compute_single_object_per_sample.xhtml#ac597f6cab052d215247719908ce3cb0b)  inherited 

defines a function object

Parameters databasethe database where the data refer to samplesthe vector of samples to which the function is applied to. Returnsthe result of the operation 



## Constructor &amp; Destructor Documentation

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

 [ComputeProbabilitySigmaInterval](class_compute_probability_sigma_interval.xhtml)  ( number  *lower*,    number  *upper*   ) 

default constructor

Parameters lowersets l uppersets u 



<a id="a07c76997cec0ddd51a94da1f91413948"></a>## [◆ ](#a07c76997cec0ddd51a94da1f91413948)ComputeProbabilitySigmaInterval() \[2/2\]

 [ComputeProbabilitySigmaInterval](class_compute_probability_sigma_interval.xhtml)  ( [DataObjectContainer](class_data_object_container.xhtml)  *the\_data*,    number  *lower*,    number  *upper*   ) 

constructor which sets suitable defaults for all members

Parameters the\_datathe subset of field data to be token as input. lowersets l uppersets u All quantity idents are extracted. Then for each quantity a new result object will be created with user specific design ident. 



## Member Function Documentation

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

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



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

 compute  ( [Structure](class_structure.xhtml)  *database*,    [DataObjectVector](class_data_object_vector.xhtml)  *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 dataa vector of samples new\_quantity\_identthe quantity ident of the new object new\_design\_identthe design ident of the new object The output object is inactive. 



<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