## On this page

  

 

 # RandomFieldData Class Reference

 Last update: 16.07.2025 

contains random field data for analysis and simulation for a single random field. [More...](class_random_field_data.xhtml#details)

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

<a id="a24d0dc626d6d31e81a461a20f9557cfa"></a>typedef boost::shared\_ptr&lt; MultivariateDistributionBase &gt; [TDistributionPtr](class_random_field_data.xhtml#a24d0dc626d6d31e81a461a20f9557cfa) a shared pointer for multivariate distributions   
 ## <a name="pub-methods"></a>Public Member Functions

[Matrix](class_matrix.xhtml) [computeAmplitudeValues](class_random_field_data.xhtml#acebb4ff4d9a51a69eb9646bb35eb22ea) ([Matrix](class_matrix.xhtml) field\_value) computes amplitudes from a single field design [More...](#acebb4ff4d9a51a69eb9646bb35eb22ea)  
 [Matrix](class_matrix.xhtml) [computeAmplitudeValues](class_random_field_data.xhtml#a583d020cdb9334f7378c0de7376f8752) ([Matrix](class_matrix.xhtml) field\_value, [Matrix](class_matrix.xhtml) missing\_items) computes amplitudes from a single field design [More...](#a583d020cdb9334f7378c0de7376f8752)  
 [Matrix](class_matrix.xhtml) [computeFieldValues](class_random_field_data.xhtml#abb292d5fb3d90f98d866dcbd114884b8) ([Matrix](class_matrix.xhtml) amplitudes) computes a field design from a single sample of amplitudes [More...](#abb292d5fb3d90f98d866dcbd114884b8)  
  [copyToDatabase](class_random_field_data.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)  
 [DataObjectVector](class_data_object_vector.xhtml) [cumulativeVariations](class_random_field_data.xhtml#adcf200c25db6c2e496eaa66edc51ee97) ()  [eraseDatabaseCopies](class_random_field_data.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)  
 [Matrix](class_matrix.xhtml) [globalCumulativeVariations](class_random_field_data.xhtml#aa914fa93f4c20c7d8673cdf5e3f8f269) () [Matrix](class_matrix.xhtml) [globalIndividualVariations](class_random_field_data.xhtml#acec8f475d53c2b1e59317c2ef59a32dc) () [DataObjectVector](class_data_object_vector.xhtml) [individualVariations](class_random_field_data.xhtml#a4d80880f7c5349051e0575814175de6e) () [RandomFieldData](class_random_field_data.xhtml) [operator=](class_random_field_data.xhtml#a402db4bc4303a80b04e6d7e94f1a9b6d) ([RandomFieldData](class_random_field_data.xhtml) other) overrides the default assignment operator (making it thread-safe) Only the shared pointers are copied (the objects are not duplicated). The distributions are duplicated! [More...](#a402db4bc4303a80b04e6d7e94f1a9b6d)  
 bool [operator==](class_random_field_data.xhtml#a9a55092319719557b7fdbcdfd93b0912) ([RandomFieldData](class_random_field_data.xhtml) other) string [quantityIdent](class_random_field_data.xhtml#a99b4f75e16e3f7ea6997ca785617935f) () destructor [More...](#a99b4f75e16e3f7ea6997ca785617935f)  
 <a id="aa3a22354f868058240f0be941b6bb0c7"></a> [RandomFieldData](class_random_field_data.xhtml#aa3a22354f868058240f0be941b6bb0c7) () a default constructor used for serialization   
  [RandomFieldData](class_random_field_data.xhtml#a61bdf13d5d68dce2e84400b8522b336f) (string quantity\_ident, [dataobject\_types](group__data.xhtml#ga1bebf1e22deb3cd41d7d99ddcdb15379) [type](class_random_field_data.xhtml#a5419dd52be3756534b1789724f4bfbbd), [TDistributionPtr](class_random_field_data.xhtml#a24d0dc626d6d31e81a461a20f9557cfa) field\_distribution, Eigen::VectorXd global\_variations\_individual, number total\_variation, [DataObjectVector](class_data_object_vector.xhtml) [shapes](class_random_field_data.xhtml#a997883dcd1950473d4d41087deb0dc56), Eigen::MatrixXd pseudo\_inverse) constructor The constructor creates values for [More...](#a61bdf13d5d68dce2e84400b8522b336f)  
 [DataObjectVector](class_data_object_vector.xhtml) [shapes](class_random_field_data.xhtml#a997883dcd1950473d4d41087deb0dc56) () number [totalVariation](class_random_field_data.xhtml#adc06eb4750fed838cee093631b1d58d6) () [dataobject\_types](group__data.xhtml#ga1bebf1e22deb3cd41d7d99ddcdb15379) [type](class_random_field_data.xhtml#a5419dd52be3756534b1789724f4bfbbd) () [DataObjectPtr](class_data_object_ptr.xhtml) [variation](class_random_field_data.xhtml#aa55eab527fe10e5f5842ae33cf3bc6f1) () <a id="details" name="details"></a>## Detailed Description

contains random field data for analysis and simulation for a single random field.



## Constructor &amp; Destructor Documentation

<a id="a61bdf13d5d68dce2e84400b8522b336f"></a>## [◆ ](#a61bdf13d5d68dce2e84400b8522b336f)RandomFieldData()

 [RandomFieldData](class_random_field_data.xhtml)  ( string  *quantity\_ident*,    [dataobject\_types](group__data.xhtml#ga1bebf1e22deb3cd41d7d99ddcdb15379)  *type*,    [TDistributionPtr](class_random_field_data.xhtml#a24d0dc626d6d31e81a461a20f9557cfa)  *field\_distribution*,    Eigen::VectorXd  *global\_variations\_individual*,    number  *total\_variation*,    [DataObjectVector](class_data_object_vector.xhtml)  *shapes*,    Eigen::MatrixXd  *pseudo\_inverse*   ) 

constructor The constructor creates values for

- m\_quantity\_ident
- m\_type
- m\_field\_distribution
- m\_gaussan\_distribution
- m\_shapes
- m\_global\_variations\_cumulative
- m\_global\_variations\_individual Parameters quantity\_identsets m\_quantity\_ident typesets m\_type, the dataobject type of this random field field\_distributionsets m\_field\_distribution; global\_variations\_individualdefines the absolute values of the variations of each shape (respective the whole random field group) total\_variationthe absolute value of the total global variation present in the system (respective the whole random field group) shapesthe linear scatter shapes pseudo\_inverseis a temporary term in the pseudo inverse, i.e. (A'A)^(-1) with A being the matrix of the shapes. For random fields, this is the dialogonal matrix of the inverse eigenvalues. Else it is the true pseudo inverse...





## Member Function Documentation

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

 [Matrix](class_matrix.xhtml) computeAmplitudeValues  ( [Matrix](class_matrix.xhtml)  *field\_value*) 

computes amplitudes from a single field design

NoteFor cross-correlated fields, you must build the sum of all amplitude vectors of all fields belongig to the same field group. Parameters field\_valuethe field design Returnsa vector of amplitudes 



<a id="a583d020cdb9334f7378c0de7376f8752"></a>## [◆ ](#a583d020cdb9334f7378c0de7376f8752)computeAmplitudeValues() \[2/2\]

 [Matrix](class_matrix.xhtml) computeAmplitudeValues  ( [Matrix](class_matrix.xhtml)  *field\_value*,    [Matrix](class_matrix.xhtml)  *missing\_items*   ) 

computes amplitudes from a single field design

NoteFor cross-correlated fields, you must build the sum of all amplitude vectors of all fields belongig to the same field group. Use this function to "reconstruct" missing items. The projection operator will be changed such that the random field can be used for "reconstruction". Parameters field\_valuethe field design missing\_itemsdefines the missing items: 0 = is existing, !=0 = is missing. Returnsa vector of amplitudes 



<a id="abb292d5fb3d90f98d866dcbd114884b8"></a>## [◆ ](#abb292d5fb3d90f98d866dcbd114884b8)computeFieldValues()

 [Matrix](class_matrix.xhtml) computeFieldValues  ( [Matrix](class_matrix.xhtml)  *amplitudes*) 

computes a field design from a single sample of amplitudes

NoteFor cross-correlated fields, you must use the same amplitude values of all fields belongig to the same field group. Parameters amplitudesthe amplitude values for a single sample Returnsthe field value vector 



<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="adcf200c25db6c2e496eaa66edc51ee97"></a>## [◆ ](#adcf200c25db6c2e496eaa66edc51ee97)cumulativeVariations()

 [DataObjectVector](class_data_object_vector.xhtml) cumulativeVariations  ( ) 

Returnsa const-reference to m\_variations\_cumulative 



<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="aa914fa93f4c20c7d8673cdf5e3f8f269"></a>## [◆ ](#aa914fa93f4c20c7d8673cdf5e3f8f269)globalCumulativeVariations()

 [Matrix](class_matrix.xhtml) globalCumulativeVariations  ( ) 

Returnsa const-reference to m\_global\_variations\_cumulative 



<a id="acec8f475d53c2b1e59317c2ef59a32dc"></a>## [◆ ](#acec8f475d53c2b1e59317c2ef59a32dc)globalIndividualVariations()

 [Matrix](class_matrix.xhtml) globalIndividualVariations  ( ) 

Returnsa const-reference to m\_global\_variations\_individual 



<a id="a4d80880f7c5349051e0575814175de6e"></a>## [◆ ](#a4d80880f7c5349051e0575814175de6e)individualVariations()

 [DataObjectVector](class_data_object_vector.xhtml) individualVariations  ( ) 

Returnsa const-reference to m\_variations\_individual 



<a id="a402db4bc4303a80b04e6d7e94f1a9b6d"></a>## [◆ ](#a402db4bc4303a80b04e6d7e94f1a9b6d)operator=()

 [RandomFieldData](class_random_field_data.xhtml) operator=  ( [RandomFieldData](class_random_field_data.xhtml)  *other*) 

overrides the default assignment operator (making it thread-safe) Only the shared pointers are copied (the objects are not duplicated). The distributions are duplicated!

Parameters otherthe source object Returnsa reference to this object 



<a id="a9a55092319719557b7fdbcdfd93b0912"></a>## [◆ ](#a9a55092319719557b7fdbcdfd93b0912)operator==()

 bool operator==  ( [RandomFieldData](class_random_field_data.xhtml)  *other*) 

Both objects must not contain NULL pointers!

Parameters otherthe other object to be compared with Returnstrue if both objects contain the same content NoteThis operator should be used with care. It is slow since the data of the distributions are first converted to Meta format and are then compared! 



<a id="a99b4f75e16e3f7ea6997ca785617935f"></a>## [◆ ](#a99b4f75e16e3f7ea6997ca785617935f)quantityIdent()

 string quantityIdent  ( ) 

destructor

Returnsa const-reference to m\_quantity\_ident 



<a id="a997883dcd1950473d4d41087deb0dc56"></a>## [◆ ](#a997883dcd1950473d4d41087deb0dc56)shapes()

 [DataObjectVector](class_data_object_vector.xhtml) shapes  ( ) 

Returnsa const-reference to m\_shapes 



<a id="adc06eb4750fed838cee093631b1d58d6"></a>## [◆ ](#adc06eb4750fed838cee093631b1d58d6)totalVariation()

 number totalVariation  ( ) 

Returnsa const-reference to m\_total\_variation 



<a id="a5419dd52be3756534b1789724f4bfbbd"></a>## [◆ ](#a5419dd52be3756534b1789724f4bfbbd)type()

 [dataobject\_types](group__data.xhtml#ga1bebf1e22deb3cd41d7d99ddcdb15379) type  ( ) 

Returnsa const-reference to m\_quantity\_ident 



<a id="aa55eab527fe10e5f5842ae33cf3bc6f1"></a>## [◆ ](#aa55eab527fe10e5f5842ae33cf3bc6f1)variation()

 [DataObjectPtr](class_data_object_ptr.xhtml) variation  ( ) 

Returnsa const-reference to m\_variation