LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
Public Types | Public Member Functions | Private Attributes | 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 boost::shared_ptr< DefectPtr
 shared pointer to Defect More...
 
- Public Types inherited from lsst.afw.image::DefectBase
typedef boost::shared_ptr
< DefectBase
Ptr
 shared pointer to DefectBase More...
 

Public Member Functions

 Defect (const lsst::afw::geom::BoxI &bbox=lsst::afw::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...
 
- Public Member Functions inherited from lsst.afw.image::DefectBase
 DefectBase (const geom::Box2I &bbox)
 
virtual ~DefectBase ()
 
geom::Box2I const & getBBox () const
 Return the Defect's bounding box. More...
 
int getX0 () const
 Return the Defect's left column. More...
 
int getX1 () const
 Return the Defect's right column. More...
 
int getY0 () const
 Return the Defect's bottom row. More...
 
int getY1 () const
 Return the Defect's top row. More...
 
void clip (geom::Box2I const &bbox)
 
void shift (int dx, int dy)
 
void shift (geom::Extent2I const &d)
 

Private Attributes

DefectPosition _pos
 Position of defect. More...
 
unsigned int _type
 Type of defect. More...
 

Detailed Description

Encapsulate information about a bad portion of a detector.

Definition at line 70 of file Interp.h.

Member Typedef Documentation

typedef boost::shared_ptr<Defect> lsst::meas::algorithms::Defect::Ptr

shared pointer to Defect

Definition at line 72 of file Interp.h.

Member Enumeration Documentation

anonymous enum
Enumerator
WIDE_DEFECT 

Definition at line 87 of file Interp.h.

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 74 of file Interp.h.

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

Constructor & Destructor Documentation

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

Definition at line 89 of file Interp.h.

91  :
92  lsst::afw::image::DefectBase(bbox), _pos(static_cast<DefectPosition>(0)), _type(0) { }
Encapsulate information about a bad portion of a detector.
Definition: Defect.h:42
DefectPosition _pos
Position of defect.
Definition: Interp.h:105
unsigned int _type
Type of defect.
Definition: Interp.h:106
virtual lsst::meas::algorithms::Defect::~Defect ( )
inlinevirtual

Definition at line 93 of file Interp.h.

93 {}

Member Function Documentation

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

Definition at line 95 of file Interp.h.

97  {
98  _pos = pos;
99  _type = type;
100  }
DefectPosition _pos
Position of defect.
Definition: Interp.h:105
unsigned int _type
Type of defect.
Definition: Interp.h:106
DefectPosition lsst::meas::algorithms::Defect::getPos ( ) const
inline

Return the position of the defect.

Definition at line 103 of file Interp.h.

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

Return the defect's interpolation type.

Definition at line 102 of file Interp.h.

Member Data Documentation

DefectPosition lsst::meas::algorithms::Defect::_pos
private

Position of defect.

Definition at line 105 of file Interp.h.

unsigned int lsst::meas::algorithms::Defect::_type
private

Type of defect.

Definition at line 106 of file Interp.h.


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