aopp_deconv_tool.algorithm.deconv.base.Base

class documentation

class Base:

Known subclasses: aopp_deconv_tool.algorithm.deconv.clean_modified.CleanModified, aopp_deconv_tool.algorithm.deconv.lucy_richardson.LucyRichardson

View In Hierarchy

Implements basic iteration of an algorithm.

Algorithm parameters are set on class construction, data to operate upon is set when an instance is called.

Method __call__ Apply algorithm to obs and psf, parameters are set at instantiation, but can be overwritten for a single call by passing new values via **kwargs. Initialises and iterates the algorithm. Subclasses should overload the ...
Method get_parameters Undocumented
Method set_parameters Undocumented
Class Variable final_hooks Undocumented
Class Variable n_iter Undocumented
Class Variable n_iter_stopped Undocumented
Class Variable post_init_hooks Undocumented
Class Variable post_iter_hooks Undocumented
Class Variable pre_init_hooks Undocumented
Class Variable pre_iter_hooks Undocumented
Instance Variable progress_string Undocumented
Method _init_algorithm Perform any initialisation that needs to be done before the algorithm runs.
Method _iter Perform a single iteration of the algorithm.
Method _set_last_parameters Undocumented
Instance Variable _components Undocumented
Instance Variable _i Undocumented
Instance Variable _last_parameters Undocumented
Instance Variable _residual Undocumented
def __call__(self, obs: np.ndarray, psf: np.ndarray, **kwargs) -> tuple[np.ndarray, np.ndarray, int]:

Apply algorithm to obs and psf, parameters are set at instantiation, but can be overwritten for a single call by passing new values via **kwargs. Initialises and iterates the algorithm. Subclasses should overload the _init_algorithm and _iter methods.

# Arguments #
obs : np.ndarray
Numpy array containing observation data to deconvolve
psf : np.ndarray
Numpy array containing the point-spread-function for the observation.
**kwargs
Other passed arguments are assumed to overwrite algorithm parameters during a singular invocation.
# Returns #
self._components : np.ndarray
Components found that make up the deconvolved image, ideally these components convolved with psf will give obs
self._residual : np.ndarray
The residual between the convolution of self._components with psf, and obs
self._i : int
The number of iterations performed before terminating
def get_parameters(self):

Undocumented

def set_parameters(self, params):

Undocumented

final_hooks: list[Callable[[Any, np.ndarray, np.ndarray], None]] =

Undocumented

n_iter: int =
overridden in aopp_deconv_tool.algorithm.deconv.clean_modified.CleanModified

Undocumented

n_iter_stopped: int =

Undocumented

post_init_hooks: list[Callable[[Any, np.ndarray, np.ndarray], None]] =

Undocumented

post_iter_hooks: list[Callable[[Any, np.ndarray, np.ndarray], None]] =

Undocumented

pre_init_hooks: list[Callable[[Any, np.ndarray, np.ndarray], None]] =

Undocumented

pre_iter_hooks: list[Callable[[Any, np.ndarray, np.ndarray], None]] =

Undocumented

progress_string: str =
overridden in aopp_deconv_tool.algorithm.deconv.clean_modified.CleanModified

Undocumented

def _init_algorithm(self, obs: np.ndarray, psf: np.ndarray):
overridden in aopp_deconv_tool.algorithm.deconv.clean_modified.CleanModified, aopp_deconv_tool.algorithm.deconv.lucy_richardson.LucyRichardson

Perform any initialisation that needs to be done before the algorithm runs.

def _iter(self, obs, psf) -> bool:
overridden in aopp_deconv_tool.algorithm.deconv.clean_modified.CleanModified, aopp_deconv_tool.algorithm.deconv.lucy_richardson.LucyRichardson

Perform a single iteration of the algorithm.

def _set_last_parameters(self):

Undocumented

_components: np.ndarray =
overridden in aopp_deconv_tool.algorithm.deconv.clean_modified.CleanModified, aopp_deconv_tool.algorithm.deconv.lucy_richardson.LucyRichardson

Undocumented

_i: int =

Undocumented

_last_parameters: dict[str, Any] =

Undocumented

_residual: np.ndarray =
overridden in aopp_deconv_tool.algorithm.deconv.clean_modified.CleanModified, aopp_deconv_tool.algorithm.deconv.lucy_richardson.LucyRichardson

Undocumented