LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Classes | Public Types | Public Member Functions | Private Member Functions | List of all members
lsst::afw::math::MaskedVector< EntryT > Class Template Reference

#include <MaskedVector.h>

Inheritance diagram for lsst::afw::math::MaskedVector< EntryT >:
lsst::afw::image::MaskedImage< 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
 
MaskedVectoroperator= (MaskedVector const &)=default
 
MaskedVectoroperator= (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...
 
Pixeloperator[] (int const i)
 
lsst::afw::image::MaskedImage< EntryT >::Image::Pixelvalue (int const i)
 
lsst::afw::image::MaskedImage< EntryT >::Mask::Pixelmask (int const i)
 
lsst::afw::image::MaskedImage< EntryT >::Variance::Pixelvariance (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.

44  : //, MaskPlaneDict const& planeDict=MaskPlaneDict()) :
45  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.

123 { return this->row_begin(0); }
x_iterator row_begin(int y) const
Return an x_iterator to the start of the image.
Definition: MaskedImage.cc:621

◆ empty()

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

Definition at line 104 of file MaskedVector.h.

104 { return this->getWidth(0) == 0; }
int getWidth() const
Return the number of columns in the image.
Definition: MaskedImage.h:1054

◆ end()

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

Definition at line 124 of file MaskedVector.h.

124 { return this->row_end(0); }
x_iterator row_end(int y) const
Return an x_iterator to the end of the image.
Definition: MaskedImage.cc:631

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

88  {
90  }
ImagePtr getImage() const
Return a (shared_ptr to) the MaskedImage's image.
Definition: MaskedImage.h:1018

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

91  {
93  }
MaskPtr getMask() const
Return a (shared_ptr to) the MaskedImage's mask.
Definition: MaskedImage.h:1030

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

94  {
96  }
VariancePtr getVariance() const
Return a (shared_ptr to) the MaskedImage's variance.
Definition: MaskedImage.h:1051

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

55  {
56  if (!this->getImage() && !noThrow) {
57  throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "MaskedVector's Image is NULL");
58  }
59 
61  for (int i_y = 0; i_y < this->getImage()->getHeight(); ++i_y) {
63  ptr != this->getImage()->row_end(i_y); ++ptr) {
64  imgcp->push_back(*ptr);
65  }
66  }
67  return imgcp;
68  }
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
uint64_t * ptr
Definition: RangeSet.cc:88
typename _view_t::x_iterator x_iterator
An iterator for traversing the pixels in a row.
Definition: ImageBase.h:133
int getHeight() const
Return the number of rows in the image.
Definition: MaskedImage.h:1056
lsst::afw::image::MaskedImage< EntryT >::ImagePtr getImage() const
Definition: MaskedVector.h:88
Reports errors that are due to events beyond the control of the program.
Definition: Runtime.h:104

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

81  {
83  }

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

72  {
76  }
typename lsst::afw::image::MaskedImage< EntryT >::Pixel Pixel
Definition: MaskedVector.h:41

◆ size()

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

Definition at line 103 of file MaskedVector.h.

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

78  {
80  }

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

84  {
86  }

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