optiSLang 3D Postprocessing Script API 2025 R1

CreateScalarMOP Class Reference

Last update: 16.07.2025

Creation/Configuration class for the ScalarMOP CreateScalarMOP may be given a number of Model Configurations (CreateModelBase). By calling compute all relevant models are scheduled and trained based on these Configuration. The resulting MOP object is the returned. More...

Public Member Functions

virtual string __str__ ()
 Output function used in python context. Use this function to print instances of this class in python. More...
 
 addConfig (CreateModelBase config)
 Add a model configuration to the ScalarMOP. More...
 
virtual addProperty (PropertyBase p)
 Properties that help the ScalarMOP scheduling the Models to be built The properties class needs to be implemented for the specific model type.
 
 compute (::data_handler::DataHandlerBase datahandler)
 Compute a MOP from the configuration data stored in this instance and the data contained in the datahandler. More...
 
 CreateScalarMOP (string ident=handler::defaultMOPIdent)
 
 CreateScalarMOP (CreateScalarMOP)
 
virtual PropertyList getProperties ()
 Returns the properties stored by this user.
 
string getReportFileLocation ()
 
bool isValid (::data_handler::DataHandlerBase datahandler)
 Test if the configuration of this instance is valid in the context of the given datahandler. More...
 
virtual loadJson (JsonValue root) override
 Funtion to read and set up the model configuration through a JSON string. More...
 
CreateScalarMOP operator= (CreateScalarMOP)
 
 removeConfig (int index)
 Remove a model configuration from the ScalarMOP. More...
 
virtual JsonValue saveJson () override
 Function to write the Models configuration data as a JSON string. More...
 
 setInputImportance (uint64_t index, ParameterImportance importance)
 Sets the input importance of input variable i to the given importance. All importances of inputs with smaller index that are not yet set Will be set to "optional" Setting an index already define overwrites the old setting. More...
 
 setQualityMeasure (quality_measure::QualityMeasureBase quality_measure)
 Let the user set the quality measure. More...
 
 setReportFileLocation (string file_path)
 
virtual transferProperties (PropertyList property_list)
 Convenience function to transfer a complete PropertyList into the model. More...
 
std::ostream write (std::ostream os)
 Writer for the CreateScalarMOP class.
 

Public Attributes

apply SWIGTYPE * DISOWN
 
ParameterImportanceVector input_importances
 The importances for the mops input variables.
 
int max_number_parallel_solve
 The number of parallal solve runs to execute.
 
int number_of_folds
 Size of folds if training == TrainingType::KFold valid value range of [2,100], -1 : Auto - a valid value will be determined internally.
 
std::vector< string > selected_outputs
 A vector of selected outputs by the user.
 

Detailed Description

Creation/Configuration class for the ScalarMOP CreateScalarMOP may be given a number of Model Configurations (CreateModelBase). By calling compute all relevant models are scheduled and trained based on these Configuration. The resulting MOP object is the returned.

Member Function Documentation

◆ __str__()

virtual string __str__ ( )
virtual

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

Returns
string containing the object

◆ addConfig()

addConfig ( CreateModelBase  config)

Add a model configuration to the ScalarMOP.

Parameters
configThe model config to add to the training of the ScalarMOP

◆ compute()

compute ( ::data_handler::DataHandlerBase  datahandler)

Compute a MOP from the configuration data stored in this instance and the data contained in the datahandler.

Parameters
datahandlerThe data to train the ScalarMOP with
Returns
The trained MOP

◆ isValid()

bool isValid ( ::data_handler::DataHandlerBase  datahandler)

Test if the configuration of this instance is valid in the context of the given datahandler.

Parameters
datahandlerThe datahandler to creat ethis MOP from
Returns
true iff configuration is ok with datahandler

◆ loadJson()

virtual loadJson ( JsonValue  root)
overridevirtual

Funtion to read and set up the model configuration through a JSON string.

Parameters
jsonThe json string to set up the configuration from

◆ removeConfig()

removeConfig ( int  index)

Remove a model configuration from the ScalarMOP.

Parameters
indexindex of the model pointer in the vector

◆ saveJson()

virtual JsonValue saveJson ( )
overridevirtual

Function to write the Models configuration data as a JSON string.

Returns
The configuration of the model as JSON string

◆ setInputImportance()

setInputImportance ( uint64_t  index,
ParameterImportance  importance 
)

Sets the input importance of input variable i to the given importance. All importances of inputs with smaller index that are not yet set Will be set to "optional" Setting an index already define overwrites the old setting.

Parameters
indexThe index of the input to set
importanceThe importance of the input with given index

◆ setQualityMeasure()

setQualityMeasure ( quality_measure::QualityMeasureBase  quality_measure)

Let the user set the quality measure.

Parameters
quality_measure

◆ transferProperties()

virtual transferProperties ( PropertyList  property_list)
virtualinherited

Convenience function to transfer a complete PropertyList into the model.

Parameters
property_listThe properties to transfer into this model

Member Data Documentation

◆ DISOWN

apply SWIGTYPE * DISOWN
Initial value:
{CreateModelBase * create_model}
addModelToList(CreateModelBase *create_model, ConfigurationList list)

Connect with Ansys