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>

Public Types
using	MaskedImageT = MaskedImage<ImageT, MaskT, VarianceT>

Public Member Functions
	Exposure (unsigned int width, unsigned int height, std::shared_ptr< geom::SkyWcs const > wcs=std::shared_ptr< geom::SkyWcs const >())
	Construct an Exposure with a blank MaskedImage of specified size (default 0x0) and a SkyWcs (which may be default constructed)
	Exposure (lsst::geom::Extent2I const &dimensions=lsst::geom::Extent2I(), std::shared_ptr< geom::SkyWcs const > wcs=std::shared_ptr< geom::SkyWcs const >())
	Construct an Exposure with a blank MaskedImage of specified size (default 0x0) and a SkyWcs (which may be default constructed)
	Exposure (lsst::geom::Box2I const &bbox, std::shared_ptr< geom::SkyWcs const > wcs=std::shared_ptr< geom::SkyWcs const >())
	Construct an Exposure with a blank MaskedImage of specified size (default 0x0) and a SkyWcs.
	Exposure (MaskedImageT &maskedImage, std::shared_ptr< geom::SkyWcs const > wcs=std::shared_ptr< geom::SkyWcs const >())
	Construct an Exposure from a MaskedImage and an optional SkyWcs.
	Exposure (MaskedImageT &maskedImage, std::shared_ptr< ExposureInfo > info)
	Construct an Exposure from a MaskedImage and an ExposureInfo.
	Exposure (std::string const &fileName, lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
	Construct an Exposure by reading a regular FITS file.
	Exposure (fits::MemFileManager &manager, lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
	Construct an Exposure by reading a FITS image in memory.
	Exposure (fits::Fits &fitsfile, lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
	Construct an Exposure from an already-open FITS object.
	Exposure (Exposure const &src, bool const deep=false)
	Copy an Exposure.
	Exposure (Exposure &&src)
	Exposure (Exposure const &src, lsst::geom::Box2I const &bbox, ImageOrigin const origin=PARENT, bool const deep=false)
	Construct a subExposure given an Exposure and a bounding box.
template<typename OtherPixelT >
	Exposure (Exposure< OtherPixelT, MaskT, VarianceT > const &rhs, const bool deep)
	generalised copy constructor; defined here in the header so that the compiler can instantiate N(N-1)/2 conversions between N ImageBase types.
Exposure &	operator= (Exposure const &)
Exposure &	operator= (Exposure &&)
Exposure	subset (lsst::geom::Box2I const &bbox, ImageOrigin origin=PARENT) const
	Return a subimage corresponding to the given box.
Exposure	operator[] (lsst::geom::Box2I const &bbox) const
	Return a subimage corresponding to the given box (interpreted as PARENT coordinates).
	~Exposure ()
	Destructor.
MaskedImageT	getMaskedImage ()
	Return the MaskedImage.
MaskedImageT	getMaskedImage () const
	Return the MaskedImage.
std::shared_ptr< geom::SkyWcs const >	getWcs () const
std::shared_ptr< ApCorrMap const >	getApCorrMap () const
std::shared_ptr< lsst::afw::cameraGeom::Detector const >	getDetector () const
	Return the Exposure's Detector information.
std::shared_ptr< FilterLabel const >	getFilter () const
	Return the Exposure's filter information.
std::shared_ptr< lsst::daf::base::PropertySet >	getMetadata () const
	Return flexible metadata.
void	setMetadata (std::shared_ptr< lsst::daf::base::PropertySet > metadata)
int	getWidth () const
	Return the Exposure's width.
int	getHeight () const
	Return the Exposure's height.
lsst::geom::Extent2I	getDimensions () const
	Return the Exposure's size.
int	getX0 () const
	Return the Exposure's column-origin.
int	getY0 () const
	Return the Exposure's row-origin.
lsst::geom::Point2I	getXY0 () const
	Return the Exposure's origin.
lsst::geom::Box2I	getBBox (ImageOrigin const origin=PARENT) const
void	setXY0 (lsst::geom::Point2I const &origin)
	Set the Exposure's origin (including correcting the Wcs)
void	setMaskedImage (MaskedImageT &maskedImage)
	Set the MaskedImage of the Exposure.
void	setWcs (std::shared_ptr< geom::SkyWcs > wcs)
void	setDetector (std::shared_ptr< lsst::afw::cameraGeom::Detector const > detector)
	Set the Exposure's Detector information.
void	setFilter (std::shared_ptr< FilterLabel const > filterLabel)
	Set the Exposure's filter information.
void	setPhotoCalib (std::shared_ptr< PhotoCalib const > photoCalib)
	Set the Exposure's PhotoCalib object.
std::shared_ptr< PhotoCalib const >	getPhotoCalib () const
	Return the Exposure's PhotoCalib object.
void	setPsf (std::shared_ptr< lsst::afw::detection::Psf const > psf)
	Set the Exposure's Psf.
std::shared_ptr< lsst::afw::detection::Psf const >	getPsf () const
	Return the Exposure's Psf object.
bool	hasPsf () const
	Does this Exposure have a Psf?
bool	hasWcs () const
	Does this Exposure have a Wcs?
void	setApCorrMap (std::shared_ptr< ApCorrMap const > apCorrMap)
	Set the Exposure's aperture correction map.
std::shared_ptr< ExposureInfo >	getInfo ()
	Get the ExposureInfo that aggregates all the non-image components. Never null.
std::shared_ptr< ExposureInfo const >	getInfo () const
	Get the ExposureInfo that aggregates all the non-image components. Never null.
void	setInfo (std::shared_ptr< ExposureInfo > exposureInfo)
	Set the ExposureInfo that aggregates all the non-image components.
void	writeFits (std::string const &fileName) const
	Write an Exposure to a regular multi-extension FITS file.
void	writeFits (fits::MemFileManager &manager) const
	Write an Exposure to a multi-extension FITS file in memory.
void	writeFits (fits::Fits &fitsfile) const
	Write an Exposure to an already-open FITS file object.
void	writeFits (std::string const &fileName, fits::ImageWriteOptions const &imageOptions, fits::ImageWriteOptions const &maskOptions, fits::ImageWriteOptions const &varianceOptions) const
	Write an Exposure to a regular multi-extension FITS file.
void	writeFits (fits::MemFileManager &manager, fits::ImageWriteOptions const &imageOptions, fits::ImageWriteOptions const &maskOptions, fits::ImageWriteOptions const &varianceOptions) const
	Write an Exposure to a regular multi-extension FITS file.
void	writeFits (fits::Fits &fitsfile, fits::ImageWriteOptions const &imageOptions, fits::ImageWriteOptions const &maskOptions, fits::ImageWriteOptions const &varianceOptions) const
	Write an Exposure to a regular multi-extension FITS file.
Exposure	getCutout (lsst::geom::SpherePoint const &center, lsst::geom::Extent2I const &size) const
	Return an Exposure that is a small cutout of the original.
Exposure	getCutout (lsst::geom::Point2D const &center, lsst::geom::Extent2I const &size) const
	Return an Exposure that is a small cutout of the original.
Exposure	getCutout (lsst::geom::Box2I const &box) const
	Return an Exposure that is a small cutout of the original.

Static Public Member Functions
static Exposure	readFits (std::string const &filename)
	Read an Exposure from a regular FITS file.
static Exposure	readFits (fits::MemFileManager &manager)
	Read an Exposure from a FITS RAM file.

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.

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 an afwImage::SkyWcs.

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, SkyWcs, 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 SkyWcs class to return the SkyWcs metadata to the member so the CRPIX values of the SkyWcs can be adjusted to reflect the new subMaskedImage origin. The getSubExposure member will eventually return a subExposure consisting of the subMAskedImage and the SkyWcs object with its corresponding adjusted metadata.

The hasWcs member is used to determine if the Exposure has a SkyWcs. It is not required to have one.

Definition at line 72 of file Exposure.h.

Member Typedef Documentation

MaskedImageT

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

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

Definition at line 74 of file Exposure.h.

Constructor & Destructor Documentation

Exposure() [1/12]

template<typename ImageT , typename MaskT , typename VarianceT >

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

explicit

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

Parameters

width	number of columns
height	number of rows
wcs	the SkyWcs

Definition at line 46 of file Exposure.cc.

        : _maskedImage(width, height), _info(new ExposureInfo(wcs)) {}

Exposure() [2/12]

template<typename ImageT , typename MaskT , typename VarianceT >

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

explicit

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

Parameters

dimensions	desired image width/height
wcs	the SkyWcs

Definition at line 51 of file Exposure.cc.

        : _maskedImage(dimensions), _info(new ExposureInfo(wcs)) {}

Exposure() [3/12]

template<typename ImageT , typename MaskT , typename VarianceT >

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

explicit

Construct an Exposure with a blank MaskedImage of specified size (default 0x0) and a SkyWcs.

Parameters

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

Definition at line 56 of file Exposure.cc.

        : _maskedImage(bbox), _info(new ExposureInfo(wcs)) {}

Exposure() [4/12]

template<typename ImageT , typename MaskT , typename VarianceT >

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

explicit

Construct an Exposure from a MaskedImage and an optional SkyWcs.

Parameters

maskedImage	the MaskedImage
wcs	the SkyWcs

Definition at line 61 of file Exposure.cc.

        : _maskedImage(maskedImage), _info(new ExposureInfo(wcs)) {}

Exposure() [5/12]

template<typename ImageT , typename MaskT , typename VarianceT >

lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::Exposure ( MaskedImageT & maskedImage, std::shared_ptr< ExposureInfo > info )

explicit

Construct an Exposure from a MaskedImage and an ExposureInfo.

If the ExposureInfo is an empty pointer then a new empty ExposureInfo is used

Parameters

maskedImage	the MaskedImage
info	the ExposureInfo

Definition at line 66 of file Exposure.cc.

        : _maskedImage(maskedImage), _info(info ? info : std::make_shared<ExposureInfo>()) {}

Exposure() [6/12]

template<typename ImageT , typename MaskT , typename VarianceT >

lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::Exposure ( std::string const & fileName, lsst::geom::Box2I const & bbox = lsst::geom::Box2I(), ImageOrigin origin = PARENT, bool conformMasks = false, bool allowUnsafe = 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.
[in]	allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

Definition at line 83 of file Exposure.cc.

        : _maskedImage(), _info(new ExposureInfo()) {
    ExposureFitsReader reader(fileName);
    *this = reader.read<ImageT, MaskT, VarianceT>(bbox, origin, conformMasks, allowUnsafe);
}

Exposure() [7/12]

template<typename ImageT , typename MaskT , typename VarianceT >

lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::Exposure ( fits::MemFileManager & manager, lsst::geom::Box2I const & bbox = lsst::geom::Box2I(), ImageOrigin origin = PARENT, bool conformMasks = false, bool allowUnsafe = 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.
[in]	allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

Definition at line 91 of file Exposure.cc.

        : _maskedImage(), _info(new ExposureInfo()) {
    ExposureFitsReader reader(manager);
    *this = reader.read<ImageT, MaskT, VarianceT>(bbox, origin, conformMasks, allowUnsafe);
}

Exposure() [8/12]

template<typename ImageT , typename MaskT , typename VarianceT >

lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::Exposure ( fits::Fits & fitsfile, lsst::geom::Box2I const & bbox = lsst::geom::Box2I(), ImageOrigin origin = PARENT, bool conformMasks = false, bool allowUnsafe = 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.
[in]	allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

Definition at line 99 of file Exposure.cc.

                                                                                                      {
    ExposureFitsReader reader(&fitsFile);
    *this = reader.read<ImageT, MaskT, VarianceT>(bbox, origin, conformMasks, allowUnsafe);
}

Exposure() [9/12]

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 70 of file Exposure.cc.

        : _maskedImage(src.getMaskedImage(), deep), _info(new ExposureInfo(*src.getInfo(), deep)) {}

Exposure() [10/12]

template<typename ImageT , typename MaskT , typename VarianceT >

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

(

Exposure< ImageT, MaskT, VarianceT > &&

src

)

Definition at line 74 of file Exposure.cc.

: Exposure(src) {}

Exposure() [11/12]

template<typename ImageT , typename MaskT , typename VarianceT >

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

Construct a subExposure given an Exposure and a bounding box.

Parameters

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

Exceptions

lsst::pex::exceptions::InvalidParameterError

if the requested subRegion is not fully contained by the original MaskedImage BBox.

Definition at line 77 of file Exposure.cc.

        : _maskedImage(src.getMaskedImage(), bbox, origin, deep),
          _info(new ExposureInfo(*src.getInfo(), deep)) {}

Exposure() [12/12]

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 189 of file Exposure.h.

            : _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");
        }
    }

~Exposure()

template<typename ImageT , typename MaskT , typename VarianceT >

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

default

Destructor.

Member Function Documentation

getApCorrMap()

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

std::shared_ptr< ApCorrMap const > lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getApCorrMap ( ) const

inline

Definition at line 234 of file Exposure.h.

{ return _info->getApCorrMap(); }

getBBox()

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

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

inline

Definition at line 275 of file Exposure.h.

                                                                   {
        return _maskedImage.getBBox(origin);
    }

getCutout() [1/3]

template<typename ImageT , typename MaskT , typename VarianceT >

Exposure< ImageT, MaskT, VarianceT > lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getCutout

(

lsst::geom::Box2I const &

box

)

const

Return an Exposure that is a small cutout of the original.

This is distinguished from subset() by allowing the box to extend off the image, and padding with NaN and mask NO_DATA in that case.

Parameters

box	Pixel box to cut from this exposure.

Returns

An Exposure of the requested box to within half a pixel in either dimension. Pixels past the edge of the original exposure will equal math::edgePixel, with their Mask set to NO_DATA.

Exceptions

lsst::pex::exceptions::InvalidParameterError

Thrown if the center of the box falls outside this Exposure.

Definition at line 242 of file Exposure.cc.

                                        {
    return getCutout(box.getCenter(), box.getDimensions());
}

getCutout() [2/3]

template<typename ImageT , typename MaskT , typename VarianceT >

Exposure< ImageT, MaskT, VarianceT > lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getCutout	(	lsst::geom::Point2D const &	center,
		lsst::geom::Extent2I const &	size ) const

Return an Exposure that is a small cutout of the original.

This is distinguished from subset() by allowing the cutout to extend off the image, and padding with NaN and mask NO_DATA in that case.

Parameters

center	Desired center of cutout in image pixels.
size	Width and height (in that order) of cutout in pixels.

Returns

An Exposure of the requested size centered on center to within half a pixel in either dimension. Pixels past the edge of the original exposure will equal math::edgePixel.

Exceptions

lsst::pex::exceptions::InvalidParameterError

Thrown if center falls outside this Exposure or if size is not a valid size.

Definition at line 215 of file Exposure.cc.

                                                                           {
    if (!lsst::geom::Box2D(getBBox()).contains(center)) {
        std::stringstream buffer;
        buffer << "Point " << center << " lies at pixel " << center << ", which lies outside Exposure "
               << getBBox();
        throw LSST_EXCEPT(pex::exceptions::InvalidParameterError, buffer.str());
    }
    if (size[0] <= 0 || size[1] <= 0) {
        std::stringstream buffer;
        buffer << "Cannot create bounding box with dimensions " << size;
        throw LSST_EXCEPT(pex::exceptions::InvalidParameterError, buffer.str());
    }
    lsst::geom::Box2I bbox = lsst::geom::Box2I::makeCenteredBox(center, size);
 
    // cutout must have independent ExposureInfo
    auto copyInfo = std::make_shared<ExposureInfo>(*getInfo());
    MaskedImageT blank(bbox);  // Can't initialize Exposure with a temporary
    blank = math::edgePixel<MaskedImageT>(
            typename image::detail::image_traits<MaskedImageT>::image_category());
    Exposure cutout(blank, copyInfo);
 
    _copyCommonPixels(cutout, *this);
    return cutout;
}

getCutout() [3/3]

template<typename ImageT , typename MaskT , typename VarianceT >

Exposure< ImageT, MaskT, VarianceT > lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getCutout	(	lsst::geom::SpherePoint const &	center,
		lsst::geom::Extent2I const &	size ) const

Return an Exposure that is a small cutout of the original.

Parameters

center	Desired center of cutout in RA and Dec.
size	Width and height (in that order) of cutout in pixels

Returns

An Exposure of the requested size centered on center to within half a pixel in either dimension. Pixels past the edge of the original exposure will equal math::edgePixel.

Exceptions

lsst::pex::exceptions::LogicError	Thrown if this Exposure does not have a WCS.
lsst::pex::exceptions::InvalidParameterError	Thrown if center falls outside this Exposure or if size is not a valid size.

Definition at line 204 of file Exposure.cc.

                                                                               {
    if (!hasWcs()) {
        throw LSST_EXCEPT(pex::exceptions::LogicError, "Cannot look up source position without WCS.");
    }
    lsst::geom::Point2D pixelCenter = getWcs()->skyToPixel(center);
 
    return getCutout(pixelCenter, size);
}

getDetector()

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

std::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 237 of file Exposure.h.

                                                                       {
        return _info->getDetector();
    }

getDimensions()

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

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

inline

Return the Exposure's size.

Definition at line 251 of file Exposure.h.

{ return _maskedImage.getDimensions(); }

getFilter()

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

std::shared_ptr< FilterLabel const > lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getFilter ( ) const

inline

Return the Exposure's filter information.

Definition at line 241 of file Exposure.h.

{ return _info->getFilter(); }

getHeight()

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 249 of file Exposure.h.

{ return _maskedImage.getHeight(); }

getInfo() [1/2]

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

std::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 322 of file Exposure.h.

{ return _info; }

getInfo() [2/2]

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

std::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 325 of file Exposure.h.

{ return _info; }

getMaskedImage() [1/2]

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 228 of file Exposure.h.

{ return _maskedImage; }

getMaskedImage() [2/2]

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 230 of file Exposure.h.

{ return _maskedImage; }

getMetadata()

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

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

inline

Return flexible metadata.

Definition at line 243 of file Exposure.h.

{ return _info->getMetadata(); }

getPhotoCalib()

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

std::shared_ptr< PhotoCalib const > lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getPhotoCalib ( ) const

inline

Return the Exposure's PhotoCalib object.

Definition at line 304 of file Exposure.h.

{ return _info->getPhotoCalib(); }

getPsf()

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

std::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 310 of file Exposure.h.

{ return _info->getPsf(); }

getWcs()

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

std::shared_ptr< geom::SkyWcs const > lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::getWcs ( ) const

inline

Definition at line 232 of file Exposure.h.

{ return _info->getWcs(); }

getWidth()

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 247 of file Exposure.h.

{ return _maskedImage.getWidth(); }

getX0()

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 column-origin.

See also

getXY0()

Definition at line 258 of file Exposure.h.

{ return _maskedImage.getX0(); }

getXY0()

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

lsst::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 273 of file Exposure.h.

{ return _maskedImage.getXY0(); }

getY0()

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 row-origin.

See also

getXY0()

Definition at line 264 of file Exposure.h.

{ return _maskedImage.getY0(); }

hasPsf()

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 313 of file Exposure.h.

{ return _info->hasPsf(); }

hasWcs()

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 316 of file Exposure.h.

{ return _info->hasWcs(); }

operator=() [1/2]

template<typename ImageT , typename MaskT , typename VarianceT >

Exposure< ImageT, MaskT, VarianceT > & lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::operator= ( Exposure< ImageT, MaskT, VarianceT > && )

default

operator=() [2/2]

template<typename ImageT , typename MaskT , typename VarianceT >

Exposure< ImageT, MaskT, VarianceT > & lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::operator= ( Exposure< ImageT, MaskT, VarianceT > const & )

default

operator[]()

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

Exposure lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::operator[] ( lsst::geom::Box2I const & bbox ) const

inline

Return a subimage corresponding to the given box (interpreted as PARENT coordinates).

Definition at line 220 of file Exposure.h.

{ return subset(bbox); }

readFits() [1/2]

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 414 of file Exposure.h.

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

readFits() [2/2]

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 405 of file Exposure.h.

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

setApCorrMap()

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

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::setApCorrMap ( std::shared_ptr< ApCorrMap const > apCorrMap )

inline

Set the Exposure's aperture correction map.

Definition at line 319 of file Exposure.h.

{ _info->setApCorrMap(apCorrMap); }

setDetector()

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

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

inline

Set the Exposure's Detector information.

Definition at line 294 of file Exposure.h.

                                                                              {
        _info->setDetector(detector);
    }

setFilter()

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

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::setFilter ( std::shared_ptr< FilterLabel const > filterLabel )

inline

Set the Exposure's filter information.

Definition at line 299 of file Exposure.h.

{ _info->setFilter(filterLabel); }

setInfo()

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

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::setInfo ( std::shared_ptr< ExposureInfo > exposureInfo )

inline

Set the ExposureInfo that aggregates all the non-image components.

Definition at line 328 of file Exposure.h.

{ _info = exposureInfo; }

setMaskedImage()

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 111 of file Exposure.cc.

                                                                                 {
    _maskedImage = maskedImage;
}

setMetadata()

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

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

inline

Definition at line 244 of file Exposure.h.

{ _info->setMetadata(metadata); }

setPhotoCalib()

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

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::setPhotoCalib ( std::shared_ptr< PhotoCalib const > photoCalib )

inline

Set the Exposure's PhotoCalib object.

Definition at line 302 of file Exposure.h.

{ _info->setPhotoCalib(photoCalib); }

setPsf()

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

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

inline

Set the Exposure's Psf.

Definition at line 307 of file Exposure.h.

{ _info->setPsf(psf); }

setWcs()

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

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::setWcs ( std::shared_ptr< geom::SkyWcs > wcs )

inline

Definition at line 292 of file Exposure.h.

{ _info->setWcs(wcs); }

setXY0()

template<typename ImageT , typename MaskT , typename VarianceT >

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

(

lsst::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 116 of file Exposure.cc.

                                                                             {
    lsst::geom::Point2I old(_maskedImage.getXY0());
    if (_info->hasWcs()) {
        auto shift = lsst::geom::Extent2D(origin - old);
        auto newWcs = _info->getWcs()->copyAtShiftedPixelOrigin(shift);
        _info->setWcs(newWcs);
    }
    _maskedImage.setXY0(origin);
}

subset()

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

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

inline

Return a subimage corresponding to the given box.

Parameters

bbox	Bounding box of the subimage returned.
origin	Origin bbox is relative to; PARENT accounts for xy0, LOCAL does not.

Returns

A subimage view into this.

This method is wrapped as getitem in Python.

Note

This method permits mutable views to be obtained from const references to images (just as the copy constructor does). This is an intrinsic flaw in Image's design.

Definition at line 215 of file Exposure.h.

                                                                                  {
        return Exposure(*this, bbox, origin, false);
    }

writeFits() [1/6]

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 146 of file Exposure.cc.

                                                                           {
    writeFits(fitsfile, fits::ImageWriteOptions(*_maskedImage.getImage()),
              fits::ImageWriteOptions(*_maskedImage.getMask()),
              fits::ImageWriteOptions(*_maskedImage.getVariance()));
}

writeFits() [2/6]

template<typename ImageT , typename MaskT , typename VarianceT >

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::writeFits	(	fits::Fits &	fitsfile,
		fits::ImageWriteOptions const &	imageOptions,
		fits::ImageWriteOptions const &	maskOptions,
		fits::ImageWriteOptions const &	varianceOptions ) const

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

Parameters

[in]	fitsfile	FITS object to which to write.
[in]	imageOptions	Options controlling writing of image as FITS.
[in]	maskOptions	Options controlling writing of mask as FITS.
[in]	varianceOptions	Options controlling writing of variance as FITS.

Definition at line 171 of file Exposure.cc.

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

writeFits() [3/6]

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 140 of file Exposure.cc.

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

writeFits() [4/6]

template<typename ImageT , typename MaskT , typename VarianceT >

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::writeFits	(	fits::MemFileManager &	manager,
		fits::ImageWriteOptions const &	imageOptions,
		fits::ImageWriteOptions const &	maskOptions,
		fits::ImageWriteOptions const &	varianceOptions ) const

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

Parameters

[in]	manager	Manager for the memory to write to.
[in]	imageOptions	Options controlling writing of image as FITS.
[in]	maskOptions	Options controlling writing of mask as FITS.
[in]	varianceOptions	Options controlling writing of variance as FITS.

Definition at line 162 of file Exposure.cc.

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

writeFits() [5/6]

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 134 of file Exposure.cc.

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

writeFits() [6/6]

template<typename ImageT , typename MaskT , typename VarianceT >

void lsst::afw::image::Exposure< ImageT, MaskT, VarianceT >::writeFits	(	std::string const &	fileName,
		fits::ImageWriteOptions const &	imageOptions,
		fits::ImageWriteOptions const &	maskOptions,
		fits::ImageWriteOptions const &	varianceOptions ) const

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

Parameters

[in]	fileName	Name of the file to write.
[in]	imageOptions	Options controlling writing of image as FITS.
[in]	maskOptions	Options controlling writing of mask as FITS.
[in]	varianceOptions	Options controlling writing of variance as FITS.

Definition at line 153 of file Exposure.cc.

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

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/include/lsst/afw/image/Exposure.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/src/image/Exposure.cc