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
Public Member Functions | List of all members
lsst::afw::image::DefectBase Class Reference

Encapsulate information about a bad portion of a detector. More...

#include <Defect.h>

Inheritance diagram for lsst::afw::image::DefectBase:
lsst::meas::algorithms::Defect

Public Member Functions

 DefectBase (const lsst::geom::Box2I &bbox)
 
 DefectBase (DefectBase const &) noexcept=default
 
 DefectBase (DefectBase &&) noexcept=default
 
DefectBaseoperator= (DefectBase const &) noexcept=default
 
DefectBaseoperator= (DefectBase &&) noexcept=default
 
virtual ~DefectBase () noexcept=default
 
lsst::geom::Box2I const & getBBox () const noexcept
 Return the Defect's bounding box. More...
 
int getX0 () const noexcept
 Return the Defect's left column. More...
 
int getX1 () const noexcept
 Return the Defect's right column. More...
 
int getY0 () const noexcept
 Return the Defect's bottom row. More...
 
int getY1 () const noexcept
 Return the Defect's top row. More...
 
void clip (lsst::geom::Box2I const &bbox) noexcept
 
void shift (int dx, int dy)
 Offset a Defect by (dx, dy) More...
 
void shift (lsst::geom::Extent2I const &d)
 

Detailed Description

Encapsulate information about a bad portion of a detector.

Definition at line 41 of file Defect.h.

Constructor & Destructor Documentation

◆ DefectBase() [1/3]

lsst::afw::image::DefectBase::DefectBase ( const lsst::geom::Box2I bbox)
inlineexplicit
Parameters
bboxBad pixels' bounding box

Definition at line 43 of file Defect.h.

45  : _bbox(bbox) {}
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117

◆ DefectBase() [2/3]

lsst::afw::image::DefectBase::DefectBase ( DefectBase const &  )
defaultnoexcept

◆ DefectBase() [3/3]

lsst::afw::image::DefectBase::DefectBase ( DefectBase &&  )
defaultnoexcept

◆ ~DefectBase()

virtual lsst::afw::image::DefectBase::~DefectBase ( )
virtualdefaultnoexcept

Member Function Documentation

◆ clip()

void lsst::afw::image::DefectBase::clip ( lsst::geom::Box2I const &  bbox)
inlinenoexcept

Definition at line 58 of file Defect.h.

58 { _bbox.clip(bbox); }
void clip(Box2I const &other) noexcept
Shrink this to ensure that other.contains(*this).
Definition: Box.cc:189

◆ getBBox()

lsst::geom::Box2I const& lsst::afw::image::DefectBase::getBBox ( ) const
inlinenoexcept

Return the Defect's bounding box.

Definition at line 52 of file Defect.h.

◆ getX0()

int lsst::afw::image::DefectBase::getX0 ( ) const
inlinenoexcept

Return the Defect's left column.

Definition at line 53 of file Defect.h.

◆ getX1()

int lsst::afw::image::DefectBase::getX1 ( ) const
inlinenoexcept

Return the Defect's right column.

Definition at line 54 of file Defect.h.

◆ getY0()

int lsst::afw::image::DefectBase::getY0 ( ) const
inlinenoexcept

Return the Defect's bottom row.

Definition at line 55 of file Defect.h.

◆ getY1()

int lsst::afw::image::DefectBase::getY1 ( ) const
inlinenoexcept

Return the Defect's top row.

Definition at line 56 of file Defect.h.

◆ operator=() [1/2]

DefectBase& lsst::afw::image::DefectBase::operator= ( DefectBase &&  )
defaultnoexcept

◆ operator=() [2/2]

DefectBase& lsst::afw::image::DefectBase::operator= ( DefectBase const &  )
defaultnoexcept

◆ shift() [1/2]

void lsst::afw::image::DefectBase::shift ( int  dx,
int  dy 
)
inline

Offset a Defect by (dx, dy)

Parameters
dxHow much to move defect in column direction
dyHow much to move in row direction

Definition at line 63 of file Defect.h.

65  {
66  _bbox.shift(lsst::geom::Extent2I(dx, dy));
67  }
void shift(Extent2I const &offset)
Shift the position of the box by the given offset.
Definition: Box.cc:134

◆ shift() [2/2]

void lsst::afw::image::DefectBase::shift ( lsst::geom::Extent2I const &  d)
inline

Definition at line 68 of file Defect.h.

68 { _bbox.shift(d); }

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