matcal.core.objective_results
This module only contains the ObjectiveResults class which is a large data structure for holding all data related to objective calculation.
Functions
|
Classes
|
|
|
The ObjectiveResults objects stores all relevant data needed to calculate the objective value for a user requested objective. |
- class matcal.core.objective_results.ObjectiveContainerBase(required_fields, fields_of_interest, large_data_sets=False)[source]
- class matcal.core.objective_results.ObjectiveQOI(required_fields, fields_of_interest, large_data_sets=False)[source]
- property simulation_qois
- Returns:
Returns a DataCollection with the simulation QoIs that were extracted from the simulation data for each state that was evaluated for the objective. The QoIs may be extracted using a MatCal default QoI extractor from module
qoi_extractoror may be a user specified QoI extractor.- Return type:
- property experiment_qois
- Returns:
Returns a DataCollection with the experimental QoIs that were extracted from the experimental data for each state that was evaluated for the objective. The QoIs may be extracted using a MatCal default QoI extractor from module
qoi_extractoror may be a user specified QoI extractor.- Return type:
- property conditioned_simulation_qois
- Returns:
Returns a DataCollection with the conditioned simulation QoIs for each state that was evaluated for the objective. Conditioning is done automatically by MatCal in an attempt to normalize all provided experimental data to be on the order of 0-1. The same conditioning that is derived from and then applied to the experimental data is applied to the corresponding simulation data by state. See MatCal Objective Calculations.
- Return type:
- property conditioned_experiment_qois
- Returns:
Returns a DataCollection with the conditioned experiment QoIs for each state that was evaluated for the objective. Conditioning is done automatically by MatCal in an attempt to normalize all provided experimental data to be on the order of 0-1. The same conditioning that is derived from and then applied to the experimental data is applied to the corresponding simulation data by state. See MatCal Objective Calculations.
- Return type:
- property weighted_conditioned_simulation_qois
- Returns:
Returns a DataCollection with the weighted and conditioned simulation QoIs stored for each state that was evaluated for the objective. Conditioning is done automatically by MatCal in an attempt to normalize all provided experimental data to be on the order of 0-1 and the weighting is what was specified by MatCal defaults and the user. See MatCal Objective Calculations.
- Return type:
- property weighted_conditioned_experiment_qois
- Returns:
Returns a DataCollection with the weighted and conditioned experiment QoIs stored for each state that was evaluated for the objective. Conditioning is done automatically by MatCal in an attempt to normalize all provided experimental data to be on the order of 0-1 and the weighting is what was specified by MatCal defaults and the user. See MatCal Objective Calculations.
- Return type:
- property conditioned_simulation_data
- Returns:
Returns a DataCollection with the conditioned simulation data for each state that was evaluated for the objective. Conditioning is done automatically by MatCal in an attempt to normalize all provided experimental data to be on the order of 0-1. The same conditioning that is derived from and then applied to the experimental data is applied to the corresponding simulation data by state. See MatCal Objective Calculations.
- Return type:
- property conditioned_experiment_data
- Returns:
Returns a DataCollection with the conditioned experimental data for each state that was evaluated for the objective. Conditioning is done automatically by MatCal in an attempt to normalize all provided experimental data to be on the order of 0-1. The same conditioning that is derived from and then applied to the experimental data is applied to the corresponding simulation data by state. See MatCal Objective Calculations.
- Return type:
- property simulation_data
- Returns:
Returns a DataCollection with the simulation data generated by the appropriate model for the objective.
- Return type:
- property experiment_data
- Returns:
Returns a DataCollection with the experimental data supplied by the user for the objective.
- Return type:
- class matcal.core.objective_results.ObjectiveResults(required_fields, fields_of_interest, large_data_sets=False)[source]
The ObjectiveResults objects stores all relevant data needed to calculate the objective value for a user requested objective.
- property objectives
- Returns:
Returns a DataCollection with objective values stored for each state that was evaluated for the objective.
- Return type:
- property residuals
- Returns:
Returns a DataCollection with the residual values stored for each state that was evaluated for the objective.
- Return type:
- property conditioned_residuals
- Returns:
Returns a DataCollection with the conditioned residual values stored for each state that was evaluated for the objective. Conditioning is done automatically by MatCal to normalize all provided experimental data to be on the order of 0-1. See Conditioning.
- Return type:
- property weighted_residuals
- Returns:
Returns a DataCollection with the weighted residual values stored for each state that was evaluated for the objective.
- Return type:
- property weighted_conditioned_residuals
- Returns:
Returns a DataCollection with the weighted and conditioned residual values stored for each state that was evaluated for the objective. Conditioning is done automatically by MatCal in an attempt to normalize all provided experimental data to be on the order of 0-1 and the weighting is what was specified by MatCal defaults and the user. See MatCal Objective Calculations.
- Return type:
- property weighted_conditioned_normalized_residuals
- Returns:
Returns a DataCollection with the weighted, conditioned and normalized residual values stored for each state that was evaluated for the objective. Conditioning is done automatically by MatCal in an attempt to normalize all provided experimental data to be on the order of 0-1 and the weighting is what was specified by MatCal defaults and the user. See MatCal Objective Calculations.
- Return type:
- property calibration_residuals
- Returns:
Returns an NumPy array that is the concatenated, weighted, conditioned, and normalized residual of this objective. This is the residual that is used by MatCal for calibration.