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

typedef boost::shared_ptr
< DefectBase
Ptr
 shared pointer to DefectBase More...
 

Public Member Functions

 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

geom::Box2I _bbox
 Bounding box for bad pixels. More...
 

Detailed Description

Encapsulate information about a bad portion of a detector.

Definition at line 42 of file Defect.h.

Member Typedef Documentation

typedef boost::shared_ptr<DefectBase> lsst.afw.image::DefectBase::Ptr

shared pointer to DefectBase

Definition at line 44 of file Defect.h.

Constructor & Destructor Documentation

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

Definition at line 46 of file Defect.h.

48  : _bbox(bbox) { }
geom::Box2I _bbox
Bounding box for bad pixels.
Definition: Defect.h:70
virtual lsst.afw.image::DefectBase::~DefectBase ( )
inlinevirtual

Definition at line 49 of file Defect.h.

49 {}

Member Function Documentation

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

Definition at line 58 of file Defect.h.

58 {_bbox.clip(bbox);}
geom::Box2I _bbox
Bounding box for bad pixels.
Definition: Defect.h:70
void clip(Box2I const &other)
Shrink this to ensure that other.contains(*this).
geom::Box2I const& lsst.afw.image::DefectBase::getBBox ( ) const
inline

Return the Defect's bounding box.

Definition at line 51 of file Defect.h.

int lsst.afw.image::DefectBase::getX0 ( ) const
inline

Return the Defect's left column.

Definition at line 52 of file Defect.h.

int lsst.afw.image::DefectBase::getX1 ( ) const
inline

Return the Defect's right column.

Definition at line 53 of file Defect.h.

int lsst.afw.image::DefectBase::getY0 ( ) const
inline

Return the Defect's bottom row.

Definition at line 54 of file Defect.h.

int lsst.afw.image::DefectBase::getY1 ( ) const
inline

Return the Defect's top row.

Definition at line 55 of file Defect.h.

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(geom::Extent2I(dx, dy));
67  }
geom::Box2I _bbox
Bounding box for bad pixels.
Definition: Defect.h:70
void shift(Extent2I const &offset)
Shift the position of the box by the given offset.
void lsst.afw.image::DefectBase::shift ( geom::Extent2I const &  d)
inline

Definition at line 68 of file Defect.h.

68 {_bbox.shift(d);}
geom::Box2I _bbox
Bounding box for bad pixels.
Definition: Defect.h:70
void shift(Extent2I const &offset)
Shift the position of the box by the given offset.

Member Data Documentation

geom::Box2I lsst.afw.image::DefectBase::_bbox
private

Bounding box for bad pixels.

Definition at line 70 of file Defect.h.


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