LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
Classes | Public Types | Public Member Functions | Static Public Member Functions | Friends | Related Functions | List of all members
lsst.afw.image::Image< T > Class Template Reference

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

#include <PSF.h>

Inheritance diagram for lsst.afw.image::Image< T >:
lsst.afw.image::ImageBase< PixelT > lsst::daf::base::Persistable lsst::daf::base::Citizen

Classes

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

Public Types

typedef boost::shared_ptr
< Image< PixelT > > 
Ptr
 
typedef boost::shared_ptr
< const Image< PixelT > > 
ConstPtr
 
typedef detail::Image_tag image_category
 
- Public Types inherited from lsst.afw.image::ImageBase< PixelT >
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

 Image (unsigned int width, unsigned int height, PixelT initialValue=0)
 
 Image (geom::Extent2I const &dimensions=geom::Extent2I(), PixelT initialValue=0)
 
 Image (geom::Box2I const &bbox, PixelT initialValue=0)
 
 Image (Image const &rhs, geom::Box2I const &bbox, ImageOrigin const origin=PARENT, const bool deep=false)
 
 Image (const Image &rhs, const bool deep=false)
 
 Image (std::string const &fileName, int hdu=0, boost::shared_ptr< lsst::daf::base::PropertySet > metadata=boost::shared_ptr< lsst::daf::base::PropertySet >(), geom::Box2I const &bbox=geom::Box2I(), ImageOrigin origin=PARENT)
 Construct an Image by reading a regular FITS file. More...
 
 Image (fits::MemFileManager &manager, int hdu=0, boost::shared_ptr< lsst::daf::base::PropertySet > metadata=boost::shared_ptr< lsst::daf::base::PropertySet >(), geom::Box2I const &bbox=geom::Box2I(), ImageOrigin origin=PARENT)
 Construct an Image by reading a FITS image in memory. More...
 
 Image (fits::Fits &fitsfile, boost::shared_ptr< lsst::daf::base::PropertySet > metadata=boost::shared_ptr< lsst::daf::base::PropertySet >(), geom::Box2I const &bbox=geom::Box2I(), ImageOrigin origin=PARENT)
 Construct an Image from an already-open FITS object. More...
 
template<typename OtherPixelT >
 Image (Image< OtherPixelT > const &rhs, const bool deep)
 
 Image (ndarray::Array< PixelT, 2, 1 > const &array, bool deep=false, geom::Point2I const &xy0=geom::Point2I())
 
virtual ~Image ()
 
Imageoperator= (const PixelT rhs)
 Set the image's pixels to rhs. More...
 
Imageoperator= (const Image &rhs)
 
void writeFits (std::string const &fileName, boost::shared_ptr< lsst::daf::base::PropertySet const > metadata=boost::shared_ptr< lsst::daf::base::PropertySet const >(), std::string const &mode="w") const
 Write an image to a regular FITS file. More...
 
void writeFits (fits::MemFileManager &manager, boost::shared_ptr< lsst::daf::base::PropertySet const > metadata=boost::shared_ptr< lsst::daf::base::PropertySet const >(), std::string const &mode="w") const
 Write an image to a FITS RAM file. More...
 
void writeFits (fits::Fits &fitsfile, boost::shared_ptr< lsst::daf::base::PropertySet const > metadata=boost::shared_ptr< lsst::daf::base::PropertySet const >()) const
 Write an image to an open FITS file object. More...
 
void swap (Image &rhs)
 
void operator+= (PixelT const rhs)
 Add scalar rhs to lhs. More...
 
virtual void operator+= (Image< PixelT >const &rhs)
 Add Image rhs to lhs. More...
 
void operator+= (lsst::afw::math::Function2< double > const &function)
 Add a Function2(x, y) to an Image. More...
 
void scaledPlus (double const c, Image< PixelT >const &rhs)
 Add Image c*rhs to lhs. More...
 
void operator-= (PixelT const rhs)
 Subtract scalar rhs from lhs. More...
 
void operator-= (Image< PixelT > const &rhs)
 Subtract Image rhs from lhs. More...
 
void operator-= (lsst::afw::math::Function2< double > const &function)
 Subtract a Function2(x, y) from an Image. More...
 
void scaledMinus (double const c, Image< PixelT >const &rhs)
 Subtract Image c*rhs from lhs. More...
 
void operator*= (PixelT const rhs)
 Multiply lhs by scalar rhs. More...
 
void operator*= (Image< PixelT > const &rhs)
 Multiply lhs by Image rhs (i.e. pixel-by-pixel multiplication) More...
 
void scaledMultiplies (double const c, Image< PixelT >const &rhs)
 Multiply lhs by Image c*rhs (i.e. pixel-by-pixel multiplication) More...
 
void operator/= (PixelT const rhs)
 
void operator/= (Image< PixelT > const &rhs)
 Divide lhs by Image rhs (i.e. pixel-by-pixel division) More...
 
void scaledDivides (double const c, Image< PixelT >const &rhs)
 Divide lhs by Image c*rhs (i.e. pixel-by-pixel division) More...
 
void sqrt ()
 
template<>
void operator/= (double const rhs)
 
template<>
void operator/= (float const rhs)
 
- Public Member Functions inherited from lsst.afw.image::ImageBase< PixelT >
 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 ()
 
ImageBaseoperator= (const ImageBase &rhs)
 
ImageBaseoperator= (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 ()
 
Citizenoperator= (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

static Image readFits (std::string const &filename, int hdu=0)
 Read an Image from a regular FITS file. More...
 
static Image readFits (fits::MemFileManager &manager, int hdu=0)
 Read an Image from a FITS RAM file. More...
 
- Static Public Member Functions inherited from lsst.afw.image::ImageBase< PixelT >
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...
 

Friends

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

Related Functions

(Note that these are not member functions.)

template<typename ImageT >
ImageT::SinglePixel badPixel (typename ImageT::Pixel bad=0)
 

Additional Inherited Members

- Protected Member Functions inherited from lsst.afw.image::ImageBase< PixelT >
_view_t _getRawView () const
 
bool isContiguous () const
 
- Static Protected Member Functions inherited from lsst.afw.image::ImageBase< PixelT >
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)
 

Detailed Description

template<typename T>
class lsst.afw.image::Image< T >

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

Examples:
forEachPixel.cc, image1.cc, image2.cc, and spatialCellExample.cc.

Definition at line 43 of file PSF.h.

Member Typedef Documentation

template<typename T>
typedef boost::shared_ptr<const Image<PixelT> > lsst.afw.image::Image< T >::ConstPtr

Definition at line 419 of file Image.h.

template<typename T>
typedef detail::Image_tag lsst.afw.image::Image< T >::image_category

Definition at line 421 of file Image.h.

template<typename T>
typedef boost::shared_ptr<Image<PixelT> > lsst.afw.image::Image< T >::Ptr

Definition at line 418 of file Image.h.

Constructor & Destructor Documentation

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

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
Parameters
widthnumber of columns
heightnumber of rows
initialValueInitial value

Definition at line 413 of file Image.cc.

416  :
418 {
419  *this = initialValue;
420 }
The base class for all image classed (Image, Mask, MaskedImage, ...)
Definition: Image.h:115
Extent< int, 2 > ExtentI
Definition: Extent.h:352
template<typename PixelT >
lsst.afw.image::Image< PixelT >::Image ( geom::Extent2I const &  dimensions = geom::Extent2I(),
PixelT  initialValue = 0 
)
explicit

Create an initialised Image of the specified size

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
Parameters
dimensionsNumber of columns, rows
initialValueInitial value

Definition at line 429 of file Image.cc.

431  :
433 {
434  *this = initialValue;
435 }
The base class for all image classed (Image, Mask, MaskedImage, ...)
Definition: Image.h:115
afw::table::PointKey< int > dimensions
template<typename PixelT >
lsst.afw.image::Image< PixelT >::Image ( geom::Box2I const &  bbox,
PixelT  initialValue = 0 
)
explicit

Create an initialized Image of the specified size

Parameters
bboxdimensions and origin of desired Image
initialValueInitial value

Definition at line 441 of file Image.cc.

443  :
445  *this = initialValue;
446 }
The base class for all image classed (Image, Mask, MaskedImage, ...)
Definition: Image.h:115
template<typename PixelT >
lsst.afw.image::Image< PixelT >::Image ( Image< T > const &  rhs,
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.

Note
Unless deep is true, the new image will share the old image's pixels; this is probably what you want
Parameters
rhsRight-hand-side Image
bboxSpecify desired region
originCoordinate system of the bbox
deepIf false, new ImageBase shares storage with rhs; if true make a new, standalone, ImageBase

Definition at line 470 of file Image.cc.

475  :
476  image::ImageBase<PixelT>(rhs, bbox, origin, deep) {}
The base class for all image classed (Image, Mask, MaskedImage, ...)
Definition: Image.h:115
template<typename PixelT >
lsst.afw.image::Image< PixelT >::Image ( const Image< T > &  rhs,
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
rhsRight-hand-side Image
deepIf false, new Image shares storage with rhs; if true make a new, standalone, ImageBase

Definition at line 455 of file Image.cc.

458  :
459  image::ImageBase<PixelT>(rhs, deep) {}
The base class for all image classed (Image, Mask, MaskedImage, ...)
Definition: Image.h:115
template<typename T>
lsst.afw.image::Image< T >::Image ( std::string const &  fileName,
int  hdu = 0,
boost::shared_ptr< lsst::daf::base::PropertySet metadata = boost::shared_ptr< lsst::daf::base::PropertySet >(),
geom::Box2I const &  bbox = geom::Box2I(),
ImageOrigin  origin = PARENT 
)
explicit

Construct an Image by reading a regular FITS file.

Parameters
[in]fileNameFile to read.
[in]hduHDU to read, 1-indexed (i.e. 1=Primary HDU). The special value of 0 reads the Primary HDU unless it is empty, in which case it reads the first extension HDU.
[in,out]metadataMetadata read from the header (may be null).
[in]bboxIf non-empty, read only the pixels within the bounding box.
[in]originCoordinate system of the bounding box; if PARENT, the bounding box should take into account the xy0 saved with the image.
template<typename T>
lsst.afw.image::Image< T >::Image ( fits::MemFileManager manager,
int  hdu = 0,
boost::shared_ptr< lsst::daf::base::PropertySet metadata = boost::shared_ptr< lsst::daf::base::PropertySet >(),
geom::Box2I const &  bbox = geom::Box2I(),
ImageOrigin  origin = PARENT 
)
explicit

Construct an Image by reading a FITS image in memory.

Parameters
[in]managerAn object that manages the memory buffer to read.
[in]hduHDU to read, 1-indexed (i.e. 1=Primary HDU). The special value of 0 reads the Primary HDU unless it is empty, in which case it reads the first extension HDU.
[in,out]metadataMetadata read from the header (may be null).
[in]bboxIf non-empty, read only the pixels within the bounding box.
[in]originCoordinate system of the bounding box; if PARENT, the bounding box should take into account the xy0 saved with the image.
template<typename T>
lsst.afw.image::Image< T >::Image ( fits::Fits fitsfile,
boost::shared_ptr< lsst::daf::base::PropertySet metadata = boost::shared_ptr< lsst::daf::base::PropertySet >(),
geom::Box2I const &  bbox = geom::Box2I(),
ImageOrigin  origin = PARENT 
)
explicit

Construct an Image from an already-open FITS object.

Parameters
[in]fitsfileA FITS object to read from, already at the desired HDU.
[in,out]metadataMetadata read from the header (may be null).
[in]bboxIf non-empty, read only the pixels within the bounding box.
[in]originCoordinate system of the bounding box; if PARENT, the bounding box should take into account the xy0 saved with the image.
template<typename T>
template<typename OtherPixelT >
lsst.afw.image::Image< T >::Image ( Image< OtherPixelT > const &  rhs,
const bool  deep 
)
inline

Definition at line 497 of file Image.h.

497  :
498  image::ImageBase<PixelT>(rhs, deep) {}
The base class for all image classed (Image, Mask, MaskedImage, ...)
Definition: Image.h:115
template<typename T>
lsst.afw.image::Image< T >::Image ( ndarray::Array< PixelT, 2, 1 > const &  array,
bool  deep = false,
geom::Point2I const &  xy0 = geom::Point2I() 
)
inlineexplicit

Definition at line 500 of file Image.h.

501  :
502  image::ImageBase<PixelT>(array, deep, xy0) {}
The base class for all image classed (Image, Mask, MaskedImage, ...)
Definition: Image.h:115
template<typename T>
virtual lsst.afw.image::Image< T >::~Image ( )
inlinevirtual

Definition at line 504 of file Image.h.

504 { }

Member Function Documentation

template<typename PixelT >
void lsst.afw.image::Image< PixelT >::operator*= ( PixelT const  rhs)

Multiply lhs by scalar rhs.

Definition at line 735 of file Image.cc.

735  {
736  transform_pixels(_getRawView(), _getRawView(), bl::ret<PixelT>(bl::_1 * rhs));
737 }
_view_t _getRawView() const
Definition: Image.h:401
template<typename PixelT >
void lsst.afw.image::Image< PixelT >::operator*= ( Image< PixelT > const &  rhs)

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

Definition at line 741 of file Image.cc.

741  {
742  if (this->getDimensions() != rhs.getDimensions()) {
743  throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
744  (boost::format("Images are of different size, %dx%d v %dx%d") %
745  this->getWidth() % this->getHeight() % rhs.getWidth() % rhs.getHeight()).str());
746  }
747  transform_pixels(_getRawView(), rhs._getRawView(), _getRawView(), bl::ret<PixelT>(bl::_1 * bl::_2));
748 }
int getWidth() const
Return the number of columns in the image.
Definition: Image.h:237
#define LSST_EXCEPT(type,...)
Definition: Exception.h:46
int getHeight() const
Return the number of rows in the image.
Definition: Image.h:239
geom::Extent2I getDimensions() const
Return the image&#39;s size; useful for passing to constructors.
Definition: Image.h:298
_view_t _getRawView() const
Definition: Image.h:401
template<typename PixelT >
void lsst.afw.image::Image< PixelT >::operator+= ( PixelT const  rhs)

Add scalar rhs to lhs.

Definition at line 643 of file Image.cc.

643  {
644  transform_pixels(_getRawView(), _getRawView(), bl::ret<PixelT>(bl::_1 + rhs));
645 }
_view_t _getRawView() const
Definition: Image.h:401
template<typename PixelT >
void lsst.afw.image::Image< PixelT >::operator+= ( Image< PixelT >const &  rhs)
virtual

Add Image rhs to lhs.

Definition at line 649 of file Image.cc.

649  {
650  if (this->getDimensions() != rhs.getDimensions()) {
651  throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
652  (boost::format("Images are of different size, %dx%d v %dx%d") %
653  this->getWidth() % this->getHeight() % rhs.getWidth() % rhs.getHeight()).str());
654  }
655  transform_pixels(_getRawView(), rhs._getRawView(), _getRawView(), bl::ret<PixelT>(bl::_1 + bl::_2));
656 }
int getWidth() const
Return the number of columns in the image.
Definition: Image.h:237
#define LSST_EXCEPT(type,...)
Definition: Exception.h:46
int getHeight() const
Return the number of rows in the image.
Definition: Image.h:239
geom::Extent2I getDimensions() const
Return the image&#39;s size; useful for passing to constructors.
Definition: Image.h:298
_view_t _getRawView() const
Definition: Image.h:401
template<typename PixelT >
void lsst.afw.image::Image< PixelT >::operator+= ( lsst::afw::math::Function2< double > const &  function)

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

Parameters
functionfunction to add

Definition at line 662 of file Image.cc.

664  {
665  for (int y = 0; y != this->getHeight(); ++y) {
666  double const yPos = this->indexToPosition(y, image::Y);
667  double xPos = this->indexToPosition(0, image::X);
668  for (typename Image<PixelT>::x_iterator ptr = this->row_begin(y), end = this->row_end(y);
669  ptr != end; ++ptr, ++xPos) {
670  *ptr += function(xPos, yPos);
671  }
672  }
673 }
int y
x_iterator row_begin(int y) const
Definition: Image.h:319
x_iterator row_end(int y) const
Return an x_iterator to the end of the y&#39;th row.
Definition: Image.h:324
double indexToPosition(double ind, lsst::afw::image::xOrY const xy) const
Convert image index to image position.
Definition: Image.h:290
iterator end() const
Return an STL compliant iterator to the end of the image.
Definition: Image.cc:331
_view_t::x_iterator x_iterator
An iterator for traversing the pixels in a row.
Definition: Image.h:151
int getHeight() const
Return the number of rows in the image.
Definition: Image.h:239
template<typename PixelT >
void lsst.afw.image::Image< PixelT >::operator-= ( PixelT const  rhs)

Subtract scalar rhs from lhs.

Definition at line 689 of file Image.cc.

689  {
690  transform_pixels(_getRawView(), _getRawView(), bl::ret<PixelT>(bl::_1 - rhs));
691 }
_view_t _getRawView() const
Definition: Image.h:401
template<typename PixelT >
void lsst.afw.image::Image< PixelT >::operator-= ( Image< PixelT > const &  rhs)

Subtract Image rhs from lhs.

Definition at line 695 of file Image.cc.

695  {
696  if (this->getDimensions() != rhs.getDimensions()) {
697  throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
698  (boost::format("Images are of different size, %dx%d v %dx%d") %
699  this->getWidth() % this->getHeight() % rhs.getWidth() % rhs.getHeight()).str());
700  }
701  transform_pixels(_getRawView(), rhs._getRawView(), _getRawView(), bl::ret<PixelT>(bl::_1 - bl::_2));
702 }
int getWidth() const
Return the number of columns in the image.
Definition: Image.h:237
#define LSST_EXCEPT(type,...)
Definition: Exception.h:46
int getHeight() const
Return the number of rows in the image.
Definition: Image.h:239
geom::Extent2I getDimensions() const
Return the image&#39;s size; useful for passing to constructors.
Definition: Image.h:298
_view_t _getRawView() const
Definition: Image.h:401
template<typename PixelT >
void lsst.afw.image::Image< PixelT >::operator-= ( lsst::afw::math::Function2< double > const &  function)

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

Parameters
functionfunction to add

Definition at line 720 of file Image.cc.

722  {
723  for (int y = 0; y != this->getHeight(); ++y) {
724  double const yPos = this->indexToPosition(y, image::Y);
725  double xPos = this->indexToPosition(0, image::X);
726  for (typename Image<PixelT>::x_iterator ptr = this->row_begin(y), end = this->row_end(y);
727  ptr != end; ++ptr, ++xPos) {
728  *ptr -= function(xPos, yPos);
729  }
730  }
731 }
int y
x_iterator row_begin(int y) const
Definition: Image.h:319
x_iterator row_end(int y) const
Return an x_iterator to the end of the y&#39;th row.
Definition: Image.h:324
double indexToPosition(double ind, lsst::afw::image::xOrY const xy) const
Convert image index to image position.
Definition: Image.h:290
iterator end() const
Return an STL compliant iterator to the end of the image.
Definition: Image.cc:331
_view_t::x_iterator x_iterator
An iterator for traversing the pixels in a row.
Definition: Image.h:151
int getHeight() const
Return the number of rows in the image.
Definition: Image.h:239
template<typename PixelT >
void 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 766 of file Image.cc.

766  {
767  transform_pixels(_getRawView(), _getRawView(), bl::ret<PixelT>(bl::_1 / rhs));
768 }
_view_t _getRawView() const
Definition: Image.h:401
template<typename PixelT >
void lsst.afw.image::Image< PixelT >::operator/= ( Image< PixelT > const &  rhs)

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

Definition at line 788 of file Image.cc.

788  {
789  if (this->getDimensions() != rhs.getDimensions()) {
790  throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
791  (boost::format("Images are of different size, %dx%d v %dx%d") %
792  this->getWidth() % this->getHeight() % rhs.getWidth() % rhs.getHeight()).str());
793  }
794  transform_pixels(_getRawView(), rhs._getRawView(), _getRawView(), bl::ret<PixelT>(bl::_1 / bl::_2));
795 }
int getWidth() const
Return the number of columns in the image.
Definition: Image.h:237
#define LSST_EXCEPT(type,...)
Definition: Exception.h:46
int getHeight() const
Return the number of rows in the image.
Definition: Image.h:239
geom::Extent2I getDimensions() const
Return the image&#39;s size; useful for passing to constructors.
Definition: Image.h:298
_view_t _getRawView() const
Definition: Image.h:401
template<>
void lsst::afw::image::Image< double >::operator/= ( double const  rhs)

Definition at line 774 of file Image.cc.

774  {
775  double const irhs = 1/rhs;
776  *this *= irhs;
777 }
template<>
void lsst::afw::image::Image< float >::operator/= ( float const  rhs)

Definition at line 780 of file Image.cc.

780  {
781  float const irhs = 1/rhs;
782  *this *= irhs;
783 }
template<typename PixelT >
image::Image< PixelT > & lsst.afw.image::Image< PixelT >::operator= ( const PixelT  rhs)

Set the image's pixels to rhs.

Definition at line 480 of file Image.cc.

480  {
481  this->ImageBase<PixelT>::operator=(rhs);
482 
483  return *this;
484 }
ImageBase & operator=(const ImageBase &rhs)
Definition: Image.cc:216
template<typename PixelT >
image::Image< PixelT > & lsst.afw.image::Image< PixelT >::operator= ( const Image< T > &  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 operator<<=()
this behaviour is required to make the swig interface work, otherwise I'd declare this function private

Definition at line 494 of file Image.cc.

494  {
495  this->ImageBase<PixelT>::operator=(rhs);
496 
497  return *this;
498 }
ImageBase & operator=(const ImageBase &rhs)
Definition: Image.cc:216
template<typename T>
static Image lsst.afw.image::Image< T >::readFits ( std::string const &  filename,
int  hdu = 0 
)
inlinestatic

Read an Image from a regular FITS file.

Parameters
[in]filenameName of the file to read.
[in]hduNumber of the "header-data unit" to read (where 1 is the Primary HDU). The default value of 0 is interpreted as "the first HDU with NAXIS != 0".

Definition at line 555 of file Image.h.

555  {
556  return Image<PixelT>(filename, hdu);
557  }
template<typename T>
static Image lsst.afw.image::Image< T >::readFits ( fits::MemFileManager manager,
int  hdu = 0 
)
inlinestatic

Read an Image from a FITS RAM file.

Parameters
[in]managerObject that manages the memory to be read.
[in]hduNumber of the "header-data unit" to read (where 1 is the Primary HDU). The default value of 0 is interpreted as "the first HDU with NAXIS != 0".

Definition at line 566 of file Image.h.

566  {
567  return Image<PixelT>(manager, hdu);
568  }
template<typename PixelT >
void lsst.afw.image::Image< PixelT >::scaledDivides ( double const  c,
Image< PixelT >const &  rhs 
)

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

Definition at line 799 of file Image.cc.

799  {
800  if (this->getDimensions() != rhs.getDimensions()) {
801  throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
802  (boost::format("Images are of different size, %dx%d v %dx%d") %
803  this->getWidth() % this->getHeight() % rhs.getWidth() % rhs.getHeight()).str());
804  }
805  transform_pixels(_getRawView(), rhs._getRawView(), _getRawView(),
806  bl::ret<PixelT>(bl::_1 / bl::ret<PixelT>(c*bl::_2)));
807 }
int getWidth() const
Return the number of columns in the image.
Definition: Image.h:237
#define LSST_EXCEPT(type,...)
Definition: Exception.h:46
int getHeight() const
Return the number of rows in the image.
Definition: Image.h:239
geom::Extent2I getDimensions() const
Return the image&#39;s size; useful for passing to constructors.
Definition: Image.h:298
_view_t _getRawView() const
Definition: Image.h:401
template<typename PixelT >
void lsst.afw.image::Image< PixelT >::scaledMinus ( double const  c,
Image< PixelT >const &  rhs 
)

Subtract Image c*rhs from lhs.

Definition at line 706 of file Image.cc.

706  {
707  if (this->getDimensions() != rhs.getDimensions()) {
708  throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
709  (boost::format("Images are of different size, %dx%d v %dx%d") %
710  this->getWidth() % this->getHeight() % rhs.getWidth() % rhs.getHeight()).str());
711  }
712  transform_pixels(_getRawView(), rhs._getRawView(), _getRawView(),
713  bl::ret<PixelT>(bl::_1 - bl::ret<PixelT>(c*bl::_2)));
714 }
int getWidth() const
Return the number of columns in the image.
Definition: Image.h:237
#define LSST_EXCEPT(type,...)
Definition: Exception.h:46
int getHeight() const
Return the number of rows in the image.
Definition: Image.h:239
geom::Extent2I getDimensions() const
Return the image&#39;s size; useful for passing to constructors.
Definition: Image.h:298
_view_t _getRawView() const
Definition: Image.h:401
template<typename PixelT >
void lsst.afw.image::Image< PixelT >::scaledMultiplies ( double const  c,
Image< PixelT >const &  rhs 
)

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

Definition at line 752 of file Image.cc.

752  {
753  if (this->getDimensions() != rhs.getDimensions()) {
754  throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
755  (boost::format("Images are of different size, %dx%d v %dx%d") %
756  this->getWidth() % this->getHeight() % rhs.getWidth() % rhs.getHeight()).str());
757  }
758  transform_pixels(_getRawView(), rhs._getRawView(), _getRawView(),
759  bl::ret<PixelT>(bl::_1 * bl::ret<PixelT>(c*bl::_2)));
760 }
int getWidth() const
Return the number of columns in the image.
Definition: Image.h:237
#define LSST_EXCEPT(type,...)
Definition: Exception.h:46
int getHeight() const
Return the number of rows in the image.
Definition: Image.h:239
geom::Extent2I getDimensions() const
Return the image&#39;s size; useful for passing to constructors.
Definition: Image.h:298
_view_t _getRawView() const
Definition: Image.h:401
template<typename PixelT >
void lsst.afw.image::Image< PixelT >::scaledPlus ( double const  c,
Image< PixelT >const &  rhs 
)

Add Image c*rhs to lhs.

Definition at line 677 of file Image.cc.

677  {
678  if (this->getDimensions() != rhs.getDimensions()) {
679  throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
680  (boost::format("Images are of different size, %dx%d v %dx%d") %
681  this->getWidth() % this->getHeight() % rhs.getWidth() % rhs.getHeight()).str());
682  }
683  transform_pixels(_getRawView(), rhs._getRawView(), _getRawView(),
684  bl::ret<PixelT>(bl::_1 + bl::ret<PixelT>(c*bl::_2)));
685 }
int getWidth() const
Return the number of columns in the image.
Definition: Image.h:237
#define LSST_EXCEPT(type,...)
Definition: Exception.h:46
int getHeight() const
Return the number of rows in the image.
Definition: Image.h:239
geom::Extent2I getDimensions() const
Return the image&#39;s size; useful for passing to constructors.
Definition: Image.h:298
_view_t _getRawView() const
Definition: Image.h:401
template<typename PixelT >
void lsst.afw.image::Image< PixelT >::sqrt ( )

Definition at line 636 of file Image.cc.

636  {
637  transform_pixels(_getRawView(), _getRawView(),
638  boost::bind(mysqrt<PixelT>, bl::_1));
639 }
_view_t _getRawView() const
Definition: Image.h:401
template<typename PixelT >
void lsst.afw.image::Image< PixelT >::swap ( Image< T > &  rhs)

Definition at line 606 of file Image.cc.

606  {
607  using std::swap; // See Meyers, Effective C++, Item 25
609  ; // no private variables to swap
610 }
void swap(ImageBase< PixelT > &a, ImageBase< PixelT > &b)
Definition: Image.cc:291
void swap(ImageBase &rhs)
Definition: Image.cc:282
template<typename T>
void lsst.afw.image::Image< T >::writeFits ( std::string const &  fileName,
boost::shared_ptr< lsst::daf::base::PropertySet const >  metadata = boost::shared_ptr< lsst::daf::base::PropertySet const  >(),
std::string const &  mode = "w" 
) const

Write an image to a regular FITS file.

Parameters
[in]fileNameName of the file to write.
[in]metadataAdditional values to write to the header (may be null).
[in]mode"w"=Create a new file; "a"=Append a new HDU.
template<typename T>
void lsst.afw.image::Image< T >::writeFits ( fits::MemFileManager manager,
boost::shared_ptr< lsst::daf::base::PropertySet const >  metadata = boost::shared_ptr< lsst::daf::base::PropertySet const  >(),
std::string const &  mode = "w" 
) const

Write an image to a FITS RAM file.

Parameters
[in]managerManager object for the memory block to write to.
[in]metadataAdditional values to write to the header (may be null).
[in]mode"w"=Create a new file; "a"=Append a new HDU.
template<typename T>
void lsst.afw.image::Image< T >::writeFits ( fits::Fits fitsfile,
boost::shared_ptr< lsst::daf::base::PropertySet const >  metadata = boost::shared_ptr< lsst::daf::base::PropertySet const  >() 
) const

Write an image to an open FITS file object.

Parameters
[in]fitsfileA FITS file already open to the desired HDU.
[in]metadataAdditional values to write to the header (may be null).

Friends And Related Function Documentation

template<typename T>
template<typename OtherPixelT >
friend class Image
friend

Definition at line 431 of file Image.h.

template<typename ImageT >
ImageT::SinglePixel badPixel ( typename ImageT::Pixel  bad = 0)
related

Return a value indicating a bad pixel for the given Image type

A quiet NaN is returned for types that support it otherwise bad

Parameters
badThe bad value if NaN isn't supported

Definition at line 70 of file Utils.h.

71  {
72  typedef typename ImageT::SinglePixel SinglePixelT;
73  return SinglePixelT(std::numeric_limits<SinglePixelT>::has_quiet_NaN ?
74  std::numeric_limits<SinglePixelT>::quiet_NaN() : bad);
75 }
template<typename T>
template<typename , typename , typename >
friend class MaskedImage
friend

Definition at line 417 of file Image.h.


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