LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+b2075782a9,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g3ddfee87b4+a60788ef87,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+a60788ef87,g591dd9f2cf+ba8caea58f,g5ec818987f+864ee9cddb,g858d7b2824+9ee1ab4172,g876c692160+a40945ebb7,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+5e309b7bc6,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+aa12a14d27,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+d0da15e3be,gba4ed39666+1ac82b564f,gbb8dafda3b+5dfd9c994b,gbeb006f7da+97157f9740,gc28159a63d+c6dfa2ddaf,gc86a011abf+9ee1ab4172,gcf0d15dbbd+a60788ef87,gdaeeff99f8+1cafcb7cd4,gdc0c513512+9ee1ab4172,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,geb961e4c1e+f9439d1e6f,gee10cc3b42+90ebb246c7,gf1cff7945b+9ee1ab4172,w.2024.12
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_MaskedImageLocator< ImageLocator, MaskLocator, VarianceLocator > Class Template Reference

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

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.
 
MaskedImageLocatorBaseoperator+= (pair2I const &p)
 Increment the locator's x and y positions by p
 
MaskedImageLocatorBaseoperator+= (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.

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

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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

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: