Represent a 2-dimensional array of bitmask pixels. More...

#include <Mask.h>

Inheritance diagram for lsst::afw::image::Mask< MaskPixelT >:

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

Public Types
using	MaskPlaneDict = detail::MaskPlaneDict

using	image_category = detail::Mask_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
	Mask (unsigned int width, unsigned int height, MaskPlaneDict const &planeDefs=MaskPlaneDict())
	Construct a Mask initialized to 0x0.

	Mask (unsigned int width, unsigned int height, MaskPixelT initialValue, MaskPlaneDict const &planeDefs=MaskPlaneDict())
	Construct a Mask initialized to a specified value.

	Mask (lsst::geom::Extent2I const &dimensions=lsst::geom::Extent2I(), MaskPlaneDict const &planeDefs=MaskPlaneDict())
	Construct a Mask initialized to 0x0.

	Mask (lsst::geom::Extent2I const &dimensions, MaskPixelT initialValue, MaskPlaneDict const &planeDefs=MaskPlaneDict())
	Construct a Mask initialized to a specified value.

	Mask (lsst::geom::Box2I const &bbox, MaskPlaneDict const &planeDefs=MaskPlaneDict())
	Construct a Mask initialized to 0x0.

	Mask (lsst::geom::Box2I const &bbox, MaskPixelT initialValue, MaskPlaneDict const &planeDefs=MaskPlaneDict())
	Construct a Mask initialized to a specified value.

	Mask (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 conformMasks=false, bool allowUnsafe=false)
	Construct a Mask by reading a regular FITS file.

	Mask (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 conformMasks=false, bool allowUnsafe=false)
	Construct a Mask by reading a FITS image in memory.

	Mask (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 conformMasks=false, bool allowUnsafe=false)
	Construct a Mask from an already-open FITS object.

template<typename OtherPixelT >
	Mask (Mask< OtherPixelT > const &rhs, const bool deep)

	Mask (const Mask &src, const bool deep=false)
	Construct a Mask from another Mask.

	Mask (Mask &&src)

	~Mask () override

	Mask (const Mask &src, const lsst::geom::Box2I &bbox, ImageOrigin const origin=PARENT, const bool deep=false)
	Construct a Mask from a subregion of another Mask.

	Mask (ndarray::Array< MaskPixelT, 2, 1 > const &array, bool deep=false, lsst::geom::Point2I const &xy0=lsst::geom::Point2I())

void	swap (Mask &rhs)

Mask &	operator= (MaskPixelT const rhs)

Mask &	operator= (const Mask &rhs)

Mask &	operator= (Mask &&rhs)

Mask &	operator\|= (Mask const &rhs)
	OR a Mask into a Mask.

Mask &	operator\|= (MaskPixelT const rhs)
	OR a bitmask into a Mask.

Mask &	operator&= (Mask const &rhs)
	AND a Mask into a Mask.

Mask &	operator&= (MaskPixelT const rhs)
	AND a bitmask into a Mask.

Mask	subset (lsst::geom::Box2I const &bbox, ImageOrigin origin=PARENT) const
	Return a subimage corresponding to the given box.

Mask	operator[] (lsst::geom::Box2I const &bbox) const
	Return a subimage corresponding to the given box (interpreted as PARENT coordinates).

Mask &	operator^= (Mask const &rhs)
	XOR a Mask into a Mask.

Mask &	operator^= (MaskPixelT const rhs)
	XOR a bitmask into a Mask.

ImageBase< MaskPixelT >::PixelReference	operator() (int x, int y)
	get a reference to the specified pixel

ImageBase< MaskPixelT >::PixelConstReference	operator() (int x, int y) const
	get the specified pixel (const version)

bool	operator() (int x, int y, int plane) const
	is the specified mask plane set in the specified pixel?

ImageBase< MaskPixelT >::PixelReference	operator() (int x, int y, CheckIndices const &check)
	get a reference to the specified pixel checking array bounds

ImageBase< MaskPixelT >::PixelConstReference	operator() (int x, int y, CheckIndices const &check) const
	get the specified pixel with array checking (const version)

bool	operator() (int x, int y, int plane, CheckIndices const &check) const
	is the specified mask plane set in the specified pixel, checking array bounds?

void	writeFits (std::string const &fileName, daf::base::PropertySet const *metadata=nullptr, std::string const &mode="w") const
	Write a mask to a regular FITS file.

void	writeFits (fits::MemFileManager &manager, daf::base::PropertySet const *metadata=nullptr, std::string const &mode="w") const
	Write a mask to a FITS RAM file.

void	writeFits (fits::Fits &fitsfile, daf::base::PropertySet const *metadata=nullptr) const
	Write a mask 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) const
	Write a mask 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) const
	Write a mask to a FITS RAM file.

void	writeFits (fits::Fits &fitsfile, fits::ImageWriteOptions const &options, daf::base::PropertySet const *header=nullptr) const
	Write a mask to an open FITS file object.

std::string	getAsString (int x, int y)

void	clearAllMaskPlanes ()
	Clear all the pixels.

void	clearMaskPlane (int plane)
	Clear the specified bit in all pixels.

void	setMaskPlaneValues (const int plane, const int x0, const int x1, const int y)
	Set the bit specified by "planeId" for pixels (x0, y) ... (x1, y)

void	removeAndClearMaskPlane (const std::string &name, bool const removeFromDefault=false)
	Clear all pixels of the specified mask and remove the plane from the mask plane dictionary; optionally remove the plane from the default dictionary too.

MaskPlaneDict const &	getMaskPlaneDict () const
	Return the Mask's maskPlaneDict.

void	printMaskPlanes () const
	print the mask plane dictionary to std::cout

void	conformMaskPlanes (const MaskPlaneDict &masterPlaneDict)
	Adjust this mask to conform to the standard Mask class's mask plane dictionary, adding any new mask planes to the standard.

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	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 MaskPixelT	getPlaneBitMask (const std::vector< std::string > &names)
	Return the bitmask corresponding to a vector of plane names OR'd together.

static Mask	readFits (std::string const &filename, int hdu=fits::DEFAULT_HDU)
	Read a Mask from a regular FITS file.

static Mask	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read a Mask from a FITS RAM file.

static std::string	interpret (MaskPixelT value)
	Interpret a mask value as a comma-separated list of mask plane names.

static MaskPlaneDict	parseMaskPlaneMetadata (std::shared_ptr< lsst::daf::base::PropertySet const > metadata)
	Given a PropertySet that contains the MaskPlane assignments, setup the MaskPlanes.

static void	clearMaskPlaneDict ()
	Reset the maskPlane dictionary.

static int	addMaskPlane (const std::string &name)

static void	removeMaskPlane (const std::string &name)

static int	getMaskPlane (const std::string &name)
	Return the mask plane number corresponding to a plane name.

static MaskPixelT	getPlaneBitMask (const std::string &name)
	Return the bitmask corresponding to a plane name.

static int	getNumPlanesMax ()

static int	getNumPlanesUsed ()

static void	addMaskPlanesToMetadata (std::shared_ptr< lsst::daf::base::PropertySet >)
	Given a PropertySet, replace any existing MaskPlane assignments with the current ones.

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
class	MaskFitsReader

Detailed Description

template<typename MaskPixelT = lsst::afw::image::MaskPixel>
class lsst::afw::image::Mask< MaskPixelT >

Represent a 2-dimensional array of bitmask pixels.

Some mask planes are always defined (although you can add more with Mask::addMaskPlane):

BAD This pixel is known to be bad (e.g. the amplifier is not working)
CR This pixel is contaminated by a cosmic ray
DETECTED This pixel lies within an object's Footprint
DETECTED_NEGATIVE This pixel lies within an object's Footprint, and the detection was looking for pixels below a specified level
EDGE This pixel is too close to the edge to be processed properly
INTRP This pixel has been interpolated over
Note
should be called INTERPOLATED
SAT This pixel is saturated and has bloomed
Note
should be called SATURATED
SUSPECT This pixel is untrustworthy, and you may wish to discard any Source containing it
NO_DATA This pixel received little or no flux, e.g. highly vignetted, no available flux from coadd input exposures.
VIGNETTED This pixel is in a vignetted region; exactly how much vignetting is set by the downstream processing code.
STREAK This pixel is part of a long linear feature, possibly a satellite or fast-moving asteroid.

Definition at line 82 of file Mask.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 MaskPixelT = lsst::afw::image::MaskPixel>

using lsst::afw::image::Mask< MaskPixelT >::image_category = detail::Mask_tag

Definition at line 86 of file Mask.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.

◆ MaskPlaneDict

template<typename MaskPixelT = lsst::afw::image::MaskPixel>

using lsst::afw::image::Mask< MaskPixelT >::MaskPlaneDict = detail::MaskPlaneDict

Definition at line 84 of file Mask.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

◆ Mask() [1/14]

template<typename MaskPixelT >

lsst::afw::image::Mask< MaskPixelT >::Mask	(	unsigned int	width,
		unsigned int	height,
		MaskPlaneDict const &	planeDefs = MaskPlaneDict() )

explicit

Construct a Mask initialized to 0x0.

Parameters

width	number of columns
height	number of rows
planeDefs	desired mask planes

Definition at line 62 of file Mask.cc.

        : ImageBase<MaskPixelT>(lsst::geom::ExtentI(width, height)) {
    _initializePlanes(planeDefs);
    *this = 0x0;
}

◆ Mask() [2/14]

template<typename MaskPixelT >

lsst::afw::image::Mask< MaskPixelT >::Mask	(	unsigned int	width,
		unsigned int	height,
		MaskPixelT	initialValue,
		MaskPlaneDict const &	planeDefs = MaskPlaneDict() )

explicit

Construct a Mask initialized to a specified value.

Parameters

width	number of columns
height	number of rows
initialValue	Initial value
planeDefs	desired mask planes

Definition at line 69 of file Mask.cc.

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

◆ Mask() [3/14]

template<typename MaskPixelT >

lsst::afw::image::Mask< MaskPixelT >::Mask	(	lsst::geom::Extent2I const &	dimensions = lsst::geom::Extent2I(),
		MaskPlaneDict const &	planeDefs = MaskPlaneDict() )

explicit

Construct a Mask initialized to 0x0.

Parameters

dimensions	Number of columns, rows
planeDefs	desired mask planes

Definition at line 77 of file Mask.cc.

        : ImageBase<MaskPixelT>(dimensions) {
    _initializePlanes(planeDefs);
    *this = 0x0;
}

◆ Mask() [4/14]

template<typename MaskPixelT >

lsst::afw::image::Mask< MaskPixelT >::Mask	(	lsst::geom::Extent2I const &	dimensions,
		MaskPixelT	initialValue,
		MaskPlaneDict const &	planeDefs = MaskPlaneDict() )

explicit

Construct a Mask initialized to a specified value.

Parameters

dimensions	Number of columns, rows
initialValue	Initial value
planeDefs	desired mask planes

Definition at line 84 of file Mask.cc.

        : ImageBase<MaskPixelT>(dimensions) {
    _initializePlanes(planeDefs);
    *this = initialValue;
}

◆ Mask() [5/14]

template<typename MaskPixelT >

lsst::afw::image::Mask< MaskPixelT >::Mask	(	lsst::geom::Box2I const &	bbox,
		MaskPlaneDict const &	planeDefs = MaskPlaneDict() )

explicit

Construct a Mask initialized to 0x0.

Parameters

bbox	Desired number of columns/rows and origin
planeDefs	desired mask planes

Definition at line 92 of file Mask.cc.

        : ImageBase<MaskPixelT>(bbox) {
    _initializePlanes(planeDefs);
    *this = 0x0;
}

◆ Mask() [6/14]

template<typename MaskPixelT >

lsst::afw::image::Mask< MaskPixelT >::Mask	(	lsst::geom::Box2I const &	bbox,
		MaskPixelT	initialValue,
		MaskPlaneDict const &	planeDefs = MaskPlaneDict() )

explicit

Construct a Mask initialized to a specified value.

Parameters

bbox	Desired number of columns/rows and origin
initialValue	Initial value
planeDefs	desired mask planes

Definition at line 99 of file Mask.cc.

        : ImageBase<MaskPixelT>(bbox) {
    _initializePlanes(planeDefs);
    *this = initialValue;
}

◆ Mask() [7/14]

template<typename MaskPixelT = lsst::afw::image::MaskPixel>

lsst::afw::image::Mask< MaskPixelT >::Mask	(	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	conformMasks = false,
		bool	allowUnsafe = false )

explicit

Construct a Mask 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]	conformMasks	If true, make Mask conform to the mask layout in the file.
[in]	allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

The meaning of the bitplanes is given in the header. If conformMasks is false (default), the bitvalues will be changed to match those in Mask's plane dictionary. If it's true, the bitvalues will be left alone, but Mask's dictionary will be modified to match the on-disk version.

◆ Mask() [8/14]

template<typename MaskPixelT = lsst::afw::image::MaskPixel>

lsst::afw::image::Mask< MaskPixelT >::Mask	(	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	conformMasks = false,
		bool	allowUnsafe = false )

explicit

Construct a Mask 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]	conformMasks	If true, make Mask conform to the mask layout in the file.
[in]	allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

The meaning of the bitplanes is given in the header. If conformMasks is false (default), the bitvalues will be changed to match those in Mask's plane dictionary. If it's true, the bitvalues will be left alone, but Mask's dictionary will be modified to match the on-disk version.

◆ Mask() [9/14]

template<typename MaskPixelT = lsst::afw::image::MaskPixel>

lsst::afw::image::Mask< MaskPixelT >::Mask	(	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	conformMasks = false,
		bool	allowUnsafe = false )

explicit

Construct a Mask 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]	conformMasks	If true, make Mask conform to the mask layout in the file.
[in]	allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

The meaning of the bitplanes is given in the header. If conformMasks is false (default), the bitvalues will be changed to match those in Mask's plane dictionary. If it's true, the bitvalues will be left alone, but Mask's dictionary will be modified to match the on-disk version.

◆ Mask() [10/14]

template<typename MaskPixelT = lsst::afw::image::MaskPixel>

template<typename OtherPixelT >

lsst::afw::image::Mask< MaskPixelT >::Mask	(	Mask< OtherPixelT > const &	rhs,
		const bool	deep )

inline

Definition at line 225 of file Mask.h.

226 : image::ImageBase<MaskPixelT>(rhs, deep), _maskDict(rhs._maskDict) {}

lsst::afw::image::ImageBase

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

Definition ImageBase.h:102

◆ Mask() [11/14]

template<typename MaskPixelT >

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

Construct a Mask from another Mask.

Parameters

src	mask to copy
deep	deep copy? (construct a view with shared pixels if false)

Definition at line 111 of file Mask.cc.

112 : ImageBase<MaskPixelT>(rhs, deep), _maskDict(rhs._maskDict) {}

◆ Mask() [12/14]

template<typename MaskPixelT >

lsst::afw::image::Mask< MaskPixelT >::Mask ( Mask< MaskPixelT > && src )

Definition at line 115 of file Mask.cc.

115: Mask(rhs, false) {}

Mask

g2d::python::Image< bool > Mask

Definition test_image.cc:16

◆ ~Mask()

template<typename MaskPixelT >

lsst::afw::image::Mask< MaskPixelT >::~Mask ( )

overridedefault

◆ Mask() [13/14]

template<typename MaskPixelT >

lsst::afw::image::Mask< MaskPixelT >::Mask	(	const Mask< MaskPixelT > &	src,
		const lsst::geom::Box2I &	bbox,
		ImageOrigin const	origin = PARENT,
		const bool	deep = false )

Construct a Mask from a subregion of another Mask.

Parameters

src	mask to copy
bbox	subregion to copy
origin	coordinate system of the bbox
deep	deep copy? (construct a view with shared pixels if false)

Definition at line 106 of file Mask.cc.

108 : ImageBase<MaskPixelT>(rhs, bbox, origin, deep), _maskDict(rhs._maskDict) {}

◆ Mask() [14/14]

template<typename MaskPixelT >

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

explicit

Definition at line 121 of file Mask.cc.

123 : image::ImageBase<MaskPixelT>(array, deep, xy0), _maskDict(detail::MaskDict::getDefault()) {}

lsst::afw::image::detail::MaskDict::getDefault

static std::shared_ptr< MaskDict > getDefault()

Definition MaskDict.cc:112

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.

465{ 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());
    }
}

◆ addMaskPlane()

template<typename MaskPixelT >

int lsst::afw::image::Mask< MaskPixelT >::addMaskPlane ( const std::string & name )

static

Definition at line 264 of file Mask.cc.

                                                        {
    int id = getMaskPlaneNoThrow(name);  // see if the plane is already available
 
    if (id < 0) {  // doesn't exist
        id = _maskPlaneDict()->getUnusedPlane();
    }
 
    // build new entry, adding the plane to all Masks where this is no contradiction
 
    if (id >= getNumPlanesMax()) {  // Max number of planes is already allocated
        throw LSST_EXCEPT(pexExcept::RuntimeError,
                          str(boost::format("Max number of planes (%1%) already used") % getNumPlanesMax()));
    }
 
    detail::MaskDict::addAllMasksPlane(name, id);
 
    return id;
}

◆ addMaskPlanesToMetadata()

template<typename MaskPixelT >

void lsst::afw::image::Mask< MaskPixelT >::addMaskPlanesToMetadata ( std::shared_ptr< lsst::daf::base::PropertySet > metadata )

static

Given a PropertySet, replace any existing MaskPlane assignments with the current ones.

Definition at line 573 of file Mask.cc.

                                                                                         {
    if (!metadata) {
        throw LSST_EXCEPT(pexExcept::InvalidParameterError, "Null std::shared_ptr<PropertySet>");
    }
 
    // First, clear existing MaskPlane metadata
    using NameList = std::vector<std::string>;
    NameList paramNames = metadata->paramNames(false);
    for (auto const &paramName : paramNames) {
        if (paramName.compare(0, maskPlanePrefix.size(), maskPlanePrefix) == 0) {
            metadata->remove(paramName);
        }
    }
 
    MaskPlaneDict const& mpd = _maskPlaneDict()->getMaskPlaneDict();
 
    // Add new MaskPlane metadata
    for (auto const &i : mpd) {
        std::string const& planeName = i.first;
        int const planeNumber = i.second;
 
        if (planeName != "") {
            metadata->add(maskPlanePrefix + planeName, planeNumber);
        }
    }
}

◆ 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);
}

◆ clearAllMaskPlanes()

template<typename MaskPixelT >

void lsst::afw::image::Mask< MaskPixelT >::clearAllMaskPlanes ( )

Clear all the pixels.

Definition at line 395 of file Mask.cc.

                                          {
    *this = 0;
}

◆ clearMaskPlane()

template<typename MaskPixelT >

void lsst::afw::image::Mask< MaskPixelT >::clearMaskPlane ( int plane )

Clear the specified bit in all pixels.

Definition at line 400 of file Mask.cc.

                                                 {
    *this &= ~getBitMask(planeId);
}

◆ clearMaskPlaneDict()

template<typename MaskPixelT >

void lsst::afw::image::Mask< MaskPixelT >::clearMaskPlaneDict ( )

static

Reset the maskPlane dictionary.

Definition at line 390 of file Mask.cc.

                                          {
    _maskPlaneDict()->clear();
}

◆ 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.

413{ 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.

416{ return _gilView.col_end(x); }

◆ conformMaskPlanes()

template<typename MaskPixelT >

void lsst::afw::image::Mask< MaskPixelT >::conformMaskPlanes ( const MaskPlaneDict & masterPlaneDict )

Adjust this mask to conform to the standard Mask class's mask plane dictionary, adding any new mask planes to the standard.

Ensures that this mask (presumably from some external source) has the same plane assignments as the Mask class. If a change in plane assignments is needed, the bits within each pixel are permuted as required. The provided masterPlaneDict describes the true state of the bits in this Mask's pixels and overrides its current MaskDict

Any new mask planes found in this mask are added to unused slots in the Mask class's mask plane dictionary.

Parameters

masterPlaneDict mask plane dictionary currently in use for this mask

Definition at line 405 of file Mask.cc.

                                                                              {
    std::shared_ptr<detail::MaskDict> currentMD = detail::MaskDict::copyOrGetDefault(currentPlaneDict);
 
    if (*_maskDict == *currentMD) {
        if (*detail::MaskDict::getDefault() == *_maskDict) {
            return;  // nothing to do
        }
    } else {
        //
        // Find out which planes need to be permuted
        //
        MaskPixelT keepBitmask = 0;                        // mask of bits to keep
        MaskPixelT canonicalMask[sizeof(MaskPixelT) * 8];  // bits in lsst::afw::image::Mask that should be
        MaskPixelT currentMask[sizeof(MaskPixelT) * 8];    //           mapped to these bits
        int numReMap = 0;
 
        for (auto const &i : currentPlaneDict) {
            std::string const name = i.first;                     // name of mask plane
            int const currentPlaneNumber = i.second;              // plane number currently in use
            int canonicalPlaneNumber = getMaskPlaneNoThrow(name);  // plane number in lsst::afw::image::Mask
 
            if (canonicalPlaneNumber < 0) {  // no such plane; add it
                canonicalPlaneNumber = addMaskPlane(name);
            }
 
            if (canonicalPlaneNumber == currentPlaneNumber) {
                keepBitmask |= getBitMask(canonicalPlaneNumber);  // bit is unchanged, so preserve it
            } else {
                canonicalMask[numReMap] = getBitMask(canonicalPlaneNumber);
                currentMask[numReMap] = getBitMaskNoThrow(currentPlaneNumber);
                numReMap++;
            }
        }
 
        // Now loop over all pixels in Mask
        if (numReMap > 0) {
            for (int r = 0; r != this->getHeight(); ++r) {  // "this->": Meyers, Effective C++, Item 43
                for (typename Mask::x_iterator ptr = this->row_begin(r), end = this->row_end(r); ptr != end;
                     ++ptr) {
                    MaskPixelT const pixel = *ptr;
 
                    MaskPixelT newPixel = pixel & keepBitmask;  // value of invariant mask bits
                    for (int i = 0; i < numReMap; i++) {
                        if (pixel & currentMask[i]) newPixel |= canonicalMask[i];
                    }
 
                    *ptr = newPixel;
                }
            }
        }
    }
    // We've made the planes match the current mask dictionary
    _maskDict = detail::MaskDict::getDefault();
}

◆ 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.

298{ return getWidth()*getHeight(); }

lsst::afw::image::ImageBase::getWidth

int getWidth() const

Return the number of columns in the image.

Definition ImageBase.h:294

◆ 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);
}

◆ getAsString()

template<typename MaskPixelT = lsst::afw::image::MaskPixel>

std::string lsst::afw::image::Mask< MaskPixelT >::getAsString	(	int	x,
		int	y )

inline

Definition at line 449 of file Mask.h.

449{ return interpret((*this)(x, y)); }

lsst::afw::image::Mask::interpret

static std::string interpret(MaskPixelT value)

Interpret a mask value as a comma-separated list of mask plane names.

Definition Mask.cc:249

◆ 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.

356{ 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.

296{ return _gilView.height(); }

◆ getMaskPlane()

template<typename MaskPixelT >

int lsst::afw::image::Mask< MaskPixelT >::getMaskPlane ( const std::string & name )

static

Return the mask plane number corresponding to a plane name.

Exceptions

lsst::pex::exceptions::InvalidParameterError if plane is invalid

Definition at line 354 of file Mask.cc.

                                                        {
    int const plane = getMaskPlaneNoThrow(name);
 
    if (plane < 0) {
        throw LSST_EXCEPT(pexExcept::InvalidParameterError,
                          str(boost::format("Invalid mask plane name: %s") % name));
    } else {
        return plane;
    }
}

◆ getMaskPlaneDict()

template<typename MaskPixelT >

detail::MaskPlaneDict const & lsst::afw::image::Mask< MaskPixelT >::getMaskPlaneDict ( ) const

Return the Mask's maskPlaneDict.

Definition at line 297 of file Mask.cc.

                                                                    {
    return _maskDict->getMaskPlaneDict();
}

◆ getNumPlanesMax()

template<typename MaskPixelT = lsst::afw::image::MaskPixel>

static int lsst::afw::image::Mask< MaskPixelT >::getNumPlanesMax ( )

inlinestatic

Definition at line 499 of file Mask.h.

499{ return 8 * sizeof(MaskPixelT); }

◆ getNumPlanesUsed()

template<typename MaskPixelT >

int lsst::afw::image::Mask< MaskPixelT >::getNumPlanesUsed ( )

static

Definition at line 385 of file Mask.cc.

                                       {
    return _maskPlaneDict()->size();
}

◆ getPlaneBitMask() [1/2]

template<typename MaskPixelT >

MaskPixelT lsst::afw::image::Mask< MaskPixelT >::getPlaneBitMask ( const std::string & name )

static

Return the bitmask corresponding to a plane name.

Exceptions

lsst::pex::exceptions::InvalidParameterError if plane is invalid

Definition at line 371 of file Mask.cc.

                                                                  {
    return getBitMask(getMaskPlane(name));
}

◆ getPlaneBitMask() [2/2]

template<typename MaskPixelT >

MaskPixelT lsst::afw::image::Mask< MaskPixelT >::getPlaneBitMask ( const std::vector< std::string > & names )

static

Return the bitmask corresponding to a vector of plane names OR'd together.

Exceptions

lsst::pex::exceptions::InvalidParameterError if plane is invalid

Definition at line 376 of file Mask.cc.

                                                                             {
    MaskPixelT mpix = 0x0;
    for (auto const &it : name) {
        mpix |= getBitMask(getMaskPlane(it));
    }
    return mpix;
}

◆ 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.

294{ 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.

306{ 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.

323{ 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.

314{ 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());
    }

◆ interpret()

template<typename MaskPixelT >

std::string lsst::afw::image::Mask< MaskPixelT >::interpret ( MaskPixelT value )

static

Interpret a mask value as a comma-separated list of mask plane names.

Definition at line 249 of file Mask.cc.

                                                      {
    std::string result = "";
    MaskPlaneDict const& mpd = _maskPlaneDict()->getMaskPlaneDict();
    for (auto const &iter : mpd) {
        if (value & getBitMask(iter.second)) {
            if (result.size() > 0) {
                result += ",";
            }
            result += iter.first;
        }
    }
    return result;
}

◆ isContiguous()

template<typename PixelT >

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

inlineprotectedinherited

Definition at line 467 of file ImageBase.h.

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

lsst::afw::image::ImageBase::begin

iterator begin() const

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

Definition Image.cc:250

◆ operator&=() [1/2]

template<typename MaskPixelT >

Mask< MaskPixelT > & lsst::afw::image::Mask< MaskPixelT >::operator&= ( Mask< MaskPixelT > const & rhs )

AND a Mask into a Mask.

Definition at line 529 of file Mask.cc.

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

◆ operator&=() [2/2]

template<typename MaskPixelT >

Mask< MaskPixelT > & lsst::afw::image::Mask< MaskPixelT >::operator&= ( MaskPixelT const rhs )

AND a bitmask into a Mask.

Definition at line 523 of file Mask.cc.

                                                                   {
    transform_pixels(_getRawView(), _getRawView(), [&val](MaskPixelT const& l) { return l & val; });
    return *this;
}

◆ operator()() [1/6]

template<typename MaskPixelT >

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

get a reference to the specified pixel

Parameters

x	x index
y	y index

Definition at line 461 of file Mask.cc.

                                                                                      {
    return this->ImageBase<MaskPixelT>::operator()(x, y);
}

◆ operator()() [2/6]

template<typename MaskPixelT >

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

get the specified pixel (const version)

Parameters

x	x index
y	y index

Definition at line 472 of file Mask.cc.

                                                                                                 {
    return this->ImageBase<MaskPixelT>::operator()(x, y);
}

◆ operator()() [3/6]

template<typename MaskPixelT >

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

get a reference to the specified pixel checking array bounds

Parameters

x	x index
y	y index
check	Check array bounds?

Definition at line 466 of file Mask.cc.

                                                                                                       {
    return this->ImageBase<MaskPixelT>::operator()(x, y, check);
}

◆ operator()() [4/6]

template<typename MaskPixelT >

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

get the specified pixel with array checking (const version)

Parameters

x	x index
y	y index
check	Check array bounds?

Definition at line 477 of file Mask.cc.

                                                       {
    return this->ImageBase<MaskPixelT>::operator()(x, y, check);
}

◆ operator()() [5/6]

template<typename MaskPixelT >

bool lsst::afw::image::Mask< MaskPixelT >::operator()	(	int	x,
		int	y,
		int	plane ) const

is the specified mask plane set in the specified pixel?

Parameters

x	x index
y	y index
plane	plane ID

Definition at line 483 of file Mask.cc.

                                                                 {
    // !! converts an int to a bool
    return !!(this->ImageBase<MaskPixelT>::operator()(x, y) & getBitMask(planeId));
}

◆ operator()() [6/6]

template<typename MaskPixelT >

bool lsst::afw::image::Mask< MaskPixelT >::operator()	(	int	x,
		int	y,
		int	plane,
		CheckIndices const &	check ) const

is the specified mask plane set in the specified pixel, checking array bounds?

Parameters

x	x index
y	y index
plane	plane ID
check	Check array bounds?

Definition at line 489 of file Mask.cc.

                                                                                            {
    // !! converts an int to a bool
    return !!(this->ImageBase<MaskPixelT>::operator()(x, y, check) & getBitMask(planeId));
}

◆ operator=() [1/3]

template<typename MaskPixelT >

Mask< MaskPixelT > & lsst::afw::image::Mask< MaskPixelT >::operator= ( const Mask< MaskPixelT > & rhs )

Definition at line 139 of file Mask.cc.

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

◆ operator=() [2/3]

template<typename MaskPixelT >

Mask< MaskPixelT > & lsst::afw::image::Mask< MaskPixelT >::operator= ( Mask< MaskPixelT > && rhs )

Definition at line 147 of file Mask.cc.

                                                                    {
    return *this = rhs;
}

◆ operator=() [3/3]

template<typename MaskPixelT >

Mask< MaskPixelT > & lsst::afw::image::Mask< MaskPixelT >::operator= ( MaskPixelT const rhs )

Definition at line 152 of file Mask.cc.

                                                                  {
    fill_pixels(_getRawView(), rhs);
 
    return *this;
}

◆ operator[]() [1/3]

template<typename MaskPixelT = lsst::afw::image::MaskPixel>

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

inline

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

Definition at line 286 of file Mask.h.

286{ return subset(bbox); }

lsst::afw::image::Mask::subset

Mask subset(lsst::geom::Box2I const &bbox, ImageOrigin origin=PARENT) const

Return a subimage corresponding to the given box.

Definition Mask.h:281

◆ 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.

288{ return get(index, PARENT); }

lsst::afw::image::ImageBase::get

PixelReference get(lsst::geom::Point2I const &index, ImageOrigin origin)

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

Definition Image.cc:209

◆ 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.

291{ return get(index, PARENT); }

◆ operator^=() [1/2]

template<typename MaskPixelT >

Mask< MaskPixelT > & lsst::afw::image::Mask< MaskPixelT >::operator^= ( Mask< MaskPixelT > const & rhs )

XOR a Mask into a Mask.

Definition at line 550 of file Mask.cc.

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

◆ operator^=() [2/2]

template<typename MaskPixelT >

Mask< MaskPixelT > & lsst::afw::image::Mask< MaskPixelT >::operator^= ( MaskPixelT const rhs )

XOR a bitmask into a Mask.

Definition at line 543 of file Mask.cc.

                                                                   {
    transform_pixels(_getRawView(), _getRawView(),
                     [&val](MaskPixelT const& l) -> MaskPixelT { return l ^ val; });
    return *this;
}

◆ operator|=() [1/2]

template<typename MaskPixelT >

Mask< MaskPixelT > & lsst::afw::image::Mask< MaskPixelT >::operator|= ( Mask< MaskPixelT > const & rhs )

OR a Mask into a Mask.

Definition at line 509 of file Mask.cc.

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

◆ operator|=() [2/2]

template<typename MaskPixelT >

Mask< MaskPixelT > & lsst::afw::image::Mask< MaskPixelT >::operator|= ( MaskPixelT const rhs )

OR a bitmask into a Mask.

Definition at line 502 of file Mask.cc.

                                                                   {
    transform_pixels(_getRawView(), _getRawView(),
                     [&val](MaskPixelT const& l) -> MaskPixelT { return l | val; });
    return *this;
}

◆ parseMaskPlaneMetadata()

template<typename MaskPixelT >

Mask< MaskPixelT >::MaskPlaneDict lsst::afw::image::Mask< MaskPixelT >::parseMaskPlaneMetadata ( std::shared_ptr< lsst::daf::base::PropertySet const > metadata )

static

Given a PropertySet that contains the MaskPlane assignments, setup the MaskPlanes.

Parameters

metadata metadata from a Mask

Returns: a dictionary of mask plane name: plane ID

Definition at line 601 of file Mask.cc.

                                                          {
    MaskPlaneDict newDict;
 
    // First, clear existing MaskPlane metadata
    using NameList = std::vector<std::string>;
    NameList paramNames = metadata->paramNames(false);
    int numPlanesUsed = 0;  // number of planes used
 
    // Iterate over childless properties with names starting with maskPlanePrefix
    for (auto const &paramName : paramNames) {
        if (paramName.compare(0, maskPlanePrefix.size(), maskPlanePrefix) == 0) {
            // split off maskPlanePrefix to obtain plane name
            std::string planeName = paramName.substr(maskPlanePrefix.size());
            int const planeId = metadata->getAsInt(paramName);
 
            MaskPlaneDict::const_iterator plane = newDict.find(planeName);
            if (plane != newDict.end() && planeId != plane->second) {
                throw LSST_EXCEPT(pexExcept::RuntimeError, "File specifies plane " + planeName + " twice");
            }
            for (MaskPlaneDict::const_iterator j = newDict.begin(); j != newDict.end(); ++j) {
                if (planeId == j->second) {
                    throw LSST_EXCEPT(pexExcept::RuntimeError,
                                      str(boost::format("File specifies plane %s has same value (%d) as %s") %
                                          planeName % planeId % j->first));
                }
            }
            // build new entry
            if (numPlanesUsed >= getNumPlanesMax()) {
                // Max number of planes already allocated
                throw LSST_EXCEPT(
                        pexExcept::RuntimeError,
                        str(boost::format("Max number of planes (%1%) already used") % getNumPlanesMax()));
            }
            newDict[planeName] = planeId;
        }
    }
    return newDict;
}

◆ 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);
    }

◆ printMaskPlanes()

template<typename MaskPixelT >

void lsst::afw::image::Mask< MaskPixelT >::printMaskPlanes ( ) const

print the mask plane dictionary to std::cout

Definition at line 642 of file Mask.cc.

                                             {
    _maskDict->print();
}

◆ 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 MaskPixelT = lsst::afw::image::MaskPixel>

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

inlinestatic

Read a Mask 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 443 of file Mask.h.

                                                                                 {
        return Mask<MaskPixelT>(manager, hdu);
    }

◆ readFits() [2/2]

template<typename MaskPixelT = lsst::afw::image::MaskPixel>

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

inlinestatic

Read a Mask 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 431 of file Mask.h.

                                                                               {
        return Mask<MaskPixelT>(filename, hdu);
    }

◆ removeAndClearMaskPlane()

template<typename MaskPixelT >

void lsst::afw::image::Mask< MaskPixelT >::removeAndClearMaskPlane	(	const std::string &	name,
		bool const	removeFromDefault = false )

Clear all pixels of the specified mask and remove the plane from the mask plane dictionary; optionally remove the plane from the default dictionary too.

Parameters

name	of maskplane
removeFromDefault	remove from default mask plane dictionary too

Exceptions

lsst::pex::exceptions::InvalidParameterError if plane is invalid

Definition at line 313 of file Mask.cc.

  {
    clearMaskPlane(getMaskPlane(name));  // clear this bits in this Mask
 
    if (_maskDict == detail::MaskDict::getDefault() && removeFromDefault) {  // we are the default
        ;
    } else {
        _maskDict = _maskDict->clone();
    }
 
    _maskDict->erase(name);
 
    if (removeFromDefault && detail::MaskDict::getDefault()->getMaskPlane(name) >= 0) {
        removeMaskPlane(name);
    }
}

◆ removeMaskPlane()

template<typename MaskPixelT >

void lsst::afw::image::Mask< MaskPixelT >::removeMaskPlane ( const std::string & name )

static

Definition at line 302 of file Mask.cc.

                                                            {
    if (detail::MaskDict::getDefault()->getMaskPlane(name) < 0) {
        throw LSST_EXCEPT(pexExcept::InvalidParameterError,
                          str(boost::format("Plane %s doesn't exist in the default Mask") % name));
    }
 
    detail::MaskDict::detachDefault();  // leave current Masks alone
    _maskPlaneDict()->erase(name);
}

◆ 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.

401{ 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.

404{ return _gilView.row_end(y); }

◆ setMaskPlaneValues()

template<typename MaskPixelT >

void lsst::afw::image::Mask< MaskPixelT >::setMaskPlaneValues	(	const int	plane,
		const int	x0,
		const int	x1,
		const int	y )

Set the bit specified by "planeId" for pixels (x0, y) ... (x1, y)

Definition at line 564 of file Mask.cc.

                                                                                                    {
    MaskPixelT const bitMask = getBitMask(planeId);
 
    for (int x = x0; x <= x1; x++) {
        operator()(x, y) = operator()(x, y) | bitMask;
    }
}

◆ 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.

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

lsst::afw::image::ImageBase::setXY0

void setXY0(lsst::geom::Point2I const origin)

Set the ImageBase's origin.

Definition ImageBase.h:434

◆ 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.

434{ _origin = origin; }

◆ subset()

template<typename MaskPixelT = lsst::afw::image::MaskPixel>

Mask lsst::afw::image::Mask< MaskPixelT >::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 281 of file Mask.h.

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

◆ swap() [1/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);
}

◆ swap() [2/2]

template<typename PixelT >

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

Definition at line 126 of file Mask.cc.

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

◆ writeFits() [1/6]

template<typename MaskPixelT = lsst::afw::image::MaskPixel>

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

Write a mask 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 MaskPixelT = lsst::afw::image::MaskPixel>

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

Write a mask 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).

◆ writeFits() [3/6]

template<typename MaskPixelT = lsst::afw::image::MaskPixel>

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

Write a mask 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 MaskPixelT = lsst::afw::image::MaskPixel>

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

Write a mask 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]	mode	"w"=Create a new file; "a"=Append a new HDU.
[in]	header	Additional values to write to the header (may be null).

◆ writeFits() [5/6]

template<typename MaskPixelT = lsst::afw::image::MaskPixel>

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

Write a mask 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 MaskPixelT = lsst::afw::image::MaskPixel>

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

Write a mask 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).

◆ 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.

407{ 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.

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

lsst::afw::image::ImageBase::xy_locator

typename _view_t::xy_locator xy_locator

An xy_locator.

Definition ImageBase.h:121

◆ 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.

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

Friends And Related Symbol Documentation

◆ MaskFitsReader

template<typename MaskPixelT = lsst::afw::image::MaskPixel>

friend class MaskFitsReader

friend

Definition at line 531 of file Mask.h.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/gef2f8181fd+0a71e47438/include/lsst/afw/image/Mask.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/gef2f8181fd+0a71e47438/src/image/Mask.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ Array

◆ const_iterator

◆ const_reverse_iterator

◆ const_x_iterator

◆ const_xy_locator

◆ const_y_iterator

◆ ConstArray

◆ fast_iterator

◆ image_category

◆ iterator

◆ MaskPlaneDict

◆ Pixel

◆ PixelConstReference

◆ PixelReference

◆ reverse_iterator

◆ SinglePixel

◆ x_iterator

◆ xy_locator

◆ xy_x_iterator

◆ xy_y_iterator

◆ y_iterator

Constructor & Destructor Documentation

◆ Mask() [1/14]

◆ Mask() [2/14]

◆ Mask() [3/14]

◆ Mask() [4/14]

◆ Mask() [5/14]

◆ Mask() [6/14]

◆ Mask() [7/14]

◆ Mask() [8/14]

◆ Mask() [9/14]

◆ Mask() [10/14]

◆ Mask() [11/14]

◆ Mask() [12/14]

◆ ~Mask()

◆ Mask() [13/14]

◆ Mask() [14/14]

Member Function Documentation

◆ _allocateView()

◆ _getRawView()

◆ _makeSubView()

◆ addMaskPlane()

◆ addMaskPlanesToMetadata()

◆ assign()

◆ at()

◆ begin() [1/2]

◆ begin() [2/2]

◆ clearAllMaskPlanes()

◆ clearMaskPlane()

◆ clearMaskPlaneDict()

◆ col_begin()

◆ col_end()

◆ conformMaskPlanes()

◆ end() [1/2]

◆ end() [2/2]

◆ get() [1/2]

◆ get() [2/2]

◆ getArea()

◆ getArray() [1/2]

◆ getArray() [2/2]

◆ getAsString()

◆ getBBox()

◆ getDimensions()

◆ getHeight()

◆ getMaskPlane()

◆ getMaskPlaneDict()

◆ getNumPlanesMax()

◆ getNumPlanesUsed()

◆ getPlaneBitMask() [1/2]

◆ getPlaneBitMask() [2/2]

◆ getWidth()