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::Pixel &	operator* ()
	Dereference a locator, returning a reference to a Pixel. More...

Image::Pixel &	operator() (int x, int y)

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::Pixel &	operator[] (cached_location_t const &)
	Dereference a `cached_location_t`, returning a reference to a Pixel. More...

Detailed Description

An ImageBase locator.

Definition at line 57 of file iterators.cc.

Member Typedef Documentation

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

Definition at line 60 of file iterators.cc.

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

Store a relative location for faster repeated access.

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 an locator ptr is moved through the image, expressions such as ptr(-1, -1) can be used to examine or set neighbouring pixels

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

Dereference a locator, returning a reference to a Pixel.

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

Dereference a cached_location_t, returning a reference to a Pixel.

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

Return an x_iterator that can move an xy_locator.

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: