gemseo_calibration / measures

Show inherited members

integrated_measure module

A module to compute the integrated measure between two data sets.

class gemseo_calibration.measures.integrated_measure.IntegratedMeasure(output_name, mesh_name, name='', f_type=FunctionType.NONE)[source]

Bases: CalibrationMeasure

An abstract integrated measure between two output 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.

  • mesh_name (str) – The name of the 1D mesh.

  • name (str) –

    The name of the function.

    By default it is set to “”.

  • f_type (CalibrationMeasure.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.

Parameters:

reference_dataset (dict[str, ndarray[Any, dtype[floating[Any]]]]) – The reference input-output data set.

Return type:

None

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.

mesh_name: str

The name of the 1D mesh.

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.