lsst.afw  21.0.0-34-g13549a6f6+8935f19055
Classes | Public Types | Public Member Functions | List of all members
lsst::afw::image::imageLocator Class Reference

An ImageBase locator. More...

Classes

struct  xy_x_iterator
 An x_iterator created from an xy_locator More...
 
struct  xy_y_iterator
 An y_iterator created from an xy_locator More...
 

Public Types

typedef void cached_location_t
 type to store relative location for efficient repeated access (not really void) More...
 

Public Member Functions

Image::Pixeloperator* ()
 Dereference a locator, returning a reference to a Pixel. More...
 
Image::Pixeloperator() (int x, int y)
 Dereference a pixel offset by (x, y) from the current locator, returning a reference to a Pixel. More...
 
xy_x_iterator x ()
 Return an x_iterator that can move an xy_locator More...
 
xy_y_iterator y ()
 Return an y_iterator that can move an xy_locator More...
 
cached_location_t cache_location (int x, int y)
 Store a relative location for faster repeated access. More...
 
Image::Pixeloperator[] (cached_location_t const &)
 Dereference a cached_location_t, returning a reference to a Pixel. More...
 

Detailed Description

An ImageBase locator.

Definition at line 56 of file iterators.cc.

Member Typedef Documentation

◆ cached_location_t

type to store relative location for efficient repeated access (not really void)

Definition at line 59 of file iterators.cc.

Member Function Documentation

◆ cache_location()

cached_location_t lsst::afw::image::imageLocator::cache_location ( int  x,
int  y 
)

Store a relative location for faster repeated access.

◆ operator()()

Image::Pixel& lsst::afw::image::imageLocator::operator() ( int  x,
int  y 
)

Dereference a pixel offset by (x, y) from the current locator, returning a reference to a Pixel.

As a locator ptr is moved through the image, expressions such as ptr(-1, -1) can be used to examine or set neighbouring pixels

◆ operator*()

Image::Pixel& lsst::afw::image::imageLocator::operator* ( )

Dereference a locator, returning a reference to a Pixel.

◆ operator[]()

Image::Pixel& lsst::afw::image::imageLocator::operator[] ( cached_location_t const &  )

Dereference a cached_location_t, returning a reference to a Pixel.

◆ x()

xy_x_iterator lsst::afw::image::imageLocator::x ( )

Return an x_iterator that can move an xy_locator

◆ y()

xy_y_iterator lsst::afw::image::imageLocator::y ( )

Return an y_iterator that can move an xy_locator


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