LSST Applications g1653933729+a8ce1bb630,g171997e3ee+76e92115be,g1a997c3884+a8ce1bb630,g28da252d5a+4013ff5194,g2bbee38e9b+d6d0f9f6ae,g2bc492864f+d6d0f9f6ae,g2cdde0e794+ccb74358b7,g3156d2b45e+07302053f8,g347aa1857d+d6d0f9f6ae,g35bb328faa+a8ce1bb630,g3a166c0a6a+d6d0f9f6ae,g3e281a1b8c+130fae20e3,g4005a62e65+17cd334064,g414038480c+c9f68e2a12,g41af890bb2+3e1f62f438,g4e1a3235cc+9db7d56ad0,g7b55021d1b+7b623691d5,g80478fca09+334cc8d2bd,g82479be7b0+b568f6b267,g858d7b2824+37b39d8760,g9125e01d80+a8ce1bb630,ga5288a1d22+11cb34fefe,gae0086650b+a8ce1bb630,gb4ec7eb0ab+37b39d8760,gb58c049af0+d64f4d3760,gc081298178+284e133171,gc28159a63d+d6d0f9f6ae,gcf0d15dbbd+00fe2e0b07,gd6b7c0dfd1+8b62435e69,gda3e153d99+37b39d8760,gda6a2b7d83+00fe2e0b07,gdaeeff99f8+1711a396fd,gdd5a9049c5+23f3b3239a,ge2409df99d+5d9f551a54,ge33fd446bb+37b39d8760,ge79ae78c31+d6d0f9f6ae,gf0baf85859+2dea8344a2,gf5289d68f6+3777f3df5e,w.2024.41
LSST Data Management Base Package
Loading...
Searching...
No Matches
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

using IMV_tuple
 The underlying iterator tuple.
 
using type
 Type pointed to by the iterator.
 

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.
 
ConstReference< ImagePixelT >::type image ()
 Return (a reference to) the image part of the Pixel pointed at by the iterator.
 
ConstReference< MaskPixelT >::type mask ()
 Return (a reference to) the mask part of the Pixel pointed at by the iterator.
 
ConstReference< VariancePixelT >::type variance ()
 Return (a reference to) the variance part of the Pixel pointed at by the iterator.
 
const IMV_iterator_tuple get_iterator_tuple () const
 Return the underlying iterator tuple.
 
MaskedImageIteratorBaseoperator+= (std::ptrdiff_t delta)
 Increment the iterator by delta
 
MaskedImageIteratorBaseoperator-= (std::ptrdiff_t delta)
 Decrement the iterator by delta
 
MaskedImageIteratorBaseoperator++ ()
 Increment the iterator (prefix)
 
MaskedImageIteratorBase operator++ (int)
 Increment the iterator (postfix)
 
std::ptrdiff_t operator- (MaskedImageIteratorBase const &rhs)
 Return the distance between two iterators.
 
bool operator== (MaskedImageIteratorBase const &rhs)
 Return true if the lhs equals the rhs.
 
bool operator!= (MaskedImageIteratorBase const &rhs)
 Return true if the lhs doesn't equal the rhs.
 
bool operator< (MaskedImageIteratorBase const &rhs)
 Return true if the lhs is less than the rhs.
 
 operator Pixel () const
 Convert an iterator to a Pixel.
 
Pixel operator* ()
 Dereference the iterator, returning a Pixel.
 
const Pixel operator* () const
 Dereference the iterator, returning a const Pixel.
 

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

using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, ConstReference >::IMV_tuple
inherited

The underlying iterator tuple.

Note
not really for public consumption; could be made protected

Definition at line 126 of file MaskedImage.h.

◆ type

using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, ConstReference >::type
inherited

Type pointed to by the iterator.

Definition at line 133 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 239 of file MaskedImage.h.

241 : MaskedImageIteratorBase_t(
242 const_ImageIterator(iter.get_iterator_tuple().template get<0>()),
243 const_MaskIterator(iter.get_iterator_tuple().template get<1>()),
244 const_VarianceIterator(iter.get_iterator_tuple().template get<2>())) {
245 ;
246 }

Member Function Documentation

◆ get_iterator_tuple()

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

Return the underlying iterator tuple.

Note
not really for public consumption; could be made protected

Definition at line 151 of file MaskedImage.h.

◆ image()

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

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

Definition at line 140 of file MaskedImage.h.

◆ mask()

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

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

Definition at line 143 of file MaskedImage.h.

◆ operator Pixel()

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

Convert an iterator to a Pixel.

Definition at line 193 of file MaskedImage.h.

◆ operator!=()

bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, 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 185 of file MaskedImage.h.

◆ operator*() [1/2]

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

Dereference the iterator, returning a Pixel.

Definition at line 199 of file MaskedImage.h.

◆ operator*() [2/2]

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

Dereference the iterator, returning a const Pixel.

Definition at line 201 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

◆ operator++() [1/2]

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

Increment the iterator (prefix)

Definition at line 166 of file MaskedImage.h.

◆ operator++() [2/2]

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

Increment the iterator (postfix)

Definition at line 171 of file MaskedImage.h.

◆ operator+=()

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

Increment the iterator by delta

Parameters
deltahow far to move the iterator

Definition at line 154 of file MaskedImage.h.

◆ operator-()

std::ptrdiff_t lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, 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 177 of file MaskedImage.h.

◆ operator-=()

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

Decrement the iterator by delta

Parameters
deltahow far to move the iterator

Definition at line 160 of file MaskedImage.h.

◆ operator<()

bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, 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 189 of file MaskedImage.h.

◆ operator==()

bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, 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 181 of file MaskedImage.h.

◆ variance()

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

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

Definition at line 146 of file MaskedImage.h.

Member Data Documentation

◆ _iter

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

Definition at line 204 of file MaskedImage.h.


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