## On this page

  

 

 # RandomFieldGroup Class Reference

 Last update: 16.07.2025 

A group of random fields belonging together (either a single random field, or multiple cross-correlated fields) [More...](class_random_field_group.xhtml#details)

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

<a id="afc7a5c2587087d5a8d8aff3cbd785fde"></a>typedef std::list&lt; [RandomFieldData](class_random_field_data.xhtml) &gt; [TElementRandomFieldDataContainer](class_random_field_group.xhtml#afc7a5c2587087d5a8d8aff3cbd785fde) a container of random field data   
 <a id="a7b3ec71aa7f93581b2db2e02b1c0fa7c"></a>typedef std::list&lt; [RandomFieldData](class_random_field_data.xhtml) &gt; [TIntptRandomFieldDataContainer](class_random_field_group.xhtml#a7b3ec71aa7f93581b2db2e02b1c0fa7c) a container of random field data   
 <a id="a513c1fdc00cecd99a7a985d5d501ebcd"></a>typedef std::list&lt; [RandomFieldData](class_random_field_data.xhtml) &gt; [TNodeRandomFieldDataContainer](class_random_field_group.xhtml#a513c1fdc00cecd99a7a985d5d501ebcd) a container of random field data   
 <a id="a049fa7126e2211f4a1ea0f5b4d280ae9"></a>typedef std::list&lt; [RandomFieldData](class_random_field_data.xhtml) &gt; [TScalarRandomFieldDataContainer](class_random_field_group.xhtml#a049fa7126e2211f4a1ea0f5b4d280ae9) a container of random field data   
 ## <a name="pub-methods"></a>Public Member Functions

template&lt;dataobject\_types TYPE&gt;  [add](class_random_field_group.xhtml#ae7cd02d902e2bb54ebea09284bb037a7) ([RandomFieldData](class_random_field_data.xhtml) field, [Structure](class_structure.xhtml) \*[database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) adds the given random field data to this group [More...](#ae7cd02d902e2bb54ebea09284bb037a7)  
 string [amplitudeIdent](class_random_field_group.xhtml#ae484c523b99de434cd5fe210340df0bb) (number i\_shape) computes the amplitude ident of this group for a given shape number [More...](#ae484c523b99de434cd5fe210340df0bb)  
  [computeCumulativeVariations](class_random_field_group.xhtml#a8899131da559a91e9d1498e35973fdb7) ([Structure](class_structure.xhtml) \*[database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) computes cumulative local variations and stores them in m\_variations\_cumulative [More...](#a8899131da559a91e9d1498e35973fdb7)  
  [computeIndividualVariations](class_random_field_group.xhtml#adc08678a972a21a848bdd8307a8aaec8) ([Structure](class_structure.xhtml) \*[database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) computes individual local variations and stores them in m\_variations\_individual [More...](#adc08678a972a21a848bdd8307a8aaec8)  
  [copyToDatabase](class_random_field_group.xhtml#a0ec04e9e17dee09820302a852e62162b) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), bool overwrite\_existing) copies contained data to the database (being visible in data object table) [More...](#a0ec04e9e17dee09820302a852e62162b)  
  [eraseDatabaseCopies](class_random_field_group.xhtml#a37662babd77d3217b300cc31a4ddf4af) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) deletes all data objects contained in this data structure from the respective database. [More...](#a37662babd77d3217b300cc31a4ddf4af)  
 template&lt;dataobject\_types TYPE&gt; bool [exists](class_random_field_group.xhtml#a7b7a93d7e8126850586e832f2e6bfafe) (string quantity) template&lt;dataobject\_types TYPE&gt; std::list&lt; [RandomFieldData](class_random_field_data.xhtml) &gt; [fields](class_random_field_group.xhtml#adbe04bfccbb9a1190215764b1cd337e9) () template&lt;dataobject\_types TYPE&gt; [RandomFieldData](class_random_field_data.xhtml) [findData](class_random_field_group.xhtml#ab66dbca5f2893866d088431c620a4be3) (string quantity) template&lt;dataobject\_types TYPE&gt; [RandomFieldData](class_random_field_data.xhtml) [findDataRef](class_random_field_group.xhtml#aabf674dceac157a34990ff653f45b8fd) (string quantity) Eigen::VectorXd [getVariationOfShapes](class_random_field_group.xhtml#a43e769e7be555c8dcf4aa3d0d458a47c) () number [getVariationTotal](class_random_field_group.xhtml#ad243d67623eb57a4a95e175e464f4706) () string [ident](class_random_field_group.xhtml#ad788420ef7464c550bfffb4e280eb417) () bool [isGroup](class_random_field_group.xhtml#ac6e1d47f61e13d3083fd03120ec8881f) () bool [isSingle](class_random_field_group.xhtml#a798f429a8eba44cef1e0c5e8f7a58f3d) () bool [isValid](class_random_field_group.xhtml#afe93e17ac89cd97917811068ba2af214) () int [numShapes](class_random_field_group.xhtml#a97a6c42ecf5bf83fbdaec77d3fd07d60) () bool [overlaps](class_random_field_group.xhtml#a14dccff2927c8871b6e977f3de4da6e8) ([RandomFieldGroup](class_random_field_group.xhtml) field) <a id="a21e87a5c9be5da8e30b6bf6606bda796"></a> [RandomFieldGroup](class_random_field_group.xhtml#a21e87a5c9be5da8e30b6bf6606bda796) () default constructor   
  [RandomFieldGroup](class_random_field_group.xhtml#ac8bd96737e4db2feb1dce27992f5ced7) ([RandomFieldGroup](class_random_field_group.xhtml) other) copy constructor [More...](#ac8bd96737e4db2feb1dce27992f5ced7)  
 string [readableIdent](class_random_field_group.xhtml#aed3bcd7430e07631258a658baf83259d) ()  [setIdent](class_random_field_group.xhtml#a26177040e50ece2fde7ee91ba2c7df97) (string [ident](class_random_field_group.xhtml#ad788420ef7464c550bfffb4e280eb417), [Structure](class_structure.xhtml) \*[database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) sets m\_ident [More...](#a26177040e50ece2fde7ee91ba2c7df97)  
 <a id="ad73b61b1c03fe37224d5ba94e6ca0060"></a> **template** (findNodeData) [findData](class_random_field_group.xhtml#ab66dbca5f2893866d088431c620a4be3)&lt; [NODE\_DATA](group__data.xhtml#gga1bebf1e22deb3cd41d7d99ddcdb15379a2bccb499db6de63e558b75b39da3d482) &gt; <a id="aff03f50e530ddbf0d1d4c015928fe84c"></a> **template** (findElementData) [findData](class_random_field_group.xhtml#ab66dbca5f2893866d088431c620a4be3)&lt; [ELEMENT\_DATA](group__data.xhtml#gga1bebf1e22deb3cd41d7d99ddcdb15379ae9445a58a2c3cd515f2058cbd3117174) &gt; <a id="a831fbbdd083583f0348b9be146df0017"></a> **template** (findScalarData) [findData](class_random_field_group.xhtml#ab66dbca5f2893866d088431c620a4be3)&lt; [SCALAR\_DATA](group__data.xhtml#gga1bebf1e22deb3cd41d7d99ddcdb15379a916fc40dfca5ba301488a121abe77495) &gt; <a id="a57708f3e0f7fd0b337561e5d78365353"></a> **template** (findNodeDataRef) [findDataRef](class_random_field_group.xhtml#aabf674dceac157a34990ff653f45b8fd)&lt; [NODE\_DATA](group__data.xhtml#gga1bebf1e22deb3cd41d7d99ddcdb15379a2bccb499db6de63e558b75b39da3d482) &gt; <a id="aa0434659fdfbb0c6b6f25934bf8ea96f"></a> **template** (findElementDataRef) [findDataRef](class_random_field_group.xhtml#aabf674dceac157a34990ff653f45b8fd)&lt; [ELEMENT\_DATA](group__data.xhtml#gga1bebf1e22deb3cd41d7d99ddcdb15379ae9445a58a2c3cd515f2058cbd3117174) &gt; <a id="ad87e3282057932a2455e5ce014f2db16"></a> **template** (findScalarDataRef) [findDataRef](class_random_field_group.xhtml#aabf674dceac157a34990ff653f45b8fd)&lt; [SCALAR\_DATA](group__data.xhtml#gga1bebf1e22deb3cd41d7d99ddcdb15379a916fc40dfca5ba301488a121abe77495) &gt; <a id="details" name="details"></a>## Detailed Description

A group of random fields belonging together (either a single random field, or multiple cross-correlated fields)



## Constructor &amp; Destructor Documentation

<a id="ac8bd96737e4db2feb1dce27992f5ced7"></a>## [◆ ](#ac8bd96737e4db2feb1dce27992f5ced7)RandomFieldGroup()

 [RandomFieldGroup](class_random_field_group.xhtml)  ( [RandomFieldGroup](class_random_field_group.xhtml)  *other*) 

copy constructor

Parameters otherthe object to be copied 



## Member Function Documentation

<a id="ae7cd02d902e2bb54ebea09284bb037a7"></a>## [◆ ](#ae7cd02d902e2bb54ebea09284bb037a7)add()

 add  ( [RandomFieldData](class_random_field_data.xhtml)  *field*,    [Structure](class_structure.xhtml) \*  *database*   ) 

adds the given random field data to this group

Parameters fieldthe field data to be added to this group databaseif not zero, then the connected listeners will be notified on changing the random field models 



<a id="ae484c523b99de434cd5fe210340df0bb"></a>## [◆ ](#ae484c523b99de434cd5fe210340df0bb)amplitudeIdent()

 string amplitudeIdent  ( number  *i\_shape*) 

computes the amplitude ident of this group for a given shape number

Parameters i\_shapeshape number (0..n-1) Returnsthe quantity ident of the respective amplitude 



<a id="a8899131da559a91e9d1498e35973fdb7"></a>## [◆ ](#a8899131da559a91e9d1498e35973fdb7)computeCumulativeVariations()

 computeCumulativeVariations  ( [Structure](class_structure.xhtml) \*  *database*) 

computes cumulative local variations and stores them in m\_variations\_cumulative

Parameters databaseif not zero, then the connected listeners will be notified on changing the random field models 



<a id="adc08678a972a21a848bdd8307a8aaec8"></a>## [◆ ](#adc08678a972a21a848bdd8307a8aaec8)computeIndividualVariations()

 computeIndividualVariations  ( [Structure](class_structure.xhtml) \*  *database*) 

computes individual local variations and stores them in m\_variations\_individual

Parameters databaseif not zero, then the connected listeners will be notified on changing the random field models 



<a id="a0ec04e9e17dee09820302a852e62162b"></a>## [◆ ](#a0ec04e9e17dee09820302a852e62162b)copyToDatabase()

 copyToDatabase  ( [Structure](class_structure.xhtml)  *database*,    bool  *overwrite\_existing*   ) 

copies contained data to the database (being visible in data object table)

Parameters databasethe target database overwrite\_existingif true, then data objects with identical ident will be replaced, else an exception is thrown. 



<a id="a37662babd77d3217b300cc31a4ddf4af"></a>## [◆ ](#a37662babd77d3217b300cc31a4ddf4af)eraseDatabaseCopies()

 eraseDatabaseCopies  ( [Structure](class_structure.xhtml)  *database*) 

deletes all data objects contained in this data structure from the respective database.

Parameters databasethe database to be deleted 



<a id="a7b7a93d7e8126850586e832f2e6bfafe"></a>## [◆ ](#a7b7a93d7e8126850586e832f2e6bfafe)exists()

 bool exists  ( string  *quantity*) 

Returnstrue if the fiven quantity ident is already contained Parameters quantitythe quantity ident 



<a id="adbe04bfccbb9a1190215764b1cd337e9"></a>## [◆ ](#adbe04bfccbb9a1190215764b1cd337e9)fields()

 std::list&lt;[RandomFieldData](class_random_field_data.xhtml)&gt; fields  ( ) 

Returnsa const-reference to the respective field container 



<a id="ab66dbca5f2893866d088431c620a4be3"></a>## [◆ ](#ab66dbca5f2893866d088431c620a4be3)findData()

 [RandomFieldData](class_random_field_data.xhtml) findData  ( string  *quantity*) 

Returnsa reference to the data of the given quantity, regardless of being part of a group or a single field Parameters quantitythe quantity ident 



<a id="aabf674dceac157a34990ff653f45b8fd"></a>## [◆ ](#aabf674dceac157a34990ff653f45b8fd)findDataRef()

 [RandomFieldData](class_random_field_data.xhtml) findDataRef  ( string  *quantity*) 

Returnsa non- reference to the data of the given quantity, regardless of being part of a group or a single field Parameters quantitythe quantity ident 



<a id="a43e769e7be555c8dcf4aa3d0d458a47c"></a>## [◆ ](#a43e769e7be555c8dcf4aa3d0d458a47c)getVariationOfShapes()

 Eigen::VectorXd getVariationOfShapes  ( ) 

Returnsthe explainable variation of each scatter shape 



<a id="ad243d67623eb57a4a95e175e464f4706"></a>## [◆ ](#ad243d67623eb57a4a95e175e464f4706)getVariationTotal()

 number getVariationTotal  ( ) 

Returnsthe total explainable variation 



<a id="ad788420ef7464c550bfffb4e280eb417"></a>## [◆ ](#ad788420ef7464c550bfffb4e280eb417)ident()

 string ident  ( ) 

Returnsm\_ident 



<a id="ac6e1d47f61e13d3083fd03120ec8881f"></a>## [◆ ](#ac6e1d47f61e13d3083fd03120ec8881f)isGroup()

 bool isGroup  ( ) 

Returnstrue if this group represents multiple cross-correlated fields 



<a id="a798f429a8eba44cef1e0c5e8f7a58f3d"></a>## [◆ ](#a798f429a8eba44cef1e0c5e8f7a58f3d)isSingle()

 bool isSingle  ( ) 

Returnstrue if this group represents a single random field, else there are multiple cross-correlated fields 



<a id="afe93e17ac89cd97917811068ba2af214"></a>## [◆ ](#afe93e17ac89cd97917811068ba2af214)isValid()

 bool isValid  ( ) 

Returnstrue if there are any fields assigned 



<a id="a97a6c42ecf5bf83fbdaec77d3fd07d60"></a>## [◆ ](#a97a6c42ecf5bf83fbdaec77d3fd07d60)numShapes()

 int numShapes  ( ) 

Returnsthe number of shapes used by this group. 



<a id="a14dccff2927c8871b6e977f3de4da6e8"></a>## [◆ ](#a14dccff2927c8871b6e977f3de4da6e8)overlaps()

 bool overlaps  ( [RandomFieldGroup](class_random_field_group.xhtml)  *field*) 

Returnstrue if any quantity of the other field has the same ident as a quantity in this object Parameters fieldthe other field to be tested 



<a id="aed3bcd7430e07631258a658baf83259d"></a>## [◆ ](#aed3bcd7430e07631258a658baf83259d)readableIdent()

 string readableIdent  ( ) 

Returnscomputes a human reable ident for LOG-output purposes of this RFGroup 



<a id="a26177040e50ece2fde7ee91ba2c7df97"></a>## [◆ ](#a26177040e50ece2fde7ee91ba2c7df97)setIdent()

 setIdent  ( string  *ident*,    [Structure](class_structure.xhtml) \*  *database*   ) 

sets m\_ident

Parameters identthe new ident databaseif not zero, then the connected listeners will be notified on changing the random field models