LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
Public Member Functions | Private Types | List of all members
lsst.afw.image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIterator< typename, typename, typename > Class Template Reference

An iterator to the MaskedImage. More...

#include <MaskedImage.h>

Inheritance diagram for lsst.afw.image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIterator< typename, typename, typename >:
lsst.afw.image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator > lsst.afw.math::MaskedVector< EntryT >::iterator

Public Member Functions

 MaskedImageIterator (ImageIterator &img, MaskIterator &msk, VarianceIterator &var)
 
MaskedImageIterator operator+ (std::ptrdiff_t delta)
 Return a MaskedImageIterator that's delta beyond this. More...
 
- Public Member Functions inherited from lsst.afw.image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator >
 MaskedImageIteratorBase (ImageIterator const &img, MaskIterator const &msk, VarianceIterator const &var)
 Construct a MaskedImageIteratorBase from the image/mask/variance iterators. More...
 
Reference< ImagePixelT >::type image ()
 Return (a reference to) the image part of the Pixel pointed at by the iterator. More...
 
Reference< MaskPixelT >::type mask ()
 Return (a reference to) the mask part of the Pixel pointed at by the iterator. More...
 
Reference< VariancePixelT >::type variance ()
 Return (a reference to) the variance part of the Pixel pointed at by the iterator. More...
 
const IMV_iterator_tuple get_iterator_tuple () const
 
void operator+= (std::ptrdiff_t delta)
 Increment the iterator by delta. More...
 
void operator-= (std::ptrdiff_t delta)
 Decrement the iterator by delta. More...
 
void operator++ ()
 Increment the iterator (prefix) More...
 
void operator++ (int)
 Increment the iterator (postfix) More...
 
std::ptrdiff_t operator- (MaskedImageIteratorBase const &rhs)
 Return the distance between two iterators. More...
 
bool operator== (MaskedImageIteratorBase const &rhs)
 Return true if the lhs equals the rhs. More...
 
bool operator!= (MaskedImageIteratorBase const &rhs)
 Return true if the lhs doesn't equal the rhs. More...
 
bool operator< (MaskedImageIteratorBase const &rhs)
 Return true if the lhs is less than the rhs. More...
 
 operator Pixel () const
 Convert an iterator to a Pixel. More...
 
Pixel operator* ()
 Dereference the iterator, returning a Pixel. More...
 
const Pixel operator* () const
 Dereference the iterator, returning a const Pixel. More...
 

Private Types

typedef
MaskedImageIteratorBase
< ImageIterator, MaskIterator,
VarianceIterator > 
MaskedImageIteratorBase_t
 

Additional Inherited Members

- Public Types inherited from lsst.afw.image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator >
typedef boost::zip_iterator
< IMV_iterator_tuple >
::reference 
IMV_tuple
 
typedef Pixel type
 Type pointed to by the iterator. More...
 
- Protected Attributes inherited from lsst.afw.image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator >
boost::zip_iterator
< IMV_iterator_tuple
_iter
 

Detailed Description

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

An iterator to the MaskedImage.

An iterator for a MaskedImage.

Definition at line 109 of file MaskedImage.h.

Member Typedef Documentation

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename , typename , typename >
typedef MaskedImageIteratorBase<ImageIterator, MaskIterator, VarianceIterator> lsst.afw.image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIterator< typename, typename, typename >::MaskedImageIteratorBase_t
private

Definition at line 225 of file MaskedImage.h.

Constructor & Destructor Documentation

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename , typename , typename >
lsst.afw.image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIterator< typename, typename, typename >::MaskedImageIterator ( ImageIterator &  img,
MaskIterator &  msk,
VarianceIterator &  var 
)
inline

Definition at line 227 of file MaskedImage.h.

227  :
228  MaskedImageIteratorBase_t(img, msk, var) {
229  }
MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator > MaskedImageIteratorBase_t
Definition: MaskedImage.h:225

Member Function Documentation

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename , typename , typename >
MaskedImageIterator lsst.afw.image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIterator< typename, typename, typename >::operator+ ( std::ptrdiff_t  delta)
inline

Return a MaskedImageIterator that's delta beyond this.

Definition at line 231 of file MaskedImage.h.

231  {
232  MaskedImageIterator lhs = *this;
233  lhs += delta;
234 
235  return lhs;
236  }
MaskedImageIterator(ImageIterator &img, MaskIterator &msk, VarianceIterator &var)
Definition: MaskedImage.h:227

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