## On this page

  

 

 # RandomFieldDecompositionFromSamples Class Reference

 Last update: 16.07.2025 

Decomposition of one or multiple random fields. [More...](class_random_field_decomposition_from_samples.xhtml#details)

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

enum [eShapeMethod](class_random_field_decomposition_from_samples.xhtml#a338b0447773d59620abdb12cb263ab2c) { [EXACT\_SVD](class_random_field_decomposition_from_samples.xhtml#a338b0447773d59620abdb12cb263ab2cae43d084e09a66f2f917da7499b8bf75b) = 0, [RED\_SVD](class_random_field_decomposition_from_samples.xhtml#a338b0447773d59620abdb12cb263ab2ca2b0b869756b3660156a4968de9f97f16), [BDC\_SVD](class_random_field_decomposition_from_samples.xhtml#a338b0447773d59620abdb12cb263ab2cabaabae290ac4993db4140a99c4002162) } an enum type for the algorithm computing the shapes [More...](class_random_field_decomposition_from_samples.xhtml#a338b0447773d59620abdb12cb263ab2c)  
 ## <a name="pub-methods"></a>Public Member Functions

 [check](class_random_field_decomposition_from_samples.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_random_field_decomposition_from_samples.xhtml#ab08e112d95fe611e7eb25491c354d115) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) Performs the reduction of a random field for multiple sets of samples. [More...](#ab08e112d95fe611e7eb25491c354d115)  
 <a id="a386de644919efc27d9549c7f74f14447"></a> [RandomFieldDecompositionFromSamples](class_random_field_decomposition_from_samples.xhtml#a386de644919efc27d9549c7f74f14447) () default constructor   
 ## <a name="pub-attribs"></a>Public Attributes

<a id="a51c72fc5bd4b724a7c9da7d23003cb19"></a>[eShapeMethod](class_random_field_decomposition_from_samples.xhtml#a338b0447773d59620abdb12cb263ab2c) [algorithm](class_random_field_decomposition_from_samples.xhtml#a51c72fc5bd4b724a7c9da7d23003cb19) Defines how the shapes are computed.   
 <a id="a742029aafb7d073a5f64c43e6110d320"></a>bool [compute\_amplitudes](class_random_field_decomposition_from_samples.xhtml#a742029aafb7d073a5f64c43e6110d320) If this is true, then also the amplitudes are computed (a single amplitude per shape per sample).   
 <a id="a90e0662e0da2173b7b39687519f6653a"></a>bool [compute\_cumulative\_variations](class_random_field_decomposition_from_samples.xhtml#a90e0662e0da2173b7b39687519f6653a) true, if the cumulative variations are to be computed   
 <a id="a6ff9b92e10644b70006b0bb16db05514"></a>bool [compute\_variations](class_random_field_decomposition_from_samples.xhtml#a6ff9b92e10644b70006b0bb16db05514) true, if the individual variations are to be computed   
 <a id="a7a8f56ebcc6ac6da7e51a59f2e84e19b"></a>bool [cross\_correlated](class_random_field_decomposition_from_samples.xhtml#a7a8f56ebcc6ac6da7e51a59f2e84e19b) True if the selected fields are assumed to be cross-correlated, else (default): each field is decomposed individually.   
 <a id="a5ecc81a378f43a9771f33fde41beab13"></a>number [desired\_variation](class_random_field_decomposition_from_samples.xhtml#a5ecc81a378f43a9771f33fde41beab13) the desired variation (when reducing the model; 0&lt;x&lt;1). Default: 0.90   
 <a id="a0c6e3d3e7e9a9245af75b6f9ef2f5c76"></a>[MultivariateDistributionTypes::enum\_type](class_multivariate_distribution_types.xhtml#af7ca783694e51f78ef01ceb1e00104c5) [distribution\_type](class_random_field_decomposition_from_samples.xhtml#a0c6e3d3e7e9a9245af75b6f9ef2f5c76) The ident of the probability distribution that is assumed to convert data from original space to Gaussian. If empty (default), then it is automatically chosen.   
 <a id="a0a142faa1cc762466b884ad3c8979f3a"></a>[DataObjectContainer](class_data_object_container.xhtml) [element\_data](class_random_field_decomposition_from_samples.xhtml#a0a142faa1cc762466b884ad3c8979f3a) the data set to be analyzed   
 <a id="a61e05f5838637f78bb680882358fced2"></a>[DataObjectIdentMap](class_data_object_ident_map.xhtml) [element\_data\_bounds\_lower](class_random_field_decomposition_from_samples.xhtml#a61e05f5838637f78bb680882358fced2) lower bounds for ELEMENT\_DATA objects   
 <a id="a8e8b1e2041fb43eff4895da3740e1475"></a>[DataObjectIdentMap](class_data_object_ident_map.xhtml) [element\_data\_bounds\_upper](class_random_field_decomposition_from_samples.xhtml#a8e8b1e2041fb43eff4895da3740e1475) upper bounds for ELEMENT\_DATA objects   
 <a id="aa8f4ee0c111743fd4a01ddd2d4ba0ad3"></a>string [field\_ident](class_random_field_decomposition_from_samples.xhtml#aa8f4ee0c111743fd4a01ddd2d4ba0ad3) If the random fields are cross correlated, they need to have a random field ident being associated.   
 bool [interpolate\_missing\_items](class_random_field_decomposition_from_samples.xhtml#a80ad12816b0c0674c578048eb2fd0afe) Defines how missing items (eroded elements) are treated: [More...](#a80ad12816b0c0674c578048eb2fd0afe)  
 <a id="a71834b001cda26914823c8b04b030cb4"></a>number [max\_number](class_random_field_decomposition_from_samples.xhtml#a71834b001cda26914823c8b04b030cb4) the maximum number of vectors to be computed. Default: 20   
 <a id="a4b3543f31398671628dd711c98a0d37e"></a>[DataObjectContainer](class_data_object_container.xhtml) [node\_data](class_random_field_decomposition_from_samples.xhtml#a4b3543f31398671628dd711c98a0d37e) the data set to be analyzed   
 <a id="a4daf14138081bb59a56ae0f6bd7e9372"></a>[DataObjectIdentMap](class_data_object_ident_map.xhtml) [node\_data\_bounds\_lower](class_random_field_decomposition_from_samples.xhtml#a4daf14138081bb59a56ae0f6bd7e9372) lower bounds for NODE\_DATA objects   
 <a id="a40ee023b9bc77310d0cb1226fa24137d"></a>[DataObjectIdentMap](class_data_object_ident_map.xhtml) [node\_data\_bounds\_upper](class_random_field_decomposition_from_samples.xhtml#a40ee023b9bc77310d0cb1226fa24137d) upper bounds for NODE\_DATA objects   
 <a id="ade25e60bd85c8b4abd4f5b416cae0eb9"></a>bool [overwrite\_existing](class_random_field_decomposition_from_samples.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="a0c1c80374ba4d28153ed219819d24612"></a>[DataObjectContainer](class_data_object_container.xhtml) [scalar\_data](class_random_field_decomposition_from_samples.xhtml#a0c1c80374ba4d28153ed219819d24612) the data set to be analyzed   
 <a id="ad43c00cd08acd216d3d4a87bcbda1d8b"></a>[DataObjectIdentMap](class_data_object_ident_map.xhtml) [scalar\_data\_bounds\_lower](class_random_field_decomposition_from_samples.xhtml#ad43c00cd08acd216d3d4a87bcbda1d8b) lower bounds for SCALAR\_DATA objects   
 <a id="a75ffd31fa74ec6b24835e4d2f199427b"></a>[DataObjectIdentMap](class_data_object_ident_map.xhtml) [scalar\_data\_bounds\_upper](class_random_field_decomposition_from_samples.xhtml#a75ffd31fa74ec6b24835e4d2f199427b) upper bounds for SCALAR\_DATA objects   
 <a id="details" name="details"></a>## Detailed Description

Decomposition of one or multiple random fields.



## Member Enumeration Documentation

<a id="a338b0447773d59620abdb12cb263ab2c"></a>## [◆ ](#a338b0447773d59620abdb12cb263ab2c)eShapeMethod

 enum [eShapeMethod](class_random_field_decomposition_from_samples.xhtml#a338b0447773d59620abdb12cb263ab2c)

an enum type for the algorithm computing the shapes

Enumerator<a id="a338b0447773d59620abdb12cb263ab2cae43d084e09a66f2f917da7499b8bf75b"></a>EXACT\_SVD exact full SVD (default up to SoS 7)

<a id="a338b0447773d59620abdb12cb263ab2ca2b0b869756b3660156a4968de9f97f16"></a>RED\_SVD reduced SVD (still needs full memory, but is much faster and less accurate)

<a id="a338b0447773d59620abdb12cb263ab2cabaabae290ac4993db4140a99c4002162"></a>BDC\_SVD exact SVD using a divide/conquer iterative algorithm (new default)





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

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

Performs the reduction of a random field for multiple sets of samples.

Parameters databaseThe output object where new objects are added to 



## Member Data Documentation

<a id="a80ad12816b0c0674c578048eb2fd0afe"></a>## [◆ ](#a80ad12816b0c0674c578048eb2fd0afe)interpolate\_missing\_items

 bool interpolate\_missing\_items

Defines how missing items (eroded elements) are treated:

- true: use the interpolated value
- false: assume the mean value