AbstractInterpolatedVignettingModel#

class optika.radiometry.AbstractInterpolatedVignettingModel[source]#

Bases: AbstractVignettingModel

A vignetting model defined by interpolating between known scene coordinates and their measured illumination.

This class has two main members, coordinates_scene and illumination, the calibration points between which subclasses interpolate.

Attributes

`axis_field`	The logical axes corresponding to changing position in the scene.
`axis_wavelength`	The logical axis corresponding to changing wavelength.
`coordinates_scene`	The wavelength and position of each calibration point in the scene.
`illumination`	The relative illumination at each calibration point.

Methods

`__init__`()
`inverse`(coordinates)	Compute the inverse of the illumination, \(1 / I\), the factor which corrects for the vignetting at the given scene coordinates.
`to_string`([prefix])	Public-facing version of the `__repr__` method that allows for defining a prefix string, which can be used to calculate how much whitespace to add to the beginning of each line of the result.

Inheritance Diagram

inverse(coordinates)#

Compute the inverse of the illumination, \(1 / I\), the factor which corrects for the vignetting at the given scene coordinates.

Parameters:: coordinates (AbstractSpectralPositionalVectorArray) – The wavelength and position of each point in the scene.
Return type:: AbstractScalar

to_string(prefix=None)#

Public-facing version of the __repr__ method that allows for defining a prefix string, which can be used to calculate how much whitespace to add to the beginning of each line of the result.

Parameters:: prefix (None | str) – an optional string, the length of which is used to calculate how much whitespace to add to the result.
Return type:: str

abstract property axis_field: tuple[str, str]#: The logical axes corresponding to changing position in the scene.

abstract property axis_wavelength: str#: The logical axis corresponding to changing wavelength.

abstract property coordinates_scene: AbstractSpectralPositionalVectorArray#: The wavelength and position of each calibration point in the scene.

abstract property illumination: AbstractScalar#: The relative illumination at each calibration point.