lsst::afw::image::Image< PixelT > Class Template Reference

A class to represent a 2-dimensional array of pixels. More...

#include <Image.h>

Inheritance diagram for lsst::afw::image::Image< PixelT >:

Classes
struct	ImageTypeFactory
	A templated class to return this classes' type (present in Image/Mask/MaskedImage) More...

Public Types
using	image_category = detail::Image_tag
using	SinglePixel = PixelT
	A single Pixel of the same type as those in the ImageBase.
using	Pixel = PixelT
	A pixel in this ImageBase.
using	PixelReference = typename Reference<PixelT>::type
	A Reference to a PixelT.
using	PixelConstReference = typename ConstReference<PixelT>::type
	A ConstReference to a PixelT.
using	xy_locator = typename _view_t::xy_locator
	An xy_locator.
using	const_xy_locator = typename _view_t::xy_locator::const_t
	A const_xy_locator.
using	iterator = typename _view_t::iterator
	An STL compliant iterator.
using	const_iterator = typename _const_view_t::iterator
	An STL compliant const iterator.
using	reverse_iterator = typename _view_t::reverse_iterator
	An STL compliant reverse iterator.
using	const_reverse_iterator = typename _const_view_t::reverse_iterator
	An STL compliant const reverse iterator.
using	x_iterator = typename _view_t::x_iterator
	An iterator for traversing the pixels in a row.
using	fast_iterator = x_iterator
	A fast STL compliant iterator for contiguous images N.b.
using	xy_x_iterator = typename _view_t::x_iterator
	An iterator for traversing the pixels in a row, created from an xy_locator.
using	const_x_iterator = typename _const_view_t::x_iterator
	A const iterator for traversing the pixels in a row.
using	y_iterator = typename _view_t::y_iterator
	An iterator for traversing the pixels in a column.
using	xy_y_iterator = typename _view_t::y_iterator
	An iterator for traversing the pixels in a row, created from an xy_locator.
using	const_y_iterator = typename _const_view_t::y_iterator
	A const iterator for traversing the pixels in a column.
using	Array = typename ndarray::Array<PixelT, 2, 1>
	A mutable ndarray representation of the image.
using	ConstArray = typename ndarray::Array<const PixelT, 2, 1>
	An immutable ndarray representation of the image.

Public Member Functions
	Image (unsigned int width, unsigned int height, PixelT initialValue=0)
	Create an initialised Image of the specified size.
	Image (lsst::geom::Extent2I const &dimensions=lsst::geom::Extent2I(), PixelT initialValue=0)
	Create an initialised Image of the specified size.
	Image (lsst::geom::Box2I const &bbox, PixelT initialValue=0)
	Create an initialized Image of the specified size.
	Image (Image const &rhs, lsst::geom::Box2I const &bbox, ImageOrigin const origin=PARENT, const bool deep=false)
	Copy constructor to make a copy of part of an Image.
	Image (const Image &rhs, const bool deep=false)
	Copy constructor.
	Image (Image &&rhs)
	Image (std::string const &fileName, int hdu=fits::DEFAULT_HDU, std::shared_ptr< lsst::daf::base::PropertySet > metadata=std::shared_ptr< lsst::daf::base::PropertySet >(), lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
	Construct an Image by reading a regular FITS file.
	Image (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU, std::shared_ptr< lsst::daf::base::PropertySet > metadata=std::shared_ptr< lsst::daf::base::PropertySet >(), lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
	Construct an Image by reading a FITS image in memory.
	Image (fits::Fits &fitsfile, std::shared_ptr< lsst::daf::base::PropertySet > metadata=std::shared_ptr< lsst::daf::base::PropertySet >(), lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
	Construct an Image from an already-open FITS object.
template<typename OtherPixelT >
	Image (Image< OtherPixelT > const &rhs, const bool deep)
	Image (ndarray::Array< PixelT, 2, 1 > const &array, bool deep=false, lsst::geom::Point2I const &xy0=lsst::geom::Point2I())
	~Image () override=default
Image &	operator= (const PixelT rhs)
	Set the image's pixels to rhs.
Image &	operator= (const Image &rhs)
	Assignment operator.
Image &	operator= (Image &&rhs)
Image	subset (lsst::geom::Box2I const &bbox, ImageOrigin origin=PARENT) const
	Return a subimage corresponding to the given box.
Image	operator[] (lsst::geom::Box2I const &bbox) const
	Return a subimage corresponding to the given box (interpreted as PARENT coordinates).
void	writeFits (std::string const &fileName, daf::base::PropertySet const *metadata=nullptr, std::string const &mode="w") const
	Write an image to a regular FITS file.
void	writeFits (fits::MemFileManager &manager, daf::base::PropertySet const *metadata=nullptr, std::string const &mode="w") const
	Write an image to a FITS RAM file.
void	writeFits (fits::Fits &fitsfile, daf::base::PropertySet const *metadata=nullptr) const
	Write an image to an open FITS file object.
void	writeFits (std::string const &filename, fits::ImageWriteOptions const &options, std::string const &mode="w", daf::base::PropertySet const *header=nullptr, Mask< MaskPixel > const *mask=nullptr) const
	Write an image to a regular FITS file.
void	writeFits (fits::MemFileManager &manager, fits::ImageWriteOptions const &options, std::string const &mode="w", daf::base::PropertySet const *header=nullptr, Mask< MaskPixel > const *mask=nullptr) const
	Write an image to a FITS RAM file.
void	writeFits (fits::Fits &fitsfile, fits::ImageWriteOptions const &options, daf::base::PropertySet const *header=nullptr, Mask< MaskPixel > const *mask=nullptr) const
	Write an image to an open FITS file object.
void	swap (Image &rhs)
Image &	operator+= (PixelT const rhs)
	Add scalar rhs to lhs.
virtual Image &	operator+= (Image< PixelT > const &rhs)
	Add Image rhs to lhs.
Image &	operator+= (lsst::afw::math::Function2< double > const &function)
	Add a Function2(x, y) to an Image.
void	scaledPlus (PixelT const c, Image< PixelT > const &rhs)
	Add Image c*rhs to lhs.
Image &	operator-= (PixelT const rhs)
	Subtract scalar rhs from lhs.
Image &	operator-= (Image< PixelT > const &rhs)
	Subtract Image rhs from lhs.
Image &	operator-= (lsst::afw::math::Function2< double > const &function)
	Subtract a Function2(x, y) from an Image.
void	scaledMinus (PixelT const c, Image< PixelT > const &rhs)
	Subtract Image c*rhs from lhs.
Image &	operator*= (PixelT const rhs)
	Multiply lhs by scalar rhs.
Image &	operator*= (Image< PixelT > const &rhs)
	Multiply lhs by Image rhs (i.e. pixel-by-pixel multiplication)
void	scaledMultiplies (PixelT const c, Image< PixelT > const &rhs)
	Multiply lhs by Image c*rhs (i.e. pixel-by-pixel multiplication)
Image &	operator/= (PixelT const rhs)
	Divide lhs by scalar rhs.
Image &	operator/= (Image< PixelT > const &rhs)
	Divide lhs by Image rhs (i.e. pixel-by-pixel division)
void	scaledDivides (PixelT const c, Image< PixelT > const &rhs)
	Divide lhs by Image c*rhs (i.e. pixel-by-pixel division)
void	sqrt ()
Image< double > &	operator/= (double const rhs)
Image< float > &	operator/= (float const rhs)
void	assign (ImageBase const &rhs, lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT)
	Copy pixels from another image to a specified subregion of this image.
PixelReference	operator() (int x, int y)
	Return a reference to the pixel (x, y) in LOCAL coordinates.
PixelReference	operator() (int x, int y, CheckIndices const &)
	Return a reference to the pixel (x, y) in LOCAL coordinates with bounds checking.
PixelConstReference	operator() (int x, int y) const
	Return a const reference to the pixel (x, y) in LOCAL coordinates.
PixelConstReference	operator() (int x, int y, CheckIndices const &) const
	Return a const reference to the pixel (x, y) in LOCAL coordinates with bounds checking.
PixelReference	get (lsst::geom::Point2I const &index, ImageOrigin origin)
	Return a reference to a single pixel (with no bounds check).
PixelConstReference	get (lsst::geom::Point2I const &index, ImageOrigin origin) const
	Return a const reference to a single pixel (with no bounds check).
PixelReference	operator[] (lsst::geom::Point2I const &index)
	Return a reference to a single pixel in PARENT coordinates (with no bounds check).
PixelConstReference	operator[] (lsst::geom::Point2I const &index) const
	Return a reference to a single pixel in PARENT coordinates (with no bounds check).
int	getWidth () const
	Return the number of columns in the image.
int	getHeight () const
	Return the number of rows in the image.
int	getArea () const
	Return the area of the image.
int	getX0 () const
	Return the image's column-origin.
int	getY0 () const
	Return the image's row-origin.
lsst::geom::Point2I	getXY0 () const
	Return the image's origin.
std::pair< int, double >	positionToIndex (double const pos, lsst::afw::image::xOrY const xy) const
	Convert image position to index (nearest integer and fractional parts)
double	indexToPosition (double ind, lsst::afw::image::xOrY const xy) const
	Convert image index to image position.
lsst::geom::Extent2I	getDimensions () const
	Return the image's size; useful for passing to constructors.
void	swap (ImageBase &rhs)
Array	getArray ()
ConstArray	getArray () const
iterator	begin () const
	Return an STL compliant iterator to the start of the image.
fast_iterator	begin (bool contiguous) const
	Return a fast STL compliant iterator to the start of the image which must be contiguous.
iterator	end () const
	Return an STL compliant iterator to the end of the image.
fast_iterator	end (bool contiguous) const
	Return a fast STL compliant iterator to the end of the image which must be contiguous.
reverse_iterator	rbegin () const
	Return an STL compliant reverse iterator to the start of the image.
reverse_iterator	rend () const
	Return an STL compliant reverse iterator to the end of the image.
iterator	at (int x, int y) const
	Return an STL compliant iterator at the point (x, y)
x_iterator	row_begin (int y) const
	Return an x_iterator to the start of the y'th row.
x_iterator	row_end (int y) const
	Return an x_iterator to the end of the y'th row.
x_iterator	x_at (int x, int y) const
	Return an x_iterator to the point (x, y) in the image.
y_iterator	col_begin (int x) const
	Return an y_iterator to the start of the y'th row.
y_iterator	col_end (int x) const
	Return an y_iterator to the start of the y'th row.
y_iterator	y_at (int x, int y) const
	Return an y_iterator to the point (x, y) in the image.
xy_locator	xy_at (int x, int y) const
	Return an xy_locator at the point (x, y) in the image.
void	setXY0 (lsst::geom::Point2I const origin)
	Set the ImageBase's origin.
void	setXY0 (int const x0, int const y0)
	Set the ImageBase's origin.
lsst::geom::Box2I	getBBox (ImageOrigin origin=PARENT) const

Static Public Member Functions
static Image	readFits (std::string const &filename, int hdu=fits::DEFAULT_HDU)
	Read an Image from a regular FITS file.
static Image	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an Image from a FITS RAM file.
template<typename SinglePixelT >
static SinglePixel	PixelCast (SinglePixelT rhs)
	Convert a type to our SinglePixel type.

Protected Member Functions
_view_t	_getRawView () const
bool	isContiguous () const

Static Protected Member Functions
static _view_t	_allocateView (lsst::geom::Extent2I const &dimensions, Manager::Ptr &manager)
static _view_t	_makeSubView (lsst::geom::Extent2I const &dimensions, lsst::geom::Extent2I const &offset, const _view_t &view)

Friends
template<typename , typename , typename >
class	MaskedImage
template<typename OtherPixelT >
class	Image

Detailed Description

template<typename PixelT>
class lsst::afw::image::Image< PixelT >

A class to represent a 2-dimensional array of pixels.

Definition at line 51 of file Image.h.

Member Typedef Documentation

Array

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::Array = typename ndarray::Array<PixelT, 2, 1>

inherited

A mutable ndarray representation of the image.

Definition at line 149 of file ImageBase.h.

const_iterator

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::const_iterator = typename _const_view_t::iterator

inherited

An STL compliant const iterator.

Definition at line 127 of file ImageBase.h.

const_reverse_iterator

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::const_reverse_iterator = typename _const_view_t::reverse_iterator

inherited

An STL compliant const reverse iterator.

Definition at line 131 of file ImageBase.h.

const_x_iterator

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::const_x_iterator = typename _const_view_t::x_iterator

inherited

A const iterator for traversing the pixels in a row.

Definition at line 141 of file ImageBase.h.

const_xy_locator

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::const_xy_locator = typename _view_t::xy_locator::const_t

inherited

A const_xy_locator.

Definition at line 123 of file ImageBase.h.

const_y_iterator

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::const_y_iterator = typename _const_view_t::y_iterator

inherited

A const iterator for traversing the pixels in a column.

Definition at line 147 of file ImageBase.h.

ConstArray

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::ConstArray = typename ndarray::Array<const PixelT, 2, 1>

inherited

An immutable ndarray representation of the image.

Definition at line 151 of file ImageBase.h.

fast_iterator

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::fast_iterator = x_iterator

inherited

A fast STL compliant iterator for contiguous images N.b.

The order of pixel access is undefined

Definition at line 137 of file ImageBase.h.

image_category

template<typename PixelT >

using lsst::afw::image::Image< PixelT >::image_category = detail::Image_tag

Definition at line 56 of file Image.h.

iterator

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::iterator = typename _view_t::iterator

inherited

An STL compliant iterator.

Definition at line 125 of file ImageBase.h.

Pixel

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::Pixel = PixelT

inherited

A pixel in this ImageBase.

Definition at line 115 of file ImageBase.h.

PixelConstReference

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::PixelConstReference = typename ConstReference<PixelT>::type

inherited

A ConstReference to a PixelT.

Definition at line 119 of file ImageBase.h.

PixelReference

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::PixelReference = typename Reference<PixelT>::type

inherited

A Reference to a PixelT.

Definition at line 117 of file ImageBase.h.

reverse_iterator

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::reverse_iterator = typename _view_t::reverse_iterator

inherited

An STL compliant reverse iterator.

Definition at line 129 of file ImageBase.h.

SinglePixel

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::SinglePixel = PixelT

inherited

A single Pixel of the same type as those in the ImageBase.

Definition at line 113 of file ImageBase.h.

x_iterator

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::x_iterator = typename _view_t::x_iterator

inherited

An iterator for traversing the pixels in a row.

Definition at line 133 of file ImageBase.h.

xy_locator

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::xy_locator = typename _view_t::xy_locator

inherited

An xy_locator.

Definition at line 121 of file ImageBase.h.

xy_x_iterator

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::xy_x_iterator = typename _view_t::x_iterator

inherited

An iterator for traversing the pixels in a row, created from an xy_locator.

Definition at line 139 of file ImageBase.h.

xy_y_iterator

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::xy_y_iterator = typename _view_t::y_iterator

inherited

An iterator for traversing the pixels in a row, created from an xy_locator.

Definition at line 145 of file ImageBase.h.

y_iterator

template<typename PixelT >

using lsst::afw::image::ImageBase< PixelT >::y_iterator = typename _view_t::y_iterator

inherited

An iterator for traversing the pixels in a column.

Definition at line 143 of file ImageBase.h.

Constructor & Destructor Documentation

Image() [1/11]

template<typename PixelT >

lsst::afw::image::Image< PixelT >::Image ( unsigned int width, unsigned int height, PixelT initialValue = 0 )

explicit

Create an initialised Image of the specified size.

Parameters

width	number of columns
height	number of rows
initialValue	Initial value

Note

Many lsst::afw::image and lsst::afw::math objects define a dimensions member which may be conveniently used to make objects of an appropriate size

Definition at line 309 of file Image.cc.

        : ImageBase<PixelT>(lsst::geom::ExtentI(width, height)) {
    *this = initialValue;
}

Image() [2/11]

template<typename PixelT >

lsst::afw::image::Image< PixelT >::Image ( lsst::geom::Extent2I const & dimensions = lsst::geom::Extent2I(), PixelT initialValue = 0 )

explicit

Create an initialised Image of the specified size.

Parameters

dimensions	Number of columns, rows
initialValue	Initial value

Note

Many lsst::afw::image and lsst::afw::math objects define a dimensions member which may be conveniently used to make objects of an appropriate size

Definition at line 315 of file Image.cc.

        : ImageBase<PixelT>(dimensions) {
    *this = initialValue;
}

Image() [3/11]

template<typename PixelT >

lsst::afw::image::Image< PixelT >::Image ( lsst::geom::Box2I const & bbox, PixelT initialValue = 0 )

explicit

Create an initialized Image of the specified size.

Parameters

bbox	dimensions and origin of desired Image
initialValue	Initial value

Definition at line 321 of file Image.cc.

                                                                   : ImageBase<PixelT>(bbox) {
    *this = initialValue;
}

Image() [4/11]

template<typename PixelT >

lsst::afw::image::Image< PixelT >::Image ( Image< PixelT > const & rhs, lsst::geom::Box2I const & bbox, ImageOrigin const origin = PARENT, const bool deep = false )

explicit

Copy constructor to make a copy of part of an Image.

The bbox ignores X0/Y0 if origin == LOCAL, and uses it if origin == PARENT.

Parameters

rhs	Right-hand-side Image
bbox	Specify desired region
origin	Coordinate system of the bbox
deep	If false, new ImageBase shares storage with rhs; if true make a new, standalone, ImageBase

Note

Unless deep is true, the new image will share the old image's pixels; this is probably what you want

Definition at line 332 of file Image.cc.

        : ImageBase<PixelT>(rhs, bbox, origin, deep) {}

Image() [5/11]

template<typename PixelT >

lsst::afw::image::Image< PixelT >::Image	(	const Image< PixelT > &	rhs,
		const bool	deep = false )

Copy constructor.

Parameters

rhs	Right-hand-side Image
deep	If false, new Image shares storage with rhs; if true make a new, standalone, ImageBase

Note

Unless deep is true, the new image will share the old image's pixels; this may not be what you want. See also assign(rhs) to copy pixels between Images

Definition at line 326 of file Image.cc.

: ImageBase<PixelT>(rhs, deep) {}

Image() [6/11]

template<typename PixelT >

lsst::afw::image::Image< PixelT >::Image

(

Image< PixelT > &&

rhs

)

Definition at line 329 of file Image.cc.

: Image(rhs, false) {}

Image() [7/11]

template<typename PixelT >

lsst::afw::image::Image< PixelT >::Image ( std::string const & fileName, int hdu = fits::DEFAULT_HDU, std::shared_ptr< lsst::daf::base::PropertySet > metadata = std::shared_ptr< lsst::daf::base::PropertySet >(), lsst::geom::Box2I const & bbox = lsst::geom::Box2I(), ImageOrigin origin = PARENT, bool allowUnsafe = false )

explicit

Construct an Image by reading a regular FITS file.

Parameters

[in]	fileName	File to read.
[in]	hdu	HDU to read, 0-indexed (i.e. 0=Primary HDU). The special value of afw::fits::DEFAULT_HDU reads the Primary HDU unless it is empty, in which case it reads the first extension HDU.
[in,out]	metadata	Metadata read from the header (may be null).
[in]	bbox	If non-empty, read only the pixels within the bounding box.
[in]	origin	Coordinate system of the bounding box; if PARENT, the bounding box should take into account the xy0 saved with the image.
[in]	allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

Image() [8/11]

template<typename PixelT >

lsst::afw::image::Image< PixelT >::Image ( fits::MemFileManager & manager, int hdu = fits::DEFAULT_HDU, std::shared_ptr< lsst::daf::base::PropertySet > metadata = std::shared_ptr< lsst::daf::base::PropertySet >(), lsst::geom::Box2I const & bbox = lsst::geom::Box2I(), ImageOrigin origin = PARENT, bool allowUnsafe = false )

explicit

Construct an Image by reading a FITS image in memory.

Parameters

[in]	manager	An object that manages the memory buffer to read.
[in]	hdu	HDU to read, 0-indexed (i.e. 0=Primary HDU). The special value of afw::fits::DEFAULT_HDU reads the Primary HDU unless it is empty, in which case it reads the first extension HDU.
[in,out]	metadata	Metadata read from the header (may be null).
[in]	bbox	If non-empty, read only the pixels within the bounding box.
[in]	origin	Coordinate system of the bounding box; if PARENT, the bounding box should take into account the xy0 saved with the image.
[in]	allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

Image() [9/11]

template<typename PixelT >

lsst::afw::image::Image< PixelT >::Image ( fits::Fits & fitsfile, std::shared_ptr< lsst::daf::base::PropertySet > metadata = std::shared_ptr< lsst::daf::base::PropertySet >(), lsst::geom::Box2I const & bbox = lsst::geom::Box2I(), ImageOrigin origin = PARENT, bool allowUnsafe = false )

explicit

Construct an Image from an already-open FITS object.

Parameters

[in]	fitsfile	A FITS object to read from, already at the desired HDU.
[in,out]	metadata	Metadata read from the header (may be null).
[in]	bbox	If non-empty, read only the pixels within the bounding box.
[in]	origin	Coordinate system of the bounding box; if PARENT, the bounding box should take into account the xy0 saved with the image.
[in]	allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

Image() [10/11]

template<typename PixelT >

template<typename OtherPixelT >

lsst::afw::image::Image< PixelT >::Image ( Image< OtherPixelT > const & rhs, const bool deep )

inline

Definition at line 182 of file Image.h.

: image::ImageBase<PixelT>(rhs, deep) {}

Image() [11/11]

template<typename PixelT >

lsst::afw::image::Image< PixelT >::Image ( ndarray::Array< PixelT, 2, 1 > const & array, bool deep = false, lsst::geom::Point2I const & xy0 = lsst::geom::Point2I() )

inlineexplicit

Definition at line 184 of file Image.h.

            : image::ImageBase<PixelT>(array, deep, xy0) {}

~Image()

template<typename PixelT >

lsst::afw::image::Image< PixelT >::~Image ( )

overridedefault

Member Function Documentation

_allocateView()

template<typename PixelT >

ImageBase< PixelT >::_view_t lsst::afw::image::ImageBase< PixelT >::_allocateView ( lsst::geom::Extent2I const & dimensions, Manager::Ptr & manager )

staticprotectedinherited

Definition at line 45 of file Image.cc.

                                                                                          {
    if (dimensions.getX() < 0 || dimensions.getY() < 0) {
        throw LSST_EXCEPT(pex::exceptions::LengthError,
                          str(boost::format("Both width and height must be non-negative: %d, %d") %
                              dimensions.getX() % dimensions.getY()));
    }
    if (dimensions.getX() != 0 && dimensions.getY() > std::numeric_limits<int>::max() / dimensions.getX()) {
        throw LSST_EXCEPT(pex::exceptions::LengthError,
                          str(boost::format("Image dimensions (%d x %d) too large; int overflow detected.") %
                              dimensions.getX() % dimensions.getY()));
    }
    std::pair<Manager::Ptr, PixelT*> r =
            ndarray::SimpleManager<PixelT>::allocate(dimensions.getX() * dimensions.getY());
    manager = r.first;
    return boost::gil::interleaved_view(dimensions.getX(), dimensions.getY(),
                                        (typename _view_t::value_type*)r.second,
                                        dimensions.getX() * sizeof(PixelT));
}

_getRawView()

template<typename PixelT >

_view_t lsst::afw::image::ImageBase< PixelT >::_getRawView ( ) const

inlineprotectedinherited

Definition at line 465 of file ImageBase.h.

{ return _gilView; }

_makeSubView()

template<typename PixelT >

ImageBase< PixelT >::_view_t lsst::afw::image::ImageBase< PixelT >::_makeSubView ( lsst::geom::Extent2I const & dimensions, lsst::geom::Extent2I const & offset, const _view_t & view )

staticprotectedinherited

Definition at line 65 of file Image.cc.

                                                                                         {
    if (offset.getX() < 0 || offset.getY() < 0 || offset.getX() + dimensions.getX() > view.width() ||
        offset.getY() + dimensions.getY() > view.height()) {
        throw LSST_EXCEPT(
                pex::exceptions::LengthError,
                (boost::format(
                         "Box2I(Point2I(%d,%d),lsst::geom::Extent2I(%d,%d)) doesn't fit in image %dx%d") %
                 offset.getX() % offset.getY() % dimensions.getX() % dimensions.getY() % view.width() %
                 view.height())
                        .str());
    }
    if (dimensions.getX() == 0 && dimensions.getY() == 0
        && view.width() == 0 && view.height() == 0) {
        // Getting a zero-extent subview of a zero-extent view returns itself
        return view;
    } else {
        return boost::gil::subimage_view(view, offset.getX(), offset.getY(), dimensions.getX(),
                                         dimensions.getY());
    }
}

assign()

template<typename PixelT >

void lsst::afw::image::ImageBase< PixelT >::assign ( ImageBase< PixelT > const & rhs, lsst::geom::Box2I const & bbox = lsst::geom::Box2I(), ImageOrigin origin = PARENT )

inherited

Copy pixels from another image to a specified subregion of this image.

Parameters

[in]	rhs	source image whose pixels are to be copied into this image (the destination)
[in]	bbox	subregion of this image to set; if empty (the default) then all pixels are set
[in]	origin	origin of bbox: if PARENT then the lower left pixel of this image is at xy0 if LOCAL then the lower left pixel of this image is at 0,0

Exceptions

lsst::pex::exceptions::LengthError

if the dimensions of rhs and the specified subregion of this image do not match.

Definition at line 153 of file Image.cc.

                                                                                                  {
    auto lhsDim = bbox.isEmpty() ? getDimensions() : bbox.getDimensions();
    if (lhsDim != rhs.getDimensions()) {
        throw LSST_EXCEPT(pex::exceptions::LengthError,
                          (boost::format("Dimension mismatch: %dx%d v. %dx%d") % lhsDim.getX() %
                           lhsDim.getY() % rhs.getWidth() % rhs.getHeight())
                                  .str());
    }
    if (bbox.isEmpty()) {
        copy_pixels(rhs._gilView, _gilView);
    } else {
        auto lhsOff = (origin == PARENT) ? bbox.getMin() - _origin : lsst::geom::Extent2I(bbox.getMin());
        auto lhsGilView = _makeSubView(lhsDim, lhsOff, _gilView);
        copy_pixels(rhs._gilView, lhsGilView);
    }
}

at()

template<typename PixelT >

ImageBase< PixelT >::iterator lsst::afw::image::ImageBase< PixelT >::at ( int x, int y ) const

inherited

Return an STL compliant iterator at the point (x, y)

Definition at line 270 of file Image.cc.

                                                                           {
    return _gilView.at(x, y);
}

begin() [1/2]

template<typename PixelT >

ImageBase< PixelT >::iterator lsst::afw::image::ImageBase< PixelT >::begin ( ) const

inherited

Return an STL compliant iterator to the start of the image.

Note that this isn't especially efficient; see Image Iterators for a discussion

Definition at line 250 of file Image.cc.

                                                                  {
    return _gilView.begin();
}

begin() [2/2]

template<typename PixelT >

ImageBase< PixelT >::fast_iterator lsst::afw::image::ImageBase< PixelT >::begin ( bool contiguous ) const

inherited

Return a fast STL compliant iterator to the start of the image which must be contiguous.

Parameters

contiguous

Pixels are contiguous (must be true)

Exceptions

lsst::pex::exceptions::RuntimeError

Argument contiguous is false, or the pixels are not in fact contiguous

Definition at line 275 of file Image.cc.

                                                                                      {
    if (!contiguous) {
        throw LSST_EXCEPT(pex::exceptions::RuntimeError, "Only contiguous == true makes sense");
    }
    if (!this->isContiguous()) {
        throw LSST_EXCEPT(pex::exceptions::RuntimeError, "Image's pixels are not contiguous");
    }
 
    return row_begin(0);
}

col_begin()

template<typename PixelT >

y_iterator lsst::afw::image::ImageBase< PixelT >::col_begin ( int x ) const

inlineinherited

Return an y_iterator to the start of the y'th row.

Incrementing an y_iterator moves it up the column

Definition at line 413 of file ImageBase.h.

{ return _gilView.col_begin(x); }

col_end()

template<typename PixelT >

y_iterator lsst::afw::image::ImageBase< PixelT >::col_end ( int x ) const

inlineinherited

Return an y_iterator to the start of the y'th row.

Definition at line 416 of file ImageBase.h.

{ return _gilView.col_end(x); }

end() [1/2]

template<typename PixelT >

ImageBase< PixelT >::iterator lsst::afw::image::ImageBase< PixelT >::end ( ) const

inherited

Return an STL compliant iterator to the end of the image.

Definition at line 255 of file Image.cc.

                                                                {
    return _gilView.end();
}

end() [2/2]

template<typename PixelT >

ImageBase< PixelT >::fast_iterator lsst::afw::image::ImageBase< PixelT >::end ( bool contiguous ) const

inherited

Return a fast STL compliant iterator to the end of the image which must be contiguous.

Parameters

contiguous

Pixels are contiguous (must be true)

Exceptions

lsst::pex::exceptions::RuntimeError

Argument contiguous is false, or the pixels are not in fact contiguous

Definition at line 287 of file Image.cc.

                                                                                    {
    if (!contiguous) {
        throw LSST_EXCEPT(pex::exceptions::RuntimeError, "Only contiguous == true makes sense");
    }
    if (!this->isContiguous()) {
        throw LSST_EXCEPT(pex::exceptions::RuntimeError, "Image's pixels are not contiguous");
    }
 
    return row_end(getHeight() - 1);
}

get() [1/2]

template<typename PixelT >

ImageBase< PixelT >::PixelReference lsst::afw::image::ImageBase< PixelT >::get ( lsst::geom::Point2I const & index, ImageOrigin origin )

inherited

Return a reference to a single pixel (with no bounds check).

Definition at line 209 of file Image.cc.

                                                                                      {
    int x = index.getX();
    int y = index.getY();
    if (origin == PARENT) {
        x -= getX0();
        y -= getY0();
    }
    return _gilView(x, y)[0];
}

get() [2/2]

template<typename PixelT >

ImageBase< PixelT >::PixelConstReference lsst::afw::image::ImageBase< PixelT >::get ( lsst::geom::Point2I const & index, ImageOrigin origin ) const

inherited

Return a const reference to a single pixel (with no bounds check).

Definition at line 221 of file Image.cc.

                                                                                                 {
    int x = index.getX();
    int y = index.getY();
    if (origin == PARENT) {
        x -= getX0();
        y -= getY0();
    }
    return _gilView(x, y)[0];
}

getArea()

template<typename PixelT >

int lsst::afw::image::ImageBase< PixelT >::getArea ( ) const

inlineinherited

Return the area of the image.

Definition at line 298 of file ImageBase.h.

{ return getWidth()*getHeight(); }

getArray() [1/2]

template<typename PixelT >

ImageBase< PixelT >::Array lsst::afw::image::ImageBase< PixelT >::getArray ( )

inherited

Definition at line 476 of file ImageBase.h.

                                                            {
    int rowStride = 1;
    PixelT * data = nullptr;
    if (getArea() > 0) {
        data = reinterpret_cast<PixelT*>(row_begin(0));
    }
    if (getHeight() > 1) {
        rowStride = reinterpret_cast<PixelT*>(row_begin(1)) - reinterpret_cast<PixelT*>(row_begin(0));
    }
    return ndarray::external(data,
                             ndarray::makeVector(getHeight(), getWidth()), ndarray::makeVector(rowStride, 1),
                             this->_manager);
}

getArray() [2/2]

template<typename PixelT >

ImageBase< PixelT >::ConstArray lsst::afw::image::ImageBase< PixelT >::getArray ( ) const

inherited

Definition at line 491 of file ImageBase.h.

                                                                       {
    int rowStride = 1;
    PixelT * data = nullptr;
    if (getArea() > 0) {
        data = reinterpret_cast<PixelT*>(row_begin(0));
    }
    if (getHeight() > 1) {
        rowStride = reinterpret_cast<PixelT*>(row_begin(1)) - reinterpret_cast<PixelT*>(row_begin(0));
    }
    return ndarray::external(data,
                             ndarray::makeVector(getHeight(), getWidth()), ndarray::makeVector(rowStride, 1),
                             this->_manager);
}

getBBox()

template<typename PixelT >

lsst::geom::Box2I lsst::afw::image::ImageBase< PixelT >::getBBox ( ImageOrigin origin = PARENT ) const

inlineinherited

Definition at line 445 of file ImageBase.h.

                                                             {
        if (origin == PARENT) {
            return lsst::geom::Box2I(_origin, getDimensions());
        } else
            return lsst::geom::Box2I(lsst::geom::Point2I(0, 0), getDimensions());
    }

getDimensions()

template<typename PixelT >

lsst::geom::Extent2I lsst::afw::image::ImageBase< PixelT >::getDimensions ( ) const

inlineinherited

Return the image's size; useful for passing to constructors.

Definition at line 356 of file ImageBase.h.

{ return lsst::geom::Extent2I(getWidth(), getHeight()); }

getHeight()

template<typename PixelT >

int lsst::afw::image::ImageBase< PixelT >::getHeight ( ) const

inlineinherited

Return the number of rows in the image.

Definition at line 296 of file ImageBase.h.

{ return _gilView.height(); }

getWidth()

template<typename PixelT >

int lsst::afw::image::ImageBase< PixelT >::getWidth ( ) const

inlineinherited

Return the number of columns in the image.

Definition at line 294 of file ImageBase.h.

{ return _gilView.width(); }

getX0()

template<typename PixelT >

int lsst::afw::image::ImageBase< PixelT >::getX0 ( ) const

inlineinherited

Return the image's column-origin.

This will usually be 0 except for images created using the ImageBase(fileName, hdu, BBox, mode) ctor or ImageBase(ImageBase, BBox) cctor The origin can be reset with setXY0

Definition at line 306 of file ImageBase.h.

{ return _origin.getX(); }

getXY0()

template<typename PixelT >

lsst::geom::Point2I lsst::afw::image::ImageBase< PixelT >::getXY0 ( ) const

inlineinherited

Return the image's origin.

This will usually be (0, 0) except for images created using the ImageBase(fileName, hdu, BBox, mode) ctor or ImageBase(ImageBase, BBox) cctor The origin can be reset with setXY0

Definition at line 323 of file ImageBase.h.

{ return _origin; }

getY0()

template<typename PixelT >

int lsst::afw::image::ImageBase< PixelT >::getY0 ( ) const

inlineinherited

Return the image's row-origin.

This will usually be 0 except for images created using the ImageBase(fileName, hdu, BBox, mode) ctor or ImageBase(ImageBase, BBox) cctor The origin can be reset with setXY0

Definition at line 314 of file ImageBase.h.

{ return _origin.getY(); }

indexToPosition()

template<typename PixelT >

double lsst::afw::image::ImageBase< PixelT >::indexToPosition ( double ind, lsst::afw::image::xOrY const xy ) const

inlineinherited

Convert image index to image position.

The LSST indexing convention is:

• the index of the bottom left pixel is 0,0
• the position of the center of the bottom left pixel is PixelZeroPos, PixelZeroPos

Returns

image position

Parameters

ind	image index
xy	Is this a column or row coordinate?

Definition at line 349 of file ImageBase.h.

                                          {
        return ind + PixelZeroPos + (xy == X ? getX0() : getY0());
    }

isContiguous()

template<typename PixelT >

bool lsst::afw::image::ImageBase< PixelT >::isContiguous ( ) const

inlineprotectedinherited

Definition at line 467 of file ImageBase.h.

{ return begin() + getWidth() * getHeight() == end(); }

operator()() [1/4]

template<typename PixelT >

ImageBase< PixelT >::PixelReference lsst::afw::image::ImageBase< PixelT >::operator() ( int x, int y )

inherited

Return a reference to the pixel (x, y) in LOCAL coordinates.

Definition at line 171 of file Image.cc.

                                                                                   {
    return const_cast<typename ImageBase<PixelT>::PixelReference>(
            static_cast<typename ImageBase<PixelT>::PixelConstReference>(_gilView(x, y)[0]));
}

operator()() [2/4]

template<typename PixelT >

ImageBase< PixelT >::PixelConstReference lsst::afw::image::ImageBase< PixelT >::operator() ( int x, int y ) const

inherited

Return a const reference to the pixel (x, y) in LOCAL coordinates.

Definition at line 191 of file Image.cc.

                                                                                              {
    return _gilView(x, y)[0];
}

operator()() [3/4]

template<typename PixelT >

ImageBase< PixelT >::PixelReference lsst::afw::image::ImageBase< PixelT >::operator() ( int x, int y, CheckIndices const & check )

inherited

Return a reference to the pixel (x, y) in LOCAL coordinates with bounds checking.

Definition at line 177 of file Image.cc.

                                                                                                    {
    if (check && (x < 0 || x >= getWidth() || y < 0 || y >= getHeight())) {
        throw LSST_EXCEPT(pex::exceptions::LengthError,
                          (boost::format("Index (%d, %d) is out of range [0--%d], [0--%d]") % x % y %
                           (getWidth() - 1) % (getHeight() - 1))
                                  .str());
    }
 
    return const_cast<typename ImageBase<PixelT>::PixelReference>(
            static_cast<typename ImageBase<PixelT>::PixelConstReference>(_gilView(x, y)[0]));
}

operator()() [4/4]

template<typename PixelT >

ImageBase< PixelT >::PixelConstReference lsst::afw::image::ImageBase< PixelT >::operator() ( int x, int y, CheckIndices const & check ) const

inherited

Return a const reference to the pixel (x, y) in LOCAL coordinates with bounds checking.

Definition at line 196 of file Image.cc.

                                                       {
    if (check && (x < 0 || x >= getWidth() || y < 0 || y >= getHeight())) {
        throw LSST_EXCEPT(pex::exceptions::LengthError,
                          (boost::format("Index (%d, %d) is out of range [0--%d], [0--%d]") % x % y %
                           (this->getWidth() - 1) % (this->getHeight() - 1))
                                  .str());
    }
 
    return _gilView(x, y)[0];
}

operator*=() [1/2]

template<typename PixelT >

Image< PixelT > & lsst::afw::image::Image< PixelT >::operator*=

(

Image< PixelT > const &

rhs

)

Multiply lhs by Image rhs (i.e. pixel-by-pixel multiplication)

Definition at line 551 of file Image.cc.

                                                                 {
    if (this->getDimensions() != rhs.getDimensions()) {
        throw LSST_EXCEPT(pex::exceptions::LengthError,
                          (boost::format("Images are of different size, %dx%d v %dx%d") % this->getWidth() %
                           this->getHeight() % rhs.getWidth() % rhs.getHeight())
                                  .str());
    }
    transform_pixels(_getRawView(), rhs._getRawView(), _getRawView(),
                     [](PixelT const& l, PixelT const& r) -> PixelT { return l * r; });
    return *this;
}

operator*=() [2/2]

template<typename PixelT >

Image< PixelT > & lsst::afw::image::Image< PixelT >::operator*=

(

PixelT const

rhs

)

Multiply lhs by scalar rhs.

Definition at line 545 of file Image.cc.

                                                         {
    transform_pixels(_getRawView(), _getRawView(), [&rhs](PixelT const& l) -> PixelT { return l * rhs; });
    return *this;
}

operator+=() [1/3]

template<typename PixelT >

Image< PixelT > & lsst::afw::image::Image< PixelT >::operator+= ( Image< PixelT > const & rhs )

virtual

Add Image rhs to lhs.

Definition at line 461 of file Image.cc.

                                                                 {
    if (this->getDimensions() != rhs.getDimensions()) {
        throw LSST_EXCEPT(pex::exceptions::LengthError,
                          (boost::format("Images are of different size, %dx%d v %dx%d") % this->getWidth() %
                           this->getHeight() % rhs.getWidth() % rhs.getHeight())
                                  .str());
    }
    transform_pixels(_getRawView(), rhs._getRawView(), _getRawView(),
                     [](PixelT const& l, PixelT const& r) -> PixelT { return l + r; });
    return *this;
}

operator+=() [2/3]

template<typename PixelT >

Image< PixelT > & lsst::afw::image::Image< PixelT >::operator+=

(

lsst::afw::math::Function2< double > const &

function

)

Add a Function2(x, y) to an Image.

Parameters

function

function to add

Definition at line 474 of file Image.cc.

                                                                              {
    for (int y = 0; y != this->getHeight(); ++y) {
        double const yPos = this->indexToPosition(y, Y);
        double xPos = this->indexToPosition(0, X);
        for (typename Image<PixelT>::x_iterator ptr = this->row_begin(y), end = this->row_end(y); ptr != end;
             ++ptr, ++xPos) {
            *ptr += function(xPos, yPos);
        }
    }
    return *this;
}

operator+=() [3/3]

template<typename PixelT >

Image< PixelT > & lsst::afw::image::Image< PixelT >::operator+=

(

PixelT const

rhs

)

Add scalar rhs to lhs.

Definition at line 455 of file Image.cc.

                                                         {
    transform_pixels(_getRawView(), _getRawView(), [&rhs](PixelT const& l) -> PixelT { return l + rhs; });
    return *this;
}

operator-=() [1/3]

template<typename PixelT >

Image< PixelT > & lsst::afw::image::Image< PixelT >::operator-=

(

Image< PixelT > const &

rhs

)

Subtract Image rhs from lhs.

Definition at line 506 of file Image.cc.

                                                                 {
    if (this->getDimensions() != rhs.getDimensions()) {
        throw LSST_EXCEPT(pex::exceptions::LengthError,
                          (boost::format("Images are of different size, %dx%d v %dx%d") % this->getWidth() %
                           this->getHeight() % rhs.getWidth() % rhs.getHeight())
                                  .str());
    }
    transform_pixels(_getRawView(), rhs._getRawView(), _getRawView(),
                     [](PixelT const& l, PixelT const& r) -> PixelT { return l - r; });
    return *this;
}

operator-=() [2/3]

template<typename PixelT >

Image< PixelT > & lsst::afw::image::Image< PixelT >::operator-=

(

lsst::afw::math::Function2< double > const &

function

)

Subtract a Function2(x, y) from an Image.

Parameters

function

function to add

Definition at line 532 of file Image.cc.

                                                                              {
    for (int y = 0; y != this->getHeight(); ++y) {
        double const yPos = this->indexToPosition(y, Y);
        double xPos = this->indexToPosition(0, X);
        for (typename Image<PixelT>::x_iterator ptr = this->row_begin(y), end = this->row_end(y); ptr != end;
             ++ptr, ++xPos) {
            *ptr -= function(xPos, yPos);
        }
    }
    return *this;
}

operator-=() [3/3]

template<typename PixelT >

Image< PixelT > & lsst::afw::image::Image< PixelT >::operator-=

(

PixelT const

rhs

)

Subtract scalar rhs from lhs.

Definition at line 500 of file Image.cc.

                                                         {
    transform_pixels(_getRawView(), _getRawView(), [&rhs](PixelT const& l) -> PixelT { return l - rhs; });
    return *this;
}

operator/=() [1/4]

Image< double > & lsst::afw::image::Image< double >::operator/=

(

double const

rhs

)

Definition at line 585 of file Image.cc.

                                                         {
    double const irhs = 1 / rhs;
    *this *= irhs;
    return *this;
}

operator/=() [2/4]

Image< float > & lsst::afw::image::Image< float >::operator/=

(

float const

rhs

)

Definition at line 592 of file Image.cc.

                                                      {
    float const irhs = 1 / rhs;
    *this *= irhs;
    return *this;
}

operator/=() [3/4]

template<typename PixelT >

Image< PixelT > & lsst::afw::image::Image< PixelT >::operator/=

(

Image< PixelT > const &

rhs

)

Divide lhs by Image rhs (i.e. pixel-by-pixel division)

Definition at line 599 of file Image.cc.

                                                                 {
    if (this->getDimensions() != rhs.getDimensions()) {
        throw LSST_EXCEPT(pex::exceptions::LengthError,
                          (boost::format("Images are of different size, %dx%d v %dx%d") % this->getWidth() %
                           this->getHeight() % rhs.getWidth() % rhs.getHeight())
                                  .str());
    }
    transform_pixels(_getRawView(), rhs._getRawView(), _getRawView(),
                     [](PixelT const& l, PixelT const& r) -> PixelT { return l / r; });
    return *this;
}

operator/=() [4/4]

template<typename PixelT >

Image< PixelT > & lsst::afw::image::Image< PixelT >::operator/=

(

PixelT const

rhs

)

Divide lhs by scalar rhs.

Note

Floating point types implement this by multiplying by the 1/rhs

Definition at line 577 of file Image.cc.

                                                         {
    transform_pixels(_getRawView(), _getRawView(), [&rhs](PixelT const& l) -> PixelT { return l / rhs; });
    return *this;
}

operator=() [1/3]

template<typename PixelT >

Image< PixelT > & lsst::afw::image::Image< PixelT >::operator=

(

const Image< PixelT > &

rhs

)

Assignment operator.

Note

that this has the effect of making the lhs share pixels with the rhs which may not be what you intended; to copy the pixels, use assign(rhs)

this behaviour is required to make the swig interface work, otherwise I'd declare this function private

Definition at line 344 of file Image.cc.

                                                        {
    this->ImageBase<PixelT>::operator=(rhs);
 
    return *this;
}

operator=() [2/3]

template<typename PixelT >

Image< PixelT > & lsst::afw::image::Image< PixelT >::operator=

(

const PixelT

rhs

)

Set the image's pixels to rhs.

Definition at line 337 of file Image.cc.

                                                        {
    this->ImageBase<PixelT>::operator=(rhs);
 
    return *this;
}

operator=() [3/3]

template<typename PixelT >

Image< PixelT > & lsst::afw::image::Image< PixelT >::operator=

(

Image< PixelT > &&

rhs

)

Definition at line 351 of file Image.cc.

                                                   {
    return *this = rhs;
}

operator[]() [1/3]

template<typename PixelT >

Image lsst::afw::image::Image< PixelT >::operator[] ( lsst::geom::Box2I const & bbox ) const

inline

Return a subimage corresponding to the given box (interpreted as PARENT coordinates).

Definition at line 224 of file Image.h.

{ return subset(bbox); }

operator[]() [2/3]

template<typename PixelT >

PixelReference lsst::afw::image::ImageBase< PixelT >::operator[] ( lsst::geom::Point2I const & index )

inlineinherited

Return a reference to a single pixel in PARENT coordinates (with no bounds check).

Definition at line 288 of file ImageBase.h.

{ return get(index, PARENT); }

operator[]() [3/3]

template<typename PixelT >

PixelConstReference lsst::afw::image::ImageBase< PixelT >::operator[] ( lsst::geom::Point2I const & index ) const

inlineinherited

Return a reference to a single pixel in PARENT coordinates (with no bounds check).

Definition at line 291 of file ImageBase.h.

{ return get(index, PARENT); }

PixelCast()

template<typename PixelT >

template<typename SinglePixelT >

static SinglePixel lsst::afw::image::ImageBase< PixelT >::PixelCast ( SinglePixelT rhs )

inlinestaticinherited

Convert a type to our SinglePixel type.

Definition at line 158 of file ImageBase.h.

                                                   {
        return SinglePixel(rhs);
    }

positionToIndex()

template<typename PixelT >

std::pair< int, double > lsst::afw::image::ImageBase< PixelT >::positionToIndex ( double const pos, lsst::afw::image::xOrY const xy ) const

inlineinherited

Convert image position to index (nearest integer and fractional parts)

Returns

std::pair(nearest integer index, fractional part)

Parameters

pos	image position
xy	Is this a column or row coordinate?

Definition at line 330 of file ImageBase.h.

                    {
        double const fullIndex = pos - PixelZeroPos - (xy == X ? getX0() : getY0());
        int const roundedIndex = static_cast<int>(fullIndex + 0.5);
        double const residual = fullIndex - roundedIndex;
        return std::pair<int, double>(roundedIndex, residual);
    }

rbegin()

template<typename PixelT >

ImageBase< PixelT >::reverse_iterator lsst::afw::image::ImageBase< PixelT >::rbegin ( ) const

inherited

Return an STL compliant reverse iterator to the start of the image.

Definition at line 260 of file Image.cc.

                                                                           {
    return _gilView.rbegin();
}

readFits() [1/2]

template<typename PixelT >

static Image lsst::afw::image::Image< PixelT >::readFits ( fits::MemFileManager & manager, int hdu = fits::DEFAULT_HDU )

inlinestatic

Read an Image from a FITS RAM file.

Parameters

[in]	manager	Object that manages the memory to be read.
[in]	hdu	Number of the "header-data unit" to read (where 0 is the Primary HDU). The default value of afw::fits::DEFAULT_HDU is interpreted as "the first HDU with NAXIS != 0".

Definition at line 330 of file Image.h.

                                                                                  {
        return Image<PixelT>(manager, hdu);
    }

readFits() [2/2]

template<typename PixelT >

static Image lsst::afw::image::Image< PixelT >::readFits ( std::string const & filename, int hdu = fits::DEFAULT_HDU )

inlinestatic

Read an Image from a regular FITS file.

Parameters

[in]	filename	Name of the file to read.
[in]	hdu	Number of the "header-data unit" to read (where 0 is the Primary HDU). The default value of afw::fits::DEFAULT_HDU is interpreted as "the first HDU with NAXIS != 0".

Definition at line 318 of file Image.h.

                                                                                {
        return Image<PixelT>(filename, hdu);
    }

rend()

template<typename PixelT >

ImageBase< PixelT >::reverse_iterator lsst::afw::image::ImageBase< PixelT >::rend ( ) const

inherited

Return an STL compliant reverse iterator to the end of the image.

Definition at line 265 of file Image.cc.

                                                                         {
    return _gilView.rend();
}

row_begin()

template<typename PixelT >

x_iterator lsst::afw::image::ImageBase< PixelT >::row_begin ( int y ) const

inlineinherited

Return an x_iterator to the start of the y'th row.

Incrementing an x_iterator moves it across the row

Definition at line 401 of file ImageBase.h.

{ return _gilView.row_begin(y); }

row_end()

template<typename PixelT >

x_iterator lsst::afw::image::ImageBase< PixelT >::row_end ( int y ) const

inlineinherited

Return an x_iterator to the end of the y'th row.

Definition at line 404 of file ImageBase.h.

{ return _gilView.row_end(y); }

scaledDivides()

template<typename PixelT >

void lsst::afw::image::Image< PixelT >::scaledDivides	(	PixelT const	c,
		Image< PixelT > const &	rhs )

Divide lhs by Image c*rhs (i.e. pixel-by-pixel division)

Definition at line 612 of file Image.cc.

                                                                    {
    if (this->getDimensions() != rhs.getDimensions()) {
        throw LSST_EXCEPT(pex::exceptions::LengthError,
                          (boost::format("Images are of different size, %dx%d v %dx%d") % this->getWidth() %
                           this->getHeight() % rhs.getWidth() % rhs.getHeight())
                                  .str());
    }
    transform_pixels(
            _getRawView(), rhs._getRawView(), _getRawView(),
            [&c](PixelT const& l, PixelT const& r) -> PixelT { return l / (c * r); });
}

scaledMinus()

template<typename PixelT >

void lsst::afw::image::Image< PixelT >::scaledMinus	(	PixelT const	c,
		Image< PixelT > const &	rhs )

Subtract Image c*rhs from lhs.

Definition at line 519 of file Image.cc.

                                                                        {
    if (this->getDimensions() != rhs.getDimensions()) {
        throw LSST_EXCEPT(pex::exceptions::LengthError,
                          (boost::format("Images are of different size, %dx%d v %dx%d") % this->getWidth() %
                           this->getHeight() % rhs.getWidth() % rhs.getHeight())
                                  .str());
    }
    transform_pixels(
            _getRawView(), rhs._getRawView(), _getRawView(),
            [&c](PixelT const& l, PixelT const& r) -> PixelT { return l - (c * r); });
}

scaledMultiplies()

template<typename PixelT >

void lsst::afw::image::Image< PixelT >::scaledMultiplies	(	PixelT const	c,
		Image< PixelT > const &	rhs )

Multiply lhs by Image c*rhs (i.e. pixel-by-pixel multiplication)

Definition at line 564 of file Image.cc.

                                                                       {
    if (this->getDimensions() != rhs.getDimensions()) {
        throw LSST_EXCEPT(pex::exceptions::LengthError,
                          (boost::format("Images are of different size, %dx%d v %dx%d") % this->getWidth() %
                           this->getHeight() % rhs.getWidth() % rhs.getHeight())
                                  .str());
    }
    transform_pixels(
            _getRawView(), rhs._getRawView(), _getRawView(),
            [&c](PixelT const& l, PixelT const& r) -> PixelT { return l * (c * r); });
}

scaledPlus()

template<typename PixelT >

void lsst::afw::image::Image< PixelT >::scaledPlus	(	PixelT const	c,
		Image< PixelT > const &	rhs )

Add Image c*rhs to lhs.

Definition at line 487 of file Image.cc.

                                                                       {
    if (this->getDimensions() != rhs.getDimensions()) {
        throw LSST_EXCEPT(pex::exceptions::LengthError,
                          (boost::format("Images are of different size, %dx%d v %dx%d") % this->getWidth() %
                           this->getHeight() % rhs.getWidth() % rhs.getHeight())
                                  .str());
    }
    transform_pixels(
            _getRawView(), rhs._getRawView(), _getRawView(),
            [&c](PixelT const& l, PixelT const& r) -> PixelT { return l + (c * r); });
}

setXY0() [1/2]

template<typename PixelT >

void lsst::afw::image::ImageBase< PixelT >::setXY0 ( int const x0, int const y0 )

inlineinherited

Set the ImageBase's origin.

The origin is usually set by the constructor, so you shouldn't need this function

Note

There are use cases (e.g. memory overlays) that may want to set these values, but don't do so unless you are an Expert.

Definition at line 443 of file ImageBase.h.

{ setXY0(lsst::geom::Point2I(x0, y0)); }

setXY0() [2/2]

template<typename PixelT >

void lsst::afw::image::ImageBase< PixelT >::setXY0 ( lsst::geom::Point2I const origin )

inlineinherited

Set the ImageBase's origin.

The origin is usually set by the constructor, so you shouldn't need this function

Note

There are use cases (e.g. memory overlays) that may want to set these values, but don't do so unless you are an Expert.

Definition at line 434 of file ImageBase.h.

{ _origin = origin; }

sqrt()

template<typename PixelT >

void lsst::afw::image::Image< PixelT >::sqrt

(

)

Definition at line 449 of file Image.cc.

                         {
    transform_pixels(_getRawView(), _getRawView(),
                     [](PixelT const& l) -> PixelT { return static_cast<PixelT>(std::sqrt(l)); });
}

subset()

template<typename PixelT >

Image lsst::afw::image::Image< PixelT >::subset ( lsst::geom::Box2I const & bbox, ImageOrigin origin = PARENT ) const

inline

Return a subimage corresponding to the given box.

Parameters

bbox	Bounding box of the subimage returned.
origin	Origin bbox is rleative to; PARENT accounts for xy0, LOCAL does not.

Returns

A subimage view into this.

This method is wrapped as getitem in Python.

Note

This method permits mutable views to be obtained from const references to images (just as the copy constructor does). This is an intrinsic flaw in Image's design.

Definition at line 219 of file Image.h.

                                                                               {
        return Image(*this, bbox, origin, false);
    }

swap() [1/2]

template<typename PixelT >

void lsst::afw::image::Image< PixelT >::swap

(

Image< PixelT > &

rhs

)

Definition at line 437 of file Image.cc.

                                   {
    using std::swap;  // See Meyers, Effective C++, Item 25
    ImageBase<PixelT>::swap(rhs);
}

swap() [2/2]

template<typename PixelT >

void lsst::afw::image::ImageBase< PixelT >::swap ( ImageBase< PixelT > & rhs )

inherited

Definition at line 233 of file Image.cc.

                                           {
    using std::swap;  // See Meyers, Effective C++, Item 25
 
    swap(_manager, rhs._manager);  // just swapping the pointers
    swap(_gilView, rhs._gilView);
    swap(_origin, rhs._origin);
}

writeFits() [1/6]

template<typename PixelT >

void lsst::afw::image::Image< PixelT >::writeFits	(	fits::Fits &	fitsfile,
		daf::base::PropertySet const *	metadata = nullptr ) const

Write an image to an open FITS file object.

Parameters

[in]	fitsfile	A FITS file already open to the desired HDU.
[in]	metadata	Additional values to write to the header (may be null).

writeFits() [2/6]

template<typename PixelT >

void lsst::afw::image::Image< PixelT >::writeFits	(	fits::Fits &	fitsfile,
		fits::ImageWriteOptions const &	options,
		daf::base::PropertySet const *	header = nullptr,
		Mask< MaskPixel > const *	mask = nullptr ) const

Write an image to an open FITS file object.

Parameters

[in]	fitsfile	A FITS file already open to the desired HDU.
[in]	options	Options controlling writing of FITS image.
[in]	header	Additional values to write to the header (may be null).
[in]	mask	Mask, for calculation of statistics.

writeFits() [3/6]

template<typename PixelT >

void lsst::afw::image::Image< PixelT >::writeFits	(	fits::MemFileManager &	manager,
		daf::base::PropertySet const *	metadata = nullptr,
		std::string const &	mode = "w" ) const

Write an image to a FITS RAM file.

Parameters

[in]	manager	Manager object for the memory block to write to.
[in]	metadata	Additional values to write to the header (may be null).
[in]	mode	"w"=Create a new file; "a"=Append a new HDU.

writeFits() [4/6]

template<typename PixelT >

void lsst::afw::image::Image< PixelT >::writeFits	(	fits::MemFileManager &	manager,
		fits::ImageWriteOptions const &	options,
		std::string const &	mode = "w",
		daf::base::PropertySet const *	header = nullptr,
		Mask< MaskPixel > const *	mask = nullptr ) const

Write an image to a FITS RAM file.

Parameters

[in]	manager	Manager object for the memory block to write to.
[in]	options	Options controlling writing of FITS image.
[in]	header	Additional values to write to the header (may be null).
[in]	mode	"w"=Create a new file; "a"=Append a new HDU.
[in]	mask	Mask, for calculation of statistics.

writeFits() [5/6]

template<typename PixelT >

void lsst::afw::image::Image< PixelT >::writeFits	(	std::string const &	fileName,
		daf::base::PropertySet const *	metadata = nullptr,
		std::string const &	mode = "w" ) const

Write an image to a regular FITS file.

Parameters

[in]	fileName	Name of the file to write.
[in]	metadata	Additional values to write to the header (may be null).
[in]	mode	"w"=Create a new file; "a"=Append a new HDU.

writeFits() [6/6]

template<typename PixelT >

void lsst::afw::image::Image< PixelT >::writeFits	(	std::string const &	filename,
		fits::ImageWriteOptions const &	options,
		std::string const &	mode = "w",
		daf::base::PropertySet const *	header = nullptr,
		Mask< MaskPixel > const *	mask = nullptr ) const

Write an image to a regular FITS file.

Parameters

[in]	filename	Name of the file to write.
[in]	options	Options controlling writing of FITS image.
[in]	mode	"w"=Create a new file; "a"=Append a new HDU.
[in]	header	Additional values to write to the header (may be null).
[in]	mask	Mask, for calculation of statistics.

x_at()

template<typename PixelT >

x_iterator lsst::afw::image::ImageBase< PixelT >::x_at ( int x, int y ) const

inlineinherited

Return an x_iterator to the point (x, y) in the image.

Definition at line 407 of file ImageBase.h.

{ return _gilView.x_at(x, y); }

xy_at()

template<typename PixelT >

xy_locator lsst::afw::image::ImageBase< PixelT >::xy_at ( int x, int y ) const

inlineinherited

Return an xy_locator at the point (x, y) in the image.

Locators may be used to access a patch in an image

Definition at line 425 of file ImageBase.h.

{ return xy_locator(_gilView.xy_at(x, y)); }

y_at()

template<typename PixelT >

y_iterator lsst::afw::image::ImageBase< PixelT >::y_at ( int x, int y ) const

inlineinherited

Return an y_iterator to the point (x, y) in the image.

Definition at line 419 of file ImageBase.h.

{ return _gilView.y_at(x, y); }

Friends And Related Symbol Documentation

Image

template<typename PixelT >

template<typename OtherPixelT >

friend class Image

friend

Definition at line 65 of file Image.h.

MaskedImage

template<typename PixelT >

template<typename , typename , typename >

friend class MaskedImage

friend

Definition at line 54 of file Image.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/include/lsst/afw/image/Image.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/src/image/Image.cc