CleanImageSkyModel.h
Classes
- CleanImageSkyModel -- Image Sky Model: Image-based Model for the Sky Brightness (full description)
Interface
- Public Members
- CleanImageSkyModel()
- CleanImageSkyModel(const CleanImageSkyModel& sm)
- Bool hasMask(Int model=0)
- virtual Bool add(ComponentList& compList)
- virtual Int add(ImageInterface<Float>& image, const Int maxNumXfr=100)
- virtual Bool addMask(Int image, ImageInterface<Float>& mask)
- Bool hasFluxMask(Int model=0)
- virtual Bool addFluxMask(Int image, ImageInterface<Float>& fluxMask)
- ImageInterface<Float>& fluxMask(Int model=0)
- virtual ~CleanImageSkyModel()
- CleanImageSkyModel& operator=(const CleanImageSkyModel& other)
- ImageInterface<Float>& mask(Int model=0)
Prerequisite
Etymology
CleanImageSkyModel describes an interface for Models to be used in
the SkyEquation. It is derived from SkyModel.
Synopsis
A CleanImageSkyModel contains a number of separate models. The interface to
SkyEquation is via an image per model. SkyEquation uses this image to
calculate Fourier transforms, etc. Some (most) SkyModels are
solvable: the SkyEquation can be used by the SkyModel to return
gradients with respect to itself (via the image interface). Thus
for a SkyModel to solve for itself, it calls the SkyEquation
methods to get gradients of chi-squared with respect to the
image pixel values (thus returning an image: basically a residual
image). The SkyModel then uses these gradients as appropriate to
update itself.
Example
See the example for SkyModel.
Motivation
The properties of a model of the sky must be described
for the SkyEquation.
To Do
- Multiple images in SkyModel
- ComponentModel
Member Description
Empty constructor
Copy constructor
Bool hasMask(Int model=0)
Has a mask for model?
Add a componentlist
virtual Int add(ImageInterface<Float>& image, const Int maxNumXfr=100)
Add an image. maxNumXfr is the maximum Number of transfer functions
that we might want to associate with this image.
virtual Bool addMask(Int image, ImageInterface<Float>& mask)
Add an mask
Has a flux mask?
virtual Bool addFluxMask(Int image, ImageInterface<Float>& fluxMask)
ImageInterface<Float>& fluxMask(Int model=0)
Destructor
CleanImageSkyModel& operator=(const CleanImageSkyModel& other)
Assignment operator
ImageInterface<Float>& mask(Int model=0)
Return masks