## On this page

  

 

 # CreateLegacyMOQModel Class Reference

 Last update: 16.07.2025 

Defines a LegacyMOPModel This type of model wraps the old MOQ and makes it accessible to The [MOP](class_m_o_p.xhtml "a group of random fields belonging together (either a single random field, or multiple cross-correlat...") framework. Used Properties: [More...](class_create_legacy_m_o_q_model.xhtml#details)

## <a name="pub-methods"></a>Public Member Functions

virtual string [\_\_str\_\_](struct_create_model_base.xhtml#a3031d648b73235d11d64df95db3d84ce) () Output function used in python context. Use this function to print instances of this class in python. [More...](#a3031d648b73235d11d64df95db3d84ce)  
 <a id="aedfb47575823522e6a6d22ce6c12e826"></a>virtual [addProperty](class_property_user_base.xhtml#aedfb47575823522e6a6d22ce6c12e826) ([PropertyBase](struct_property_base.xhtml) p) Properties that help the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") scheduling the Models to be built The properties class needs to be implemented for the specific model type.   
 [ModelBase](class_model_base.xhtml) \* [compute](class_create_legacy_m_o_q_model.xhtml#a428e7ba979340c651ec1372a3307e037) (::data\_handler::DataHandlerBase datahandler, [TrainingPlanBase](struct_training_plan_base.xhtml) training\_plan, quality\_measure::QualityMeasureBase quality\_measure) Builds the model from the given samples and returns the model. [More...](#a428e7ba979340c651ec1372a3307e037)  
 <a id="a604dd8fac349f4031c8e7bcac66ed2f6"></a> [CreateLegacyMOQModel](class_create_legacy_m_o_q_model.xhtml#a604dd8fac349f4031c8e7bcac66ed2f6) () Creates an default initialized instance of this class.   
 <a id="af974357aa62311511d47c7b6c5f1a843"></a> [CreateLegacyMOQModel](class_create_legacy_m_o_q_model.xhtml#af974357aa62311511d47c7b6c5f1a843) ([CreateLegacyMOQModel](class_create_legacy_m_o_q_model.xhtml) other) Copies an instance of this class.   
 <a id="a0e1dd7df82728594fc128ed1c797b0c0"></a>virtual [PropertyList](class_property_list.xhtml) [getProperties](class_property_user_base.xhtml#a0e1dd7df82728594fc128ed1c797b0c0) () Returns the properties stored by this user.   
 virtual bool [isValid](class_create_legacy_m_o_q_model.xhtml#a1a42d0ff7ef3b9c17965ecc14310ed5d) (::data\_handler::DataHandlerBase datahandler, [TrainingPlanBase](struct_training_plan_base.xhtml) training\_plan) override Destroys an instance of this class. [More...](#a1a42d0ff7ef3b9c17965ecc14310ed5d)  
 <a id="a4be004a83db31e2a7b337478420ffe90"></a>[CreateLegacyMOQModel](class_create_legacy_m_o_q_model.xhtml) [operator=](class_create_legacy_m_o_q_model.xhtml#a4be004a83db31e2a7b337478420ffe90) ([CreateLegacyMOQModel](class_create_legacy_m_o_q_model.xhtml)) Copies an instance of this class.   
 virtual [transferProperties](class_property_user_base.xhtml#ab9507274f126b856fb69cd621f0f9fb4) ([PropertyList](class_property_list.xhtml) property\_list) Convenience function to transfer a complete [PropertyList](class_property_list.xhtml "Container class for handling properties Uses templates to easily find and cast configurations of diff...") into the model. [More...](#ab9507274f126b856fb69cd621f0f9fb4)  
 ## <a name="pub-attribs"></a>Public Attributes

<a id="ad59f74edd2cee4b6ca041c129e4c0a3c"></a>number [altsupport](class_create_legacy_m_o_q_model.xhtml#ad59f74edd2cee4b6ca041c129e4c0a3c) Defines the usage of localization points. Default: 0. If this value is 0, then each sample (design) of a DOE will be used directly as localization point for the RBF interpolation. If this value is greater zero, then it is equal to the number of localization points to be used (eg. 1000). The localization points will be samples to match roughly the statistical properties of the input DOE. Use this option, if there are too many samples and the creation of the default eta model will take too much time.   
 <a id="a8e6f94721593ca05c2be2ed71d594b5e"></a>number [anisotropic](class_create_legacy_m_o_q_model.xhtml#a8e6f94721593ca05c2be2ed71d594b5e) Defines if the RBF interpolation functions are anisotropic. Value 1: Ansitotropy is used; Value 0: RBF funtions are isotropic. Anisotropy means in this context, that the RBF functions are scaled by a distance factor individually for each input parameter dimension.   
 <a id="a2414b09a907b9949960cca3eb4483f90"></a>number [corrfilter](class_create_legacy_m_o_q_model.xhtml#a2414b09a907b9949960cca3eb4483f90) Defines the usage of the correlation filter. The correlation filter tries to eliminate input parameters that are not significantly correlated to the response. The amount of correlation is measured in terms of a polynomial regression model. Only as many inputs are consideres as important as long as they increase the [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") of the polynomial regression model. Therefore, one may ensure that certain parameters are not removed by defining them as 'mandatory' or by using the mincorr option that defines the significance level of important parameters. A value of 0 means not active; The filter is active for a value of greater than 0. In the latter case, the filter becomes only active if more inputs are available than the number in this item.   
 <a id="a335ea5c4234dde32c761eb073e7378ff"></a>bool [generate\_auto\_settings](class_create_legacy_m_o_q_model.xhtml#a335ea5c4234dde32c761eb073e7378ff) if true, then FMOP will automatically generate a settings object, if false the settings of this object will be chosen.   
 <a id="a6800f9a034fa5e0bc4a6482700b6207e"></a>number [mincorr](class_create_legacy_m_o_q_model.xhtml#a6800f9a034fa5e0bc4a6482700b6207e) Defines the significance level of the correlation filter This value is only used when the corrfilter option is set (corrfilter!=0). It ensures that input parameters with a 'significant' linear correlation to the response are not eliminated as 'unimportant' when the correlation filter is active. The value defines a significance value from which the actual correlation value is computed that is required to enforce that an input becomes mandatory if the correlation between this input and the response is greater than this limit value. The significance value is first translated into a t-distribution of a test variable.   
 <a id="aeccb5f3a3f09db023b55ab5326ae7ff0"></a>number [mineval](class_create_legacy_m_o_q_model.xhtml#aeccb5f3a3f09db023b55ab5326ae7ff0) Defines the input-correlation filter Value of zero: There is not filter using input-correlations Values greater than zero: This is the smallest eigenvalue of the input-correlation matrix which is interpreted as non-zero! The inputs associated with eigenvalues below will be eliminated.   
 number [reshuffles](class_create_legacy_m_o_q_model.xhtml#aa5769b13c65c9e6ee1eae71b2b078b5f) Defines the number of shuffles in the computation of the sensitivities. Default value: 0. The special value of 0 means that as many shuffles as designs are used. This version takes most time, but is most accurate. A value greater 0 defines the actual number of shuffles. [More...](#aa5769b13c65c9e6ee1eae71b2b078b5f)  
 number [tolerance](class_create_legacy_m_o_q_model.xhtml#a593cce5ceb99745d936991573c146cf2) tolerance for the internal iterative algorithm This tolerance is used by the optimizer as termination criterion that tests: (a) gradients being near zero (b) objective function value improvements decline to nearly zero. The optimizer is used to determine the model coefficients. [More...](#a593cce5ceb99745d936991573c146cf2)  
 <a id="a1fa6b21ae19828191536d2c5fbeb83a2"></a>bool [use\_basic\_fit](class_create_legacy_m_o_q_model.xhtml#a1fa6b21ae19828191536d2c5fbeb83a2) if true, then FMOP will use basic polynomial regression fit only.   
 <a id="details" name="details"></a>## Detailed Description

Defines a LegacyMOPModel This type of model wraps the old MOQ and makes it accessible to The [MOP](class_m_o_p.xhtml "a group of random fields belonging together (either a single random field, or multiple cross-correlat...") framework. Used Properties:

- ComplexityProperty



## Member Function Documentation

<a id="a3031d648b73235d11d64df95db3d84ce"></a>## [◆ ](#a3031d648b73235d11d64df95db3d84ce)\_\_str\_\_()

 virtual string \_\_str\_\_  ( )   virtualinherited 

Output function used in python context. Use this function to print instances of this class in python.

Returnsstring containing the object Reimplemented in [CreateCustomModel](class_create_custom_model.xhtml#a3031d648b73235d11d64df95db3d84ce).





<a id="a428e7ba979340c651ec1372a3307e037"></a>## [◆ ](#a428e7ba979340c651ec1372a3307e037)compute()

 [ModelBase](class_model_base.xhtml)\* compute  ( ::data\_handler::DataHandlerBase  *datahandler*,    [TrainingPlanBase](struct_training_plan_base.xhtml)  *training\_plan*,    quality\_measure::QualityMeasureBase  *quality\_measure*   ) 

Builds the model from the given samples and returns the model.

Parameters datahandlerThe datahandler that contains the samples training\_planThe training plan that specifies how the model will be trained quality\_measureThe quality measure that allows to compute a models approximation quality ReturnsThe trained model iff not cancelled 



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

 virtual bool isValid  ( ::data\_handler::DataHandlerBase  *datahandler*,    [TrainingPlanBase](struct_training_plan_base.xhtml)  *training\_plan*   )   overridevirtual 

Destroys an instance of this class.

This function checks if the model can validly be trained from the given samples

Parameters samplesThe samples the model shall be trained with. ReturnsTrue iff th emodel can be trained with the configuration data, the properties and samples Implements [CreateModelBase](struct_create_model_base.xhtml#a1202ca4468e899d1e6d321ebf59e67a1).





<a id="ab9507274f126b856fb69cd621f0f9fb4"></a>## [◆ ](#ab9507274f126b856fb69cd621f0f9fb4)transferProperties()

 virtual transferProperties  ( [PropertyList](class_property_list.xhtml)  *property\_list*)   virtualinherited 

Convenience function to transfer a complete [PropertyList](class_property_list.xhtml "Container class for handling properties Uses templates to easily find and cast configurations of diff...") into the model.

Parameters property\_listThe properties to transfer into this model 



## Member Data Documentation

<a id="aa5769b13c65c9e6ee1eae71b2b078b5f"></a>## [◆ ](#aa5769b13c65c9e6ee1eae71b2b078b5f)reshuffles

 number reshuffles

Defines the number of shuffles in the computation of the sensitivities. Default value: 0. The special value of 0 means that as many shuffles as designs are used. This version takes most time, but is most accurate. A value greater 0 defines the actual number of shuffles.

NoteDo not mistake this with the number of shuffles in the cross-validation! This is different! 



<a id="a593cce5ceb99745d936991573c146cf2"></a>## [◆ ](#a593cce5ceb99745d936991573c146cf2)tolerance

 number tolerance

tolerance for the internal iterative algorithm This tolerance is used by the optimizer as termination criterion that tests: (a) gradients being near zero (b) objective function value improvements decline to nearly zero. The optimizer is used to determine the model coefficients.

Default: 0.001; Meaningful values are 1e-1 ... 1e-4.