AbstractVignettingModel

class optika.radiometry.AbstractVignettingModel

Bases: Printable

An interface describing an arbitrary vignetting model, which maps scene coordinates to the relative illumination of the optical system (the spatial response normalized to one at the center of the field of view).

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