ArrayModel.h

Classes

ArrayModel -- models with an internal & external representation as an array (full description)

template<class T> class ArrayModel: public LinearModel<Array<T> >

Interface

Public Members

ArrayModel()

ArrayModel(const Array<T> & model)

ArrayModel(Array<T> & model)

virtual const Array<T> & getModel() const

virtual void getModel(Array<T>& model) const

virtual void setModel(const Array<T>& model)

virtual void setModel(Array<T> & model)

Description

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

Arrays
LinearModel
LinearModel/LinearEquation paradigm

Synopsis

An ArrayModel is a base class for Models that can be represented by arrays. It is expected that this class will be mainly used as base classes for other classes which will then provide the solve() functions necessary to update the model given an equation.

However this class does not contain any pure virtual functions and hence can be used "as is". An example of this is given below. For an example of how this class can be used by derived classes see the HogbomCleanModel class.

This class makes an internal copy of the Array supplied to it (either when constructed or when using the setModel function). If this is found to significantly affect performance (execution speed or memory requirements) this may be changed to a reference, perhaps using a smart pointer like the COWPtr

Example

    ArrayModel<Float> currentModel(); // Cannot use the model yet!
    {
      Matrix<Float> bestGuess(32,32);
       ... put your best guess into the Matrix ...
      currentModel.setModel(bestGuess); // This does a real copy
    }
    ConvolutionEquation eqn(psf, dirty); // psf, and dirty are arrays defined
                                         // elsewhere.
    eqn.evaluate(result, currentModel); // Here result is the convolution of
                                        // of the model with the psf.

Motivation

All the different image plane based clean algorithms have a common implementation in that they can use an array to store the current model. This class provides a way to abstract this functionality.

Template Type Argument Requirements (T)

Float
StokesVector

Thrown Exceptions

This class does not explicitly throw exceptions however the objects used by this class may

To Do

Decide whether to copy the input array by reference or stay with the current scheme.