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

Public Types
using	IMV_tuple = typename boost::zip_iterator<IMV_iterator_tuple>::reference
	The underlying iterator tuple.

using	type = Pixel
	Type pointed to by the iterator.

Public Member Functions
	MaskedImageIteratorBase (ImageIterator const &img, MaskIterator const &msk, VarianceIterator const &var)
	Construct a MaskedImageIteratorBase from the image/mask/variance iterators.

Ref< ImagePixelT >::type	image ()
	Return (a reference to) the image part of the Pixel pointed at by the iterator.

Ref< MaskPixelT >::type	mask ()
	Return (a reference to) the mask part of the Pixel pointed at by the iterator.

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

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

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

using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::IMV_tuple = typename boost::zip_iterator<IMV_iterator_tuple>::reference

The underlying iterator tuple.

Note: not really for public consumption; could be made protected

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

using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageIteratorBase< ImageIterator, MaskIterator, VarianceIterator, Ref >::type = Pixel

Type pointed to by the iterator.

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

138 : _iter(boost::make_zip_iterator(boost::make_tuple(img, msk, var))) {}

lsst::afw::image::MaskedImage

A class to manipulate images, masks, and variance as a single object.

Definition MaskedImage.h:74

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 151 of file MaskedImage.h.

151{ return _iter.get_iterator_tuple(); }

◆ 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 140 of file MaskedImage.h.

140{ return _iter->template get<0>()[0]; }

◆ 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 143 of file MaskedImage.h.

143{ return _iter->template get<1>()[0]; }

◆ 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 193 of file MaskedImage.h.

                               {
            return Pixel(_iter->template get<0>()[0], _iter->template get<1>()[0],
                         _iter->template get<2>()[0]);
        }

◆ 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 185 of file MaskedImage.h.

                                                            {
            return &this->_iter->template get<0>() != &rhs._iter->template get<0>();
        }

◆ 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 199 of file MaskedImage.h.

199{ return Pixel(image(), mask(), variance()); }

◆ 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 201 of file MaskedImage.h.

201{ return Pixel(image(), mask(), variance()); }

◆ 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 166 of file MaskedImage.h.

                                              {  // prefix
            ++_iter;
            return *this;
        }

◆ 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 171 of file MaskedImage.h.

                                                {  // postfix
            MaskedImageIteratorBase tmp(*this);
            _iter++;
            return tmp;
        }

◆ 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

delta how far to move the iterator

Definition at line 154 of file MaskedImage.h.

          {
            _iter += delta;
            return *this;
        }

◆ 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 177 of file MaskedImage.h.

                                                                   {
            return &this->_iter->template get<0>() - &rhs._iter->template get<0>();
        }

◆ 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

delta how far to move the iterator

Definition at line 160 of file MaskedImage.h.

          {
            _iter -= delta;
            return *this;
        }

◆ 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 189 of file MaskedImage.h.

                                                           {
            return &this->_iter->template get<0>() < &rhs._iter->template get<0>();
        }

◆ 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 181 of file MaskedImage.h.

                                                            {
            return &this->_iter->template get<0>() == &rhs._iter->template get<0>();
        }

◆ 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 146 of file MaskedImage.h.

146{ return _iter->template get<2>()[0]; }

Friends And Related Symbol 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 131 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 204 of file MaskedImage.h.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/afw/g7ae74a0b1c+a25e60b391/include/lsst/afw/image/MaskedImage.h

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ IMV_tuple

◆ type

Constructor & Destructor Documentation

◆ MaskedImageIteratorBase()

Member Function Documentation

◆ get_iterator_tuple()

◆ image()

◆ mask()

◆ operator Pixel()

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator<()

◆ operator==()

◆ variance()

Friends And Related Symbol Documentation

◆ const_MaskedImageIterator

Member Data Documentation

◆ _iter