curryer.correction.io_config

NetCDF output configuration and standard attribute definitions.

Separates I/O-specific configuration from the core correction config models.

Attributes

Classes

NetCDFParameterMetadata

NetCDF metadata for a single output parameter variable.

NetCDFConfig

Configuration for NetCDF output structure and metadata.

Module Contents

curryer.correction.io_config.logger
curryer.correction.io_config.DEFAULT_NETCDF_ATTRIBUTES
class curryer.correction.io_config.NetCDFParameterMetadata(/, **data: Any)

Bases: pydantic.BaseModel

NetCDF metadata for a single output parameter variable.

variable_name: str
units: str
long_name: str
class curryer.correction.io_config.NetCDFConfig(/, **data: Any)

Bases: pydantic.BaseModel

Configuration for NetCDF output structure and metadata.

performance_threshold_m

Accuracy threshold in meters used to derive threshold-specific variable names (e.g. "percent_under_250m").

title

Global title attribute for the output NetCDF file.

description

Global description attribute for the output NetCDF file.

parameter_metadata

Optional mapping of parameter key → NetCDFParameterMetadata. Auto-generated from the sweep’s parameters when None.

standard_attributes

Optional mission-specific attribute overrides. Falls back to the module-level DEFAULT_NETCDF_ATTRIBUTES when None.

performance_threshold_m: float
title: str = 'Correction Geolocation Analysis Results'
description: str = 'Parameter sensitivity analysis'
parameter_metadata: dict[str, NetCDFParameterMetadata] | None = None
standard_attributes: dict[str, dict[str, str]] | None = None
property threshold_metric_name: str

Threshold-derived metric variable name, e.g. "percent_under_250m".

property standard_attributes_dict: dict[str, dict[str, str]]

Standard variable attributes, with optional mission-specific overrides.

Returns a shallow copy so callers may add derived entries (e.g. the threshold metric) without mutating the stored config.

get_parameter_netcdf_metadata(param_config: curryer.correction.config.ParameterConfig, angle_type: str | None = None) NetCDFParameterMetadata

Get NetCDF metadata for a parameter.

_auto_generate_metadata(param_config: curryer.correction.config.ParameterConfig, angle_type: str | None, base_key: str) NetCDFParameterMetadata

Auto-generate NetCDF metadata from parameter configuration.