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

The base class for all image classed (Image, Mask, MaskedImage, ...) More...

#include <Image.h>

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

Public Types
typedef boost::shared_ptr < ImageBase< PixelT > >	Ptr
	A shared_ptr to an ImageBase. More...
typedef boost::shared_ptr < const ImageBase< PixelT > >	ConstPtr
	A shared_ptr to a const ImageBase. More...
typedef detail::basic_tag	image_category
	trait class to identify type of image More...
typedef PixelT	SinglePixel
	A single Pixel of the same type as those in the ImageBase. More...
typedef PixelT	Pixel
	A pixel in this ImageBase. More...
typedef Reference< PixelT >::type	PixelReference
	A Reference to a PixelT. More...
typedef ConstReference< PixelT > ::type	PixelConstReference
	A ConstReference to a PixelT. More...
typedef _view_t::xy_locator	xy_locator
	An xy_locator. More...
typedef _view_t::xy_locator::const_t	const_xy_locator
	A const_xy_locator. More...
typedef _view_t::iterator	iterator
	An STL compliant iterator. More...
typedef _const_view_t::iterator	const_iterator
	An STL compliant const iterator. More...
typedef _view_t::reverse_iterator	reverse_iterator
	An STL compliant reverse iterator. More...
typedef _const_view_t::reverse_iterator	const_reverse_iterator
	An STL compliant const reverse iterator. More...
typedef _view_t::x_iterator	x_iterator
	An iterator for traversing the pixels in a row. More...
typedef x_iterator	fast_iterator
typedef _view_t::x_iterator	xy_x_iterator
	An iterator for traversing the pixels in a row, created from an xy_locator. More...
typedef _const_view_t::x_iterator	const_x_iterator
	A const iterator for traversing the pixels in a row. More...
typedef _view_t::y_iterator	y_iterator
	An iterator for traversing the pixels in a column. More...
typedef _view_t::y_iterator	xy_y_iterator
	An iterator for traversing the pixels in a row, created from an xy_locator. More...
typedef _const_view_t::y_iterator	const_y_iterator
	A const iterator for traversing the pixels in a column. More...
typedef ndarray::Array< PixelT, 2, 1 >	Array
	A mutable ndarray representation of the image. More...
typedef ndarray::Array< PixelT const, 2, 1 >	ConstArray
	An immutable ndarray representation of the image. More...
Public Types inherited from lsst::daf::base::Persistable
typedef boost::shared_ptr < Persistable >	Ptr
Public Types inherited from lsst::daf::base::Citizen
enum	{ magicSentinel = 0xdeadbeef }
typedef unsigned long	memId
	Type of the block's ID. More...
typedef memId(*	memNewCallback )(const memId cid)
	A function used to register a callback. More...
typedef memId(*	memCallback )(const Citizen *ptr)

Public Member Functions
	ImageBase (const geom::Extent2I &dimensions=geom::Extent2I())
	ImageBase (const geom::Box2I &bbox)
	ImageBase (const ImageBase &src, const bool deep=false)
	ImageBase (const ImageBase &src, const geom::Box2I &bbox, const ImageOrigin origin=PARENT, const bool deep=false)
template<typename OtherPixelT >
	ImageBase (const ImageBase< OtherPixelT > &rhs, const bool deep)
	ImageBase (Array const &array, bool deep=false, geom::Point2I const &xy0=geom::Point2I())
virtual	~ImageBase ()
ImageBase &	operator= (const ImageBase &rhs)
ImageBase &	operator= (const PixelT rhs)
	Set the image's pixels to rhs. More...
void	operator<<= (const ImageBase &rhs)
	Set the lhs's pixel values to equal the rhs's. More...
PixelReference	operator() (int x, int y)
	Return a reference to the pixel (x, y) More...
PixelReference	operator() (int x, int y, CheckIndices const &)
	Return a reference to the pixel (x, y) with bounds checking. More...
PixelConstReference	operator() (int x, int y) const
	Return a const reference to the pixel (x, y) More...
PixelConstReference	operator() (int x, int y, CheckIndices const &) const
	Return a const reference to the pixel (x, y) with bounds checking. More...
PixelConstReference	get0 (int x, int y) const
PixelConstReference	get0 (int x, int y, CheckIndices const &check) const
void	set0 (int x, int y, const PixelT v)
void	set0 (int x, int y, const PixelT v, CheckIndices const &check)
int	getWidth () const
	Return the number of columns in the image. More...
int	getHeight () const
	Return the number of rows in the image. More...
int	getX0 () const
int	getY0 () const
geom::Point2I	getXY0 () const
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) More...
double	indexToPosition (double ind, lsst::afw::image::xOrY const xy) const
	Convert image index to image position. More...
geom::Extent2I	getDimensions () const
	Return the image's size; useful for passing to constructors. More...
void	swap (ImageBase &rhs)
Array	getArray ()
ConstArray	getArray () const
iterator	begin () const
iterator	end () const
	Return an STL compliant iterator to the end of the image. More...
reverse_iterator	rbegin () const
	Return an STL compliant reverse iterator to the start of the image. More...
reverse_iterator	rend () const
	Return an STL compliant reverse iterator to the end of the image. More...
iterator	at (int x, int y) const
	Return an STL compliant iterator at the point (x, y) More...
fast_iterator	begin (bool) const
fast_iterator	end (bool) const
x_iterator	row_begin (int y) const
x_iterator	row_end (int y) const
	Return an x_iterator to the end of the y'th row. More...
x_iterator	x_at (int x, int y) const
	Return an x_iterator to the point (x, y) in the image. More...
y_iterator	col_begin (int x) const
y_iterator	col_end (int x) const
	Return an y_iterator to the end of the y'th row. More...
y_iterator	y_at (int x, int y) const
	Return an y_iterator to the point (x, y) in the image. More...
xy_locator	xy_at (int x, int y) const
void	setXY0 (geom::Point2I const origin)
void	setXY0 (int const x0, int const y0)
geom::Box2I	getBBox (ImageOrigin origin=PARENT) const
Public Member Functions inherited from lsst::daf::base::Persistable
	Persistable (void)
virtual	~Persistable (void)
template<class Archive >
void	serialize (Archive &, unsigned int const)
Public Member Functions inherited from lsst::daf::base::Citizen
	Citizen (const std::type_info &)
	Citizen (Citizen const &)
	~Citizen ()
Citizen &	operator= (Citizen const &)
std::string	repr () const
	Return a string representation of a Citizen. More...
void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...
memId	getId () const
	Return the Citizen's ID. More...

Static Public Member Functions
template<typename SinglePixelT >
static SinglePixel	PixelCast (SinglePixelT rhs)
	Convert a type to our SinglePixel type. More...
Static Public Member Functions inherited from lsst::daf::base::Citizen
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...
static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...
static int	init ()
	Called once when the memory system is being initialised. More...
static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...
static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...
static const std::vector < const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...
static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...
static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...
static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...
static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...
static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

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

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

Private Types
typedef lsst::afw::image::detail::types_traits < PixelT >::view_t	_view_t
typedef lsst::afw::image::detail::types_traits < PixelT >::const_view_t	_const_view_t
typedef ndarray::Manager	Manager

Private Attributes
geom::Point2I	_origin
Manager::Ptr	_manager
_view_t	_gilView

Friends
template<typename OtherPixelT >
class	ImageBase
template<typename >
class	DecoratedImage
template<typename , typename , typename >
class	MaskedImage

Detailed Description

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

The base class for all image classed (Image, Mask, MaskedImage, ...)

Definition at line 115 of file Image.h.

Member Typedef Documentation

template<typename PixelT>

typedef lsst::afw::image::detail::types_traits<PixelT>::const_view_t lsst::afw::image::ImageBase< PixelT >::_const_view_t

private

Definition at line 119 of file Image.h.

template<typename PixelT>

typedef lsst::afw::image::detail::types_traits<PixelT>::view_t lsst::afw::image::ImageBase< PixelT >::_view_t

private

Definition at line 118 of file Image.h.

template<typename PixelT>

typedef ndarray::Array<PixelT, 2, 1> lsst::afw::image::ImageBase< PixelT >::Array

A mutable ndarray representation of the image.

Definition at line 166 of file Image.h.

template<typename PixelT>

typedef _const_view_t::iterator lsst::afw::image::ImageBase< PixelT >::const_iterator

An STL compliant const iterator.

Definition at line 145 of file Image.h.

template<typename PixelT>

typedef _const_view_t::reverse_iterator lsst::afw::image::ImageBase< PixelT >::const_reverse_iterator

An STL compliant const reverse iterator.

Definition at line 149 of file Image.h.

template<typename PixelT>

typedef _const_view_t::x_iterator lsst::afw::image::ImageBase< PixelT >::const_x_iterator

A const iterator for traversing the pixels in a row.

Definition at line 158 of file Image.h.

template<typename PixelT>

typedef _view_t::xy_locator::const_t lsst::afw::image::ImageBase< PixelT >::const_xy_locator

A const_xy_locator.

Definition at line 141 of file Image.h.

template<typename PixelT>

typedef _const_view_t::y_iterator lsst::afw::image::ImageBase< PixelT >::const_y_iterator

A const iterator for traversing the pixels in a column.

Definition at line 164 of file Image.h.

template<typename PixelT>

typedef ndarray::Array<PixelT const, 2, 1> lsst::afw::image::ImageBase< PixelT >::ConstArray

An immutable ndarray representation of the image.

Definition at line 168 of file Image.h.

template<typename PixelT>

typedef boost::shared_ptr<const ImageBase<PixelT> > lsst::afw::image::ImageBase< PixelT >::ConstPtr

A shared_ptr to a const ImageBase.

Definition at line 126 of file Image.h.

template<typename PixelT>

typedef x_iterator lsst::afw::image::ImageBase< PixelT >::fast_iterator

A fast STL compliant iterator for contiguous images N.b. The order of pixel access is undefined

Definition at line 154 of file Image.h.

template<typename PixelT>

typedef detail::basic_tag lsst::afw::image::ImageBase< PixelT >::image_category

trait class to identify type of image

Definition at line 128 of file Image.h.

template<typename PixelT>

typedef _view_t::iterator lsst::afw::image::ImageBase< PixelT >::iterator

An STL compliant iterator.

Definition at line 143 of file Image.h.

template<typename PixelT>

typedef ndarray::Manager lsst::afw::image::ImageBase< PixelT >::Manager

private

Definition at line 122 of file Image.h.

template<typename PixelT>

typedef PixelT lsst::afw::image::ImageBase< PixelT >::Pixel

A pixel in this ImageBase.

Definition at line 133 of file Image.h.

template<typename PixelT>

typedef ConstReference<PixelT>::type lsst::afw::image::ImageBase< PixelT >::PixelConstReference

A ConstReference to a PixelT.

Definition at line 137 of file Image.h.

template<typename PixelT>

typedef Reference<PixelT>::type lsst::afw::image::ImageBase< PixelT >::PixelReference

A Reference to a PixelT.

Definition at line 135 of file Image.h.

template<typename PixelT>

typedef boost::shared_ptr<ImageBase<PixelT> > lsst::afw::image::ImageBase< PixelT >::Ptr

A shared_ptr to an ImageBase.

Definition at line 125 of file Image.h.

template<typename PixelT>

typedef _view_t::reverse_iterator lsst::afw::image::ImageBase< PixelT >::reverse_iterator

An STL compliant reverse iterator.

Definition at line 147 of file Image.h.

template<typename PixelT>

typedef PixelT lsst::afw::image::ImageBase< PixelT >::SinglePixel

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

Definition at line 131 of file Image.h.

template<typename PixelT>

typedef _view_t::x_iterator lsst::afw::image::ImageBase< PixelT >::x_iterator

An iterator for traversing the pixels in a row.

Definition at line 151 of file Image.h.

template<typename PixelT>

typedef _view_t::xy_locator lsst::afw::image::ImageBase< PixelT >::xy_locator

An xy_locator.

Definition at line 139 of file Image.h.

template<typename PixelT>

typedef _view_t::x_iterator lsst::afw::image::ImageBase< PixelT >::xy_x_iterator

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

Definition at line 156 of file Image.h.

template<typename PixelT>

typedef _view_t::y_iterator lsst::afw::image::ImageBase< PixelT >::xy_y_iterator

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

Definition at line 162 of file Image.h.

template<typename PixelT>

typedef _view_t::y_iterator lsst::afw::image::ImageBase< PixelT >::y_iterator

An iterator for traversing the pixels in a column.

Definition at line 160 of file Image.h.

Constructor & Destructor Documentation

template<typename PixelT >

lsst::afw::image::ImageBase< PixelT >::ImageBase ( const geom::Extent2I &  dimensions = geom::Extent2I() )

explicit

Allocator Constructor

allocate a new image with the specified dimensions. Sets origin at (0,0)

Definition at line 104 of file Image.cc.

  : lsst::daf::base::Citizen(typeid(this)),
    _origin(0,0), _manager(),
    _gilView(_allocateView(dimensions, _manager))
{}

template<typename PixelT >

lsst::afw::image::ImageBase< PixelT >::ImageBase ( const geom::Box2I &  bbox )

explicit

Allocator Constructor

allocate a new image with the specified dimensions and origin

Definition at line 117 of file Image.cc.

  : lsst::daf::base::Citizen(typeid(this)),
    _origin(bbox.getMin()), _manager(),
    _gilView(_allocateView(bbox.getDimensions(), _manager))
{}

template<typename PixelT >

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

Copy constructor.

Note

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

Parameters

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

Definition at line 131 of file Image.cc.

  :
    lsst::daf::base::Citizen(typeid(this)),
    _origin(rhs._origin),
    _manager(rhs._manager),
    _gilView(rhs._gilView)
{
    if (deep) {
        ImageBase tmp(getBBox());
        tmp <<= *this;                  // now copy the pixels
        swap(tmp);
    }
}

template<typename PixelT >

lsst::afw::image::ImageBase< PixelT >::ImageBase ( const ImageBase< PixelT > &  src, const geom::Box2I &  bbox, const ImageOrigin  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.

Note

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

Parameters

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

Definition at line 157 of file Image.cc.

  :
    lsst::daf::base::Citizen(typeid(this)),
    _origin((origin==PARENT) ? bbox.getMin(): rhs._origin + geom::Extent2I(bbox.getMin())),
    _manager(rhs._manager), // reference counted pointer, don't copy pixels
    _gilView(_makeSubView(bbox.getDimensions(), _origin - rhs._origin, rhs._gilView))
{
    if (deep) {
        ImageBase tmp(getBBox());        
        tmp <<= *this;                  // now copy the pixels
        swap(tmp);
    }
}

template<typename PixelT>

template<typename OtherPixelT >

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

inline

generalised copy constructor

defined here in the header so that the compiler can instantiate N(N-1) conversions between N ImageBase types.

Definition at line 193 of file Image.h.

                                                                      :
            lsst::daf::base::Citizen(typeid(this)) {
            if (!deep) {
                throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
                    "Only deep copies are permitted for ImageBases with different pixel types");
            }

            ImageBase<PixelT> tmp(rhs.getBBox());
            copy_and_convert_pixels(rhs._gilView, tmp._gilView); // from boost::gil

            using std::swap;                           // See Meyers, Effective C++, Item 25
            ImageBase<PixelT>::swap(tmp);                  // See Meyers, Effective C++, Items 11 and 43
        }

template<typename PixelT >

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

explicit

Construction from ndarray::Array and NumPy.

Note

ndarray and NumPy indexes are ordered (y,x), but Image indices are ordered (x,y).

Unless deep is true, the new image will share memory with the array if the the dimension is contiguous in memory. If the last dimension is not contiguous, the array will be deep-copied in Python, but the constructor will fail to compile in pure C++.

Definition at line 186 of file Image.cc.

                                                                                         :
    lsst::daf::base::Citizen(typeid(this)),
    _origin(xy0),
    _manager(array.getManager()),
    _gilView(
        boost::gil::interleaved_view(
            array.template getSize<1>(), array.template getSize<0>(), 
            (typename _view_t::value_type* )array.getData(), 
            array.template getStride<0>() * sizeof(PixelT)
        )
    )
{
    if (deep) {
        ImageBase tmp(*this, true);
        swap(tmp);
    }
}

template<typename PixelT>

virtual lsst::afw::image::ImageBase< PixelT >::~ImageBase ( )

inlinevirtual

Definition at line 211 of file Image.h.

{ }

Member Function Documentation

template<typename PixelT >

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

staticprotected

Definition at line 53 of file Image.cc.

  {
    if (dimensions.getX() < 0 || dimensions.getY() < 0) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
                          str(boost::format("Both width and height must be non-negative: %d, %d")
                              % 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)
    );
}

template<typename PixelT>

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

inlineprotected

Definition at line 401 of file Image.h.

{ return _gilView; }

template<typename PixelT >

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

staticprotected

Definition at line 74 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(
            lsst::pex::exceptions::LengthError,
            (boost::format("Box2I(Point2I(%d,%d),Extent2I(%d,%d)) doesn't fit in image %dx%d") %
                offset.getX() % offset.getY() % 
                dimensions.getX() % dimensions.getY() %
                view.width() % view.height()
            ).str()
        );
    }
    return boost::gil::subimage_view(
        view, 
        offset.getX(), offset.getY(),
        dimensions.getX(), dimensions.getY()
    );
}

template<typename PixelT >

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

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

Definition at line 345 of file Image.cc.

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

template<typename PixelT >

image::ImageBase< PixelT >::iterator lsst::afw::image::ImageBase< PixelT >::begin

(

)

const

Return an STL compliant iterator to the start of the image

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

Definition at line 321 of file Image.cc.

                                                                            {
    return _gilView.begin();
}

template<typename PixelT >

image::ImageBase< PixelT >::fast_iterator lsst::afw::image::ImageBase< PixelT >::begin

(

bool

contiguous

)

const

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

Exceptions

lsst::pex::exceptions::Runtime

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

Parameters

contiguous

Pixels are contiguous (must be true)

Definition at line 354 of file Image.cc.

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

    return row_begin(0);
}

template<typename PixelT>

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

inline

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

Incrementing an y_iterator moves it up the column

Definition at line 334 of file Image.h.

                                          {
            return _gilView.col_begin(x);
        }

template<typename PixelT>

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

inline

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

Definition at line 339 of file Image.h.

                                        {
            return _gilView.col_end(x);
        }

template<typename PixelT >

image::ImageBase< PixelT >::iterator lsst::afw::image::ImageBase< PixelT >::end

(

)

const

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

Definition at line 327 of file Image.cc.

                                                                          {
    return _gilView.end();
}

template<typename PixelT >

image::ImageBase< PixelT >::fast_iterator lsst::afw::image::ImageBase< PixelT >::end

(

bool

contiguous

)

const

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

Exceptions

lsst::pex::exceptions::Runtime

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

Parameters

contiguous

Pixels are contiguous (must be true)

Definition at line 374 of file Image.cc.

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

    return row_end(getHeight()-1);
}

template<typename PixelT>

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

inline

Definition at line 223 of file Image.h.

                                                     {
            return operator()(x-getX0(), y-getY0());
        }

template<typename PixelT>

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

inline

Definition at line 226 of file Image.h.

                                                                                {
            return operator()(x-getX0(), y-getY0(), check);
        }

template<typename PixelT >

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

(

)

Definition at line 292 of file Image.cc.

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

template<typename PixelT >

image::ImageBase< PixelT >::ConstArray lsst::afw::image::ImageBase< PixelT >::getArray

(

)

const

Definition at line 304 of file Image.cc.

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

template<typename PixelT>

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

inline

Definition at line 377 of file Image.h.

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

template<typename PixelT>

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

inline

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

Definition at line 298 of file Image.h.

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

template<typename PixelT>

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

inline

Return the number of rows in the image.

Definition at line 239 of file Image.h.

{ return _gilView.height(); }

template<typename PixelT>

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

inline

Return the number of columns in the image.

Definition at line 237 of file Image.h.

{ return _gilView.width(); }

template<typename PixelT>

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

inline

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 247 of file Image.h.

{ return _origin.getX(); }

template<typename PixelT>

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

inline

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 264 of file Image.h.

{ return _origin; }

template<typename PixelT>

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

inline

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 255 of file Image.h.

{ return _origin.getY(); }

template<typename PixelT>

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

inline

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 290 of file Image.h.

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

template<typename PixelT>

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

inlineprotected

Definition at line 404 of file Image.h.

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

template<typename PixelT >

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

Return a reference to the pixel (x, y)

Definition at line 232 of file Image.cc.

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

template<typename PixelT >

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

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

Definition at line 240 of file Image.cc.

{
    if (check && (x < 0 || x >= getWidth() || y < 0 || y >= getHeight())) {
        throw LSST_EXCEPT(lsst::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 image::ImageBase<PixelT>::PixelReference>(
        static_cast<typename image::ImageBase<PixelT>::PixelConstReference>(_gilView(x, y)[0])
    );
}

template<typename PixelT >

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

Return a const reference to the pixel (x, y)

Definition at line 260 of file Image.cc.

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

template<typename PixelT >

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

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

Definition at line 267 of file Image.cc.

                                                                                         {
    if (check && (x < 0 || x >= getWidth() || y < 0 || y >= getHeight())) {
        throw LSST_EXCEPT(lsst::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];
}

template<typename PixelT >

void lsst::afw::image::ImageBase< PixelT >::operator<<=

(

const ImageBase< PixelT > &

rhs

)

Set the lhs's pixel values to equal the rhs's.

Definition at line 221 of file Image.cc.

                                                             {
    if (getDimensions() != rhs.getDimensions()) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
                          (boost::format("Dimension mismatch: %dx%d v. %dx%d") %
                              getWidth() % getHeight() % rhs.getWidth() % rhs.getHeight()).str());
    }
    copy_pixels(rhs._gilView, _gilView);
}

template<typename PixelT >

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

(

const ImageBase< PixelT > &

rhs

)

Shallow 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 operator<<=()

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

Definition at line 212 of file Image.cc.

                                                                              {
    ImageBase tmp(rhs);
    swap(tmp);                          // See Meyers, Effective C++, Item 11
    
    return *this;
}

template<typename PixelT>

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

(

const PixelT

rhs

)

Set the image's pixels to rhs.

Definition at line 392 of file Image.cc.

                                                                          {
    fill_pixels(_gilView, rhs);

    return *this;
}

template<typename PixelT>

template<typename SinglePixelT >

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

inlinestatic

Convert a type to our SinglePixel type.

Definition at line 175 of file Image.h.

                                                       {
            return SinglePixel(rhs);
        }

template<typename PixelT>

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

inline

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 271 of file Image.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);
        }

template<typename PixelT >

image::ImageBase< PixelT >::reverse_iterator lsst::afw::image::ImageBase< PixelT >::rbegin

(

)

const

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

Definition at line 333 of file Image.cc.

                                                                                     {
    return _gilView.rbegin();
}

template<typename PixelT >

image::ImageBase< PixelT >::reverse_iterator lsst::afw::image::ImageBase< PixelT >::rend

(

)

const

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

Definition at line 339 of file Image.cc.

                                                                                   {
    return _gilView.rend();
}

template<typename PixelT>

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

inline

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

Incrementing an x_iterator moves it across the row

Definition at line 319 of file Image.h.

                                          {
            return _gilView.row_begin(y);
        }

template<typename PixelT>

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

inline

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

Definition at line 324 of file Image.h.

                                        {
            return _gilView.row_end(y);
        }

template<typename PixelT>

void lsst::afw::image::ImageBase< PixelT >::set0 ( int  x, int  y, const PixelT  v  )

inline

Definition at line 229 of file Image.h.

                                                {
            operator()(x-getX0(), y-getY0()) = v;
        }

template<typename PixelT>

void lsst::afw::image::ImageBase< PixelT >::set0 ( int  x, int  y, const PixelT  v, CheckIndices const &  check  )

inline

Definition at line 232 of file Image.h.

                                                                           {
            operator()(x-getX0(), y-getY0(), check) = v;
        }

template<typename PixelT>

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

inline

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 362 of file Image.h.

                                              {
            _origin=origin;
        }

template<typename PixelT>

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

inline

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 373 of file Image.h.

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

template<typename PixelT >

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

(

ImageBase< PixelT > &

rhs

)

Definition at line 278 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);
}

template<typename PixelT>

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

inline

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

Definition at line 329 of file Image.h.

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

template<typename PixelT>

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

inline

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 351 of file Image.h.

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

template<typename PixelT>

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

inline

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

Definition at line 344 of file Image.h.

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

Friends And Related Function Documentation

template<typename PixelT>

template<typename OtherPixelT >

friend class ImageBase

friend

Definition at line 170 of file Image.h.

template<typename PixelT>

template<typename >

friend class DecoratedImage

friend

Definition at line 181 of file Image.h.

template<typename PixelT>

template<typename , typename , typename >

friend class MaskedImage

friend

Definition at line 182 of file Image.h.

Member Data Documentation

template<typename PixelT>

_view_t lsst::afw::image::ImageBase< PixelT >::_gilView

private

Definition at line 386 of file Image.h.

template<typename PixelT>

Manager::Ptr lsst::afw::image::ImageBase< PixelT >::_manager

private

Definition at line 385 of file Image.h.

template<typename PixelT>

geom::Point2I lsst::afw::image::ImageBase< PixelT >::_origin

private

Definition at line 384 of file Image.h.

---

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

• /lsst/home/lsstsw/stack/Linux64/afw/master-gae20e2b580+3/include/lsst/afw/image/Image.h
• /lsst/home/lsstsw/stack/Linux64/afw/master-gae20e2b580+3/src/image/Image.cc