lsst.afw  22.0.1-22-gf1d71818e+4206820b0d
Public Types | Public Member Functions | Protected Attributes | Friends | List of all members
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref > Class Template Reference

The base class for MaskedImageIterators (const and non-const) More...

#include <MaskedImage.h>

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

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

 MaskedImageIteratorBase (ImageIterator const &img, MaskIterator const &msk, VarianceIterator const &var)
 Construct a MaskedImageIteratorBase from the image/mask/variance iterators. More...
 
Ref< ImagePixelT >::type image ()
 Return (a reference to) the image part of the Pixel pointed at by the iterator. More...
 
Ref< MaskPixelT >::type mask ()
 Return (a reference to) the mask part of the Pixel pointed at by the iterator. More...
 
Ref< 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
 

Friends

template<typename , typename , typename >
class const_MaskedImageIterator
 The underlying const iterator tuple. More...
 

Detailed Description

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageIterator, typename MaskIterator, typename VarianceIterator, template< typename > class Ref = Reference>
class lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >

The base class for MaskedImageIterators (const and non-const)

Definition at line 118 of file MaskedImage.h.

Member Typedef Documentation

◆ IMV_tuple

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageIterator , typename MaskIterator , typename VarianceIterator , template< typename > class Ref = Reference>
typedef boost::zip_iterator<IMV_iterator_tuple>::reference lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::IMV_tuple

The underlying iterator tuple.

Note
not really for public consumption; could be made protected

Definition at line 125 of file MaskedImage.h.

◆ type

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageIterator , typename MaskIterator , typename VarianceIterator , template< typename > class Ref = Reference>
typedef Pixel lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::type

Type pointed to by the iterator.

Definition at line 132 of file MaskedImage.h.

Constructor & Destructor Documentation

◆ MaskedImageIteratorBase()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageIterator , typename MaskIterator , typename VarianceIterator , template< typename > class Ref = Reference>
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::MaskedImageIteratorBase ( ImageIterator const &  img,
MaskIterator const &  msk,
VarianceIterator const &  var 
)
inline

Construct a MaskedImageIteratorBase from the image/mask/variance iterators.

Definition at line 135 of file MaskedImage.h.

Member Function Documentation

◆ get_iterator_tuple()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageIterator , typename MaskIterator , typename VarianceIterator , template< typename > class Ref = Reference>
const IMV_iterator_tuple lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::get_iterator_tuple ( ) const
inline

Return the underlying iterator tuple.

Note
not really for public consumption; could be made protected

Definition at line 150 of file MaskedImage.h.

◆ image()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageIterator , typename MaskIterator , typename VarianceIterator , template< typename > class Ref = Reference>
Ref<ImagePixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::image ( )
inline

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

Definition at line 139 of file MaskedImage.h.

◆ mask()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageIterator , typename MaskIterator , typename VarianceIterator , template< typename > class Ref = Reference>
Ref<MaskPixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::mask ( )
inline

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()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageIterator , typename MaskIterator , typename VarianceIterator , template< typename > class Ref = Reference>
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::operator Pixel ( ) const
inline

Convert an iterator to a Pixel.

Definition at line 192 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 , template< typename > class Ref = Reference>
bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::operator!= ( MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref > const &  rhs)
inline

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

Definition at line 184 of file MaskedImage.h.

◆ operator*() [1/2]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageIterator , typename MaskIterator , typename VarianceIterator , template< typename > class Ref = Reference>
Pixel lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::operator* ( )
inline

Dereference the iterator, returning a Pixel.

Definition at line 198 of file MaskedImage.h.

◆ operator*() [2/2]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageIterator , typename MaskIterator , typename VarianceIterator , template< typename > class Ref = Reference>
const Pixel lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::operator* ( ) const
inline

Dereference the iterator, returning a const Pixel.

Definition at line 200 of file MaskedImage.h.

◆ operator++() [1/2]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageIterator , typename MaskIterator , typename VarianceIterator , template< typename > class Ref = Reference>
MaskedImageIteratorBase& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::operator++ ( )
inline

Increment the iterator (prefix)

Definition at line 165 of file MaskedImage.h.

◆ operator++() [2/2]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageIterator , typename MaskIterator , typename VarianceIterator , template< typename > class Ref = Reference>
MaskedImageIteratorBase lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::operator++ ( int  )
inline

Increment the iterator (postfix)

Definition at line 170 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 , template< typename > class Ref = Reference>
MaskedImageIteratorBase& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::operator+= ( std::ptrdiff_t  delta)
inline

Increment the iterator by delta

Parameters
deltahow far to move the iterator

Definition at line 153 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 , template< typename > class Ref = Reference>
std::ptrdiff_t lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::operator- ( MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref > const &  rhs)
inline

Return the distance between two iterators.

Definition at line 176 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 , template< typename > class Ref = Reference>
MaskedImageIteratorBase& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::operator-= ( std::ptrdiff_t  delta)
inline

Decrement the iterator by delta

Parameters
deltahow far to move the iterator

Definition at line 159 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 , template< typename > class Ref = Reference>
bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::operator< ( MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref > const &  rhs)
inline

Return true if the lhs is less than the rhs.

Definition at line 188 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 , template< typename > class Ref = Reference>
bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::operator== ( MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref > const &  rhs)
inline

Return true if the lhs equals the rhs.

Definition at line 180 of file MaskedImage.h.

◆ variance()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageIterator , typename MaskIterator , typename VarianceIterator , template< typename > class Ref = Reference>
Ref<VariancePixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::variance ( )
inline

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

Definition at line 145 of file MaskedImage.h.

Friends And Related Function 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 , template< typename > class Ref = Reference>
template<typename , typename , typename >
friend class const_MaskedImageIterator
friend

The underlying const iterator tuple.

Note
not really for public consumption; could be made protected

Definition at line 130 of file MaskedImage.h.

Member Data Documentation

◆ _iter

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageIterator , typename MaskIterator , typename VarianceIterator , template< typename > class Ref = Reference>
boost::zip_iterator<IMV_iterator_tuple> lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::_iter
protected

Definition at line 203 of file MaskedImage.h.


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