LSST Applications g0f08755f38+9c285cab97,g1635faa6d4+13f3999e92,g1653933729+a8ce1bb630,g1a0ca8cf93+bf6eb00ceb,g28da252d5a+0829b12dee,g29321ee8c0+5700dc9eac,g2bbee38e9b+9634bc57db,g2bc492864f+9634bc57db,g2cdde0e794+c2c89b37c4,g3156d2b45e+41e33cbcdc,g347aa1857d+9634bc57db,g35bb328faa+a8ce1bb630,g3a166c0a6a+9634bc57db,g3e281a1b8c+9f2c4e2fc3,g414038480c+077ccc18e7,g41af890bb2+fde0dd39b6,g5fbc88fb19+17cd334064,g781aacb6e4+a8ce1bb630,g80478fca09+55a9465950,g82479be7b0+d730eedb7d,g858d7b2824+9c285cab97,g9125e01d80+a8ce1bb630,g9726552aa6+10f999ec6a,ga5288a1d22+2a84bb7594,gacf8899fa4+c69c5206e8,gae0086650b+a8ce1bb630,gb58c049af0+d64f4d3760,gc28159a63d+9634bc57db,gcf0d15dbbd+4b7d09cae4,gda3e153d99+9c285cab97,gda6a2b7d83+4b7d09cae4,gdaeeff99f8+1711a396fd,ge2409df99d+5e831397f4,ge79ae78c31+9634bc57db,gf0baf85859+147a0692ba,gf3967379c6+41c94011de,gf3fb38a9a8+8f07a9901b,gfb92a5be7c+9c285cab97,w.2024.46
LSST Data Management Base Package
Loading...
Searching...
No Matches
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.
 
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).
 
iterator begin () const
 Return an iterator to the start of the image.
 
fast_iterator begin (bool contiguous) const
 Fast iterators to contiguous images.
 
iterator end () const
 Return an iterator to the end of the image.
 
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.
 

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()) :
A class to manipulate images, masks, and variance as a single object.
Definition MaskedImage.h:74

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

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

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

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

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

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

◆ 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
std::uint64_t * ptr
Definition RangeSet.cc:95
A class to represent a 2-dimensional array of pixels.
Definition Image.h:51
int getHeight() const
Return the number of rows in the image.
lsst::afw::image::MaskedImage< EntryT >::ImagePtr getImage() const
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.

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