LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > Class Template Reference

A class to manipulate images, masks, and variance as a single object. More...

#include <MaskedImage.h>

Classes

class  const_MaskedImageIterator
 An const iterator to the MaskedImage. More...
 
class  const_MaskedImageLocator
 A const locator for the MaskedImage. More...
 
struct  ImageTypeFactory
 A templated class to return this classes' type (present in Image/Mask/MaskedImage) More...
 
class  MaskedImageIterator
 An iterator to the MaskedImage. More...
 
class  MaskedImageIteratorBase
 The base class for MaskedImageIterators (const and non-const) More...
 
class  MaskedImageLocator
 A locator for the MaskedImage. More...
 
class  MaskedImageLocatorBase
 The base class for MaskedImageLocators (const and non-const) More...
 

Public Types

using ImagePtr = std::shared_ptr< image::Image< ImagePixelT > >
 shared pointer to the Image More...
 
using MaskPtr = std::shared_ptr< image::Mask< MaskPixelT > >
 shared pointer to the Mask More...
 
using VariancePtr = std::shared_ptr< image::Image< VariancePixelT > >
 shared pointer to the variance Image More...
 
using MaskPlaneDict = typename Mask< MaskPixelT >::MaskPlaneDict
 The Mask's MaskPlaneDict. More...
 
using Variance = lsst::afw::image::Image< VariancePixelT >
 
using Image = lsst::afw::image::Image< ImagePixelT >
 
using Mask = lsst::afw::image::Mask< MaskPixelT >
 
using image_category = detail::MaskedImage_tag
 
using Pixel = lsst::afw::image::pixel::Pixel< ImagePixelT, MaskPixelT, VariancePixelT >
 A Pixel in the MaskedImage. More...
 
using SinglePixel = lsst::afw::image::pixel::SinglePixel< ImagePixelT, MaskPixelT, VariancePixelT >
 A single Pixel of the same type as those in the MaskedImage. More...
 
using iterator = MaskedImageIterator< typename Image::iterator, typename Mask::iterator, typename Variance::iterator >
 
using const_iterator = const_MaskedImageIterator< typename Image::iterator, typename Mask::iterator, typename Variance::iterator >
 
using reverse_iterator = MaskedImageIterator< typename Image::reverse_iterator, typename Mask::reverse_iterator, typename Variance::reverse_iterator >
 
using x_iterator = MaskedImageIterator< typename Image::x_iterator, typename Mask::x_iterator, typename Variance::x_iterator >
 An iterator to a row of a MaskedImage. More...
 
using const_x_iterator = const_MaskedImageIterator< typename Image::x_iterator, typename Mask::x_iterator, typename Variance::x_iterator >
 A const_iterator to a row of a MaskedImage. More...
 
using fast_iterator = x_iterator
 A fast STL compliant iterator for contiguous images N.b. More...
 
using y_iterator = MaskedImageIterator< typename Image::y_iterator, typename Mask::y_iterator, typename Variance::y_iterator >
 An iterator to a column of a MaskedImage. More...
 
using const_y_iterator = const_MaskedImageIterator< typename Image::y_iterator, typename Mask::y_iterator, typename Variance::y_iterator >
 A const_iterator to a column of a MaskedImage. More...
 
using xy_locator = MaskedImageLocator< typename Image::xy_locator, typename Mask::xy_locator, typename Variance::xy_locator >
 A locator for a MaskedImage. More...
 
using const_xy_locator = const_MaskedImageLocator< typename Image::xy_locator, typename Mask::xy_locator, typename Variance::xy_locator >
 A const_locator for a MaskedImage. More...
 
using xy_x_iterator = typename MaskedImageLocator< typename Image::xy_locator, typename Mask::xy_locator, typename Variance::xy_locator >::x_iterator
 an x_iterator associated with an xy_locator More...
 
using xy_y_iterator = typename MaskedImageLocator< typename Image::xy_locator, typename Mask::xy_locator, typename Variance::xy_locator >::y_iterator
 an y_iterator associated with an xy_locator More...
 

Public Member Functions

 MaskedImage (unsigned int width, unsigned int height, MaskPlaneDict const &planeDict=MaskPlaneDict())
 Construct from a supplied dimensions. More...
 
 MaskedImage (lsst::geom::Extent2I const &dimensions=lsst::geom::Extent2I(), MaskPlaneDict const &planeDict=MaskPlaneDict())
 Construct from a supplied dimensions. More...
 
 MaskedImage (ImagePtr image, MaskPtr mask=MaskPtr(), VariancePtr variance=VariancePtr())
 Construct from a supplied Image and optional Mask and Variance. More...
 
 MaskedImage (lsst::geom::Box2I const &bbox, MaskPlaneDict const &planeDict=MaskPlaneDict())
 Create an MaskedImage of the specified size. More...
 
 MaskedImage (std::string const &fileName, std::shared_ptr< daf::base::PropertySet > metadata=std::shared_ptr< daf::base::PropertySet >(), lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool needAllHdus=false, std::shared_ptr< daf::base::PropertySet > imageMetadata=std::shared_ptr< daf::base::PropertySet >(), std::shared_ptr< daf::base::PropertySet > maskMetadata=std::shared_ptr< daf::base::PropertySet >(), std::shared_ptr< daf::base::PropertySet > varianceMetadata=std::shared_ptr< daf::base::PropertySet >(), bool allowUnsafe=false)
 Construct a MaskedImage by reading a regular FITS file. More...
 
 MaskedImage (fits::MemFileManager &manager, std::shared_ptr< daf::base::PropertySet > metadata=std::shared_ptr< daf::base::PropertySet >(), lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool needAllHdus=false, std::shared_ptr< daf::base::PropertySet > imageMetadata=std::shared_ptr< daf::base::PropertySet >(), std::shared_ptr< daf::base::PropertySet > maskMetadata=std::shared_ptr< daf::base::PropertySet >(), std::shared_ptr< daf::base::PropertySet > varianceMetadata=std::shared_ptr< daf::base::PropertySet >(), bool allowUnsafe=false)
 Construct a MaskedImage by reading a FITS image in memory. More...
 
 MaskedImage (fits::Fits &fitsfile, std::shared_ptr< daf::base::PropertySet > metadata=std::shared_ptr< daf::base::PropertySet >(), lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool needAllHdus=false, std::shared_ptr< daf::base::PropertySet > imageMetadata=std::shared_ptr< daf::base::PropertySet >(), std::shared_ptr< daf::base::PropertySet > maskMetadata=std::shared_ptr< daf::base::PropertySet >(), std::shared_ptr< daf::base::PropertySet > varianceMetadata=std::shared_ptr< daf::base::PropertySet >(), bool allowUnsafe=false)
 Construct a MaskedImage from an already-open FITS object. More...
 
 MaskedImage (MaskedImage const &rhs, bool const deep=false)
 Copy constructor; shallow, unless deep is true. More...
 
 MaskedImage (MaskedImage &&rhs)
 
 MaskedImage (MaskedImage const &rhs, lsst::geom::Box2I const &bbox, ImageOrigin const origin=PARENT, bool const deep=false)
 Copy constructor of the pixels specified by bbox; shallow, unless deep is true. More...
 
template<typename OtherPixelT >
 MaskedImage (MaskedImage< OtherPixelT, MaskPixelT, VariancePixelT > 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. More...
 
MaskedImageoperator= (MaskedImage const &rhs)
 Make the lhs use the rhs's pixels. More...
 
MaskedImageoperator= (MaskedImage &&rhs)
 
virtual ~MaskedImage ()=default
 
void swap (MaskedImage &rhs)
 
MaskedImageoperator= (Pixel const &rhs)
 Set the pixels in the MaskedImage to the rhs. More...
 
MaskedImageoperator= (SinglePixel const &rhs)
 Set the pixels in the MaskedImage to the rhs. More...
 
MaskedImage subset (lsst::geom::Box2I const &bbox, ImageOrigin origin=PARENT) const
 Return a subimage corresponding to the given box. More...
 
MaskedImage operator[] (lsst::geom::Box2I const &bbox) const
 Return a subimage corresponding to the given box (interpreted as PARENT coordinates). More...
 
void assign (MaskedImage const &rhs, lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT)
 Copy pixels from another masked image to a specified subregion of this masked image. More...
 
MaskedImageoperator+= (ImagePixelT const rhs)
 Add a scalar rhs to a MaskedImage. More...
 
MaskedImageoperator+= (MaskedImage const &rhs)
 Add a MaskedImage rhs to a MaskedImage. More...
 
MaskedImageoperator+= (lsst::afw::image::Image< ImagePixelT > const &rhs)
 
MaskedImageoperator+= (lsst::afw::math::Function2< double > const &function)
 
void scaledPlus (double const c, MaskedImage const &rhs)
 Add a scaled MaskedImage c*rhs to a MaskedImage. More...
 
MaskedImageoperator-= (ImagePixelT const rhs)
 Subtract a scalar rhs from a MaskedImage. More...
 
MaskedImageoperator-= (MaskedImage const &rhs)
 Subtract a MaskedImage rhs from a MaskedImage. More...
 
MaskedImageoperator-= (lsst::afw::image::Image< ImagePixelT > const &rhs)
 
MaskedImageoperator-= (lsst::afw::math::Function2< double > const &function)
 
void scaledMinus (double const c, MaskedImage const &rhs)
 Subtract a scaled MaskedImage c*rhs from a MaskedImage. More...
 
MaskedImageoperator*= (ImagePixelT const rhs)
 
MaskedImageoperator*= (MaskedImage const &rhs)
 
MaskedImageoperator*= (lsst::afw::image::Image< ImagePixelT > const &rhs)
 
void scaledMultiplies (double const c, MaskedImage const &rhs)
 
MaskedImageoperator/= (ImagePixelT const rhs)
 
MaskedImageoperator/= (MaskedImage const &rhs)
 
MaskedImageoperator/= (lsst::afw::image::Image< ImagePixelT > const &rhs)
 
void scaledDivides (double const c, MaskedImage const &rhs)
 
void writeFits (std::string const &fileName, std::shared_ptr< daf::base::PropertySet const > metadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > imageMetadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > maskMetadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > varianceMetadata=std::shared_ptr< daf::base::PropertySet const >()) const
 Write a MaskedImage to a regular FITS file. More...
 
void writeFits (fits::MemFileManager &manager, std::shared_ptr< daf::base::PropertySet const > metadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > imageMetadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > maskMetadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > varianceMetadata=std::shared_ptr< daf::base::PropertySet const >()) const
 Write a MaskedImage to a FITS RAM file. More...
 
void writeFits (fits::Fits &fitsfile, std::shared_ptr< daf::base::PropertySet const > metadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > imageMetadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > maskMetadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > varianceMetadata=std::shared_ptr< daf::base::PropertySet const >()) const
 Write a MaskedImage to a FITS file. More...
 
void writeFits (std::string const &fileName, fits::ImageWriteOptions const &imageOptions, fits::ImageWriteOptions const &maskOptions, fits::ImageWriteOptions const &varianceOptions, std::shared_ptr< daf::base::PropertySet const > metadata=nullptr, std::shared_ptr< daf::base::PropertySet const > imageMetadata=nullptr, std::shared_ptr< daf::base::PropertySet const > maskMetadata=nullptr, std::shared_ptr< daf::base::PropertySet const > varianceMetadata=nullptr) const
 Write a MaskedImage to a FITS file. More...
 
void writeFits (fits::MemFileManager &manager, fits::ImageWriteOptions const &imageOptions, fits::ImageWriteOptions const &maskOptions, fits::ImageWriteOptions const &varianceOptions, std::shared_ptr< daf::base::PropertySet const > metadata=nullptr, std::shared_ptr< daf::base::PropertySet const > imageMetadata=nullptr, std::shared_ptr< daf::base::PropertySet const > maskMetadata=nullptr, std::shared_ptr< daf::base::PropertySet const > varianceMetadata=nullptr) const
 Write a MaskedImage to a FITS file. More...
 
void writeFits (fits::Fits &fitsfile, fits::ImageWriteOptions const &imageOptions, fits::ImageWriteOptions const &maskOptions, fits::ImageWriteOptions const &varianceOptions, std::shared_ptr< daf::base::PropertySet const > metadata=nullptr, std::shared_ptr< daf::base::PropertySet const > imageMetadata=nullptr, std::shared_ptr< daf::base::PropertySet const > maskMetadata=nullptr, std::shared_ptr< daf::base::PropertySet const > varianceMetadata=nullptr) const
 Write a MaskedImage to a FITS file. More...
 
ImagePtr getImage () const
 Return a (shared_ptr to) the MaskedImage's image. More...
 
void setImage (Image const &other)
 Set the image plane's pixel values to those of another Image. More...
 
MaskPtr getMask () const
 Return a (shared_ptr to) the MaskedImage's mask. More...
 
void setMask (Mask const &other)
 Set the mask plane's pixel values to those of another Mask. More...
 
void setVariance (Variance const &other)
 Set the variance plane's pixel values to those of another Image. More...
 
VariancePtr getVariance () const
 Return a (shared_ptr to) the MaskedImage's variance. More...
 
int getWidth () const
 Return the number of columns in the image. More...
 
int getHeight () const
 Return the number of rows in the image. More...
 
lsst::geom::Extent2I getDimensions () const
 
lsst::geom::Box2I getBBox (ImageOrigin const origin=PARENT) const
 
int getX0 () const
 Return the image's column-origin. More...
 
int getY0 () const
 Return the image's row-origin. More...
 
lsst::geom::Point2I getXY0 () const
 Return the image's origin. More...
 
void setXY0 (int const x0, int const y0)
 Set the MaskedImage's origin. More...
 
void setXY0 (lsst::geom::Point2I const origin)
 Set the MaskedImage's origin. More...
 
double indexToPosition (double ind, lsst::afw::image::xOrY const xy) const
 Convert image index to image position (see Image::indexToPosition) More...
 
std::pair< int, double > positionToIndex (double const pos, lsst::afw::image::xOrY const xy) const
 Convert image position to index (see Image::positionToIndex) More...
 
iterator begin () const
 Return an iterator to the start of the image. More...
 
iterator end () const
 Return an iterator to the end of the image. More...
 
iterator at (int const x, int const y) const
 Return an iterator at the point (x, y) More...
 
reverse_iterator rbegin () const
 Return a reverse_iterator to the start of the image. More...
 
reverse_iterator rend () const
 Return a reverse_iterator to the end of the image. More...
 
fast_iterator begin (bool contiguous) const
 Fast iterators to contiguous images. More...
 
fast_iterator end (bool contiguous) const
 Return a fast iterator to the end of the image, which must be contiguous Note that the order in which pixels are visited is undefined. More...
 
x_iterator row_begin (int y) const
 Return an x_iterator to the start of the image. More...
 
x_iterator row_end (int y) const
 Return an x_iterator to the end of the image. More...
 
x_iterator x_at (int x, int y) const
 Return an x_iterator at the point (x, y) More...
 
y_iterator col_begin (int x) const
 Return an y_iterator to the start of the image. More...
 
y_iterator col_end (int x) const
 Return an y_iterator to the end of the image. More...
 
y_iterator y_at (int x, int y) const
 Return an y_iterator at the point (x, y) More...
 
xy_locator xy_at (int x, int y) const
 Return an xy_locator at the point (x, y) More...
 

Static Public Member Functions

static MaskedImage readFits (std::string const &filename)
 Read a MaskedImage from a regular FITS file. More...
 
static MaskedImage readFits (fits::MemFileManager &manager)
 Read a MaskedImage from a FITS RAM file. More...
 

Detailed Description

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
class lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >

A class to manipulate images, masks, and variance as a single object.

Examples
imageStatistics.cc, maskedImage1.cc, and maskedImage2.cc.

Definition at line 73 of file MaskedImage.h.

Member Typedef Documentation

◆ const_iterator

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::const_iterator = const_MaskedImageIterator<typename Image::iterator, typename Mask::iterator, typename Variance::iterator>

Definition at line 531 of file MaskedImage.h.

◆ const_x_iterator

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::const_x_iterator = const_MaskedImageIterator<typename Image::x_iterator, typename Mask::x_iterator, typename Variance::x_iterator>

A const_iterator to a row of a MaskedImage.

Definition at line 542 of file MaskedImage.h.

◆ const_xy_locator

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::const_xy_locator = const_MaskedImageLocator<typename Image::xy_locator, typename Mask::xy_locator, typename Variance::xy_locator>

A const_locator for a MaskedImage.

Definition at line 555 of file MaskedImage.h.

◆ const_y_iterator

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::const_y_iterator = const_MaskedImageIterator<typename Image::y_iterator, typename Mask::y_iterator, typename Variance::y_iterator>

A const_iterator to a column of a MaskedImage.

Definition at line 550 of file MaskedImage.h.

◆ fast_iterator

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::fast_iterator = x_iterator

A fast STL compliant iterator for contiguous images N.b.

The order of pixel access is undefined

Definition at line 546 of file MaskedImage.h.

◆ Image

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::Image = lsst::afw::image::Image<ImagePixelT>

Definition at line 85 of file MaskedImage.h.

◆ image_category

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::image_category = detail::MaskedImage_tag

Definition at line 88 of file MaskedImage.h.

◆ ImagePtr

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::ImagePtr = std::shared_ptr<image::Image<ImagePixelT> >

shared pointer to the Image

Definition at line 76 of file MaskedImage.h.

◆ iterator

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::iterator = MaskedImageIterator<typename Image::iterator, typename Mask::iterator, typename Variance::iterator>

Definition at line 529 of file MaskedImage.h.

◆ Mask

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::Mask = lsst::afw::image::Mask<MaskPixelT>

Definition at line 86 of file MaskedImage.h.

◆ MaskPlaneDict

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskPlaneDict = typename Mask<MaskPixelT>::MaskPlaneDict

The Mask's MaskPlaneDict.

Definition at line 82 of file MaskedImage.h.

◆ MaskPtr

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskPtr = std::shared_ptr<image::Mask<MaskPixelT> >

shared pointer to the Mask

Definition at line 78 of file MaskedImage.h.

◆ Pixel

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::Pixel = lsst::afw::image::pixel::Pixel<ImagePixelT, MaskPixelT, VariancePixelT>

A Pixel in the MaskedImage.

Definition at line 111 of file MaskedImage.h.

◆ reverse_iterator

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::reverse_iterator = MaskedImageIterator<typename Image::reverse_iterator, typename Mask::reverse_iterator, typename Variance::reverse_iterator>

Definition at line 533 of file MaskedImage.h.

◆ SinglePixel

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::SinglePixel = lsst::afw::image::pixel::SinglePixel<ImagePixelT, MaskPixelT, VariancePixelT>

A single Pixel of the same type as those in the MaskedImage.

Definition at line 113 of file MaskedImage.h.

◆ Variance

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::Variance = lsst::afw::image::Image<VariancePixelT>

Definition at line 84 of file MaskedImage.h.

◆ VariancePtr

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::VariancePtr = std::shared_ptr<image::Image<VariancePixelT> >

shared pointer to the variance Image

Definition at line 80 of file MaskedImage.h.

◆ x_iterator

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::x_iterator = MaskedImageIterator<typename Image::x_iterator, typename Mask::x_iterator, typename Variance::x_iterator>

An iterator to a row of a MaskedImage.

Definition at line 540 of file MaskedImage.h.

◆ xy_locator

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::xy_locator = MaskedImageLocator<typename Image::xy_locator, typename Mask::xy_locator, typename Variance::xy_locator>

A locator for a MaskedImage.

Definition at line 553 of file MaskedImage.h.

◆ xy_x_iterator

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::xy_x_iterator = typename MaskedImageLocator<typename Image::xy_locator, typename Mask::xy_locator, typename Variance::xy_locator>::x_iterator

an x_iterator associated with an xy_locator

Definition at line 558 of file MaskedImage.h.

◆ xy_y_iterator

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::xy_y_iterator = typename MaskedImageLocator<typename Image::xy_locator, typename Mask::xy_locator, typename Variance::xy_locator>::y_iterator

an y_iterator associated with an xy_locator

Definition at line 560 of file MaskedImage.h.

◆ y_iterator

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::y_iterator = MaskedImageIterator<typename Image::y_iterator, typename Mask::y_iterator, typename Variance::y_iterator>

An iterator to a column of a MaskedImage.

Definition at line 548 of file MaskedImage.h.

Constructor & Destructor Documentation

◆ MaskedImage() [1/11]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImage ( unsigned int  width,
unsigned int  height,
MaskPlaneDict const &  planeDict = MaskPlaneDict() 
)
explicit

Construct from a supplied dimensions.

The Image, Mask, and Variance will be set to zero

Parameters
widthnumber of columns
heightnumber of rows
planeDictMake Mask conform to this mask layout (ignore if empty)

Definition at line 43 of file MaskedImage.cc.

45  : _image(new Image(width, height)),
46  _mask(new Mask(width, height, planeDict)),
47  _variance(new Variance(width, height)) {
48  *_image = 0;
49  *_mask = 0x0;
50  *_variance = 0;
51 }
lsst::afw::image::Image< VariancePixelT > Variance
Definition: MaskedImage.h:84
lsst::afw::image::Mask< MaskPixelT > Mask
Definition: MaskedImage.h:86
lsst::afw::image::Image< ImagePixelT > Image
Definition: MaskedImage.h:85

◆ MaskedImage() [2/11]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImage ( lsst::geom::Extent2I const &  dimensions = lsst::geom::Extent2I(),
MaskPlaneDict const &  planeDict = MaskPlaneDict() 
)
explicit

Construct from a supplied dimensions.

The Image, Mask, and Variance will be set to zero

Parameters
dimensionsNumber of columns, rows in image
planeDictMake Mask conform to this mask layout (ignore if empty)

Definition at line 54 of file MaskedImage.cc.

56  : _image(new Image(dimensions)),
57  _mask(new Mask(dimensions, planeDict)),
58  _variance(new Variance(dimensions)) {
59  *_image = 0;
60  *_mask = 0x0;
61  *_variance = 0;
62 }
afw::table::PointKey< int > dimensions
Definition: GaussianPsf.cc:48

◆ MaskedImage() [3/11]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImage ( ImagePtr  image,
MaskPtr  mask = MaskPtr(),
VariancePtr  variance = VariancePtr() 
)
explicit

Construct from a supplied Image and optional Mask and Variance.

The Mask and Variance will be set to zero if omitted

Parameters
imageImage
maskMask
varianceVariance Mask

Definition at line 149 of file MaskedImage.cc.

151  : _image(image), _mask(mask), _variance(variance) {
152  conformSizes();
153 }
afw::table::Key< afw::table::Array< MaskPixelT > > mask
afw::table::Key< afw::table::Array< VariancePixelT > > variance
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.

◆ MaskedImage() [4/11]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImage ( lsst::geom::Box2I const &  bbox,
MaskPlaneDict const &  planeDict = MaskPlaneDict() 
)
explicit

Create an MaskedImage of the specified size.

The Image, Mask, and Variance will be set to zero

Parameters
bboxdimensions of image: width x height
planeDictMake Mask conform to this mask layout (ignore if empty)
Note
Many lsst::afw::image and lsst::afw::math objects define a dimensions member which may be conveniently used to make objects of an appropriate size

Definition at line 65 of file MaskedImage.cc.

67  : _image(new Image(bbox)), _mask(new Mask(bbox, planeDict)), _variance(new Variance(bbox)) {
68  *_image = 0;
69  *_mask = 0x0;
70  *_variance = 0;
71 }
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117

◆ MaskedImage() [5/11]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImage ( std::string const &  fileName,
std::shared_ptr< daf::base::PropertySet metadata = std::shared_ptr<daf::base::PropertySet>(),
lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  conformMasks = false,
bool  needAllHdus = false,
std::shared_ptr< daf::base::PropertySet imageMetadata = std::shared_ptr<daf::base::PropertySet>(),
std::shared_ptr< daf::base::PropertySet maskMetadata = std::shared_ptr<daf::base::PropertySet>(),
std::shared_ptr< daf::base::PropertySet varianceMetadata = std::shared_ptr<daf::base::PropertySet>(),
bool  allowUnsafe = false 
)
explicit

Construct a MaskedImage by reading a regular FITS file.

Parameters
[in]fileNameFile to read.
[in,out]metadataMetadata read from the primary HDU header.
[in]bboxIf non-empty, read only the pixels within the bounding box.
[in]originCoordinate system of the bounding box; if PARENT, the bounding box should take into account the xy0 saved with the image.
[in]conformMasksIf true, make Mask conform to the mask layout in the file.
[in]needAllHdusIf true, throw fits::FitsError if the mask and/or variance plane is missing. If false, silently initialize them to zero.
[in,out]imageMetadataMetadata read from the image HDU header.
[in,out]maskMetadataMetadata read from the mask HDU header.
[in,out]varianceMetadataMetadata read from the variance HDU header.
[in]allowUnsafePermit reading into the requested pixel type even when on-disk values may overflow or truncate.

Definition at line 74 of file MaskedImage.cc.

80  : _image(), _mask(), _variance() {
81  MaskedImageFitsReader reader(fileName);
82  *this = reader.read<ImagePixelT, MaskPixelT, VariancePixelT>(bbox, origin, conformMasks, needAllHdus,
83  allowUnsafe);
84  if (metadata) {
85  metadata->combine(reader.readPrimaryMetadata());
86  }
87  if (imageMetadata) {
88  imageMetadata->combine(reader.readImageMetadata());
89  }
90  if (maskMetadata) {
91  maskMetadata->combine(reader.readMaskMetadata());
92  }
93  if (varianceMetadata) {
94  varianceMetadata->combine(reader.readVarianceMetadata());
95  }
96 }

◆ MaskedImage() [6/11]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImage ( fits::MemFileManager manager,
std::shared_ptr< daf::base::PropertySet metadata = std::shared_ptr<daf::base::PropertySet>(),
lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  conformMasks = false,
bool  needAllHdus = false,
std::shared_ptr< daf::base::PropertySet imageMetadata = std::shared_ptr<daf::base::PropertySet>(),
std::shared_ptr< daf::base::PropertySet maskMetadata = std::shared_ptr<daf::base::PropertySet>(),
std::shared_ptr< daf::base::PropertySet varianceMetadata = std::shared_ptr<daf::base::PropertySet>(),
bool  allowUnsafe = false 
)
explicit

Construct a MaskedImage by reading a FITS image in memory.

Parameters
[in]managerAn object that manages the memory buffer to read.
[in,out]metadataMetadata read from the primary HDU header.
[in]bboxIf non-empty, read only the pixels within the bounding box.
[in]originCoordinate system of the bounding box; if PARENT, the bounding box should take into account the xy0 saved with the image.
[in]conformMasksIf true, make Mask conform to the mask layout in the file.
[in]needAllHdusIf true, throw fits::FitsError if the mask and/or variance plane is missing. If false, silently initialize them to zero.
[in,out]imageMetadataMetadata read from the image HDU header.
[in,out]maskMetadataMetadata read from the mask HDU header.
[in,out]varianceMetadataMetadata read from the variance HDU header.
[in]allowUnsafePermit reading into the requested pixel type even when on-disk values may overflow or truncate.

Definition at line 99 of file MaskedImage.cc.

105  : _image(), _mask(), _variance() {
106  MaskedImageFitsReader reader(manager);
107  *this = reader.read<ImagePixelT, MaskPixelT, VariancePixelT>(bbox, origin, conformMasks, needAllHdus,
108  allowUnsafe);
109  if (metadata) {
110  metadata->combine(reader.readPrimaryMetadata());
111  }
112  if (imageMetadata) {
113  imageMetadata->combine(reader.readImageMetadata());
114  }
115  if (maskMetadata) {
116  maskMetadata->combine(reader.readMaskMetadata());
117  }
118  if (varianceMetadata) {
119  varianceMetadata->combine(reader.readVarianceMetadata());
120  }
121 }

◆ MaskedImage() [7/11]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImage ( fits::Fits fitsfile,
std::shared_ptr< daf::base::PropertySet metadata = std::shared_ptr<daf::base::PropertySet>(),
lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  conformMasks = false,
bool  needAllHdus = false,
std::shared_ptr< daf::base::PropertySet imageMetadata = std::shared_ptr<daf::base::PropertySet>(),
std::shared_ptr< daf::base::PropertySet maskMetadata = std::shared_ptr<daf::base::PropertySet>(),
std::shared_ptr< daf::base::PropertySet varianceMetadata = std::shared_ptr<daf::base::PropertySet>(),
bool  allowUnsafe = false 
)
explicit

Construct a MaskedImage from an already-open FITS object.

Parameters
[in]fitsfileA FITS object to read from. Current HDU is ignored.
[in,out]metadataMetadata read from the primary HDU header.
[in]bboxIf non-empty, read only the pixels within the bounding box.
[in]originCoordinate system of the bounding box; if PARENT, the bounding box should take into account the xy0 saved with the image.
[in]conformMasksIf true, make Mask conform to the mask layout in the file.
[in]needAllHdusIf true, throw fits::FitsError if the mask and/or variance plane is missing. If false, silently initialize them to zero.
[in,out]imageMetadataMetadata read from the image HDU header.
[in,out]maskMetadataMetadata read from the mask HDU header.
[in,out]varianceMetadataMetadata read from the variance HDU header.
[in]allowUnsafePermit reading into the requested pixel type even when on-disk values may overflow or truncate.

Definition at line 124 of file MaskedImage.cc.

130  : _image(), _mask(), _variance() {
131  MaskedImageFitsReader reader(&fitsFile);
132  *this = reader.read<ImagePixelT, MaskPixelT, VariancePixelT>(bbox, origin, conformMasks, needAllHdus,
133  allowUnsafe);
134  if (metadata) {
135  metadata->combine(reader.readPrimaryMetadata());
136  }
137  if (imageMetadata) {
138  imageMetadata->combine(reader.readImageMetadata());
139  }
140  if (maskMetadata) {
141  maskMetadata->combine(reader.readMaskMetadata());
142  }
143  if (varianceMetadata) {
144  varianceMetadata->combine(reader.readVarianceMetadata());
145  }
146 }

◆ MaskedImage() [8/11]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImage ( MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &  rhs,
bool const  deep = false 
)

Copy constructor; shallow, unless deep is true.

Parameters
rhsImage to copy
deepMake deep copy?

Definition at line 156 of file MaskedImage.cc.

157  : _image(rhs._image), _mask(rhs._mask), _variance(rhs._variance) {
158  if (deep) {
159  _image = std::shared_ptr<Image>(new Image(*rhs.getImage(), deep));
160  _mask = std::shared_ptr<Mask>(new Mask(*rhs.getMask(), deep));
161  _variance = std::shared_ptr<Variance>(new Variance(*rhs.getVariance(), deep));
162  }
163  conformSizes();
164 }

◆ MaskedImage() [9/11]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImage ( MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > &&  rhs)

Definition at line 168 of file MaskedImage.cc.

169  : MaskedImage(rhs, false) {}
MaskedImage(unsigned int width, unsigned int height, MaskPlaneDict const &planeDict=MaskPlaneDict())
Construct from a supplied dimensions.
Definition: MaskedImage.cc:43

◆ MaskedImage() [10/11]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImage ( MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &  rhs,
lsst::geom::Box2I const &  bbox,
ImageOrigin const  origin = PARENT,
bool const  deep = false 
)

Copy constructor of the pixels specified by bbox; shallow, unless deep is true.

Parameters
rhsMaskedImage to copy
bboxSpecify desired region
originSpecify the coordinate system of the bbox
deepIf false, new ImageBase shares storage with rhs; if true make a new, standalone, MaskedImage

Definition at line 172 of file MaskedImage.cc.

177  : _image(new Image(*rhs.getImage(), bbox, origin, deep)),
178  _mask(rhs._mask ? new Mask(*rhs.getMask(), bbox, origin, deep) : static_cast<Mask*>(nullptr)),
179  _variance(rhs._variance ? new Variance(*rhs.getVariance(), bbox, origin, deep)
180  : static_cast<Variance*>(nullptr)) {
181  conformSizes();
182 }

◆ MaskedImage() [11/11]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename OtherPixelT >
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImage ( MaskedImage< OtherPixelT, MaskPixelT, VariancePixelT > 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
rhsInput image
deepMust be true; needed to disambiguate

Definition at line 712 of file MaskedImage.h.

716  : _image(), _mask(), _variance() {
717  if (!deep) {
719  "Only deep copies are permitted for MaskedImages with different pixel types");
720  }
721 
722  _image = ImagePtr(new Image(*rhs.getImage(), deep));
723  _mask = MaskPtr(new Mask(*rhs.getMask(), deep));
724  _variance = VariancePtr(new Variance(*rhs.getVariance(), deep));
725  }
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
std::shared_ptr< image::Mask< MaskPixelT > > MaskPtr
shared pointer to the Mask
Definition: MaskedImage.h:78
std::shared_ptr< image::Image< ImagePixelT > > ImagePtr
shared pointer to the Image
Definition: MaskedImage.h:76
std::shared_ptr< image::Image< VariancePixelT > > VariancePtr
shared pointer to the variance Image
Definition: MaskedImage.h:80
Reports invalid arguments.
Definition: Runtime.h:66

◆ ~MaskedImage()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
virtual lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::~MaskedImage ( )
virtualdefault

Member Function Documentation

◆ assign()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
void lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::assign ( MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &  rhs,
lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT 
)

Copy pixels from another masked image to a specified subregion of this masked image.

Parameters
[in]rhssource image whose pixels are to be copied into this image (the destination)
[in]bboxsubregion of this image to set; if empty (the default) then all pixels are set
[in]originorigin of bbox: if PARENT then the lower left pixel of this image is at xy0 if LOCAL then the lower left pixel of this image is at 0,0
Exceptions
lsst::pex::exceptions::LengthErrorif the dimensions of rhs and the specified subregion of this image do not match.

Definition at line 223 of file MaskedImage.cc.

225  {
226  _image->assign(*rhs.getImage(), bbox, origin);
227  _mask->assign(*rhs.getMask(), bbox, origin);
228  _variance->assign(*rhs.getVariance(), bbox, origin);
229 }

◆ at()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::at ( int const  x,
int const  y 
) const

Return an iterator at the point (x, y)

Definition at line 591 of file MaskedImage.cc.

591  {
592  typename Image::iterator imageEnd = getImage()->at(x, y);
593  typename Mask::iterator maskEnd = getMask()->at(x, y);
594  typename Variance::iterator varianceEnd = getVariance()->at(x, y);
595 
596  return iterator(imageEnd, maskEnd, varianceEnd);
597 }
double x
int y
Definition: SpanSet.cc:48
typename _view_t::iterator iterator
An STL compliant iterator.
Definition: ImageBase.h:125
MaskedImageIterator< typename Image::iterator, typename Mask::iterator, typename Variance::iterator > iterator
Definition: MaskedImage.h:529
VariancePtr getVariance() const
Return a (shared_ptr to) the MaskedImage's variance.
Definition: MaskedImage.h:1051
MaskPtr getMask() const
Return a (shared_ptr to) the MaskedImage's mask.
Definition: MaskedImage.h:1030
ImagePtr getImage() const
Return a (shared_ptr to) the MaskedImage's image.
Definition: MaskedImage.h:1018

◆ begin() [1/2]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::begin

Return an iterator to the start of the image.

Definition at line 567 of file MaskedImage.cc.

567  {
568 #if 0 // this doesn't compile; why?
569  return iterator(_image->begin(), _mask->begin(), _variance->begin());
570 #else
571  typename Image::iterator imageBegin = _image->begin();
572  typename Mask::iterator maskBegin = _mask->begin();
573  typename Variance::iterator varianceBegin = _variance->begin();
574 
575  return iterator(imageBegin, maskBegin, varianceBegin);
576 #endif
577 }

◆ begin() [2/2]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::fast_iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::begin ( bool  contiguous) const

Fast iterators to contiguous images.

Return a fast iterator to the start of the image, which must be contiguous Note that the order in which pixels are visited is undefined.

Parameters
contiguousPixels are contiguous (must be true)
Exceptions
lsst::pex::exceptions::RuntimeErrorArgument contiguous is false, or the pixels are not in fact contiguous

Definition at line 661 of file MaskedImage.cc.

661  {
662  typename Image::fast_iterator imageBegin = _image->begin(contiguous);
663  typename Mask::fast_iterator maskBegin = _mask->begin(contiguous);
664  typename Variance::fast_iterator varianceBegin = _variance->begin(contiguous);
665 
666  return fast_iterator(imageBegin, maskBegin, varianceBegin);
667 }
x_iterator fast_iterator
A fast STL compliant iterator for contiguous images N.b.
Definition: ImageBase.h:137
x_iterator fast_iterator
A fast STL compliant iterator for contiguous images N.b.
Definition: MaskedImage.h:546

◆ col_begin()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::y_iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::col_begin ( int  x) const

Return an y_iterator to the start of the image.

Definition at line 641 of file MaskedImage.cc.

641  {
642  typename Image::y_iterator imageBegin = _image->col_begin(x);
643  typename Mask::y_iterator maskBegin = _mask->col_begin(x);
644  typename Variance::y_iterator varianceBegin = _variance->col_begin(x);
645 
646  return y_iterator(imageBegin, maskBegin, varianceBegin);
647 }
typename _view_t::y_iterator y_iterator
An iterator for traversing the pixels in a column.
Definition: ImageBase.h:143
MaskedImageIterator< typename Image::y_iterator, typename Mask::y_iterator, typename Variance::y_iterator > y_iterator
An iterator to a column of a MaskedImage.
Definition: MaskedImage.h:548

◆ col_end()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::y_iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::col_end ( int  x) const

Return an y_iterator to the end of the image.

Definition at line 651 of file MaskedImage.cc.

651  {
652  typename Image::y_iterator imageEnd = getImage()->col_end(x);
653  typename Mask::y_iterator maskEnd = getMask()->col_end(x);
654  typename Variance::y_iterator varianceEnd = getVariance()->col_end(x);
655 
656  return y_iterator(imageEnd, maskEnd, varianceEnd);
657 }

◆ end() [1/2]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::end

Return an iterator to the end of the image.

Definition at line 581 of file MaskedImage.cc.

581  {
582  typename Image::iterator imageEnd = getImage()->end();
583  typename Mask::iterator maskEnd = getMask()->end();
584  typename Variance::iterator varianceEnd = getVariance()->end();
585 
586  return iterator(imageEnd, maskEnd, varianceEnd);
587 }

◆ end() [2/2]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::fast_iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::end ( bool  contiguous) const

Return a fast iterator to the end of the image, which must be contiguous Note that the order in which pixels are visited is undefined.

Parameters
contiguousPixels are contiguous (must be true)
Exceptions
lsst::pex::exceptions::RuntimeErrorArgument contiguous is false, or the pixels are not in fact contiguous

Definition at line 671 of file MaskedImage.cc.

671  {
672  typename Image::fast_iterator imageEnd = getImage()->end(contiguous);
673  typename Mask::fast_iterator maskEnd = getMask()->end(contiguous);
674  typename Variance::fast_iterator varianceEnd = getVariance()->end(contiguous);
675 
676  return fast_iterator(imageEnd, maskEnd, varianceEnd);
677 }

◆ getBBox()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
lsst::geom::Box2I lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::getBBox ( ImageOrigin const  origin = PARENT) const
inline

Definition at line 1058 of file MaskedImage.h.

1058 { return _image->getBBox(origin); }

◆ getDimensions()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
lsst::geom::Extent2I lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::getDimensions ( ) const
inline

Definition at line 1057 of file MaskedImage.h.

1057 { return _image->getDimensions(); }

◆ getHeight()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
int lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::getHeight ( ) const
inline

Return the number of rows in the image.

Definition at line 1056 of file MaskedImage.h.

1056 { return _image->getHeight(); }

◆ getImage()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
ImagePtr lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::getImage ( ) const
inline

Return a (shared_ptr to) the MaskedImage's image.

Definition at line 1018 of file MaskedImage.h.

1018 { return _image; }

◆ getMask()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
MaskPtr lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::getMask ( ) const
inline

Return a (shared_ptr to) the MaskedImage's mask.

Definition at line 1030 of file MaskedImage.h.

1030 { return _mask; }

◆ getVariance()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
VariancePtr lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::getVariance ( ) const
inline

Return a (shared_ptr to) the MaskedImage's variance.

Definition at line 1051 of file MaskedImage.h.

1051 { return _variance; }

◆ getWidth()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
int lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::getWidth ( ) const
inline

Return the number of columns in the image.

Definition at line 1054 of file MaskedImage.h.

1054 { return _image->getWidth(); }

◆ getX0()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
int lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::getX0 ( ) const
inline

Return the image's column-origin.

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

Definition at line 1066 of file MaskedImage.h.

1066 { return _image->getX0(); }

◆ getXY0()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
lsst::geom::Point2I lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::getXY0 ( ) const
inline

Return the image's origin.

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

Definition at line 1082 of file MaskedImage.h.

1082 { return _image->getXY0(); }

◆ getY0()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
int lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::getY0 ( ) const
inline

Return the image's row-origin.

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

Definition at line 1074 of file MaskedImage.h.

1074 { return _image->getY0(); }

◆ indexToPosition()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
double lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::indexToPosition ( double  ind,
lsst::afw::image::xOrY const  xy 
) const
inline

Convert image index to image position (see Image::indexToPosition)

Returns
image position
Parameters
indimage index
xyIs this a column or row coordinate?

Definition at line 1121 of file MaskedImage.h.

1123  {
1124  return getImage()->indexToPosition(ind, xy);
1125  }

◆ operator*=() [1/3]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > & lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator*= ( ImagePixelT const  rhs)

Definition at line 342 of file MaskedImage.cc.

343  {
344  *_image *= rhs;
345  *_variance *= rhs * rhs;
346  return *this;
347 }

◆ operator*=() [2/3]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
MaskedImage& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator*= ( lsst::afw::image::Image< ImagePixelT > const &  rhs)
inline

Definition at line 840 of file MaskedImage.h.

840  {
841  *_image *= rhs;
842  *_variance *= rhs; // yes, multiply twice
843  *_variance *= rhs;
844  return *this;
845  }

◆ operator*=() [3/3]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > & lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator*= ( MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &  rhs)

Definition at line 301 of file MaskedImage.cc.

302  {
303  // Must do variance before we modify the image values
304  if (_image->getDimensions() != rhs._image->getDimensions()) {
306  boost::str(boost::format("Images are of different size, %dx%d v %dx%d") %
307  _image->getWidth() % _image->getHeight() % rhs._image->getWidth() % rhs._image->getHeight()));
308  }
309  transform_pixels(_image->_getRawView(), // lhs
310  rhs._image->_getRawView(), // rhs,
311  _variance->_getRawView(), // Var(lhs),
312  rhs._variance->_getRawView(), // Var(rhs)
313  _variance->_getRawView(), // result
314  productVariance<ImagePixelT, VariancePixelT>());
315 
316  *_image *= *rhs.getImage();
317  *_mask |= *rhs.getMask();
318  return *this;
319 }
Reports attempts to exceed implementation-defined length limits for some classes.
Definition: Runtime.h:76
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174

◆ operator+=() [1/4]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > & lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator+= ( ImagePixelT const  rhs)

Add a scalar rhs to a MaskedImage.

Definition at line 249 of file MaskedImage.cc.

250  {
251  *_image += rhs;
252  return *this;
253 }

◆ operator+=() [2/4]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
MaskedImage& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator+= ( lsst::afw::image::Image< ImagePixelT > const &  rhs)
inline

Definition at line 795 of file MaskedImage.h.

795  {
796  *_image += rhs;
797  return *this;
798  }

◆ operator+=() [3/4]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
MaskedImage& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator+= ( lsst::afw::math::Function2< double > const &  function)
inline

Definition at line 799 of file MaskedImage.h.

799  {
800  *_image += function;
801  return *this;
802  }

◆ operator+=() [4/4]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > & lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator+= ( MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &  rhs)

Add a MaskedImage rhs to a MaskedImage.

The image and variances are added; the masks are ORd together

Note
The pixels in the two images are taken to be independent. There is a Pixel operation (plus) which models the covariance, but this is not (yet?) available as full-MaskedImage operators

Definition at line 232 of file MaskedImage.cc.

233  {
234  *_image += *rhs.getImage();
235  *_mask |= *rhs.getMask();
236  *_variance += *rhs.getVariance();
237  return *this;
238 }

◆ operator-=() [1/4]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > & lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator-= ( ImagePixelT const  rhs)

Subtract a scalar rhs from a MaskedImage.

Definition at line 273 of file MaskedImage.cc.

274  {
275  *_image -= rhs;
276  return *this;
277 }

◆ operator-=() [2/4]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
MaskedImage& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator-= ( lsst::afw::image::Image< ImagePixelT > const &  rhs)
inline

Definition at line 822 of file MaskedImage.h.

822  {
823  *_image -= rhs;
824  return *this;
825  }

◆ operator-=() [3/4]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
MaskedImage& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator-= ( lsst::afw::math::Function2< double > const &  function)
inline

Definition at line 826 of file MaskedImage.h.

826  {
827  *_image -= function;
828  return *this;
829  }

◆ operator-=() [4/4]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > & lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator-= ( MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &  rhs)

Subtract a MaskedImage rhs from a MaskedImage.

The images are subtracted; the masks are ORd together; and the variances are added

Note
the pixels in the two images are taken to be independent

Definition at line 256 of file MaskedImage.cc.

257  {
258  *_image -= *rhs.getImage();
259  *_mask |= *rhs.getMask();
260  *_variance += *rhs.getVariance();
261  return *this;
262 }

◆ operator/=() [1/3]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > & lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator/= ( ImagePixelT const  rhs)

Definition at line 413 of file MaskedImage.cc.

414  {
415  *_image /= rhs;
416  *_variance /= rhs * rhs;
417  return *this;
418 }

◆ operator/=() [2/3]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
MaskedImage& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator/= ( lsst::afw::image::Image< ImagePixelT > const &  rhs)
inline

Definition at line 850 of file MaskedImage.h.

850  {
851  *_image /= rhs;
852  *_variance /= rhs; // yes, divide twice
853  *_variance /= rhs;
854  return *this;
855  }

◆ operator/=() [3/3]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > & lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator/= ( MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &  rhs)

Definition at line 372 of file MaskedImage.cc.

373  {
374  // Must do variance before we modify the image values
375  if (_image->getDimensions() != rhs._image->getDimensions()) {
377  boost::str(boost::format("Images are of different size, %dx%d v %dx%d") %
378  _image->getWidth() % _image->getHeight() % rhs._image->getWidth() % rhs._image->getHeight()));
379  }
380  transform_pixels(_image->_getRawView(), // lhs
381  rhs._image->_getRawView(), // rhs,
382  _variance->_getRawView(), // Var(lhs),
383  rhs._variance->_getRawView(), // Var(rhs)
384  _variance->_getRawView(), // result
385  quotientVariance<ImagePixelT, VariancePixelT>());
386 
387  *_image /= *rhs.getImage();
388  *_mask |= *rhs.getMask();
389  return *this;
390 }

◆ operator=() [1/4]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > & lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator= ( MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > &&  rhs)
default

◆ operator=() [2/4]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > & lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator= ( MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &  rhs)
default

Make the lhs use the rhs's pixels.

If you are copying a scalar value, a simple lhs = scalar; is OK, but this is probably not the function that you want to use with an image. To copy pixel values from the rhs use assign(rhs)

Parameters
rhsRight hand side

◆ operator=() [3/4]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > & lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator= ( MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::Pixel const &  rhs)

Set the pixels in the MaskedImage to the rhs.

Definition at line 203 of file MaskedImage.cc.

204  {
205  *_image = rhs.image();
206  *_mask = rhs.mask();
207  *_variance = rhs.variance();
208 
209  return *this;
210 }

◆ operator=() [4/4]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > & lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator= ( MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::SinglePixel const &  rhs)

Set the pixels in the MaskedImage to the rhs.

Definition at line 213 of file MaskedImage.cc.

214  {
215  *_image = rhs.image();
216  *_mask = rhs.mask();
217  *_variance = rhs.variance();
218 
219  return *this;
220 }

◆ operator[]()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
MaskedImage lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::operator[] ( lsst::geom::Box2I const &  bbox) const
inline

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

Definition at line 767 of file MaskedImage.h.

767 { return subset(bbox); }
MaskedImage subset(lsst::geom::Box2I const &bbox, ImageOrigin origin=PARENT) const
Return a subimage corresponding to the given box.
Definition: MaskedImage.h:762

◆ positionToIndex()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
std::pair<int, double> lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::positionToIndex ( double const  pos,
lsst::afw::image::xOrY const  xy 
) const
inline

Convert image position to index (see Image::positionToIndex)

Returns
std::pair(nearest integer index, fractional part)
Parameters
posimage position
xyIs this a column or row coordinate?

Definition at line 1132 of file MaskedImage.h.

1135  {
1136  return getImage()->positionToIndex(pos, xy);
1137  }

◆ rbegin()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::reverse_iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::rbegin

Return a reverse_iterator to the start of the image.

Definition at line 601 of file MaskedImage.cc.

601  {
602  typename Image::reverse_iterator imageBegin = _image->rbegin();
603  typename Mask::reverse_iterator maskBegin = _mask->rbegin();
604  typename Variance::reverse_iterator varianceBegin = _variance->rbegin();
605 
606  return reverse_iterator(imageBegin, maskBegin, varianceBegin);
607 }
typename _view_t::reverse_iterator reverse_iterator
An STL compliant reverse iterator.
Definition: ImageBase.h:129
MaskedImageIterator< typename Image::reverse_iterator, typename Mask::reverse_iterator, typename Variance::reverse_iterator > reverse_iterator
Definition: MaskedImage.h:533

◆ readFits() [1/2]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
static MaskedImage lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::readFits ( fits::MemFileManager manager)
inlinestatic

Read a MaskedImage from a FITS RAM file.

Parameters
[in]managerObject that manages the memory to be read.

Definition at line 1011 of file MaskedImage.h.

1011  {
1012  return MaskedImage<ImagePixelT, MaskPixelT, VariancePixelT>(manager);
1013  }

◆ readFits() [2/2]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
static MaskedImage lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::readFits ( std::string const &  filename)
inlinestatic

Read a MaskedImage from a regular FITS file.

Parameters
[in]filenameName of the file to read.

Definition at line 1002 of file MaskedImage.h.

1002  {
1003  return MaskedImage<ImagePixelT, MaskPixelT, VariancePixelT>(filename);
1004  }

◆ rend()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::reverse_iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::rend

Return a reverse_iterator to the end of the image.

Definition at line 611 of file MaskedImage.cc.

611  {
612  typename Image::reverse_iterator imageEnd = getImage()->rend();
613  typename Mask::reverse_iterator maskEnd = getMask()->rend();
614  typename Variance::reverse_iterator varianceEnd = getVariance()->rend();
615 
616  return reverse_iterator(imageEnd, maskEnd, varianceEnd);
617 }

◆ row_begin()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::x_iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::row_begin ( int  y) const

Return an x_iterator to the start of the image.

Definition at line 621 of file MaskedImage.cc.

621  {
622  typename Image::x_iterator imageBegin = _image->row_begin(y);
623  typename Mask::x_iterator maskBegin = _mask->row_begin(y);
624  typename Variance::x_iterator varianceBegin = _variance->row_begin(y);
625 
626  return x_iterator(imageBegin, maskBegin, varianceBegin);
627 }
typename _view_t::x_iterator x_iterator
An iterator for traversing the pixels in a row.
Definition: ImageBase.h:133
MaskedImageIterator< typename Image::x_iterator, typename Mask::x_iterator, typename Variance::x_iterator > x_iterator
An iterator to a row of a MaskedImage.
Definition: MaskedImage.h:540

◆ row_end()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::x_iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::row_end ( int  y) const

Return an x_iterator to the end of the image.

Definition at line 631 of file MaskedImage.cc.

631  {
632  typename Image::x_iterator imageEnd = getImage()->row_end(y);
633  typename Mask::x_iterator maskEnd = getMask()->row_end(y);
634  typename Variance::x_iterator varianceEnd = getVariance()->row_end(y);
635 
636  return x_iterator(imageEnd, maskEnd, varianceEnd);
637 }

◆ scaledDivides()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
void lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::scaledDivides ( double const  c,
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &  rhs 
)

Definition at line 393 of file MaskedImage.cc.

394  {
395  // Must do variance before we modify the image values
396  if (_image->getDimensions() != rhs._image->getDimensions()) {
398  str(boost::format("Images are of different size, %dx%d v %dx%d") %
399  _image->getWidth() % _image->getHeight() % rhs._image->getWidth() % rhs._image->getHeight()));
400  }
401  transform_pixels(_image->_getRawView(), // lhs
402  rhs._image->_getRawView(), // rhs,
403  _variance->_getRawView(), // Var(lhs),
404  rhs._variance->_getRawView(), // Var(rhs)
405  _variance->_getRawView(), // result
406  scaledQuotientVariance<ImagePixelT, VariancePixelT>(c));
407 
408  (*_image).scaledDivides(c, *rhs.getImage());
409  *_mask |= *rhs._mask;
410 }

◆ scaledMinus()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
void lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::scaledMinus ( double const  c,
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &  rhs 
)

Subtract a scaled MaskedImage c*rhs from a MaskedImage.

The images are subtracted; the masks are ORd together; and the variances are added

Note
the pixels in the two images are taken to be independent

Definition at line 265 of file MaskedImage.cc.

266  {
267  (*_image).scaledMinus(c, *rhs.getImage());
268  *_mask |= *rhs.getMask();
269  (*_variance).scaledPlus(c * c, *rhs.getVariance());
270 }

◆ scaledMultiplies()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
void lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::scaledMultiplies ( double const  c,
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &  rhs 
)

Definition at line 322 of file MaskedImage.cc.

323  {
324  // Must do variance before we modify the image values
325  if (_image->getDimensions() != rhs._image->getDimensions()) {
327  boost::str(boost::format("Images are of different size, %dx%d v %dx%d") %
328  _image->getWidth() % _image->getHeight() % rhs._image->getWidth() % rhs._image->getHeight()));
329  }
330  transform_pixels(_image->_getRawView(), // lhs
331  rhs._image->_getRawView(), // rhs,
332  _variance->_getRawView(), // Var(lhs),
333  rhs._variance->_getRawView(), // Var(rhs)
334  _variance->_getRawView(), // result
335  scaledProductVariance<ImagePixelT, VariancePixelT>(c));
336 
337  (*_image).scaledMultiplies(c, *rhs.getImage());
338  *_mask |= *rhs.getMask();
339 }

◆ scaledPlus()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
void lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::scaledPlus ( double const  c,
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &  rhs 
)

Add a scaled MaskedImage c*rhs to a MaskedImage.

The image and variances are added; the masks are ORd together

Note
The pixels in the two images are taken to be independent. There is a Pixel operation (plus) which models the covariance, but this is not (yet?) available as full-MaskedImage operators

Definition at line 241 of file MaskedImage.cc.

242  {
243  (*_image).scaledPlus(c, *rhs.getImage());
244  *_mask |= *rhs.getMask();
245  (*_variance).scaledPlus(c * c, *rhs.getVariance());
246 }

◆ setImage()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
void lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::setImage ( Image const &  other)
inline

Set the image plane's pixel values to those of another Image.

This copies pixel values, not pointers.

Exceptions
pex::exceptions::LengthErrorif dimensions do not match.

Definition at line 1027 of file MaskedImage.h.

1027 { _image->assign(other); }

◆ setMask()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
void lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::setMask ( Mask const &  other)
inline

Set the mask plane's pixel values to those of another Mask.

This copies pixel values, not pointers.

Exceptions
pex::exceptions::LengthErrorif dimensions do not match.

Definition at line 1039 of file MaskedImage.h.

1039 { _mask->assign(other); }

◆ setVariance()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
void lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::setVariance ( Variance const &  other)
inline

Set the variance plane's pixel values to those of another Image.

This copies pixel values, not pointers.

Exceptions
pex::exceptions::LengthErrorif dimensions do not match.

Definition at line 1048 of file MaskedImage.h.

1048 { _variance->assign(other); }

◆ setXY0() [1/2]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
void lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::setXY0 ( int const  x0,
int const  y0 
)
inline

Set the MaskedImage's origin.

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 1092 of file MaskedImage.h.

1092 { setXY0(lsst::geom::Point2I(x0, y0)); }
void setXY0(int const x0, int const y0)
Set the MaskedImage's origin.
Definition: MaskedImage.h:1092

◆ setXY0() [2/2]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
void lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::setXY0 ( lsst::geom::Point2I const  origin)
inline

Set the MaskedImage's origin.

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 1102 of file MaskedImage.h.

1102  {
1103  if (_image) {
1104  _image->setXY0(origin);
1105  }
1106 
1107  if (_mask) {
1108  _mask->setXY0(origin);
1109  }
1110 
1111  if (_variance) {
1112  _variance->setXY0(origin);
1113  }
1114  }

◆ subset()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
MaskedImage lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::subset ( lsst::geom::Box2I const &  bbox,
ImageOrigin  origin = PARENT 
) const
inline

Return a subimage corresponding to the given box.

Parameters
bboxBounding box of the subimage returned.
originOrigin bbox is rleative 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 762 of file MaskedImage.h.

762  {
763  return MaskedImage(*this, bbox, origin, false);
764  }

◆ swap()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
void lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::swap ( MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > &  rhs)

Definition at line 193 of file MaskedImage.cc.

193  {
194  using std::swap; // See Meyers, Effective C++, Item 25
195 
196  _image.swap(rhs._image);
197  _mask.swap(rhs._mask);
198  _variance.swap(rhs._variance);
199 }
T swap(T... args)

◆ writeFits() [1/6]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
void lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::writeFits ( fits::Fits fitsfile,
fits::ImageWriteOptions const &  imageOptions,
fits::ImageWriteOptions const &  maskOptions,
fits::ImageWriteOptions const &  varianceOptions,
std::shared_ptr< daf::base::PropertySet const >  metadata = nullptr,
std::shared_ptr< daf::base::PropertySet const >  imageMetadata = nullptr,
std::shared_ptr< daf::base::PropertySet const >  maskMetadata = nullptr,
std::shared_ptr< daf::base::PropertySet const >  varianceMetadata = nullptr 
) const

Write a MaskedImage to a FITS file.

Parameters
[in]fitsfileAn empty FITS file object.
[in]imageOptionsOptions controlling writing of image as FITS.
[in]maskOptionsOptions controlling writing of mask as FITS.
[in]varianceOptionsOptions controlling writing of variance as FITS.
[in]metadataAdditional values to write to the primary HDU header (may be null).
[in]imageMetadataMetadata to be written to the image header.
[in]maskMetadataMetadata to be written to the mask header.
[in]varianceMetadataMetadata to be written to the variance header.

The FITS file will have four HDUs; the primary HDU will contain only metadata, while the image, mask, and variance HDU headers will use the "INHERIT='T'" convention to indicate that the primary metadata applies to those HDUs as well.

Definition at line 493 of file MaskedImage.cc.

499  {
501  if (metadata) {
502  header = metadata->deepCopy();
503  } else {
504  header = std::make_shared<daf::base::PropertyList>();
505  }
506 
507  if (fitsfile.countHdus() != 0) {
508  throw LSST_EXCEPT(pex::exceptions::LogicError,
509  "MaskedImage::writeFits can only write to an empty file");
510  }
511  if (fitsfile.getHdu() < 1) {
512  // Don't ever write images to primary; instead we make an empty primary.
513  fitsfile.createEmpty();
514  } else {
515  fitsfile.setHdu(0);
516  }
517  fitsfile.writeMetadata(*header);
518 
519  processPlaneMetadata(imageMetadata, header, "IMAGE");
520  _image->writeFits(fitsfile, imageOptions, header, _mask);
521 
522  processPlaneMetadata(maskMetadata, header, "MASK");
523  _mask->writeFits(fitsfile, maskOptions, header);
524 
525  processPlaneMetadata(varianceMetadata, header, "VARIANCE");
526  _variance->writeFits(fitsfile, varianceOptions, header, _mask);
527 }

◆ writeFits() [2/6]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
void lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::writeFits ( fits::Fits fitsfile,
std::shared_ptr< daf::base::PropertySet const >  metadata = std::shared_ptr<daf::base::PropertySet const>(),
std::shared_ptr< daf::base::PropertySet const >  imageMetadata = std::shared_ptr<daf::base::PropertySet const>(),
std::shared_ptr< daf::base::PropertySet const >  maskMetadata = std::shared_ptr<daf::base::PropertySet const>(),
std::shared_ptr< daf::base::PropertySet const >  varianceMetadata = std::shared_ptr<daf::base::PropertySet const>() 
) const

Write a MaskedImage to a FITS file.

Parameters
[in]fitsfileAn empty FITS file object.
[in]metadataAdditional values to write to the primary HDU header (may be null).
[in]imageMetadataMetadata to be written to the image header.
[in]maskMetadataMetadata to be written to the mask header.
[in]varianceMetadataMetadata to be written to the variance header.

The FITS file will have four HDUs; the primary HDU will contain only metadata, while the image, mask, and variance HDU headers will use the "INHERIT='T'" convention to indicate that the primary metadata applies to those HDUs as well.

Definition at line 457 of file MaskedImage.cc.

461  {
462  writeFits(fitsfile, fits::ImageWriteOptions(*_image), fits::ImageWriteOptions(*_mask),
463  fits::ImageWriteOptions(*_variance), metadata, imageMetadata, maskMetadata, varianceMetadata);
464 }
void writeFits(std::string const &fileName, std::shared_ptr< daf::base::PropertySet const > metadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > imageMetadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > maskMetadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > varianceMetadata=std::shared_ptr< daf::base::PropertySet const >()) const
Write a MaskedImage to a regular FITS file.
Definition: MaskedImage.cc:421

◆ writeFits() [3/6]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
void lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::writeFits ( fits::MemFileManager manager,
fits::ImageWriteOptions const &  imageOptions,
fits::ImageWriteOptions const &  maskOptions,
fits::ImageWriteOptions const &  varianceOptions,
std::shared_ptr< daf::base::PropertySet const >  metadata = nullptr,
std::shared_ptr< daf::base::PropertySet const >  imageMetadata = nullptr,
std::shared_ptr< daf::base::PropertySet const >  maskMetadata = nullptr,
std::shared_ptr< daf::base::PropertySet const >  varianceMetadata = nullptr 
) const

Write a MaskedImage to a FITS file.

Parameters
[in]managerManager object for the memory block to write to.
[in]imageOptionsOptions controlling writing of image as FITS.
[in]maskOptionsOptions controlling writing of mask as FITS.
[in]varianceOptionsOptions controlling writing of variance as FITS.
[in]metadataAdditional values to write to the primary HDU header (may be null).
[in]imageMetadataMetadata to be written to the image header.
[in]maskMetadataMetadata to be written to the mask header.
[in]varianceMetadataMetadata to be written to the variance header.

The FITS file will have four HDUs; the primary HDU will contain only metadata, while the image, mask, and variance HDU headers will use the "INHERIT='T'" convention to indicate that the primary metadata applies to those HDUs as well.

Definition at line 480 of file MaskedImage.cc.

486  {
487  fits::Fits fitsfile(manager, "w", fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
488  writeFits(fitsfile, imageOptions, maskOptions, varianceOptions, metadata, imageMetadata, maskMetadata,
489  varianceMetadata);
490 }

◆ writeFits() [4/6]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
void lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::writeFits ( fits::MemFileManager manager,
std::shared_ptr< daf::base::PropertySet const >  metadata = std::shared_ptr<daf::base::PropertySet const>(),
std::shared_ptr< daf::base::PropertySet const >  imageMetadata = std::shared_ptr<daf::base::PropertySet const>(),
std::shared_ptr< daf::base::PropertySet const >  maskMetadata = std::shared_ptr<daf::base::PropertySet const>(),
std::shared_ptr< daf::base::PropertySet const >  varianceMetadata = std::shared_ptr<daf::base::PropertySet const>() 
) const

Write a MaskedImage to a FITS RAM file.

Parameters
[in]managerManager object for the memory block to write to.
[in]metadataAdditional values to write to the primary HDU header (may be null).
[in]imageMetadataMetadata to be written to the image header.
[in]maskMetadataMetadata to be written to the mask header.
[in]varianceMetadataMetadata to be written to the variance header.

The FITS file will have four HDUs; the primary HDU will contain only metadata, while the image, mask, and variance HDU headers will use the "INHERIT='T'" convention to indicate that the primary metadata applies to those HDUs as well.

Definition at line 431 of file MaskedImage.cc.

435  {
436  fits::Fits fitsfile(manager, "w", fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
437  writeFits(fitsfile, metadata, imageMetadata, maskMetadata, varianceMetadata);
438 }

◆ writeFits() [5/6]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
void lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::writeFits ( std::string const &  fileName,
fits::ImageWriteOptions const &  imageOptions,
fits::ImageWriteOptions const &  maskOptions,
fits::ImageWriteOptions const &  varianceOptions,
std::shared_ptr< daf::base::PropertySet const >  metadata = nullptr,
std::shared_ptr< daf::base::PropertySet const >  imageMetadata = nullptr,
std::shared_ptr< daf::base::PropertySet const >  maskMetadata = nullptr,
std::shared_ptr< daf::base::PropertySet const >  varianceMetadata = nullptr 
) const

Write a MaskedImage to a FITS file.

Parameters
[in]fileNameName of the file to write.
[in]imageOptionsOptions controlling writing of image as FITS.
[in]maskOptionsOptions controlling writing of mask as FITS.
[in]varianceOptionsOptions controlling writing of variance as FITS.
[in]metadataAdditional values to write to the primary HDU header (may be null).
[in]imageMetadataMetadata to be written to the image header.
[in]maskMetadataMetadata to be written to the mask header.
[in]varianceMetadataMetadata to be written to the variance header.

The FITS file will have four HDUs; the primary HDU will contain only metadata, while the image, mask, and variance HDU headers will use the "INHERIT='T'" convention to indicate that the primary metadata applies to those HDUs as well.

Definition at line 467 of file MaskedImage.cc.

473  {
474  fits::Fits fitsfile(fileName, "w", fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
475  writeFits(fitsfile, imageOptions, maskOptions, varianceOptions, metadata, imageMetadata, maskMetadata,
476  varianceMetadata);
477 }

◆ writeFits() [6/6]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
void lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::writeFits ( std::string const &  fileName,
std::shared_ptr< daf::base::PropertySet const >  metadata = std::shared_ptr<daf::base::PropertySet const>(),
std::shared_ptr< daf::base::PropertySet const >  imageMetadata = std::shared_ptr<daf::base::PropertySet const>(),
std::shared_ptr< daf::base::PropertySet const >  maskMetadata = std::shared_ptr<daf::base::PropertySet const>(),
std::shared_ptr< daf::base::PropertySet const >  varianceMetadata = std::shared_ptr<daf::base::PropertySet const>() 
) const

Write a MaskedImage to a regular FITS file.

Parameters
[in]fileNameName of the file to write. When writing separate files, this is the "base" of the filename (e.g. foo reads foo_{img.msk.var}.fits).
[in]metadataAdditional values to write to the primary HDU header (may be null).
[in]imageMetadataMetadata to be written to the image header.
[in]maskMetadataMetadata to be written to the mask header.
[in]varianceMetadataMetadata to be written to the variance header.

The FITS file will have four HDUs; the primary HDU will contain only metadata, while the image, mask, and variance HDU headers will use the "INHERIT='T'" convention to indicate that the primary metadata applies to those HDUs as well.

Definition at line 421 of file MaskedImage.cc.

425  {
426  fits::Fits fitsfile(fileName, "w", fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
427  writeFits(fitsfile, metadata, imageMetadata, maskMetadata, varianceMetadata);
428 }

◆ x_at()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
x_iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::x_at ( int  x,
int  y 
) const
inline

Return an x_iterator at the point (x, y)

Definition at line 1180 of file MaskedImage.h.

1180  {
1181 #if 0
1182  typename Image::x_iterator imageEnd = getImage()->x_at(x, y);
1183  typename Mask::x_iterator maskEnd = getMask()->x_at(x, y);
1184  typename Variance::x_iterator varianceEnd = getVariance()->x_at(x, y);
1185 #else // bypass checks for non-NULL pointers
1186  typename Image::x_iterator imageEnd = _image->x_at(x, y);
1187  typename Mask::x_iterator maskEnd = _mask->x_at(x, y);
1188  typename Variance::x_iterator varianceEnd = _variance->x_at(x, y);
1189 #endif
1190 
1191  return x_iterator(imageEnd, maskEnd, varianceEnd);
1192  }

◆ xy_at()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
xy_locator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::xy_at ( int  x,
int  y 
) const
inline

Return an xy_locator at the point (x, y)

Definition at line 1214 of file MaskedImage.h.

1214  {
1215 #if 0
1216  typename Image::xy_locator imageEnd = getImage()->xy_at(x, y);
1217  typename Mask::xy_locator maskEnd = getMask()->xy_at(x, y);
1218  typename Variance::xy_locator varianceEnd = getVariance()->xy_at(x, y);
1219 #else // bypass checks for non-NULL pointers
1220  typename Image::xy_locator imageEnd = _image->xy_at(x, y);
1221  typename Mask::xy_locator maskEnd = _mask->xy_at(x, y);
1222  typename Variance::xy_locator varianceEnd = _variance->xy_at(x, y);
1223 #endif
1224 
1225  return xy_locator(imageEnd, maskEnd, varianceEnd);
1226  }
typename _view_t::xy_locator xy_locator
An xy_locator.
Definition: ImageBase.h:121
MaskedImageLocator< typename Image::xy_locator, typename Mask::xy_locator, typename Variance::xy_locator > xy_locator
A locator for a MaskedImage.
Definition: MaskedImage.h:553

◆ y_at()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
y_iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::y_at ( int  x,
int  y 
) const
inline

Return an y_iterator at the point (x, y)

Definition at line 1200 of file MaskedImage.h.

1200  {
1201 #if 0
1202  typename Image::y_iterator imageEnd = getImage()->y_at(x, y);
1203  typename Mask::y_iterator maskEnd = getMask()->y_at(x, y);
1204  typename Variance::y_iterator varianceEnd = getVariance()->y_at(x, y);
1205 #else // bypass checks for non-NULL pointers
1206  typename Image::y_iterator imageEnd = _image->y_at(x, y);
1207  typename Mask::y_iterator maskEnd = _mask->y_at(x, y);
1208  typename Variance::y_iterator varianceEnd = _variance->y_at(x, y);
1209 #endif
1210  return y_iterator(imageEnd, maskEnd, varianceEnd);
1211  }

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