measure module¶
A module to measure the consistency or the inconsistency between two data sets.
- class gemseo_calibration.measure.CalibrationMeasure(output_name, name='', f_type=FunctionType.NONE)[source]
Bases:
MDOFunction
A measure of the consistency (or inconsistency) between two data sets.
Initialize self. See help(type(self)) for accurate signature.
- Parameters:
output_name (str) – The name of the output to be taken into account by the measure.
name (str) –
The name of the function.
By default it is set to “”.
f_type (MDOFunction.FunctionType) –
The type of the function.
By default it is set to “”.
- set_reference_data(reference_dataset)[source]
Define the reference input-output data set.
- force_real: bool
Whether to cast the results to real value.
- property full_output_name: str
The full name of the output.
- has_default_name: bool
Whether the name has been set with a default value.
- last_eval: OutputType | None
The value of the function output at the last evaluation.
None
if it has not yet been evaluated.
- maximize: ClassVar[bool] = False
Whether to maximize the calibration measure.
- output_name: str
The name of the output used by the measure for calibration.
- special_repr: str
The string representation of the function overloading its default string ones.
- gemseo_calibration.measure.DataType
The type of data.
The data are set as
{variable_name: variable_values}
wherevariable_values
is a 2D NumPy array whose rows are the samples and columns are the components of the variable.