AbstractInversionResult

class ctis.inverters.AbstractInversionResult

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[, num_bins, ...])

Inheritance Diagram

plot_moments(truth, num_bins=50, range_radiance=None, range_median=None, range_iqr=None)

Parameters:

• truth (FunctionArray[AbstractDopplerPositionalVectorArray, ScalarArray])

• num_bins (int)

• range_radiance (None | tuple[Quantity, Quantity])

• range_median (None | tuple[Quantity, Quantity])

• range_iqr (None | tuple[Quantity, Quantity])

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.

abstract property success: bool

Whether the inversion was successful.