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 Types | Public Member Functions | List of all members
lsst::meas::algorithms::Defect Class Reference

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

#include <Interp.h>

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

Public Types

enum  DefectPosition {
  LEFT = 1 , NEAR_LEFT , WIDE_LEFT , MIDDLE ,
  WIDE_NEAR_LEFT , WIDE , WIDE_NEAR_RIGHT , NEAR_RIGHT ,
  WIDE_RIGHT , RIGHT
}
 
enum  { WIDE_DEFECT = 11 }
 
typedef std::shared_ptr< DefectPtr
 shared pointer to Defect More...
 

Public Member Functions

 Defect (const geom::BoxI &bbox=geom::BoxI())
 
virtual ~Defect ()
 
void classify (DefectPosition pos, unsigned int type)
 
unsigned int getType () const
 Return the defect's interpolation type. More...
 
DefectPosition getPos () const
 Return the position of the defect. More...
 
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 72 of file Interp.h.

Member Typedef Documentation

◆ Ptr

shared pointer to Defect

Definition at line 74 of file Interp.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
WIDE_DEFECT 

Definition at line 89 of file Interp.h.

◆ DefectPosition

Enumerator
LEFT 

defect is at left boundary

NEAR_LEFT 

defect is near left boundary

WIDE_LEFT 

defect is wide at left boundary

MIDDLE 

defect is in middle of frame

WIDE_NEAR_LEFT 

defect is near left, and wide

WIDE 

defect is in middle, and wide

WIDE_NEAR_RIGHT 

defect is near right, and wide

NEAR_RIGHT 

defect is near right boundary

WIDE_RIGHT 

defect is wide at right boundary

RIGHT 

defect is at right boundary

Definition at line 76 of file Interp.h.

76  {
77  LEFT = 1,
78  NEAR_LEFT,
79  WIDE_LEFT,
80  MIDDLE,
82  WIDE,
84  NEAR_RIGHT,
85  WIDE_RIGHT,
86  RIGHT
87  };
@ WIDE
defect is in middle, and wide
Definition: Interp.h:82
@ NEAR_RIGHT
defect is near right boundary
Definition: Interp.h:84
@ NEAR_LEFT
defect is near left boundary
Definition: Interp.h:78
@ WIDE_LEFT
defect is wide at left boundary
Definition: Interp.h:79
@ WIDE_RIGHT
defect is wide at right boundary
Definition: Interp.h:85
@ MIDDLE
defect is in middle of frame
Definition: Interp.h:80
@ WIDE_NEAR_LEFT
defect is near left, and wide
Definition: Interp.h:81
@ RIGHT
defect is at right boundary
Definition: Interp.h:86
@ LEFT
defect is at left boundary
Definition: Interp.h:77
@ WIDE_NEAR_RIGHT
defect is near right, and wide
Definition: Interp.h:83

Constructor & Destructor Documentation

◆ Defect()

lsst::meas::algorithms::Defect::Defect ( const geom::BoxI bbox = geom::BoxI())
inlineexplicit
Parameters
bboxRegion's bounding box

Definition at line 91 of file Interp.h.

93  : afw::image::DefectBase(bbox), _pos(static_cast<DefectPosition>(0)), _type(0) {}
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117

◆ ~Defect()

virtual lsst::meas::algorithms::Defect::~Defect ( )
inlinevirtual

Definition at line 94 of file Interp.h.

94 {}

Member Function Documentation

◆ classify()

void lsst::meas::algorithms::Defect::classify ( DefectPosition  pos,
unsigned int  type 
)
inline
Parameters
posPosition of defect in chip
typeType of defect

Definition at line 96 of file Interp.h.

98  {
99  _pos = pos;
100  _type = type;
101  }
table::Key< int > type
Definition: Detector.cc:163

◆ clip()

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

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
inlinenoexceptinherited

Return the Defect's bounding box.

Definition at line 52 of file Defect.h.

◆ getPos()

DefectPosition lsst::meas::algorithms::Defect::getPos ( ) const
inline

Return the position of the defect.

Definition at line 104 of file Interp.h.

◆ getType()

unsigned int lsst::meas::algorithms::Defect::getType ( ) const
inline

Return the defect's interpolation type.

Definition at line 103 of file Interp.h.

◆ getX0()

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

Return the Defect's left column.

Definition at line 53 of file Defect.h.

◆ getX1()

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

Return the Defect's right column.

Definition at line 54 of file Defect.h.

◆ getY0()

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

Return the Defect's bottom row.

Definition at line 55 of file Defect.h.

◆ getY1()

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

Return the Defect's top row.

Definition at line 56 of file Defect.h.

◆ shift() [1/2]

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

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)
inlineinherited

Definition at line 68 of file Defect.h.

68 { _bbox.shift(d); }

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