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:

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< Defect >	Ptr
	shared pointer to Defect

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.
DefectPosition	getPos () const
	Return the position of the defect.
lsst::geom::Box2I const &	getBBox () const noexcept
	Return the Defect's bounding box.
int	getX0 () const noexcept
	Return the Defect's left column.
int	getX1 () const noexcept
	Return the Defect's right column.
int	getY0 () const noexcept
	Return the Defect's bottom row.
int	getY1 () const noexcept
	Return the Defect's top row.
void	clip (lsst::geom::Box2I const &bbox) noexcept
void	shift (int dx, int dy)
	Offset a Defect by (dx, dy)
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

typedef std::shared_ptr<Defect> lsst::meas::algorithms::Defect::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.

{ WIDE_DEFECT = 11 };  

DefectPosition

enum lsst::meas::algorithms::Defect::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.

                        {
        LEFT = 1,         
        NEAR_LEFT,        
        WIDE_LEFT,        
        MIDDLE,           
        WIDE_NEAR_LEFT,   
        WIDE,             
        WIDE_NEAR_RIGHT,  
        NEAR_RIGHT,       
        WIDE_RIGHT,       
        RIGHT             
    };

Constructor & Destructor Documentation

Defect()

lsst::meas::algorithms::Defect::Defect ( const geom::BoxI & bbox = geom::BoxI() )

inlineexplicit

Parameters

bbox	Region's bounding box

Definition at line 91 of file Interp.h.

            : afw::image::DefectBase(bbox), _pos(static_cast<DefectPosition>(0)), _type(0) {}

~Defect()

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

inlinevirtual

Definition at line 94 of file Interp.h.

{}

Member Function Documentation

classify()

void lsst::meas::algorithms::Defect::classify ( DefectPosition pos, unsigned int type )

inline

Parameters

pos	Position of defect in chip
type	Type of defect

Definition at line 96 of file Interp.h.

      {
        _pos = pos;
        _type = type;
    }

clip()

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

inlinenoexceptinherited

Definition at line 56 of file Defect.h.

{ _bbox.clip(bbox); }

getBBox()

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

inlinenoexceptinherited

Return the Defect's bounding box.

Definition at line 50 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 51 of file Defect.h.

getX1()

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

inlinenoexceptinherited

Return the Defect's right column.

Definition at line 52 of file Defect.h.

getY0()

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

inlinenoexceptinherited

Return the Defect's bottom row.

Definition at line 53 of file Defect.h.

getY1()

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

inlinenoexceptinherited

Return the Defect's top row.

Definition at line 54 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

dx	How much to move defect in column direction
dy	How much to move in row direction

Definition at line 61 of file Defect.h.

      {
        _bbox.shift(lsst::geom::Extent2I(dx, dy));
    }

shift() [2/2]

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

inlineinherited

Definition at line 66 of file Defect.h.

{ _bbox.shift(d); }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/meas_algorithms/g98a1a72a9c+028271c396/include/lsst/meas/algorithms/Interp.h