## On this page

  

 

 # CreateLegacyMOPModel Class Reference

 Last update: 16.07.2025 

Defines a LegacyMOPModel. This type of model wraps the old [MOP](class_m_o_p.xhtml "a group of random fields belonging together (either a single random field, or multiple cross-correlat...") 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_p_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_p_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="ad61adf030cb568f50d71d165d420b61e"></a> [CreateLegacyMOPModel](class_create_legacy_m_o_p_model.xhtml#ad61adf030cb568f50d71d165d420b61e) () Creates an default initialized instance of this class.   
 <a id="a76549ea2eabdc1ff32424f570ad5e41f"></a> [CreateLegacyMOPModel](class_create_legacy_m_o_p_model.xhtml#a76549ea2eabdc1ff32424f570ad5e41f) ([CreateLegacyMOPModel](class_create_legacy_m_o_p_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_p_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="a3b2ee4d9715a1fa272b70b3f62f78955"></a>[CreateLegacyMOPModel](class_create_legacy_m_o_p_model.xhtml) [operator=](class_create_legacy_m_o_p_model.xhtml#a3b2ee4d9715a1fa272b70b3f62f78955) ([CreateLegacyMOPModel](class_create_legacy_m_o_p_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="a65a2d27d476efcf99f7bbd35388ff02e"></a>string **node\_name** <a id="ae3a2c0110357b15e55285a625c21e028"></a>bool [use\_BoxCox](class_create_legacy_m_o_p_model.xhtml#ae3a2c0110357b15e55285a625c21e028) if true, then Box Cox is tested   
 <a id="ad454212264147757ead8a6b1a702019d"></a>bool [use\_CoD\_filter](class_create_legacy_m_o_p_model.xhtml#ad454212264147757ead8a6b1a702019d) if true, then [CoD](struct_co_d.xhtml "Reference implementation for a quality metric for MOP models. ") filter is used   
 <a id="adb678f343269092390e130a99b1d2dad"></a>bool [use\_CoI\_filter](class_create_legacy_m_o_p_model.xhtml#adb678f343269092390e130a99b1d2dad) if true, then CoI filter is used   
 <a id="afd89ea7f62227924199890c55f41439f"></a>bool [use\_correlation\_filter](class_create_legacy_m_o_p_model.xhtml#afd89ea7f62227924199890c55f41439f) if true, then correlation filter is used   
 <a id="a7bc1de6eaf8c93f135797f06992972a4"></a>bool [use\_input\_correlation\_filter](class_create_legacy_m_o_p_model.xhtml#a7bc1de6eaf8c93f135797f06992972a4) if true, then input correlation filter is used   
 <a id="a777c1c86f4a98e63b65b2b395b8b551c"></a>bool [use\_kriging](class_create_legacy_m_o_p_model.xhtml#a777c1c86f4a98e63b65b2b395b8b551c) if true, then kriging is tested   
 <a id="a21ae967782584b3e9eedcde16144132d"></a>bool [use\_kriging\_anisotropic](class_create_legacy_m_o_p_model.xhtml#a21ae967782584b3e9eedcde16144132d) if true, then anisotropic kriging is tested   
 <a id="ae1d69f069ec0d2747cbee8c5e629dfd7"></a>bool [use\_MLS](class_create_legacy_m_o_p_model.xhtml#ae1d69f069ec0d2747cbee8c5e629dfd7) if true, then MLS is tested   
 <a id="a705beab6587cd69b7d89d4ea6d830a2e"></a>bool [use\_polynomials](class_create_legacy_m_o_p_model.xhtml#a705beab6587cd69b7d89d4ea6d830a2e) if true, then polynomial models are tested   
 <a id="aea97490d1b9082db4c2ec6b37012c17e"></a>bool [use\_significance\_filter](class_create_legacy_m_o_p_model.xhtml#aea97490d1b9082db4c2ec6b37012c17e) if true, then significance filter is used   
 <a id="a4545c85407236294e80529caabe599af"></a>bool [use\_Spearman\_filter](class_create_legacy_m_o_p_model.xhtml#a4545c85407236294e80529caabe599af) if true, then Spearman filter is used   
 <a id="acbb9a6e9c62149080b78c707dd1f555c"></a>string **working\_dir** <a id="details" name="details"></a>## Detailed Description

Defines a LegacyMOPModel. This type of model wraps the old [MOP](class_m_o_p.xhtml "a group of random fields belonging together (either a single random field, or multiple cross-correlat...") 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