observation_data
observation_data
ObservationData domain object for history matching.
Classes
ObservationData
Encapsulates observational data and implausibility calculations.
ObservationData
observation_data.ObservationData(observations)
Encapsulates observational data and implausibility calculations.
Represents the target observations that the model should match, including their means and variances. Provides methods for calculating implausibility metrics.
Methods
calculate_implausibilities
observation_data.ObservationData.calculate_implausibilities(
predictions,
model_discrepancy= 0.0 ,
)
Calculate implausibilities for multiple features.
Parameters
predictions
Dict [str , Tuple [float , float ]]
Dict mapping feature names to (predicted_mean, predicted_variance) tuples
required
model_discrepancy
float
Additional model uncertainty
0.0
Returns
Dict [str , float ]
Dict mapping feature names to implausibility values
calculate_implausibility
observation_data.ObservationData.calculate_implausibility(
feature_name,
predicted_mean,
predicted_variance,
model_discrepancy= 0.0 ,
)
Calculate implausibility metric for a single feature.
The implausibility is calculated as: I = |predicted_mean - observed_mean| / sqrt(predicted_variance + observed_variance + model_discrepancy^2)
Parameters
feature_name
str
Name of the feature
required
predicted_mean
Union [float , pd .Series ]
Predicted mean from emulator (scalar or Series)
required
predicted_variance
Union [float , pd .Series ]
Predicted variance from emulator (scalar or Series)
required
model_discrepancy
float
Additional model uncertainty
0.0
Returns
Union [float , pd .Series ]
Implausibility value(s) (lower is more plausible) - scalar if inputs are scalar, Series if inputs are Series
calculate_maximum_implausibility
observation_data.ObservationData.calculate_maximum_implausibility(
predictions,
model_discrepancy= 0.0 ,
)
Calculate maximum implausibility across all features.
Parameters
predictions
Dict [str , Tuple [float , float ]]
Dict mapping feature names to (predicted_mean, predicted_variance) tuples
required
model_discrepancy
float
Additional model uncertainty
0.0
Returns
float
Maximum implausibility value across all features
filter_features
observation_data.ObservationData.filter_features(feature_names)
Create new ObservationData with only specified features.
Parameters
feature_names
List [str ]
List of feature names to keep
required
get_all_targets
observation_data.ObservationData.get_all_targets()
Get all feature targets as a dictionary.
get_feature_names
observation_data.ObservationData.get_feature_names()
Get list of all observed feature names.
get_target_for_feature
observation_data.ObservationData.get_target_for_feature(feature_name)
Get target mean and std for a specific feature.
Parameters
feature_name
str
Name of the feature
required
has_feature
observation_data.ObservationData.has_feature(feature_name)
Check if a feature exists in observations.
Parameters
feature_name
str
Name of the feature to check
required
Returns
bool
True if feature exists, False otherwise
plot_targets
observation_data.ObservationData.plot_targets(ax= None , ** kwargs)
Plot observation targets as means with ±1σ error bars (delegates to historymatching.plotting.plot_targets ).
summary
observation_data.ObservationData.summary()
Human-readable summary: one line per observed feature (mean, std).
to_dataframe
observation_data.ObservationData.to_dataframe()
Return the underlying observations DataFrame.