lsst.afw  21.0.0-23-g03fb9f672+f385fa6f38
Public Types | Public Member Functions | Protected Attributes | List of all members
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::const_MaskedImageIterator< ImageIterator, MaskIterator, VarianceIterator > Class Template Reference

An const iterator to the MaskedImage. More...

#include <MaskedImage.h>

Inheritance diagram for lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::const_MaskedImageIterator< ImageIterator, MaskIterator, VarianceIterator >:
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type, detail::const_iterator_type< MaskIterator >::type, detail::const_iterator_type< VarianceIterator >::type, ConstReference >

Public Types

typedef boost::zip_iterator< IMV_iterator_tuple >::reference IMV_tuple
 The underlying iterator tuple. More...
 
typedef Pixel type
 Type pointed to by the iterator. More...
 

Public Member Functions

 const_MaskedImageIterator (MaskedImageIterator< ImageIterator, MaskIterator, VarianceIterator > const &iter)
 
const_MaskedImageIteratoroperator+ (std::ptrdiff_t delta)
 Return a const_MaskedImageIterator that's delta beyond this. More...
 
ConstReference< ImagePixelT >::type image ()
 Return (a reference to) the image part of the Pixel pointed at by the iterator. More...
 
ConstReference< MaskPixelT >::type mask ()
 Return (a reference to) the mask part of the Pixel pointed at by the iterator. More...
 
ConstReference< 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
 Return the underlying iterator tuple. More...
 
MaskedImageIteratorBaseoperator+= (std::ptrdiff_t delta)
 Increment the iterator by delta More...
 
MaskedImageIteratorBaseoperator-= (std::ptrdiff_t delta)
 Decrement the iterator by delta More...
 
MaskedImageIteratorBaseoperator++ ()
 Increment the iterator (prefix) More...
 
MaskedImageIteratorBase 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...
 

Protected Attributes

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 ImageIterator, typename MaskIterator, typename VarianceIterator>
class lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::const_MaskedImageIterator< ImageIterator, MaskIterator, VarianceIterator >

An const iterator to the MaskedImage.

An const iterator for a MaskedImage.

Definition at line 227 of file MaskedImage.h.

Member Typedef Documentation

◆ IMV_tuple

typedef boost::zip_iterator<IMV_iterator_tuple>::reference lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::IMV_tuple
inherited

The underlying iterator tuple.

Note
not really for public consumption; could be made protected

Definition at line 125 of file MaskedImage.h.

◆ type

typedef Pixel lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::type
inherited

Type pointed to by the iterator.

Definition at line 132 of file MaskedImage.h.

Constructor & Destructor Documentation

◆ const_MaskedImageIterator()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageIterator , typename MaskIterator , typename VarianceIterator >
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::const_MaskedImageIterator< ImageIterator, MaskIterator, VarianceIterator >::const_MaskedImageIterator ( MaskedImageIterator< ImageIterator, MaskIterator, VarianceIterator > const &  iter)
inline

Definition at line 241 of file MaskedImage.h.

Member Function Documentation

◆ get_iterator_tuple()

const IMV_iterator_tuple lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::get_iterator_tuple ( ) const
inlineinherited

Return the underlying iterator tuple.

Note
not really for public consumption; could be made protected

Definition at line 150 of file MaskedImage.h.

◆ image()

ConstReference <ImagePixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::image ( )
inlineinherited

Return (a reference to) the image part of the Pixel pointed at by the iterator.

Definition at line 139 of file MaskedImage.h.

◆ mask()

ConstReference <MaskPixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::mask ( )
inlineinherited

Return (a reference to) the mask part of the Pixel pointed at by the iterator.

Definition at line 142 of file MaskedImage.h.

◆ operator Pixel()

lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::operator Pixel ( ) const
inlineinherited

Convert an iterator to a Pixel.

Definition at line 192 of file MaskedImage.h.

◆ operator!=()

bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::operator!= ( MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type, detail::const_iterator_type< MaskIterator >::type, detail::const_iterator_type< VarianceIterator >::type, ConstReference > const &  rhs)
inlineinherited

Return true if the lhs doesn't equal the rhs.

Definition at line 184 of file MaskedImage.h.

◆ operator*() [1/2]

Pixel lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::operator* ( )
inlineinherited

Dereference the iterator, returning a Pixel.

Definition at line 198 of file MaskedImage.h.

◆ operator*() [2/2]

const Pixel lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::operator* ( ) const
inlineinherited

Dereference the iterator, returning a const Pixel.

Definition at line 200 of file MaskedImage.h.

◆ operator+()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageIterator , typename MaskIterator , typename VarianceIterator >
const_MaskedImageIterator& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::const_MaskedImageIterator< ImageIterator, MaskIterator, VarianceIterator >::operator+ ( std::ptrdiff_t  delta)
inline

Return a const_MaskedImageIterator that's delta beyond this.

Definition at line 250 of file MaskedImage.h.

◆ operator++() [1/2]

MaskedImageIteratorBase& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::operator++ ( )
inlineinherited

Increment the iterator (prefix)

Definition at line 165 of file MaskedImage.h.

◆ operator++() [2/2]

MaskedImageIteratorBase lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::operator++ ( int  )
inlineinherited

Increment the iterator (postfix)

Definition at line 170 of file MaskedImage.h.

◆ operator+=()

MaskedImageIteratorBase& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::operator+= ( std::ptrdiff_t  delta)
inlineinherited

Increment the iterator by delta

Parameters
deltahow far to move the iterator

Definition at line 153 of file MaskedImage.h.

◆ operator-()

std::ptrdiff_t lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::operator- ( MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type, detail::const_iterator_type< MaskIterator >::type, detail::const_iterator_type< VarianceIterator >::type, ConstReference > const &  rhs)
inlineinherited

Return the distance between two iterators.

Definition at line 176 of file MaskedImage.h.

◆ operator-=()

MaskedImageIteratorBase& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::operator-= ( std::ptrdiff_t  delta)
inlineinherited

Decrement the iterator by delta

Parameters
deltahow far to move the iterator

Definition at line 159 of file MaskedImage.h.

◆ operator<()

bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::operator< ( MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type, detail::const_iterator_type< MaskIterator >::type, detail::const_iterator_type< VarianceIterator >::type, ConstReference > const &  rhs)
inlineinherited

Return true if the lhs is less than the rhs.

Definition at line 188 of file MaskedImage.h.

◆ operator==()

bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::operator== ( MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type, detail::const_iterator_type< MaskIterator >::type, detail::const_iterator_type< VarianceIterator >::type, ConstReference > const &  rhs)
inlineinherited

Return true if the lhs equals the rhs.

Definition at line 180 of file MaskedImage.h.

◆ variance()

ConstReference <VariancePixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::variance ( )
inlineinherited

Return (a reference to) the variance part of the Pixel pointed at by the iterator.

Definition at line 145 of file MaskedImage.h.

Member Data Documentation

◆ _iter

boost::zip_iterator<IMV_iterator_tuple> lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< detail::const_iterator_type< ImageIterator >::type , detail::const_iterator_type< MaskIterator >::type , detail::const_iterator_type< VarianceIterator >::type , ConstReference >::_iter
protectedinherited

Definition at line 203 of file MaskedImage.h.


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