skretrieval.core.sensor package¶

Submodules¶

skretrieval.core.sensor.pixel module¶

class skretrieval.core.sensor.pixel.Pixel(mean_wavel_nm: float, pixel_shape: skretrieval.core.lineshape.LineShape, vert_fov: skretrieval.core.lineshape.LineShape, horiz_fov: skretrieval.core.lineshape.LineShape)¶

Bases: skretrieval.core.sensor.Sensor

A single pixel with corresponding horizontal field of view, vertical field of view, and wavelength line shape.

measurement_geometry(optical_geometry: skretrieval.core.OpticalGeometry)¶

Takes in the sensors orientation and returns back a Geometry object corresonding to the central point of each measurement.

Parameters: optical_geometry (OpticalGeometry) – Sensor orientation
Returns
Return type: Geometry

measurement_wavelengths()¶: Central wavelength of the pixel

model_radiance(optical_geometry: skretrieval.core.OpticalGeometry, model_wavel_nm: numpy.array, model_geometry: sasktran.geometry.Geometry, radiance: numpy.array, wf=None)¶

Takes in high resolution radiances at the front of the aperture and converts them to what is observed by the sensor.

Parameters

optical_geometry (OpticalGeometry) – The orientation, look vector, time, position of the sensor
model_wavel_nm (np.array) – Array of radiances that correspond to radiance
model_geometry (Geometry) – The Geometry object that corresponds to radiance
radiance (np.array) – An array (wavelength, line of sight) of input radiances
wf (np.array, optional) – An array (wavelength, line of sight, perturbation) corresponding to weighting functions. Default None.

Returns

Output L1 radiances in a format specific to the sensor. The format is defined by radiance_format

Return type

radianceformat.RadianceBase

static radiance_format()¶

Returns the format that model_radiance returns data in

Returns
Return type: A specialized instance of radianceformat.RadianceBase

required_wavelengths(res_nm: float) → numpy.array¶

Recommended wavelengths to use in the high resolution input radiance

Parameters: res_nm (float) – Desired model resolution
Returns: Array of wavelengths
Return type: np.array

skretrieval.core.sensor.spectrograph module¶

class skretrieval.core.sensor.spectrograph.Spectrograph(wavelength_nm: numpy.array, pixel_shape: skretrieval.core.lineshape.LineShape, vert_fov: skretrieval.core.lineshape.LineShape, horiz_fov: skretrieval.core.lineshape.LineShape)¶

Bases: skretrieval.core.sensor.Sensor

A spectrograph created from an array of Pixels

measurement_geometry(optical_geometry: skretrieval.core.OpticalGeometry)¶

Takes in the sensors orientation and returns back a Geometry object corresonding to the central point of each measurement.

Parameters: optical_geometry (OpticalGeometry) – Sensor orientation
Returns
Return type: Geometry

measurement_wavelengths()¶

Returns: Central wavelengths of the measurement
Return type: np.array

model_radiance(optical_geometry: skretrieval.core.OpticalGeometry, model_wavel_nm: numpy.array, model_geometry: sasktran.geometry.Geometry, radiance: numpy.array, wf=None)¶

Takes in high resolution radiances at the front of the aperture and converts them to what is observed by the sensor.

Parameters

optical_geometry (OpticalGeometry) – The orientation, look vector, time, position of the sensor
model_wavel_nm (np.array) – Array of radiances that correspond to radiance
model_geometry (Geometry) – The Geometry object that corresponds to radiance
radiance (np.array) – An array (wavelength, line of sight) of input radiances
wf (np.array, optional) – An array (wavelength, line of sight, perturbation) corresponding to weighting functions. Default None.

Returns

Output L1 radiances in a format specific to the sensor. The format is defined by radiance_format

Return type

radianceformat.RadianceBase

static radiance_format()¶

Returns the format that model_radiance returns data in

Returns
Return type: A specialized instance of radianceformat.RadianceBase

required_wavelengths(res_nm: float) → numpy.array¶

Recommended wavelengths for high resolution calculations

Parameters: res_nm (float) – Resolution in nm
Returns
Return type: np.array

class skretrieval.core.sensor.spectrograph.SpectrographFast(wavelength_nm: numpy.array, pixel_shape: skretrieval.core.lineshape.LineShape, vert_fov: skretrieval.core.lineshape.LineShape, horiz_fov: skretrieval.core.lineshape.LineShape)¶

Bases: skretrieval.core.sensor.spectrograph.Spectrograph

Same functionality as Spectrogaph, but coded to not consist of individual pixels for speed

model_radiance(optical_geometry: skretrieval.core.OpticalGeometry, model_wavel_nm: numpy.array, model_geometry: sasktran.geometry.Geometry, radiance: numpy.array, wf=None)¶

Takes in high resolution radiances at the front of the aperture and converts them to what is observed by the sensor.

Parameters

optical_geometry (OpticalGeometry) – The orientation, look vector, time, position of the sensor
model_wavel_nm (np.array) – Array of radiances that correspond to radiance
model_geometry (Geometry) – The Geometry object that corresponds to radiance
radiance (np.array) – An array (wavelength, line of sight) of input radiances
wf (np.array, optional) – An array (wavelength, line of sight, perturbation) corresponding to weighting functions. Default None.

Returns

Output L1 radiances in a format specific to the sensor. The format is defined by radiance_format

Return type

radianceformat.RadianceBase

Module contents¶

class skretrieval.core.sensor.Sensor¶

Bases: abc.ABC

A sensor is an object which takes in radiances at the front of an aperture, and returns backend radiances observed by the sensor.

abstract measurement_geometry(optical_geometry: skretrieval.core.OpticalGeometry)¶

Takes in the sensors orientation and returns back a Geometry object corresonding to the central point of each measurement.

Parameters: optical_geometry (OpticalGeometry) – Sensor orientation
Returns
Return type: Geometry

abstract measurement_wavelengths()¶

Returns: Central wavelengths of the measurement
Return type: np.array

abstract model_radiance(optical_geometry: skretrieval.core.OpticalGeometry, model_wavel_nm: numpy.array, model_geometry: sasktran.geometry.Geometry, radiance: numpy.array, wf=None) → skretrieval.core.radianceformat.RadianceBase ¶

Takes in high resolution radiances at the front of the aperture and converts them to what is observed by the sensor.

Parameters

optical_geometry (OpticalGeometry) – The orientation, look vector, time, position of the sensor
model_wavel_nm (np.array) – Array of radiances that correspond to radiance
model_geometry (Geometry) – The Geometry object that corresponds to radiance
radiance (np.array) – An array (wavelength, line of sight) of input radiances
wf (np.array, optional) – An array (wavelength, line of sight, perturbation) corresponding to weighting functions. Default None.

Returns

Output L1 radiances in a format specific to the sensor. The format is defined by radiance_format

Return type

radianceformat.RadianceBase

abstract static radiance_format()¶

Returns the format that model_radiance returns data in

Returns
Return type: A specialized instance of radianceformat.RadianceBase