lsst::afw::image::Exposure< ImageT, MaskT, VarianceT > Class Template Reference

A class to contain the data, WCS, and other information needed to describe an image of the sky. More...

#include <Exposure.h>

Inheritance diagram for lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >:

Public Types
typedef MaskedImage< ImageT, MaskT, VarianceT >	MaskedImageT
typedef boost::shared_ptr < Exposure >	Ptr
typedef boost::shared_ptr < Exposure const >	ConstPtr
Public Types inherited from lsst::daf::base::Persistable
typedef boost::shared_ptr < Persistable >	Ptr
Public Types inherited from lsst::daf::base::Citizen
enum	{ magicSentinel = 0xdeadbeef }
typedef unsigned long	memId
	Type of the block's ID. More...
typedef memId(*	memNewCallback )(const memId cid)
	A function used to register a callback. More...
typedef memId(*	memCallback )(const Citizen *ptr)

Public Member Functions
	Exposure (unsigned int width, unsigned int height, boost::shared_ptr< Wcs const > wcs=boost::shared_ptr< Wcs const >())
	Exposure Class Implementation for LSST: a templated framework class for creating an Exposure from a MaskedImage and a Wcs. More...
	Exposure (lsst::afw::geom::Extent2I const &dimensions=lsst::afw::geom::Extent2I(), boost::shared_ptr< Wcs const > wcs=boost::shared_ptr< Wcs const >())
	Construct an Exposure with a blank MaskedImage of specified size (default 0x0) and a Wcs (which may be default constructed) More...
	Exposure (lsst::afw::geom::Box2I const &bbox, boost::shared_ptr< Wcs const > wcs=boost::shared_ptr< Wcs const >())
	Construct an Exposure with a blank MaskedImage of specified size (default 0x0) and a Wcs (which may be default constructed) More...
	Exposure (MaskedImageT &maskedImage, boost::shared_ptr< Wcs const > wcs=boost::shared_ptr< Wcs const >())
	Construct an Exposure from a MaskedImage. More...
	Exposure (std::string const &fileName, geom::Box2I const &bbox=geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false)
	Construct an Exposure by reading a regular FITS file. More...
	Exposure (fits::MemFileManager &manager, geom::Box2I const &bbox=geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false)
	Construct an Exposure by reading a FITS image in memory. More...
	Exposure (fits::Fits &fitsfile, geom::Box2I const &bbox=geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false)
	Construct an Exposure from an already-open FITS object. More...
	Exposure (Exposure const &src, bool const deep=false)
	Copy an Exposure. More...
	Exposure (Exposure const &src, lsst::afw::geom::Box2I const &bbox, ImageOrigin const origin=PARENT, bool const deep=false)
	Construct a subExposure given an Exposure and a bounding box. More...
template<typename OtherPixelT >
	Exposure (Exposure< OtherPixelT, MaskT, VarianceT > const &rhs, const bool deep)
virtual	~Exposure ()
MaskedImageT	getMaskedImage ()
	Return the MaskedImage. More...
MaskedImageT	getMaskedImage () const
	Return the MaskedImage. More...
boost::shared_ptr< Wcs const >	getWcs () const
boost::shared_ptr< Wcs >	getWcs ()
boost::shared_ptr < lsst::afw::cameraGeom::Detector const >	getDetector () const
	Return the Exposure's Detector information. More...
Filter	getFilter () const
	Return the Exposure's filter. More...
lsst::daf::base::PropertySet::Ptr	getMetadata () const
	Return flexible metadata. More...
void	setMetadata (lsst::daf::base::PropertySet::Ptr metadata)
int	getWidth () const
	Return the Exposure's width. More...
int	getHeight () const
	Return the Exposure's height. More...
geom::Extent2I	getDimensions () const
	Return the Exposure's size. More...
int	getX0 () const
int	getY0 () const
geom::Point2I	getXY0 () const
geom::Box2I	getBBox (ImageOrigin const origin=PARENT) const
void	setXY0 (geom::Point2I const &origin)
void	setMaskedImage (MaskedImageT &maskedImage)
	Set the MaskedImage of the Exposure. More...
void	setWcs (boost::shared_ptr< Wcs > wcs)
void	setDetector (boost::shared_ptr< lsst::afw::cameraGeom::Detector const > detector)
	Set the Exposure's Detector information. More...
void	setFilter (Filter const &filter)
	Set the Exposure's filter. More...
void	setCalib (boost::shared_ptr< Calib > calib)
	Set the Exposure's Calib object. More...
boost::shared_ptr< Calib >	getCalib ()
	Return the Exposure's Calib object. More...
boost::shared_ptr< Calib const >	getCalib () const
	Return the Exposure's Calib object. More...
void	setPsf (boost::shared_ptr< lsst::afw::detection::Psf const > psf)
	Set the Exposure's Psf. More...
boost::shared_ptr < lsst::afw::detection::Psf >	getPsf ()
	Return the Exposure's Psf object. More...
boost::shared_ptr < lsst::afw::detection::Psf const >	getPsf () const
	Return the Exposure's Psf object. More...
bool	hasPsf () const
	Does this Exposure have a Psf? More...
bool	hasWcs () const
	Does this Exposure have a Wcs? More...
boost::shared_ptr< ExposureInfo >	getInfo ()
	Get the ExposureInfo that aggregates all the non-image components. Never null. More...
boost::shared_ptr < ExposureInfo const >	getInfo () const
	Get the ExposureInfo that aggregates all the non-image components. Never null. More...
void	writeFits (std::string const &fileName) const
	Write an Exposure to a regular multi-extension FITS file. More...
void	writeFits (fits::MemFileManager &manager) const
	Write an Exposure to a multi-extension FITS file in memory. More...
void	writeFits (fits::Fits &fitsfile) const
	Write an Exposure to an already-open FITS file object. More...
Public Member Functions inherited from lsst::daf::base::Persistable
	Persistable (void)
virtual	~Persistable (void)
template<class Archive >
void	serialize (Archive &, unsigned int const)
Public Member Functions inherited from lsst::daf::base::Citizen
	Citizen (const std::type_info &)
	Citizen (Citizen const &)
	~Citizen ()
Citizen &	operator= (Citizen const &)
std::string	repr () const
	Return a string representation of a Citizen. More...
void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...
memId	getId () const
	Return the Citizen's ID. More...

Static Public Member Functions
static Exposure	readFits (std::string const &filename)
	Read an Exposure from a regular FITS file. More...
static Exposure	readFits (fits::MemFileManager &manager)
	Read an Exposure from a FITS RAM file. More...
Static Public Member Functions inherited from lsst::daf::base::Citizen
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...
static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...
static int	init ()
	Called once when the memory system is being initialised. More...
static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...
static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...
static const std::vector < const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...
static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...
static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...
static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...
static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...
static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

Private Member Functions
void	_readFits (fits::Fits &fitsfile, geom::Box2I const &bbox, ImageOrigin origin, bool conformMasks)

Private Attributes
MaskedImageT	_maskedImage
boost::shared_ptr< ExposureInfo >	_info

Detailed Description

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>
class lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >

A class to contain the data, WCS, and other information needed to describe an image of the sky.

Definition at line 48 of file Exposure.h.

Member Typedef Documentation

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

typedef boost::shared_ptr<Exposure const> lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::ConstPtr

Definition at line 53 of file Exposure.h.

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

typedef MaskedImage<ImageT, MaskT, VarianceT> lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::MaskedImageT

Definition at line 51 of file Exposure.h.

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

typedef boost::shared_ptr<Exposure> lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::Ptr

Definition at line 52 of file Exposure.h.

Constructor & Destructor Documentation

template<typename ImageT , typename MaskT , typename VarianceT >

lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::Exposure ( unsigned int  width, unsigned int  height, boost::shared_ptr< Wcs const >  wcs = boost::shared_ptr< Wcs const>()  )

explicit

Exposure Class Implementation for LSST: a templated framework class for creating an Exposure from a MaskedImage and a Wcs.

An Exposure is required to take one afwImage::MaskedImage or a region (col, row) defining the size of a MaskedImage (this can be of size 0,0). An Exposure can (but is not required to) contain a afwImage::Wcs.

The template types should optimally be a float, double, unsigned int 16 bit, or unsigned int 32 bit for the image (pixel) type and an unsigned int 32 bit for the mask type. These types have been explicitly instantiated for the Exposure class. All MaskedImage and Wcs constructors are 'const' to allow for views and copying.

An Exposure can get and return its MaskedImage, Wcs, and a subExposure. The getSubExposure member takes a BBox region defining the subRegion of the original Exposure to be returned. The member retrieves the MaskedImage corresponding to the subRegion. The MaskedImage class throws an exception for any subRegion extending beyond the original MaskedImage bounding box. This member is not yet fully implemented because it requires the Wcs class to return the Wcs metadata to the member so the CRPIX values of the Wcs can be adjusted to reflect the new subMaskedImage origin. The getSubExposure member will eventually return a subExposure consisting of the subMAskedImage and the Wcs object with its corresponding adjusted metadata.

The hasWcs member is used to determine if the Exposure has a Wcs. It is not required to have one.Construct an Exposure with a blank MaskedImage of specified size (default 0x0) and a Wcs (which may be default constructed)

Parameters

width	number of columns
height	number of rows
wcs	the Wcs

Definition at line 85 of file Exposure.cc.

  :
    lsst::daf::base::Citizen(typeid(this)),
    _maskedImage(width, height),
    _info(new ExposureInfo(wcs))
{}

template<typename ImageT , typename MaskT , typename VarianceT >

lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::Exposure ( lsst::afw::geom::Extent2I const &  dimensions = lsst::afw::geom::Extent2I(), boost::shared_ptr< Wcs const >  wcs = boost::shared_ptr< Wcs const>()  )

explicit

Construct an Exposure with a blank MaskedImage of specified size (default 0x0) and a Wcs (which may be default constructed)

Parameters

dimensions	desired image width/height
wcs	the Wcs

Definition at line 99 of file Exposure.cc.

  :
    lsst::daf::base::Citizen(typeid(this)),
    _maskedImage(dimensions),
    _info(new ExposureInfo(wcs))
{}

template<typename ImageT , typename MaskT , typename VarianceT >

lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::Exposure ( lsst::afw::geom::Box2I const &  bbox, boost::shared_ptr< Wcs const >  wcs = boost::shared_ptr< Wcs const>()  )

explicit

Construct an Exposure with a blank MaskedImage of specified size (default 0x0) and a Wcs (which may be default constructed)

Parameters

bbox	desired image width/height, and origin
wcs	the Wcs

Definition at line 112 of file Exposure.cc.

  :
    lsst::daf::base::Citizen(typeid(this)),
    _maskedImage(bbox),
    _info(new ExposureInfo(wcs))
{}

template<typename ImageT , typename MaskT , typename VarianceT >

lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::Exposure ( MaskedImageT &  maskedImage, boost::shared_ptr< Wcs const >  wcs = boost::shared_ptr< Wcs const>()  )

explicit

Construct an Exposure from a MaskedImage.

Parameters

maskedImage	the MaskedImage
wcs	the Wcs

Definition at line 124 of file Exposure.cc.

  :
    lsst::daf::base::Citizen(typeid(this)),
    _maskedImage(maskedImage),
    _info(new ExposureInfo(wcs))
{}

template<typename ImageT , typename MaskT , typename VarianceT >

lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::Exposure ( std::string const &  fileName, geom::Box2I const &  bbox = geom::Box2I(), ImageOrigin  origin = PARENT, bool  conformMasks = false  )

explicit

Construct an Exposure by reading a regular FITS file.

Parameters

[in]	fileName	File to read.
[in]	bbox	If non-empty, read only the pixels within the bounding box.
[in]	origin	Coordinate system of the bounding box; if PARENT, the bounding box should take into account the xy0 saved with the image.
[in]	conformMasks	If true, make Mask conform to the mask layout in the file.

Definition at line 164 of file Exposure.cc.

  :
    lsst::daf::base::Citizen(typeid(this)),
    _maskedImage(),
    _info(new ExposureInfo())
{
    fits::Fits fitsfile(fileName, "r", fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    _readFits(fitsfile, bbox, origin, conformMasks);
}

template<typename ImageT , typename MaskT , typename VarianceT >

lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::Exposure ( fits::MemFileManager &  manager, geom::Box2I const &  bbox = geom::Box2I(), ImageOrigin  origin = PARENT, bool  conformMasks = false  )

explicit

Construct an Exposure by reading a FITS image in memory.

Parameters

[in]	manager	An object that manages the memory buffer to read.
[in]	bbox	If non-empty, read only the pixels within the bounding box.
[in]	origin	Coordinate system of the bounding box; if PARENT, the bounding box should take into account the xy0 saved with the image.
[in]	conformMasks	If true, make Mask conform to the mask layout in the file.

Definition at line 177 of file Exposure.cc.

  :
    lsst::daf::base::Citizen(typeid(this)),
    _maskedImage(),
    _info(new ExposureInfo())
{
    fits::Fits fitsfile(manager, "r", fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    _readFits(fitsfile, bbox, origin, conformMasks);
}

template<typename ImageT , typename MaskT , typename VarianceT >

lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::Exposure ( fits::Fits &  fitsfile, geom::Box2I const &  bbox = geom::Box2I(), ImageOrigin  origin = PARENT, bool  conformMasks = false  )

explicit

Construct an Exposure from an already-open FITS object.

Parameters

[in]	fitsfile	A FITS object to read from. Current HDU is ignored.
[in]	bbox	If non-empty, read only the pixels within the bounding box.
[in]	origin	Coordinate system of the bounding box; if PARENT, the bounding box should take into account the xy0 saved with the image.
[in]	conformMasks	If true, make Mask conform to the mask layout in the file.

Definition at line 190 of file Exposure.cc.

  :
    lsst::daf::base::Citizen(typeid(this))
{
    _readFits(fitsfile, bbox, origin, conformMasks);
}

template<typename ImageT , typename MaskT , typename VarianceT >

lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::Exposure	(	Exposure< ImageT, MaskT, VarianceT > const &	src,
		bool const	deep = false
	)

Copy an Exposure.

Parameters

src	Parent Exposure
deep	Should we copy the pixels?

Definition at line 137 of file Exposure.cc.

  :
    lsst::daf::base::Citizen(typeid(this)),
    _maskedImage(src.getMaskedImage(), deep),
    _info(new ExposureInfo(*src.getInfo(), deep))
{}

template<typename ImageT , typename MaskT , typename VarianceT >

lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::Exposure	(	Exposure< ImageT, MaskT, VarianceT > const &	src,
		lsst::afw::geom::Box2I const &	bbox,
		ImageOrigin const	origin = PARENT,
		bool const	deep = false
	)

Construct a subExposure given an Exposure and a bounding box.

Exceptions

a	lsst::pex::exceptions::InvalidParameter if the requested subRegion is not fully contained by the original MaskedImage BBox.

Parameters

src	Parent Exposure
bbox	Desired region in Exposure
origin	Coordinate system for bbox
deep	Should we copy the pixels?

Definition at line 152 of file Exposure.cc.

  :
    lsst::daf::base::Citizen(typeid(this)),
    _maskedImage(src.getMaskedImage(), bbox, origin, deep),
    _info(new ExposureInfo(*src.getInfo(), deep))
{}

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

template<typename OtherPixelT >

lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::Exposure ( Exposure< OtherPixelT, MaskT, VarianceT > const &  rhs, const bool  deep  )

inline

generalised copy constructor; defined here in the header so that the compiler can instantiate N(N-1)/2 conversions between N ImageBase types.

We only support converting the Image part

Parameters

rhs	Input Exposure
deep	Must be true; needed to disambiguate

Definition at line 133 of file Exposure.h.

      :
        lsst::daf::base::Citizen(typeid(this)),
        _maskedImage(rhs.getMaskedImage(), deep),
        _info(new ExposureInfo(*rhs.getInfo(), deep))
    {
        if (not deep) {
            throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
                              "Exposure's converting copy constructor must make a deep copy");
        }
    }

template<typename ImageT , typename MaskT , typename VarianceT >

lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::~Exposure ( )

virtual

Destructor

Definition at line 214 of file Exposure.cc.

{}

Member Function Documentation

template<typename ImageT , typename MaskT , typename VarianceT >

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::_readFits ( fits::Fits &  fitsfile, geom::Box2I const &  bbox, ImageOrigin  origin, bool  conformMasks  )

private

Definition at line 200 of file Exposure.cc.

  {
    PTR(daf::base::PropertySet) metadata(new lsst::daf::base::PropertyList());
    PTR(daf::base::PropertySet) imageMetadata(new lsst::daf::base::PropertyList());
    _maskedImage = MaskedImageT(fitsfile, metadata, bbox, origin, conformMasks, false, imageMetadata);
    _info->_readFits(fitsfile, metadata, imageMetadata);
}

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

geom::Box2I lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getBBox ( ImageOrigin const  origin = PARENT ) const

inline

Definition at line 194 of file Exposure.h.

                                                             {
        return _maskedImage.getBBox(origin);
    }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

boost::shared_ptr< Calib > lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getCalib ( )

inline

Return the Exposure's Calib object.

Definition at line 217 of file Exposure.h.

{ return _info->getCalib(); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

boost::shared_ptr< Calib const> lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getCalib ( ) const

inline

Return the Exposure's Calib object.

Definition at line 219 of file Exposure.h.

{ return _info->getCalib(); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

boost::shared_ptr< lsst::afw::cameraGeom::Detector const> lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getDetector ( ) const

inline

Return the Exposure's Detector information.

Definition at line 158 of file Exposure.h.

{ return _info->getDetector(); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

geom::Extent2I lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getDimensions ( ) const

inline

Return the Exposure's size.

Definition at line 170 of file Exposure.h.

{ return _maskedImage.getDimensions(); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

Filter lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getFilter ( ) const

inline

Return the Exposure's filter.

Definition at line 160 of file Exposure.h.

{ return _info->getFilter(); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

int lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getHeight ( ) const

inline

Return the Exposure's height.

Definition at line 168 of file Exposure.h.

{ return _maskedImage.getHeight(); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

boost::shared_ptr< ExposureInfo > lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getInfo ( )

inline

Get the ExposureInfo that aggregates all the non-image components. Never null.

Definition at line 235 of file Exposure.h.

{ return _info; }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

boost::shared_ptr< ExposureInfo const> lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getInfo ( ) const

inline

Get the ExposureInfo that aggregates all the non-image components. Never null.

Definition at line 238 of file Exposure.h.

{ return _info; }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

MaskedImageT lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getMaskedImage ( )

inline

Return the MaskedImage.

Definition at line 150 of file Exposure.h.

{ return _maskedImage; }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

MaskedImageT lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getMaskedImage ( ) const

inline

Return the MaskedImage.

Definition at line 152 of file Exposure.h.

{ return _maskedImage; }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

lsst::daf::base::PropertySet::Ptr lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getMetadata ( ) const

inline

Return flexible metadata.

Definition at line 162 of file Exposure.h.

{ return _info->getMetadata(); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

boost::shared_ptr< lsst::afw::detection::Psf > lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getPsf ( )

inline

Return the Exposure's Psf object.

Definition at line 224 of file Exposure.h.

{ return _info->getPsf(); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

boost::shared_ptr< lsst::afw::detection::Psf const> lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getPsf ( ) const

inline

Return the Exposure's Psf object.

Definition at line 226 of file Exposure.h.

{ return _info->getPsf(); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

boost::shared_ptr< Wcs const> lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getWcs ( ) const

inline

Definition at line 154 of file Exposure.h.

{ return _info->getWcs(); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

boost::shared_ptr< Wcs > lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getWcs ( )

inline

Definition at line 155 of file Exposure.h.

{ return _info->getWcs(); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

int lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getWidth ( ) const

inline

Return the Exposure's width.

Definition at line 166 of file Exposure.h.

{ return _maskedImage.getWidth(); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

int lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getX0 ( ) const

inline

Return the Exposure's row-origin

See Also

getXY0()

Definition at line 177 of file Exposure.h.

{ return _maskedImage.getX0(); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

geom::Point2I lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getXY0 ( ) const

inline

Return the Exposure's origin

This will usually be (0, 0) except for images created using the Exposure(fileName, hdu, BBox, mode) ctor or Exposure(Exposure, BBox) cctor The origin can be reset with setXY0

Definition at line 192 of file Exposure.h.

{ return _maskedImage.getXY0(); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

int lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getY0 ( ) const

inline

Return the Exposure's column-origin

See Also

getXY0()

Definition at line 183 of file Exposure.h.

{ return _maskedImage.getY0(); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

bool lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::hasPsf ( ) const

inline

Does this Exposure have a Psf?

Definition at line 229 of file Exposure.h.

{ return _info->hasPsf(); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

bool lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::hasWcs ( ) const

inline

Does this Exposure have a Wcs?

Definition at line 232 of file Exposure.h.

{ return _info->hasWcs(); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

static Exposure lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::readFits ( std::string const &  filename )

inlinestatic

Read an Exposure from a regular FITS file.

Parameters

[in]

filename

Name of the file to read.

Definition at line 279 of file Exposure.h.

                                                         {
        return Exposure<ImageT, MaskT, VarianceT>(filename);
    }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

static Exposure lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::readFits ( fits::MemFileManager &  manager )

inlinestatic

Read an Exposure from a FITS RAM file.

Parameters

[in]

manager

Object that manages the memory to be read.

Definition at line 288 of file Exposure.h.

                                                           {
        return Exposure<ImageT, MaskT, VarianceT>(manager);
    }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::setCalib ( boost::shared_ptr< Calib >  calib )

inline

Set the Exposure's Calib object.

Definition at line 215 of file Exposure.h.

{ _info->setCalib(calib); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::setDetector ( boost::shared_ptr< lsst::afw::cameraGeom::Detector const >  detector )

inline

Set the Exposure's Detector information.

Definition at line 211 of file Exposure.h.

{ _info->setDetector(detector); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::setFilter ( Filter const &  filter )

inline

Set the Exposure's filter.

Definition at line 213 of file Exposure.h.

{ _info->setFilter(filter); }

template<typename ImageT , typename MaskT , typename VarianceT >

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::setMaskedImage

(

MaskedImageT &

maskedImage

)

Set the MaskedImage of the Exposure.

Definition at line 221 of file Exposure.cc.

                                                                                        {
    _maskedImage = maskedImage; 
}

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::setMetadata ( lsst::daf::base::PropertySet::Ptr  metadata )

inline

Definition at line 163 of file Exposure.h.

{ _info->setMetadata(metadata); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::setPsf ( boost::shared_ptr< lsst::afw::detection::Psf const >  psf )

inline

Set the Exposure's Psf.

Definition at line 221 of file Exposure.h.

{ _info->setPsf(psf); }

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::setWcs ( boost::shared_ptr< Wcs >  wcs )

inline

Definition at line 209 of file Exposure.h.

{ _info->setWcs(wcs); }

template<typename ImageT , typename MaskT , typename VarianceT >

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::setXY0

(

geom::Point2I const &

origin

)

Set the Exposure's origin (including correcting the Wcs)

The origin is usually set by the constructor, so you shouldn't need this function

Note

There are use cases (e.g. memory overlays) that may want to set these values, but don't do so unless you are an Expert.

Definition at line 226 of file Exposure.cc.

                                                                                    {
    afwGeom::Point2I old(_maskedImage.getXY0());
    if (_info->hasWcs())
        _info->getWcs()->shiftReferencePixel(origin.getX() - old.getX(), origin.getY() - old.getY());
    _maskedImage.setXY0(origin);
}

template<typename ImageT , typename MaskT , typename VarianceT >

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::writeFits

(

std::string const &

fileName

)

const

Write an Exposure to a regular multi-extension FITS file.

Parameters

[in]

fileName

Name of the file to write.

As with MaskedImage persistence, an empty primary HDU will be created and all images planes will be saved to extension HDUs. Most metadata will be saved only to the header of the main image HDU, but the WCS will be saved to the header of the mask and variance as well. If present, the Psf will be written to one or more additional HDUs.

Note that the LSST pixel origin differs from the FITS convention by one, so the values of CRPIX and LTV saved in the file are not the same as those in the C++ objects in memory, but are rather modified so they are interpreted by external tools (like ds9).

Definition at line 237 of file Exposure.cc.

                                                                                           {
    fits::Fits fitsfile(fileName, "w", fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

template<typename ImageT , typename MaskT , typename VarianceT >

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::writeFits

(

fits::MemFileManager &

manager

)

const

Write an Exposure to a multi-extension FITS file in memory.

Parameters

[in]

manager

Manager for the memory to write to.

See Also

writeFits

Definition at line 243 of file Exposure.cc.

                                                                                             {
    fits::Fits fitsfile(manager, "w", fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

template<typename ImageT , typename MaskT , typename VarianceT >

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::writeFits

(

fits::Fits &

fitsfile

)

const

Write an Exposure to an already-open FITS file object.

Parameters

[in]

fitsfile

FITS object to write.

See Also

writeFits

Definition at line 249 of file Exposure.cc.

                                                                                    {
    ExposureInfo::FitsWriteData data = _info->_startWriteFits(getXY0());
    _maskedImage.writeFits(
        fitsfile, data.metadata,
        data.imageMetadata, data.maskMetadata, data.varianceMetadata
    );
    _info->_finishWriteFits(fitsfile, data);
}

Member Data Documentation

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

boost::shared_ptr< ExposureInfo > lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::_info

private

Definition at line 301 of file Exposure.h.

template<typename ImageT, typename MaskT = lsst::afw::image::MaskPixel, typename VarianceT = lsst::afw::image::VariancePixel>

MaskedImageT lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::_maskedImage

private

Definition at line 300 of file Exposure.h.

---

The documentation for this class was generated from the following files:

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/image/Exposure.h
• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/src/image/Exposure.cc