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

#include <MaskedVector.h>

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

Classes
class	iterator

Public Types
using	Pixel = typename lsst::afw::image::MaskedImage< EntryT >::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 Member Functions
MaskedImage	operator[] (lsst::geom::Box2I const &bbox) const
	Return a subimage corresponding to the given box (interpreted as PARENT coordinates). 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...

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 >

using lsst::afw::math::MaskedVector< EntryT >::Pixel = typename lsst::afw::image::MaskedImage<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 > &&  )

default

operator=() [2/2]

template<typename EntryT >

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

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/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-32-g5ddfab5d3+60ce4897b0/include/lsst/afw/math/MaskedVector.h