AbstractInversionResult#

class ctis.inverters.AbstractInversionResult[source]#

Bases: ABC

An interface describing the results of an inversion attempt.

Attributes

`images`	The observed images used to calculate the inversion.
`inverter`	The inversion algorithm instance that produced these results.
`message`	Any message from the inverter regarding these results.
`solution`	The reconstructed scene found by the inversion.
`success`	Whether the inversion was successful.

Methods

`__init__`()
`plot_moments`(truth, axis[, num_bins, ...])	Plot column-normalized 2D histograms of the true vs. reconstructed radiance, median, and interquartile range of the spectral line profile.

Inheritance Diagram

plot_moments(truth, axis, num_bins=50, range_radiance=None, range_median=None, range_iqr=None, percentile_radiance=0)[source]#

Plot column-normalized 2D histograms of the true vs. reconstructed radiance, median, and interquartile range of the spectral line profile.

Parameters:

truth (FunctionArray[AbstractDopplerPositionalVectorArray, ScalarArray]) – The true scene which will be compared to the reconstructed scene.
axis (str) – The axis along which to compute the radiance, median, and interquartile range.
num_bins (int) – The number of bins along each axis of the histogram.
range_radiance (None | tuple[Quantity, Quantity]) – The domain of the radiance histogram.
range_median (None | tuple[Quantity, Quantity]) – The domain of the median histogram.
range_iqr (None | tuple[Quantity, Quantity]) – The domain of the interquartile range histogram.
percentile_radiance (float) – Spatial locations below this threshold are excluded from the histogram. The default is to not exclude any pixels.

Return type:

tuple[Figure, ndarray]

abstract property images: FunctionArray[AbstractDopplerPositionalVectorArray, ScalarArray]#: The observed images used to calculate the inversion.

abstract property inverter: AbstractInverter#: The inversion algorithm instance that produced these results.

abstract property message: str#: Any message from the inverter regarding these results.

abstract property solution: FunctionArray[AbstractDopplerPositionalVectorArray, ScalarArray]#: The reconstructed scene found by the inversion.