`rtm_wrapper.parameters.common`#

Parameter definitions.

Module Contents#

Classes#

`AltitudePredefined`	Predefined altitude level.
`AltitudeKilometers`	Altitude given in kilometers
`AtmospherePredefined`	Predefined atmosphere profile.
`AtmosphereWaterOzone`	Atmosphere expressed as water and ozone columns.
`AerosolProfilePredefined`	Predefined aerosol profile.
`AerosolAOTSingleLayer`	Aerosol profile consisting of a single layer with a given AOT.
`AerosolAOTLayers`	Aerosol profile consist of various AOT layers.
`GroundReflectanceHomogenousUniformLambertian`	Uniform homogeneous lambertian ground reflectance.
`GroundReflectanceHomogenousLambertian`	Homogeneous lambertian ground reflectance.
`GroundReflectanceHeterogeneousLambertian`	Heterogeneous lambertian ground reflectance.
`WavelengthFixed`	Single wavelength.
`AngleParameter`	Base class for angle parameters.
`AngleDegreesParameter`	Angle in degrees.
`AngleCosineParameter`	Cosine of angle.
`GeometryAngleDate`	Geometry description.

class AltitudePredefined(**kwargs: Any)[source]#

Bases: rtm_wrapper.parameters.base.Parameter

Predefined altitude level.

Parameters:: kwargs (Any) –

name: rtm_wrapper.parameters.base.StrField#: Name of altitude level.

class AltitudeKilometers(**kwargs: Any)[source]#

Bases: rtm_wrapper.parameters.base.Parameter

Altitude given in kilometers

Parameters:: kwargs (Any) –

value: rtm_wrapper.parameters.base.FloatField#: Altitude in kilometers.

class AtmospherePredefined(**kwargs: Any)[source]#

Bases: rtm_wrapper.parameters.base.Parameter

Predefined atmosphere profile.

Parameters:: kwargs (Any) –

name: rtm_wrapper.parameters.base.StrField#: Name of atmosphere profile.

class AtmosphereWaterOzone(**kwargs: Any)[source]#

Bases: rtm_wrapper.parameters.base.Parameter

Atmosphere expressed as water and ozone columns.

Parameters:: kwargs (Any) –

water: rtm_wrapper.parameters.base.FloatField#: Water column in g/cm^2.

ozone: rtm_wrapper.parameters.base.FloatField#: Ozone column in cm-atm.

class AerosolProfilePredefined(**kwargs: Any)[source]#

Bases: rtm_wrapper.parameters.base.Parameter

Predefined aerosol profile.

Parameters:: kwargs (Any) –

profile#: Name of aerosol profile.

class AerosolAOTSingleLayer(**kwargs: Any)[source]#

Bases: AerosolProfilePredefined

Aerosol profile consisting of a single layer with a given AOT.

Parameters:: kwargs (Any) –

height#: Heights of each layer in kilometers.

aot#: Aerosol optical thickness of each layer.

class AerosolAOTLayers(**kwargs: Any)[source]#

Bases: AerosolProfilePredefined

Aerosol profile consist of various AOT layers.

Parameters:: kwargs (Any) –

layers: rtm_wrapper.parameters.base.FloatArrayField#: AOT layers given as Nx2 array, with layer heights in the first column and layer AOTs in the second column.

class GroundReflectanceHomogenousUniformLambertian(**kwargs: Any)[source]#

Bases: rtm_wrapper.parameters.base.Parameter

Uniform homogeneous lambertian ground reflectance.

Parameters:: kwargs (Any) –

class GroundReflectanceHomogenousLambertian(**kwargs: Any)[source]#

Bases: rtm_wrapper.parameters.base.Parameter

Homogeneous lambertian ground reflectance.

Parameters:: kwargs (Any) –

wavelengths: rtm_wrapper.parameters.base.FloatArrayField#: Wavelengths vector.

spectrum: rtm_wrapper.parameters.base.FloatArrayField#: Spectrum vector.

class GroundReflectanceHeterogeneousLambertian(**kwargs: Any)[source]#

Bases: rtm_wrapper.parameters.base.Parameter

Heterogeneous lambertian ground reflectance.

Parameters:: kwargs (Any) –

target: rtm_wrapper.parameters.base.ParameterField[GroundReflectanceHomogenousLambertian]#: Target spectrum.

background: rtm_wrapper.parameters.base.ParameterField[GroundReflectanceHomogenousLambertian]#: Background spectrum.

class WavelengthFixed(**kwargs: Any)[source]#

Bases: rtm_wrapper.parameters.base.Parameter

Single wavelength.

Parameters:: kwargs (Any) –

value: rtm_wrapper.parameters.base.FloatField#: Wavelength in micrometers.

class AngleParameter(**kwargs: Any)[source]#

Bases: rtm_wrapper.parameters.base.AbstractParameter

Base class for angle parameters.

Parameters:: kwargs (Any) –

abstract as_degrees() → float[source]#

Retrieve this angle as degrees.

Return type:: float

class AngleDegreesParameter(**kwargs: Any)[source]#

Bases: AngleParameter

Angle in degrees.

Parameters:: kwargs (Any) –

degrees: rtm_wrapper.parameters.base.FloatField#: Angle in degrees.

as_degrees() → float[source]#

Retrieve this angle as degrees.

Return type:: float

class AngleCosineParameter(**kwargs: Any)[source]#

Bases: AngleParameter

Cosine of angle.

Parameters:: kwargs (Any) –

cosine: rtm_wrapper.parameters.base.FloatField#: Angle cosine.

as_degrees() → float[source]#

Retrieve this angle as degrees.

Return type:: float

class GeometryAngleDate(**kwargs: Any)[source]#

Bases: rtm_wrapper.parameters.base.Parameter

Geometry description.

Parameters:: kwargs (Any) –

solar_zenith: rtm_wrapper.parameters.base.ParameterField[AngleParameter]#: Solar zenith angle.

solar_azimuth: rtm_wrapper.parameters.base.ParameterField[AngleParameter]#: Solar azimuth angle.

view_zenith: rtm_wrapper.parameters.base.ParameterField[AngleParameter]#: Target zenith angle.

view_azimuth: rtm_wrapper.parameters.base.ParameterField[AngleParameter]#: Target azimuth angle.

day: rtm_wrapper.parameters.base.IntField#: Day of month.

month: rtm_wrapper.parameters.base.IntField#: Month.