A const locator for the MaskedImage. More...

#include <MaskedImage.h>

Inheritance diagram for lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::const_MaskedImageLocator< ImageLocator, MaskLocator, VarianceLocator >:

Public Types
typedef boost::tuple< typename ImageLocator::cached_location_t, typename MaskLocator::cached_location_t, typename VarianceLocator::cached_location_t >	IMVCachedLocation

typedef _x_or_y_iterator< apply_x >	x_iterator
	An x_iterator that provides a view of the xy_locator (i.e. advancing one advances the other) More...

typedef _x_or_y_iterator< apply_y >	y_iterator
	A y_iterator that provides a view of the xy_locator (i.e. advancing one advances the other) More...

typedef boost::mpl::vector< ImagePixelT, MaskPixelT, VariancePixelT >	PixelTVec

Public Member Functions
	const_MaskedImageLocator (MaskedImageLocator< ImageLocator, MaskLocator, VarianceLocator > const &iter)

Pixel	operator* ()
	Dereference a locator, returning a Pixel. More...

Pixel	operator() (int x, int y)
	Dereference a locator, returning a Pixel offset by `(x, y)` from the locator. More...

Pixel	operator[] (cached_location_t const &cached_loc)
	Dereference a locator, returning a Pixel offset by the amount set when we created the `cached_location_t` More...

x_iterator	x ()
	Return an iterator that can be used to move (or dereference) a locator. More...

y_iterator	y ()
	Return an iterator that can be used to move (or dereference) a locator. More...

cached_location_t	cache_location (int x, int y) const
	Create a cached_location_t offset by `(x, y)` from locator. More...

ConstReference< typename boost::mpl::at< PixelTVec, N >::type >::type	apply_IMV (cached_location_t const &cached_loc)

ConstReference< typename boost::mpl::at< PixelTVec, N >::type >::type	apply_IMV ()

ConstReference< typename boost::mpl::at< PixelTVec, N >::type >::type	apply_IMV (int x, int y)

ConstReference< ImagePixelT >::type	image (cached_location_t const &cached_loc)
	Return a reference to the image at the offset set when we created the `cached_location_t` More...

ConstReference< ImagePixelT >::type	image ()
	Return a reference to the image at the current position of the locator. More...

ConstReference< ImagePixelT >::type	image (int x, int y)
	Return a reference to the image offset by `(x, y)` from the current position of the locator. More...

ConstReference< MaskPixelT >::type	mask (cached_location_t const &cached_loc)
	Return a reference to the mask at the offset set when we created the `cached_location_t` More...

ConstReference< MaskPixelT >::type	mask ()
	Return a reference to the mask at the current position of the locator. More...

ConstReference< MaskPixelT >::type	mask (int x, int y)
	Return a reference to the mask offset by `(x, y)` from the current position of the locator. More...

ConstReference< VariancePixelT >::type	variance (cached_location_t const &cached_loc)
	Return a reference to the variance at the offset set when we created the `cached_location_t` More...

ConstReference< VariancePixelT >::type	variance ()
	Return a reference to the variance at the current position of the locator. More...

ConstReference< VariancePixelT >::type	variance (int x, int y)
	Return a reference to the variance offset by `(x, y)` from the current position of the locator. More...

bool	operator== (MaskedImageLocatorBase const &rhs)
	Return true iff two locators are equal. More...

bool	operator!= (MaskedImageLocatorBase const &rhs)
	Return true iff two locators are not equal. More...

bool	operator< (MaskedImageLocatorBase const &rhs)
	Return true iff lhs is less than rhs. More...

MaskedImageLocatorBase &	operator+= (pair2I const &p)
	Increment the locator's `x` and `y` positions by `p` More...

MaskedImageLocatorBase &	operator+= (detail::difference_type p)
	Increment the locator's `x` and `y` positions by `p` More...

IMVLocator const &	getLoc () const

Protected Attributes
IMVLocator	_loc

Detailed Description

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageLocator, typename MaskLocator, typename VarianceLocator>
class lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::const_MaskedImageLocator< ImageLocator, MaskLocator, VarianceLocator >

A const locator for the MaskedImage.

A const locator for a MaskedImage.

Definition at line 514 of file MaskedImage.h.

Member Typedef Documentation

◆ IMVCachedLocation

typedef boost::tuple<typename ImageLocator::cached_location_t, typename MaskLocator::cached_location_t, typename VarianceLocator::cached_location_t> lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::IMVCachedLocation

inherited

Definition at line 353 of file MaskedImage.h.

◆ PixelTVec

typedef boost::mpl::vector<ImagePixelT, MaskPixelT, VariancePixelT> lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::PixelTVec

inherited

Definition at line 420 of file MaskedImage.h.

◆ x_iterator

typedef _x_or_y_iterator<apply_x> lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::x_iterator

inherited

An x_iterator that provides a view of the xy_locator (i.e. advancing one advances the other)

Definition at line 355 of file MaskedImage.h.

◆ y_iterator

typedef _x_or_y_iterator<apply_y> lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::y_iterator

inherited

A y_iterator that provides a view of the xy_locator (i.e. advancing one advances the other)

Definition at line 357 of file MaskedImage.h.

Constructor & Destructor Documentation

◆ const_MaskedImageLocator()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>

template<typename ImageLocator , typename MaskLocator , typename VarianceLocator >

lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::const_MaskedImageLocator< ImageLocator, MaskLocator, VarianceLocator >::const_MaskedImageLocator ( MaskedImageLocator< ImageLocator, MaskLocator, VarianceLocator > const & iter )

inline

Definition at line 528 of file MaskedImage.h.

                 : MaskedImageLocatorBase_t(const_ImageLocator(iter.getLoc().template get<0>()),
                                            const_MaskLocator(iter.getLoc().template get<1>()),
                                            const_VarianceLocator(iter.getLoc().template get<2>())) {
             ;
         }

Member Function Documentation

◆ apply_IMV() [1/3]

ConstReference <typename boost::mpl::at<PixelTVec, N>::type>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::apply_IMV ( )

inlineinherited

Definition at line 429 of file MaskedImage.h.

                                                                             {
             return _loc.template get<N::value>()[0][0];
         }

◆ apply_IMV() [2/3]

ConstReference <typename boost::mpl::at<PixelTVec, N>::type>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::apply_IMV ( cached_location_t const & cached_loc )

inlineinherited

Definition at line 423 of file MaskedImage.h.

                                                      {
             return _loc.template get<N::value>()[cached_loc._imv.template get<N::value>()][0];
         }

◆ apply_IMV() [3/3]

ConstReference <typename boost::mpl::at<PixelTVec, N>::type>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::apply_IMV	(	int	x,
		int	y
	)

inlineinherited

Definition at line 434 of file MaskedImage.h.

                                                                                         {
             return _loc.template get<N::value>()(x, y)[0];
         }

◆ cache_location()

cached_location_t lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::cache_location	(	int	x,
		int	y
	)		const

inlineinherited

Create a cached_location_t offset by (x, y) from locator.

Definition at line 414 of file MaskedImage.h.

414 { return cached_location_t(_loc, x, y); }

◆ getLoc()

IMVLocator const& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::getLoc ( ) const

inlineinherited

Definition at line 496 of file MaskedImage.h.

496 { return _loc; }

◆ image() [1/3]

ConstReference <ImagePixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::image ( )

inlineinherited

Return a reference to the image at the current position of the locator.

Definition at line 445 of file MaskedImage.h.

445 { return apply_IMV<boost::mpl::int_<0>>(); }

◆ image() [2/3]

ConstReference <ImagePixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::image ( cached_location_t const & cached_loc )

inlineinherited

Return a reference to the image at the offset set when we created the cached_location_t

Definition at line 441 of file MaskedImage.h.

                                                                                  {
             return apply_IMV<boost::mpl::int_<0>>(cached_loc);
         }

◆ image() [3/3]

ConstReference <ImagePixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::image	(	int	x,
		int	y
	)

inlineinherited

Return a reference to the image offset by (x, y) from the current position of the locator.

Definition at line 447 of file MaskedImage.h.

447 { return apply_IMV<boost::mpl::int_<0>>(x, y); }

◆ mask() [1/3]

ConstReference <MaskPixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::mask ( )

inlineinherited

Return a reference to the mask at the current position of the locator.

Definition at line 454 of file MaskedImage.h.

454 { return apply_IMV<boost::mpl::int_<1>>(); }

◆ mask() [2/3]

ConstReference <MaskPixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::mask ( cached_location_t const & cached_loc )

inlineinherited

Return a reference to the mask at the offset set when we created the cached_location_t

Definition at line 450 of file MaskedImage.h.

                                                                                {
             return apply_IMV<boost::mpl::int_<1>>(cached_loc);
         }

◆ mask() [3/3]

ConstReference <MaskPixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::mask	(	int	x,
		int	y
	)

inlineinherited

Return a reference to the mask offset by (x, y) from the current position of the locator.

Definition at line 456 of file MaskedImage.h.

456 { return apply_IMV<boost::mpl::int_<1>>(x, y); }

◆ operator!=()

bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::operator!= ( MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type, detail::const_locator_type< MaskLocator >::type, detail::const_locator_type< VarianceLocator >::type, ConstReference > const & rhs )

inlineinherited

Return true iff two locators are not equal.

Definition at line 474 of file MaskedImage.h.

474 { return !(*this == rhs); }

◆ operator()()

Pixel lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::operator()	(	int	x,
		int	y
	)

inlineinherited

Dereference a locator, returning a Pixel offset by (x, y) from the locator.

Definition at line 389 of file MaskedImage.h.

                                        {
             return Pixel(_loc.template get<0>()(x, y)[0], _loc.template get<1>()(x, y)[0],
                          _loc.template get<2>()(x, y)[0]);
         }

◆ operator*()

Pixel lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::operator* ( )

inlineinherited

Dereference a locator, returning a Pixel.

Definition at line 383 of file MaskedImage.h.

                           {
             return Pixel(_loc.template get<0>().x()[0][0], _loc.template get<1>().x()[0][0],
                          _loc.template get<2>().x()[0][0]);
         }

◆ operator+=() [1/2]

MaskedImageLocatorBase& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::operator+= ( detail::difference_type p )

inlineinherited

Increment the locator's x and y positions by p

Definition at line 486 of file MaskedImage.h.

                                                                     {
             _loc.template get<0>() += p;
             _loc.template get<1>() += p;
             _loc.template get<2>() += p;
  
             return *this;
         }

◆ operator+=() [2/2]

MaskedImageLocatorBase& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::operator+= ( pair2I const & p )

inlineinherited

Increment the locator's x and y positions by p

Definition at line 481 of file MaskedImage.h.

                                                             {
             return operator+=(detail::difference_type(p.first, p.second));
         }

◆ operator<()

bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::operator< ( MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type, detail::const_locator_type< MaskLocator >::type, detail::const_locator_type< VarianceLocator >::type, ConstReference > const & rhs )

inlineinherited

Return true iff lhs is less than rhs.

Definition at line 476 of file MaskedImage.h.

                                                           {
             return _loc.template get<0>() < rhs._loc.template get<0>();
         }

◆ operator==()

bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::operator== ( MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type, detail::const_locator_type< MaskLocator >::type, detail::const_locator_type< VarianceLocator >::type, ConstReference > const & rhs )

inlineinherited

Return true iff two locators are equal.

Definition at line 470 of file MaskedImage.h.

                                                            {
             return _loc.template get<0>() == rhs._loc.template get<0>();
         }

◆ operator[]()

Pixel lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::operator[] ( cached_location_t const & cached_loc )

inlineinherited

Dereference a locator, returning a Pixel offset by the amount set when we created the cached_location_t

Definition at line 396 of file MaskedImage.h.

                                                               {
             return Pixel(_loc.template get<0>()[cached_loc._imv.template get<0>()][0],
                          _loc.template get<1>()[cached_loc._imv.template get<1>()][0],
                          _loc.template get<2>()[cached_loc._imv.template get<2>()][0]);
         }

◆ variance() [1/3]

ConstReference <VariancePixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::variance ( )

inlineinherited

Return a reference to the variance at the current position of the locator.

Definition at line 463 of file MaskedImage.h.

463 { return apply_IMV<boost::mpl::int_<2>>(); }

◆ variance() [2/3]

ConstReference <VariancePixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::variance ( cached_location_t const & cached_loc )

inlineinherited

Return a reference to the variance at the offset set when we created the cached_location_t

Definition at line 459 of file MaskedImage.h.

                                                                                        {
             return apply_IMV<boost::mpl::int_<2>>(cached_loc);
         }

◆ variance() [3/3]

ConstReference <VariancePixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::variance	(	int	x,
		int	y
	)

inlineinherited

Return a reference to the variance offset by (x, y) from the current position of the locator.

Definition at line 465 of file MaskedImage.h.

                                                                 {
             return apply_IMV<boost::mpl::int_<2>>(x, y);
         }

◆ x()

x_iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::x ( )

inlineinherited

Return an iterator that can be used to move (or dereference) a locator.

Note: this x_locator is xy_locator::x_locator, not MaskedImage::x_locator

Definition at line 405 of file MaskedImage.h.

405 { return x_iterator(this); }

lsst::afw::image::MaskedImage::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type, detail::const_locator_type< MaskLocator >::type, detail::const_locator_type< VarianceLocator >::type, ConstReference >::x_iterator

_x_or_y_iterator< apply_x > x_iterator

An x_iterator that provides a view of the xy_locator (i.e. advancing one advances the other)

Definition: MaskedImage.h:355

◆ y()

y_iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::y ( )

inlineinherited

Return an iterator that can be used to move (or dereference) a locator.

Note: this y_locator is xy_locator::y_locator, not MaskedImage::y_locator

Definition at line 411 of file MaskedImage.h.

411 { return y_iterator(this); }

lsst::afw::image::MaskedImage::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type, detail::const_locator_type< MaskLocator >::type, detail::const_locator_type< VarianceLocator >::type, ConstReference >::y_iterator

_x_or_y_iterator< apply_y > y_iterator

A y_iterator that provides a view of the xy_locator (i.e. advancing one advances the other)

Definition: MaskedImage.h:357

Member Data Documentation

◆ _loc

IMVLocator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::_loc

protectedinherited

Definition at line 499 of file MaskedImage.h.

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

/j/snowflake/release/lsstsw/stack/0.4.3/Linux64/afw/21.0.0-25-g1d57be3cd+e73869a214/include/lsst/afw/image/MaskedImage.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ IMVCachedLocation

◆ PixelTVec

◆ x_iterator

◆ y_iterator

Constructor & Destructor Documentation

◆ const_MaskedImageLocator()

Member Function Documentation

◆ apply_IMV() [1/3]

◆ apply_IMV() [2/3]

◆ apply_IMV() [3/3]

◆ cache_location()

◆ getLoc()

◆ image() [1/3]

◆ image() [2/3]

◆ image() [3/3]

◆ mask() [1/3]

◆ mask() [2/3]

◆ mask() [3/3]

◆ operator!=()

◆ operator()()

◆ operator*()

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator<()

◆ operator==()

◆ operator[]()

◆ variance() [1/3]

◆ variance() [2/3]

◆ variance() [3/3]

◆ x()

◆ y()

Member Data Documentation

◆ _loc