eradiate.spectral.CKDQuadConfig

eradiate.spectral.CKDQuadConfig#

class eradiate.spectral.CKDQuadConfig(type='gauss_legendre', ng_max=1, policy='fixed')[source]#

Bases: object

This class holds configuration parameters for a CKD quadrature rule. Once the quadrature definition is set, it can query an absorption database to generate a quadrature rule for a specified spectral bin using its get_quad() method.

Parameters:

  • type (QuadType or str, default: "gauss_legendre") – Quadrature type.

  • ng_max (int, default: 1) – Maximum number of quadrature points.

  • policy (CKDQuadPolicy or str, default: fixed) – Quadrature definition policy.

Fields:

  • type (QuadType) – Quadrature type.

  • ng_max (int) – Maximum number of quadrature points.

  • policy (CKDQuadPolicy) – Quadrature definition policy.

classmethod convert(value)[source]#

Convert a value to a CKDQuadConfig. If value is a dictionary, its values are passed to the constructor as keyword arguments. Otherwise, value is returned unchanged.

get_quad(abs_db=None, wcenter=None)[source]#

Generate a quadrature rule for a specific bin, using information from a specified molecular absorption database.

Parameters:

  • abs_db (CKDAbsorptionDatabase, optional) – An absorption database with a transmittance error variable.

  • wcenter (quantity or float, optional) – The central wavelength of the spectral bin for which the quadrature rule is requested. Unitless values are interpreted in default wavelength units (generally nm).

Returns:

CKDQuad