lsst::afw::math::MaskedVector< EntryT > Class Template Reference

#include <MaskedVector.h>

Inheritance diagram for lsst::afw::math::MaskedVector< EntryT >:

Classes
class	iterator

Public Types
typedef lsst::afw::image::MaskedImage< EntryT >::Pixel	Pixel

Public Member Functions
	MaskedVector (int width=0)
	MaskedVector (MaskedVector const &)=default
	MaskedVector (MaskedVector &&)=default
MaskedVector &	operator= (MaskedVector const &)=default
MaskedVector &	operator= (MaskedVector &&)=default
	~MaskedVector () override=default
std::shared_ptr< std::vector< EntryT > >	getVector (bool const noThrow=false) const
	Return a (Ptr to) the MaskedImage's image. More...
Pixel &	operator[] (int const i)
lsst::afw::image::MaskedImage< EntryT >::Image::Pixel &	value (int const i)
lsst::afw::image::MaskedImage< EntryT >::Mask::Pixel &	mask (int const i)
lsst::afw::image::MaskedImage< EntryT >::Variance::Pixel &	variance (int const i)
lsst::afw::image::MaskedImage< EntryT >::ImagePtr	getImage () const
lsst::afw::image::MaskedImage< EntryT >::MaskPtr	getMask () const
lsst::afw::image::MaskedImage< EntryT >::VariancePtr	getVariance () const
int	size ()
bool	empty ()
iterator	begin ()
iterator	end ()

Private Types
typedef std::shared_ptr< image::Image< EntryT > >	ImagePtr
	shared pointer to the Image More...
typedef std::shared_ptr< image::Mask< lsst::afw::image::MaskPixel > >	MaskPtr
	shared pointer to the Mask More...
typedef std::shared_ptr< image::Image< lsst::afw::image::VariancePixel > >	VariancePtr
	shared pointer to the variance Image More...
typedef Mask< lsst::afw::image::MaskPixel >::MaskPlaneDict	MaskPlaneDict
	The Mask's MaskPlaneDict. More...
typedef lsst::afw::image::Image< lsst::afw::image::VariancePixel >	Variance
typedef lsst::afw::image::Image< EntryT >	Image
typedef lsst::afw::image::Mask< lsst::afw::image::MaskPixel >	Mask
typedef detail::MaskedImage_tag	image_category
typedef lsst::afw::image::pixel::SinglePixel< EntryT, lsst::afw::image::MaskPixel, lsst::afw::image::VariancePixel >	SinglePixel
	A single Pixel of the same type as those in the MaskedImage. More...
typedef MaskedImageIterator< typename Image::iterator, typename Mask::iterator, typename Variance::iterator >	iterator
typedef const_MaskedImageIterator< typename Image::iterator, typename Mask::iterator, typename Variance::iterator >	const_iterator
typedef MaskedImageIterator< typename Image::reverse_iterator, typename Mask::reverse_iterator, typename Variance::reverse_iterator >	reverse_iterator
typedef MaskedImageIterator< typename Image::x_iterator, typename Mask::x_iterator, typename Variance::x_iterator >	x_iterator
	An iterator to a row of a MaskedImage. More...
typedef const_MaskedImageIterator< typename Image::x_iterator, typename Mask::x_iterator, typename Variance::x_iterator >	const_x_iterator
	A const_iterator to a row of a MaskedImage. More...
typedef x_iterator	fast_iterator
	A fast STL compliant iterator for contiguous images N.b. More...
typedef MaskedImageIterator< typename Image::y_iterator, typename Mask::y_iterator, typename Variance::y_iterator >	y_iterator
	An iterator to a column of a MaskedImage. More...
typedef const_MaskedImageIterator< typename Image::y_iterator, typename Mask::y_iterator, typename Variance::y_iterator >	const_y_iterator
	A const_iterator to a column of a MaskedImage. More...
typedef MaskedImageLocator< typename Image::xy_locator, typename Mask::xy_locator, typename Variance::xy_locator >	xy_locator
	A locator for a MaskedImage. More...
typedef const_MaskedImageLocator< typename Image::xy_locator, typename Mask::xy_locator, typename Variance::xy_locator >	const_xy_locator
	A const_locator for a MaskedImage. More...
typedef MaskedImageLocator< typename Image::xy_locator, typename Mask::xy_locator, typename Variance::xy_locator >::x_iterator	xy_x_iterator
	an x_iterator associated with an xy_locator More...
typedef MaskedImageLocator< typename Image::xy_locator, typename Mask::xy_locator, typename Variance::xy_locator >::y_iterator	xy_y_iterator
	an y_iterator associated with an xy_locator More...

Private Member Functions
void	swap (MaskedImage &rhs)
MaskedImage	subset (lsst::geom::Box2I const &bbox, ImageOrigin origin=PARENT) const
	Return a subimage corresponding to the given box. More...
MaskedImage	operator[] (lsst::geom::Box2I const &bbox) const
	Return a subimage corresponding to the given box (interpreted as PARENT coordinates). More...
MaskedImage &	operator<<= (MaskedImage const &rhs)
	Copy the pixels from the rhs to the lhs. More...
void	assign (MaskedImage const &rhs, lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT)
	Copy pixels from another masked image to a specified subregion of this masked image. More...
MaskedImage &	operator+= (EntryT const rhs)
	Add a scalar rhs to a MaskedImage. More...
MaskedImage &	operator+= (MaskedImage const &rhs)
	Add a MaskedImage rhs to a MaskedImage. More...
MaskedImage &	operator+= (lsst::afw::image::Image< EntryT > const &rhs)
MaskedImage &	operator+= (lsst::afw::math::Function2< double > const &function)
void	scaledPlus (double const c, MaskedImage const &rhs)
	Add a scaled MaskedImage c*rhs to a MaskedImage. More...
MaskedImage &	operator-= (EntryT const rhs)
	Subtract a scalar rhs from a MaskedImage. More...
MaskedImage &	operator-= (MaskedImage const &rhs)
	Subtract a MaskedImage rhs from a MaskedImage. More...
MaskedImage &	operator-= (lsst::afw::image::Image< EntryT > const &rhs)
MaskedImage &	operator-= (lsst::afw::math::Function2< double > const &function)
void	scaledMinus (double const c, MaskedImage const &rhs)
	Subtract a scaled MaskedImage c*rhs from a MaskedImage. More...
MaskedImage &	operator*= (EntryT const rhs)
MaskedImage &	operator*= (MaskedImage const &rhs)
MaskedImage &	operator*= (lsst::afw::image::Image< EntryT > const &rhs)
void	scaledMultiplies (double const c, MaskedImage const &rhs)
MaskedImage &	operator/= (EntryT const rhs)
MaskedImage &	operator/= (MaskedImage const &rhs)
MaskedImage &	operator/= (lsst::afw::image::Image< EntryT > const &rhs)
void	scaledDivides (double const c, MaskedImage const &rhs)
void	writeFits (std::string const &fileName, std::shared_ptr< daf::base::PropertySet const > metadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > imageMetadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > maskMetadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > varianceMetadata=std::shared_ptr< daf::base::PropertySet const >()) const
	Write a MaskedImage to a regular FITS file. More...
void	writeFits (fits::MemFileManager &manager, std::shared_ptr< daf::base::PropertySet const > metadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > imageMetadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > maskMetadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > varianceMetadata=std::shared_ptr< daf::base::PropertySet const >()) const
	Write a MaskedImage to a FITS RAM file. More...
void	writeFits (fits::Fits &fitsfile, std::shared_ptr< daf::base::PropertySet const > metadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > imageMetadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > maskMetadata=std::shared_ptr< daf::base::PropertySet const >(), std::shared_ptr< daf::base::PropertySet const > varianceMetadata=std::shared_ptr< daf::base::PropertySet const >()) const
	Write a MaskedImage to a FITS file. More...
void	writeFits (std::string const &fileName, fits::ImageWriteOptions const &imageOptions, fits::ImageWriteOptions const &maskOptions, fits::ImageWriteOptions const &varianceOptions, std::shared_ptr< daf::base::PropertySet const > metadata=nullptr, std::shared_ptr< daf::base::PropertySet const > imageMetadata=nullptr, std::shared_ptr< daf::base::PropertySet const > maskMetadata=nullptr, std::shared_ptr< daf::base::PropertySet const > varianceMetadata=nullptr) const
	Write a MaskedImage to a FITS file. More...
void	writeFits (fits::MemFileManager &manager, fits::ImageWriteOptions const &imageOptions, fits::ImageWriteOptions const &maskOptions, fits::ImageWriteOptions const &varianceOptions, std::shared_ptr< daf::base::PropertySet const > metadata=nullptr, std::shared_ptr< daf::base::PropertySet const > imageMetadata=nullptr, std::shared_ptr< daf::base::PropertySet const > maskMetadata=nullptr, std::shared_ptr< daf::base::PropertySet const > varianceMetadata=nullptr) const
	Write a MaskedImage to a FITS file. More...
void	writeFits (fits::Fits &fitsfile, fits::ImageWriteOptions const &imageOptions, fits::ImageWriteOptions const &maskOptions, fits::ImageWriteOptions const &varianceOptions, std::shared_ptr< daf::base::PropertySet const > metadata=nullptr, std::shared_ptr< daf::base::PropertySet const > imageMetadata=nullptr, std::shared_ptr< daf::base::PropertySet const > maskMetadata=nullptr, std::shared_ptr< daf::base::PropertySet const > varianceMetadata=nullptr) const
	Write a MaskedImage to a FITS file. More...
void	setImage (Image const &other)
	Set the image plane's pixel values to those of another Image. More...
void	setMask (Mask const &other)
	Set the mask plane's pixel values to those of another Mask. More...
void	setVariance (Variance const &other)
	Set the variance plane's pixel values to those of another Image. 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...
lsst::geom::Extent2I	getDimensions () const
lsst::geom::Box2I	getBBox (ImageOrigin const origin=PARENT) const
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...
void	setXY0 (int const x0, int const y0)
	Set the MaskedImage's origin. More...
void	setXY0 (lsst::geom::Point2I const origin)
	Set the MaskedImage's origin. More...
double	indexToPosition (double ind, lsst::afw::image::xOrY const xy) const
	Convert image index to image position (see Image::indexToPosition) More...
std::pair< int, double >	positionToIndex (double const pos, lsst::afw::image::xOrY const xy) const
	Convert image position to index (see Image::positionToIndex) More...
iterator	begin () const
	Return an iterator to the start of the image. More...
fast_iterator	begin (bool contiguous) const
	Fast iterators to contiguous images. More...
iterator	end () const
	Return an iterator to the end of the image. More...
fast_iterator	end (bool contiguous) const
	Return a fast iterator to the end of the image, which must be contiguous Note that the order in which pixels are visited is undefined. More...
iterator	at (int const x, int const y) const
	Return an iterator at the point (x, y) More...
reverse_iterator	rbegin () const
	Return a reverse_iterator to the start of the image. More...
reverse_iterator	rend () const
	Return a reverse_iterator to the end of the image. More...
x_iterator	row_begin (int y) const
	Return an x_iterator to the start of the image. More...
x_iterator	row_end (int y) const
	Return an x_iterator to the end of the image. More...
x_iterator	x_at (int x, int y) const
	Return an x_iterator at the point (x, y) More...
y_iterator	col_begin (int x) const
	Return an y_iterator to the start of the image. More...
y_iterator	col_end (int x) const
	Return an y_iterator to the end of the image. More...
y_iterator	y_at (int x, int y) const
	Return an y_iterator at the point (x, y) More...
xy_locator	xy_at (int x, int y) const
	Return an xy_locator at the point (x, y) More...

Static Private Member Functions
static MaskedImage	readFits (std::string const &filename)
	Read a MaskedImage from a regular FITS file. More...
static MaskedImage	readFits (fits::MemFileManager &manager)
	Read a MaskedImage from a FITS RAM file. More...

Detailed Description

template<typename EntryT>
class lsst::afw::math::MaskedVector< EntryT >

Definition at line 37 of file MaskedVector.h.

Member Typedef Documentation

Pixel

template<typename EntryT>

typedef lsst::afw::image::MaskedImage<EntryT>::Pixel lsst::afw::math::MaskedVector< EntryT >::Pixel

Definition at line 41 of file MaskedVector.h.

Constructor & Destructor Documentation

MaskedVector() [1/3]

template<typename EntryT>

lsst::afw::math::MaskedVector< EntryT >::MaskedVector ( int  width = 0 )

inlineexplicit

Definition at line 43 of file MaskedVector.h.

            :  //, MaskPlaneDict const& planeDict=MaskPlaneDict()) :
              lsst::afw::image::MaskedImage<EntryT>(lsst::geom::Extent2I(width, 1)) {}  //, planeDict) {}

MaskedVector() [2/3]

template<typename EntryT>

lsst::afw::math::MaskedVector< EntryT >::MaskedVector ( MaskedVector< EntryT > const &  )

default

MaskedVector() [3/3]

template<typename EntryT>

lsst::afw::math::MaskedVector< EntryT >::MaskedVector ( MaskedVector< EntryT > &&  )

default

~MaskedVector()

template<typename EntryT>

lsst::afw::math::MaskedVector< EntryT >::~MaskedVector ( )

overridedefault

Member Function Documentation

begin()

template<typename EntryT>

iterator lsst::afw::math::MaskedVector< EntryT >::begin ( )

inline

Definition at line 123 of file MaskedVector.h.

{ return this->row_begin(0); }

empty()

template<typename EntryT>

bool lsst::afw::math::MaskedVector< EntryT >::empty ( )

inline

Definition at line 104 of file MaskedVector.h.

{ return this->getWidth(0) == 0; }

end()

template<typename EntryT>

iterator lsst::afw::math::MaskedVector< EntryT >::end ( )

inline

Definition at line 124 of file MaskedVector.h.

{ return this->row_end(0); }

getImage()

template<typename EntryT>

lsst::afw::image::MaskedImage<EntryT>::ImagePtr lsst::afw::math::MaskedVector< EntryT >::getImage ( ) const

inline

Definition at line 88 of file MaskedVector.h.

                                                                      {
        return lsst::afw::image::MaskedImage<EntryT>::getImage();
    }

getMask()

template<typename EntryT>

lsst::afw::image::MaskedImage<EntryT>::MaskPtr lsst::afw::math::MaskedVector< EntryT >::getMask ( ) const

inline

Definition at line 91 of file MaskedVector.h.

                                                                    {
        return lsst::afw::image::MaskedImage<EntryT>::getMask();
    }

getVariance()

template<typename EntryT>

lsst::afw::image::MaskedImage<EntryT>::VariancePtr lsst::afw::math::MaskedVector< EntryT >::getVariance ( ) const

inline

Definition at line 94 of file MaskedVector.h.

                                                                            {
        return lsst::afw::image::MaskedImage<EntryT>::getVariance();
    }

getVector()

template<typename EntryT>

std::shared_ptr<std::vector<EntryT> > lsst::afw::math::MaskedVector< EntryT >::getVector ( bool const  noThrow = false ) const

inline

Return a (Ptr to) the MaskedImage's image.

Definition at line 55 of file MaskedVector.h.

                                                                                  {
        if (!this->getImage() && !noThrow) {
            throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "MaskedVector's Image is NULL");
        }

        std::shared_ptr<std::vector<EntryT> > imgcp(new std::vector<EntryT>(0));
        for (int i_y = 0; i_y < this->getImage()->getHeight(); ++i_y) {
            for (typename lsst::afw::image::Image<EntryT>::x_iterator ptr = this->getImage()->row_begin(i_y);
                 ptr != this->getImage()->row_end(i_y); ++ptr) {
                imgcp->push_back(*ptr);
            }
        }
        return imgcp;
    }

mask()

template<typename EntryT>

lsst::afw::image::MaskedImage<EntryT>::Mask::Pixel& lsst::afw::math::MaskedVector< EntryT >::mask ( int const  i )

inline

Definition at line 81 of file MaskedVector.h.

                                                                         {
        return (*lsst::afw::image::MaskedImage<EntryT>::getMask())(i, 0);
    }

operator=() [1/2]

template<typename EntryT>

MaskedVector& lsst::afw::math::MaskedVector< EntryT >::operator= ( MaskedVector< EntryT > const &  )

default

operator=() [2/2]

template<typename EntryT>

MaskedVector& lsst::afw::math::MaskedVector< EntryT >::operator= ( MaskedVector< EntryT > &&  )

default

operator[]()

template<typename EntryT>

Pixel& lsst::afw::math::MaskedVector< EntryT >::operator[] ( int const  i )

inline

Definition at line 72 of file MaskedVector.h.

                                   {
        return Pixel(lsst::afw::image::MaskedImage<EntryT>::getImage()(i, 0),
                     lsst::afw::image::MaskedImage<EntryT>::getMask()(i, 0),
                     lsst::afw::image::MaskedImage<EntryT>::getVariance()(i, 0));
    }

size()

template<typename EntryT>

int lsst::afw::math::MaskedVector< EntryT >::size ( )

inline

Definition at line 103 of file MaskedVector.h.

{ return this->getWidth(0); }

value()

template<typename EntryT>

lsst::afw::image::MaskedImage<EntryT>::Image::Pixel& lsst::afw::math::MaskedVector< EntryT >::value ( int const  i )

inline

Definition at line 78 of file MaskedVector.h.

                                                                           {
        return (*lsst::afw::image::MaskedImage<EntryT>::getImage())(i, 0);
    }

variance()

template<typename EntryT>

lsst::afw::image::MaskedImage<EntryT>::Variance::Pixel& lsst::afw::math::MaskedVector< EntryT >::variance ( int const  i )

inline

Definition at line 84 of file MaskedVector.h.

                                                                                 {
        return (*lsst::afw::image::MaskedImage<EntryT>::getVariance())(i, 0);
    }

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/include/lsst/afw/math/MaskedVector.h