eradiate.spectral.QuadSpec

class eradiate.spectral.QuadSpec

Bases: object

Abstract base class for all quadrature specification patterns.

Each subclass defines a strategy used to generate a spectral quadrature corresponding to a CKD dataset and must implement the strategy in the make_quad().

classmethod convert(value)

Attempt conversion to a QuadSpec instance. If value is a dictionary, it is passed to from_dict(); otherwise, it is left unchanged.

static default()

Return the default spectral quadrature (Gauss-Legendre, 16 g-points).

static from_dict(value)

Create a quadrature specification subtype from a dictionary. The dictionary must have a type entry, whose value maps to a give quadrature specification subtype as follows:

• fixed: QuadSpecFixed

• minimize_error: QuadSpecMinError

• error_threshold: QuadSpecErrorThreshold

Parameters:

value (dict) – A dictionary mapping parameter names to their respective values.

Returns:

QuadSpec

make_quad(dataset)

Apply the quadrature generation strategy and generate a quadrature rule for a given dataset.

Parameters:

dataset (Dataset) – An xarray dataset following the CKD absorption data format, for which a quadrature rule is generated.

Returns:

Quad