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
typedef detail::MaskPlaneDict	MaskPlaneDict

typedef detail::Mask_tag	image_category

typedef lsst::afw::image::MaskPixel	SinglePixel
	A single Pixel of the same type as those in the ImageBase. More...

typedef lsst::afw::image::MaskPixel	Pixel
	A pixel in this ImageBase. More...

typedef Reference< lsst::afw::image::MaskPixel >::type	PixelReference
	A Reference to a PixelT. More...

typedef ConstReference< lsst::afw::image::MaskPixel >::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
	A fast STL compliant iterator for contiguous images N.b. More...

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< lsst::afw::image::MaskPixel, 2, 1 >	Array
	A mutable ndarray representation of the image. More...

typedef ndarray::Array< lsst::afw::image::MaskPixel const, 2, 1 >	ConstArray
	An immutable ndarray representation of the image. More...

Public Member Functions
	Mask (unsigned int width, unsigned int height, MaskPlaneDict const &planeDefs=MaskPlaneDict())
	Construct a Mask initialized to 0x0. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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? More...

void	writeFits (std::string const &fileName, std::shared_ptr< lsst::daf::base::PropertySet const > metadata=std::shared_ptr< lsst::daf::base::PropertySet >(), std::string const &mode="w") const
	Write a mask to a regular FITS file. More...

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

void	writeFits (fits::Fits &fitsfile, std::shared_ptr< lsst::daf::base::PropertySet const > metadata=std::shared_ptr< lsst::daf::base::PropertySet const >()) const
	Write a mask to an open FITS file object. More...

void	writeFits (std::string const &filename, fits::ImageWriteOptions const &options, std::string const &mode="w", std::shared_ptr< daf::base::PropertySet const > header=nullptr) const
	Write a mask to a regular FITS file. More...

void	writeFits (fits::MemFileManager &manager, fits::ImageWriteOptions const &options, std::string const &mode="w", std::shared_ptr< daf::base::PropertySet const > header=nullptr) const
	Write a mask to a FITS RAM file. More...

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

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

void	clearAllMaskPlanes ()
	Clear all the pixels. More...

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

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

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

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

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

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

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

PixelReference	get (lsst::geom::Point2I const &index, ImageOrigin origin)
	Return a reference to a single pixel (with no bounds check). More...

PixelConstReference	get (lsst::geom::Point2I const &index, ImageOrigin origin) const
	Return a const reference to a single pixel (with no bounds check). More...

PixelReference	operator[] (lsst::geom::Point2I const &index)
	Return a reference to a single pixel in PARENT coordinates (with no bounds check). More...

PixelConstReference	operator[] (lsst::geom::Point2I const &index) const
	Return a reference to a single pixel in PARENT coordinates (with no bounds check). More...

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

lsst::geom::Point2I	getXY0 () const
	Return the image's origin. More...

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

lsst::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
	Return an STL compliant iterator to the start of the image. More...

fast_iterator	begin (bool contiguous) const
	Return a fast STL compliant iterator to the start of the image which must be contiguous. More...

iterator	end () const
	Return an STL compliant iterator to the end of the image. More...

fast_iterator	end (bool contiguous) const
	Return a fast STL compliant iterator to the end of the image which must be contiguous. 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...

x_iterator	row_begin (int y) const
	Return an `x_iterator` to the start of the `y`'th row. More...

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
	Return an `y_iterator` to the start of the `y`'th row. More...

y_iterator	col_end (int x) const
	Return an `y_iterator` to the start 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
	Return an `xy_locator` at the point `(x, y)` in the image. More...

void	setXY0 (lsst::geom::Point2I const origin)
	Set the ImageBase's origin. More...

void	setXY0 (int const x0, int const y0)
	Set the ImageBase's origin. More...

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

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

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

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

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

static void	clearMaskPlaneDict ()
	Reset the maskPlane dictionary. More...

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

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

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

static SinglePixel	PixelCast (SinglePixelT rhs)
	Convert a type to our SinglePixel type. More...

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

Definition at line 77 of file Mask.h.

Member Typedef Documentation

◆ Array

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

inherited

A mutable ndarray representation of the image.

Definition at line 149 of file ImageBase.h.

◆ const_iterator

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

inherited

An STL compliant const iterator.

Definition at line 127 of file ImageBase.h.

◆ const_reverse_iterator

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

inherited

An STL compliant const reverse iterator.

Definition at line 131 of file ImageBase.h.

◆ const_x_iterator

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

inherited

A const iterator for traversing the pixels in a row.

Definition at line 141 of file ImageBase.h.

◆ const_xy_locator

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

inherited

A const_xy_locator.

Definition at line 123 of file ImageBase.h.

◆ const_y_iterator

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

inherited

A const iterator for traversing the pixels in a column.

Definition at line 147 of file ImageBase.h.

◆ ConstArray

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

inherited

An immutable ndarray representation of the image.

Definition at line 151 of file ImageBase.h.

◆ fast_iterator

typedef x_iterator lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::fast_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>

typedef detail::Mask_tag lsst::afw::image::Mask< MaskPixelT >::image_category

Definition at line 81 of file Mask.h.

◆ iterator

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

inherited

An STL compliant iterator.

Definition at line 125 of file ImageBase.h.

◆ MaskPlaneDict

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

typedef detail::MaskPlaneDict lsst::afw::image::Mask< MaskPixelT >::MaskPlaneDict

Definition at line 79 of file Mask.h.

◆ Pixel

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

inherited

A pixel in this ImageBase.

Definition at line 115 of file ImageBase.h.

◆ PixelConstReference

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

inherited

A ConstReference to a PixelT.

Definition at line 119 of file ImageBase.h.

◆ PixelReference

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

inherited

A Reference to a PixelT.

Definition at line 117 of file ImageBase.h.

◆ reverse_iterator

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

inherited

An STL compliant reverse iterator.

Definition at line 129 of file ImageBase.h.

◆ SinglePixel

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

inherited

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

Definition at line 113 of file ImageBase.h.

◆ x_iterator

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

inherited

An iterator for traversing the pixels in a row.

Definition at line 133 of file ImageBase.h.

◆ xy_locator

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

inherited

An xy_locator.

Definition at line 121 of file ImageBase.h.

◆ xy_x_iterator

typedef _view_t::x_iterator lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::xy_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

typedef _view_t::y_iterator lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::xy_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

typedef _view_t::y_iterator lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::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 69 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 76 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 84 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 91 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 99 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 106 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 220 of file Mask.h.

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

◆ 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 118 of file Mask.cc.

119 : 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 122 of file Mask.cc.

122 : Mask(rhs, false) {}

◆ ~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 113 of file Mask.cc.

115 : 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 128 of file Mask.cc.

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

Member Function Documentation

◆ _allocateView()

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

staticprotectedinherited

Definition at line 459 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()

_view_t lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::_getRawView

inlineprotectedinherited

Definition at line 463 of file ImageBase.h.

463 { return _gilView; }

◆ _makeSubView()

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

staticprotectedinherited

Definition at line 460 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());
     }
     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 267 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 576 of file Mask.cc.

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

◆ assign()

void lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::assign	(	ImageBase< lsst::afw::image::MaskPixel > 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 267 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()

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

inherited

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

Definition at line 376 of file Image.cc.

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

◆ begin() [1/2]

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

inherited

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

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

Definition at line 368 of file Image.cc.

                                                                   {
     return _gilView.begin();
 }

◆ begin() [2/2]

ImageBase< lsst::afw::image::MaskPixel >::fast_iterator lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::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 385 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 398 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 403 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 393 of file Mask.cc.

                                           {
     _maskPlaneDict()->clear();
 }

◆ col_begin()

y_iterator lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::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 411 of file ImageBase.h.

411 { return _gilView.col_begin(x); }

◆ col_end()

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

inlineinherited

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

Definition at line 414 of file ImageBase.h.

414 { 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 408 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 (MaskPlaneDict::const_iterator i = currentPlaneDict.begin(); i != currentPlaneDict.end(); i++) {
             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]

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

inherited

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

Definition at line 370 of file Image.cc.

                                                                 {
     return _gilView.end();
 }

◆ end() [2/2]

ImageBase< lsst::afw::image::MaskPixel >::fast_iterator lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::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 393 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]

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

inherited

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

Definition at line 282 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]

ImageBase< lsst::afw::image::MaskPixel >::PixelConstReference lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::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 285 of file Image.cc.

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

◆ getArray() [1/2]

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

inherited

Definition at line 358 of file ImageBase.h.

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

◆ getArray() [2/2]

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

inherited

Definition at line 359 of file ImageBase.h.

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

◆ getAsString()

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

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

inline

Definition at line 439 of file Mask.h.

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

◆ getBBox()

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

inlineinherited

Definition at line 443 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()

lsst::geom::Extent2I lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::getDimensions

inlineinherited

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

Definition at line 354 of file ImageBase.h.

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

◆ getHeight()

int lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::getHeight

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 357 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

Return the Mask's maskPlaneDict.

Definition at line 300 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 489 of file Mask.h.

489 { return 8 * sizeof(MaskPixelT); }

◆ getNumPlanesUsed()

template<typename MaskPixelT >

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

static

Definition at line 388 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 374 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 379 of file Mask.cc.

                                                                              {
     MaskPixelT mpix = 0x0;
     for (std::vector<std::string>::const_iterator it = name.begin(); it != name.end(); ++it) {
         mpix |= getBitMask(getMaskPlane(*it));
     }
     return mpix;
 }

◆ getWidth()

int lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::getWidth

inlineinherited

Return the number of columns in the image.

Definition at line 294 of file ImageBase.h.

294 { return _gilView.width(); }

◆ getX0()

int lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::getX0

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 304 of file ImageBase.h.

304 { return _origin.getX(); }

◆ getXY0()

lsst::geom::Point2I lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::getXY0

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 321 of file ImageBase.h.

321 { return _origin; }

◆ getY0()

int lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::getY0

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 312 of file ImageBase.h.

312 { return _origin.getY(); }

◆ indexToPosition()

double lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::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 347 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 252 of file Mask.cc.

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

◆ isContiguous()

bool lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::isContiguous

inlineprotectedinherited

Definition at line 465 of file ImageBase.h.

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

◆ 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 532 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 526 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 464 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 475 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 469 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 480 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 486 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 492 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 146 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 154 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 159 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 281 of file Mask.h.

281 { return subset(bbox); }

◆ operator[]() [2/3]

PixelReference lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::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); }

◆ operator[]() [3/3]

PixelConstReference lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::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 553 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 546 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 512 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 505 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 604 of file Mask.cc.

                                                           {
     MaskPlaneDict newDict;
  
     // First, clear existing MaskPlane metadata
     typedef std::vector<std::string> NameList;
     NameList paramNames = metadata->paramNames(false);
     int numPlanesUsed = 0;  // number of planes used
  
     // Iterate over childless properties with names starting with maskPlanePrefix
     for (NameList::const_iterator i = paramNames.begin(); i != paramNames.end(); ++i) {
         if (i->compare(0, maskPlanePrefix.size(), maskPlanePrefix) == 0) {
             // split off maskPlanePrefix to obtain plane name
             std::string planeName = i->substr(maskPlanePrefix.size());
             int const planeId = metadata->getAsInt(*i);
  
             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()

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

inlinestaticinherited

Convert a type to our SinglePixel type.

Definition at line 158 of file ImageBase.h.

                                                    {
         return SinglePixel(rhs);
     }

◆ positionToIndex()

std::pair<int, double> lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::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 328 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

print the mask plane dictionary to std::cout

Definition at line 645 of file Mask.cc.

                                              {
     _maskDict->print();
 }

◆ rbegin()

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

inherited

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

Definition at line 372 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 433 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 421 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 316 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 305 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()

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

inherited

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

Definition at line 374 of file Image.cc.

                                                                          {
     return _gilView.rend();
 }

◆ row_begin()

x_iterator lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::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 399 of file ImageBase.h.

399 { return _gilView.row_begin(y); }

◆ row_end()

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

inlineinherited

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

Definition at line 402 of file ImageBase.h.

402 { 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 567 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]

void lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::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 441 of file ImageBase.h.

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

◆ setXY0() [2/2]

void lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::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 432 of file ImageBase.h.

432 { _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 276 of file Mask.h.

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

◆ swap() [1/2]

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

inherited

Definition at line 356 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 133 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,
		fits::ImageWriteOptions const &	options,
		std::shared_ptr< 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() [2/6]

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

void lsst::afw::image::Mask< MaskPixelT >::writeFits	(	fits::Fits &	fitsfile,
		std::shared_ptr< lsst::daf::base::PropertySet const >	metadata = `std::shared_ptr< lsst::daf::base::PropertySet const >()`
	)		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() [3/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"`,
		std::shared_ptr< 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() [4/6]

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

void lsst::afw::image::Mask< MaskPixelT >::writeFits	(	fits::MemFileManager &	manager,
		std::shared_ptr< lsst::daf::base::PropertySet const >	metadata = `std::shared_ptr< lsst::daf::base::PropertySet >()`,
		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() [5/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"`,
		std::shared_ptr< 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).

◆ writeFits() [6/6]

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

void lsst::afw::image::Mask< MaskPixelT >::writeFits	(	std::string const &	fileName,
		std::shared_ptr< lsst::daf::base::PropertySet const >	metadata = `std::shared_ptr< lsst::daf::base::PropertySet >()`,
		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.

◆ x_at()

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

inlineinherited

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

Definition at line 405 of file ImageBase.h.

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

◆ xy_at()

xy_locator lsst::afw::image::ImageBase< lsst::afw::image::MaskPixel >::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 423 of file ImageBase.h.

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

◆ y_at()

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

inlineinherited

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

Definition at line 417 of file ImageBase.h.

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

Friends And Related Function Documentation

◆ MaskFitsReader

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

friend class MaskFitsReader

friend

Definition at line 521 of file Mask.h.

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

/j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/afw/20.0.0-16-gfab17e72e+fdf35455f6/include/lsst/afw/image/Mask.h
/j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/afw/20.0.0-16-gfab17e72e+fdf35455f6/src/image/Mask.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Detailed Description

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

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]

◆ getArray() [1/2]

◆ getArray() [2/2]

◆ getAsString()

◆ getBBox()

◆ getDimensions()

◆ getHeight()

◆ getMaskPlane()

◆ getMaskPlaneDict()

◆ getNumPlanesMax()

◆ getNumPlanesUsed()

◆ getPlaneBitMask() [1/2]

◆ getPlaneBitMask() [2/2]

◆ getWidth()

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