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
using	IMVCachedLocation

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

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

using	PixelTVec

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

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

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

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`

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

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

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

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

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

ConstReference< typenameboost::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`

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

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.

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`

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

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.

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`

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

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.

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

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

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

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

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

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

Member Typedef Documentation

◆ IMVCachedLocation

using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator, ConstReference >::IMVCachedLocation

inherited

Definition at line 348 of file MaskedImage.h.

◆ PixelTVec

using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator, ConstReference >::PixelTVec

inherited

Definition at line 415 of file MaskedImage.h.

◆ x_iterator

using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator, 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 350 of file MaskedImage.h.

◆ y_iterator

using lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator, 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 352 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 521 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< typenameboost::mpl::at< PixelTVec, N >::type >::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator, ConstReference >::apply_IMV ( )

inlineinherited

Definition at line 424 of file MaskedImage.h.

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

◆ apply_IMV() [2/3]

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

inlineinherited

Definition at line 418 of file MaskedImage.h.

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

◆ apply_IMV() [3/3]

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

inlineinherited

Definition at line 429 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< ImageLocator, MaskLocator, VarianceLocator, ConstReference >::cache_location	(	int	x,
		int	y ) const

inlineinherited

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

Definition at line 409 of file MaskedImage.h.

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

◆ getLoc()

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

inlineinherited

Definition at line 491 of file MaskedImage.h.

491{ return _loc; }

◆ image() [1/3]

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

inlineinherited

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

Definition at line 440 of file MaskedImage.h.

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

◆ image() [2/3]

ConstReference< ImagePixelT >::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator, 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 436 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< ImageLocator, MaskLocator, VarianceLocator, 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 442 of file MaskedImage.h.

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

◆ mask() [1/3]

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

inlineinherited

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

Definition at line 449 of file MaskedImage.h.

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

◆ mask() [2/3]

ConstReference< MaskPixelT >::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator, 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 445 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< ImageLocator, MaskLocator, VarianceLocator, 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 451 of file MaskedImage.h.

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

◆ operator!=()

bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator, 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 469 of file MaskedImage.h.

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

◆ operator()()

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

inlineinherited

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

Definition at line 384 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< ImageLocator, MaskLocator, VarianceLocator, ConstReference >::operator* ( )

inlineinherited

Dereference a locator, returning a Pixel.

Definition at line 378 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< ImageLocator, MaskLocator, VarianceLocator, ConstReference >::operator+= ( detail::difference_type p )

inlineinherited

Increment the locator's x and y positions by p

Definition at line 481 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< ImageLocator, MaskLocator, VarianceLocator, ConstReference >::operator+= ( pair2I const & p )

inlineinherited

Increment the locator's x and y positions by p

Definition at line 476 of file MaskedImage.h.

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

◆ operator<()

bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator, 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 471 of file MaskedImage.h.

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

◆ operator==()

bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator, 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 465 of file MaskedImage.h.

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

◆ operator[]()

Pixel lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator, 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 391 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< ImageLocator, MaskLocator, VarianceLocator, ConstReference >::variance ( )

inlineinherited

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

Definition at line 458 of file MaskedImage.h.

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

◆ variance() [2/3]

ConstReference< VariancePixelT >::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator, 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 454 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< ImageLocator, MaskLocator, VarianceLocator, 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 460 of file MaskedImage.h.

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

◆ x()

x_iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator, 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 400 of file MaskedImage.h.

400{ return x_iterator(this); }

◆ y()

y_iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator, 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 406 of file MaskedImage.h.

406{ return y_iterator(this); }

Member Data Documentation

◆ _loc

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

protectedinherited

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

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