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 >:

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_MaskedImageIterator &	operator+ (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.

MaskedImageIteratorBase &	operator+= (std::ptrdiff_t delta)
	Increment the iterator by `delta`

MaskedImageIteratorBase &	operator-= (std::ptrdiff_t delta)
	Decrement the iterator by `delta`

MaskedImageIteratorBase &	operator++ ()
	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.

                : MaskedImageIteratorBase_t(
                          const_ImageIterator(iter.get_iterator_tuple().template get<0>()),
                          const_MaskIterator(iter.get_iterator_tuple().template get<1>()),
                          const_VarianceIterator(iter.get_iterator_tuple().template get<2>())) {
            ;
        }

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

Return a const_MaskedImageIterator that's delta beyond this.

Definition at line 248 of file MaskedImage.h.

                                                                 {
            const_MaskedImageIterator lhs = *this;
            lhs += delta;
 
            return lhs;
        }

◆ 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

delta how 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

delta how 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:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+be83d3ecdb/include/lsst/afw/image/MaskedImage.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ IMV_tuple

◆ type

Constructor & Destructor Documentation

◆ const_MaskedImageIterator()

Member Function Documentation

◆ get_iterator_tuple()

◆ image()

◆ mask()

◆ operator Pixel()

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator+()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator<()

◆ operator==()

◆ variance()

Member Data Documentation

◆ _iter