pod

pod(
    poi_col,
    threshold,
    nuisance_col=None,
    bandwidth_ratio=0.1,
    n_boot=1000,
    model_override='auto',
    force_degree=None,
    n_jobs=None,
)

Runs the generalized Probability of Detection (PoD) analysis.

Parameters

Name Type Description Default
poi_col list | str The parameter(s) of interest (e.g., ‘Crack Length’, [‘Angle’, ‘Depth’]). required
threshold float The failure threshold (e.g., 4.0 dB). required
nuisance_col list | str | None The nuisance parameters to marginalize over via MC integration. None
bandwidth_ratio float Smoothing bandwidth fraction (default 0.1). 0.1
n_boot int Bootstrap iterations for confidence bounds. 1000
model_override str Force a model type. One of “auto”, “polynomial”, or “kriging”. Defaults to “auto”. 'auto'
force_degree int | None When model_override=“polynomial”, use this degree. Defaults to None (CV selects). None
n_jobs int | None Number of CPU cores for parallel bootstrap execution. Defaults to None (single-core). Set to -1 to auto-detect and use all available cores. None

Returns

Name Type Description
Dict Dict[str, Any] Dictionary containing models, curves, and fit statistics.

Examples

results = study.pod(poi_col="Length", threshold=0.5)
print(results['dist_info'])