InversionResult#

class ctis.inverters.InversionResult(solution, success, images, inverter, message)[source]#

The results of an inversion attempt.

Attributes

`images`	The observed images on which the inversion was performed.
`inverter`	The inversion algorithm instance that produced these results.
`message`	Any message from the inversion routine concerning the results.
`solution`	The reconstructed scene found by the inversion.
`success`	A boolean flag indicating whether the inversion was successful.

Methods

`__init__`(solution, success, images, ...)
`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

Parameters:

solution (FunctionArray[AbstractDopplerPositionalVectorArray, ScalarArray])
success (bool)
images (FunctionArray[SpectralPositionalVectorArray, ScalarArray])
inverter (AbstractInverter)
message (str)

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

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]

images: FunctionArray[SpectralPositionalVectorArray, ScalarArray] = <dataclasses._MISSING_TYPE object>#: The observed images on which the inversion was performed.

inverter: AbstractInverter = <dataclasses._MISSING_TYPE object>#: The inversion algorithm instance that produced these results.

message: str = <dataclasses._MISSING_TYPE object>#: Any message from the inversion routine concerning the results.

solution: FunctionArray[AbstractDopplerPositionalVectorArray, ScalarArray] = <dataclasses._MISSING_TYPE object>#: The reconstructed scene found by the inversion.

success: bool = <dataclasses._MISSING_TYPE object>#: A boolean flag indicating whether the inversion was successful.