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

A container for an Image and its associated metadata. More...

#include <Image.h>

Public Member Functions
	DecoratedImage (const lsst::geom::Extent2I &dimensions=lsst::geom::Extent2I())
	Create an image of the specified size. More...
	DecoratedImage (const lsst::geom::Box2I &bbox)
	Create an image of the specified size. More...
	DecoratedImage (std::shared_ptr< Image< PixelT >> rhs)
	Create a DecoratedImage wrapping rhs More...
	DecoratedImage (DecoratedImage const &rhs, const bool deep=false)
	Copy constructor. More...
	DecoratedImage (std::string const &fileName, const int hdu=fits::DEFAULT_HDU, lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin const origin=PARENT, bool allowUnsafe=false)
	Create a DecoratedImage from a FITS file. More...
DecoratedImage &	operator= (const DecoratedImage &image)
	Assignment operator. More...
std::shared_ptr< lsst::daf::base::PropertySet >	getMetadata () const
void	setMetadata (std::shared_ptr< lsst::daf::base::PropertySet > metadata)
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
	Return the image's column-origin. More...
int	getY0 () const
	Return the image's row-origin. More...
const lsst::geom::Extent2I	getDimensions () const
	Return the image's size; useful for passing to constructors. More...
void	swap (DecoratedImage &rhs)
void	writeFits (std::string const &fileName, std::shared_ptr< lsst::daf::base::PropertySet const > metadata=std::shared_ptr< lsst::daf::base::PropertySet const >(), std::string const &mode="w") const
	Write a FITS file. More...
void	writeFits (std::string const &fileName, fits::ImageWriteOptions const &options, std::shared_ptr< lsst::daf::base::PropertySet const > metadata=std::shared_ptr< lsst::daf::base::PropertySet const >(), std::string const &mode="w") const
	Write a FITS file. More...
std::shared_ptr< Image< PixelT > >	getImage ()
	Return a shared_ptr to the DecoratedImage's Image. More...
std::shared_ptr< Image< PixelT > const >	getImage () const
	Return a shared_ptr to the DecoratedImage's Image as const. More...
double	getGain () const
	Return the DecoratedImage's gain. More...
void	setGain (double gain)
	Set the DecoratedImage's gain. More...

Detailed Description

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

A container for an Image and its associated metadata.

Definition at line 404 of file Image.h.

Constructor & Destructor Documentation

DecoratedImage() [1/5]

template<typename PixelT >

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

explicit

Create an image of the specified size.

Parameters

dimensions

desired number of columns. rows

Definition at line 56 of file DecoratedImage.cc.

        : _image(new Image<PixelT>(dimensions)) {
    init();
}

DecoratedImage() [2/5]

template<typename PixelT >

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

explicit

Create an image of the specified size.

Parameters

bbox	(width, height) and origin of the desired Image

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 61 of file DecoratedImage.cc.

                                                                : _image(new Image<PixelT>(bbox)) {
    init();
}

DecoratedImage() [3/5]

template<typename PixelT >

lsst::afw::image::DecoratedImage< PixelT >::DecoratedImage ( std::shared_ptr< Image< PixelT >>  rhs )

explicit

Create a DecoratedImage wrapping rhs

Note that this ctor shares pixels with the rhs; it isn't a deep copy

Parameters

rhs	Image to go into DecoratedImage

Definition at line 65 of file DecoratedImage.cc.

                                                                       : _image(rhs) {
    init();
}

DecoratedImage() [4/5]

template<typename PixelT >

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

Copy constructor.

Note that the lhs will share memory with the rhs unless deep is true

Parameters

rhs	right hand side
deep	Make deep copy?

Definition at line 69 of file DecoratedImage.cc.

        : _image(new Image<PixelT>(*src._image, deep)), _gain(src._gain) {
    setMetadata(src.getMetadata());
}

DecoratedImage() [5/5]

template<typename PixelT >

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

explicit

Create a DecoratedImage from a FITS file.

Parameters

fileName	File to read
hdu	The HDU to read
bbox	Only read these pixels
origin	Coordinate system of the bbox
allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

Definition at line 98 of file DecoratedImage.cc.

                                                         {
    init();
    _image = std::shared_ptr<Image<PixelT>>(
            new Image<PixelT>(fileName, hdu, getMetadata(), bbox, origin, allowUnsafe));
}

Member Function Documentation

getDimensions()

template<typename PixelT>

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

inline

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

Definition at line 473 of file Image.h.

{ return _image->getDimensions(); }

getGain()

template<typename PixelT>

double lsst::afw::image::DecoratedImage< PixelT >::getGain ( ) const

inline

Return the DecoratedImage's gain.

Note

This is mostly just a place holder for other properties that we might want to associate with a DecoratedImage

Definition at line 512 of file Image.h.

{ return _gain; }

getHeight()

template<typename PixelT>

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

inline

Return the number of rows in the image.

Definition at line 465 of file Image.h.

{ return _image->getHeight(); }

getImage() [1/2]

template<typename PixelT>

std::shared_ptr<Image<PixelT> > lsst::afw::image::DecoratedImage< PixelT >::getImage ( )

inline

Return a shared_ptr to the DecoratedImage's Image.

Definition at line 503 of file Image.h.

{ return _image; }

getImage() [2/2]

template<typename PixelT>

std::shared_ptr<Image<PixelT> const> lsst::afw::image::DecoratedImage< PixelT >::getImage ( ) const

inline

Return a shared_ptr to the DecoratedImage's Image as const.

Definition at line 505 of file Image.h.

{ return _image; }

getMetadata()

template<typename PixelT>

std::shared_ptr<lsst::daf::base::PropertySet> lsst::afw::image::DecoratedImage< PixelT >::getMetadata ( ) const

inline

Definition at line 459 of file Image.h.

{ return _metadata; }

getWidth()

template<typename PixelT>

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

inline

Return the number of columns in the image.

Definition at line 463 of file Image.h.

{ return _image->getWidth(); }

getX0()

template<typename PixelT>

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

inline

Return the image's column-origin.

Definition at line 468 of file Image.h.

{ return _image->getX0(); }

getY0()

template<typename PixelT>

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

inline

Return the image's row-origin.

Definition at line 470 of file Image.h.

{ return _image->getY0(); }

operator=()

template<typename PixelT >

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

(

const DecoratedImage< PixelT > &

image

)

Assignment operator.

N.b. this is a shallow assignment; use set(src) if you want to copy the pixels

Definition at line 74 of file DecoratedImage.cc.

                                                                                   {
    DecoratedImage tmp(src);
    swap(tmp);  // See Meyers, Effective C++, Item 11

    return *this;
}

setGain()

template<typename PixelT>

void lsst::afw::image::DecoratedImage< PixelT >::setGain ( double  gain )

inline

Set the DecoratedImage's gain.

Definition at line 514 of file Image.h.

{ _gain = gain; }

setMetadata()

template<typename PixelT>

void lsst::afw::image::DecoratedImage< PixelT >::setMetadata ( std::shared_ptr< lsst::daf::base::PropertySet >  metadata )

inline

Definition at line 460 of file Image.h.

{ _metadata = metadata; }

swap()

template<typename PixelT >

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

(

DecoratedImage< PixelT > &

rhs

)

Definition at line 82 of file DecoratedImage.cc.

                                                     {
    using std::swap;  // See Meyers, Effective C++, Item 25

    swap(_image, rhs._image);  // just swapping the pointers
    swap(_gain, rhs._gain);
}

writeFits() [1/2]

template<typename PixelT >

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

Write a FITS file.

Parameters

fileName	the file to write
metadata	metadata to write to header; or NULL
mode	"w" to write a new file; "a" to append

Definition at line 107 of file DecoratedImage.cc.

                                                                    {
    fits::ImageWriteOptions const options;
    writeFits(fileName, options, metadata, mode);
}

writeFits() [2/2]

template<typename PixelT >

void lsst::afw::image::DecoratedImage< PixelT >::writeFits	(	std::string const &	fileName,
		fits::ImageWriteOptions const &	options,
		std::shared_ptr< lsst::daf::base::PropertySet const >	metadata = std::shared_ptr<lsst::daf::base::PropertySet const>(),
		std::string const &	mode = "w"
	)		const

Write a FITS file.

Parameters

[in]	fileName	the file to write
[in]	options	Options controlling writing of FITS image.
[in]	metadata	metadata to write to header; or NULL
[in]	mode	"w" to write a new file; "a" to append

Definition at line 115 of file DecoratedImage.cc.

                                                                    {
    std::shared_ptr<daf::base::PropertySet> metadata;

    if (metadata_i) {
        metadata = getMetadata()->deepCopy();
        metadata->combine(metadata_i);
    } else {
        metadata = getMetadata();
    }

    getImage()->writeFits(fileName, options, mode, metadata);
}

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/include/lsst/afw/image/Image.h
• /j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/src/image/DecoratedImage.cc