Skip to main content

observation_data

observation_data

ObservationData domain object for history matching.

Classes

Name Description
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

Name Description
calculate_implausibilities Calculate implausibilities for multiple features.
calculate_implausibility Calculate implausibility metric for a single feature.
calculate_maximum_implausibility Calculate maximum implausibility across all features.
filter_features Create new ObservationData with only specified features.
get_all_targets Get all feature targets as a dictionary.
get_feature_names Get list of all observed feature names.
get_target_for_feature Get target mean and std for a specific feature.
has_feature Check if a feature exists in observations.
plot_targets Plot observation targets as means with ±1σ error bars (delegates to
summary Human-readable summary: one line per observed feature (mean, std).
to_dataframe Return the underlying observations DataFrame.
calculate_implausibilities
observation_data.ObservationData.calculate_implausibilities(
    predictions,
    model_discrepancy=0.0,
)

Calculate implausibilities for multiple features.

Parameters
Name Type Description Default
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
Name Type Description
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
Name Type Description Default
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
Name Type Description
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
Name Type Description Default
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
Name Type Description
float Maximum implausibility value across all features
filter_features
observation_data.ObservationData.filter_features(feature_names)

Create new ObservationData with only specified features.

Parameters
Name Type Description Default
feature_names List[str] List of feature names to keep required
Returns
Name Type Description
ObservationData New ObservationData instance with filtered features
get_all_targets
observation_data.ObservationData.get_all_targets()

Get all feature targets as a dictionary.

Returns
Name Type Description
Dict[str, Tuple[float, float]] Dict mapping feature names to (mean, std) tuples
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
Name Type Description Default
feature_name str Name of the feature required
Returns
Name Type Description
Tuple[float, float] Tuple of (mean, std) values
has_feature
observation_data.ObservationData.has_feature(feature_name)

Check if a feature exists in observations.

Parameters
Name Type Description Default
feature_name str Name of the feature to check required
Returns
Name Type Description
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.

Returns
Name Type Description
pd.DataFrame DataFrame with observations data