Ctrl+K

eradiate.spectral.QuadSpecErrorThreshold

eradiate.spectral.QuadSpecErrorThreshold#

class eradiate.spectral.QuadSpecErrorThreshold(threshold, nmax=None)[source]#

Bases: QuadSpec

Error-threshold number of quadrature points [error_threshold]

Find the number of quadrature points so that the error on the atmospheric transmittance is below a specified threshold.

Parameters:

  • threshold (float) – Error threshold value

  • nmax (int, optional) – Maximum number of quadrature points

Fields:

  • threshold (float) – Error threshold value.

  • nmax (int or None) – Maximum number of quadrature points.

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).

classmethod from_dict(value)[source]#

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:

Parameters:

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

Returns:

QuadSpec

make_quad(dataset)[source]#

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

Contents