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::detection::FootprintControl Class Reference

A Control Object for Footprints, controlling e.g. More...

#include <FootprintCtrl.h>

Public Member Functions

 FootprintControl ()
 
 FootprintControl (bool circular, bool isotropic=false)
 
 FootprintControl (bool left, bool right, bool up, bool down)
 
 ~FootprintControl ()=default
 
 FootprintControl (FootprintControl const &)=default
 
 FootprintControl (FootprintControl &&)=default
 
FootprintControloperator= (FootprintControl const &)=default
 
FootprintControloperator= (FootprintControl &&)=default
 
void growCircular (bool val)
 Set whether Footprint should be grown in a circular sort of
More...
 
std::pair< bool, bool > isCircular () const
 Return <isSet, Value> for circular grows. More...
 
void growLeft (bool val)
 Set whether Footprint should be grown in a left sort of
More...
 
std::pair< bool, bool > isLeft () const
 Return <isSet, Value> for left grows. More...
 
void growRight (bool val)
 Set whether Footprint should be grown in a right sort of
More...
 
std::pair< bool, bool > isRight () const
 Return <isSet, Value> for right grows. More...
 
void growUp (bool val)
 Set whether Footprint should be grown in a up sort of
More...
 
std::pair< bool, bool > isUp () const
 Return <isSet, Value> for up grows. More...
 
void growDown (bool val)
 Set whether Footprint should be grown in a down sort of
More...
 
std::pair< bool, bool > isDown () const
 Return <isSet, Value> for down grows. More...
 
void growIsotropic (bool val)
 Set whether Footprint should be grown isotropically. More...
 
std::pair< bool, bool > isIsotropic () const
 Return <isSet, Value> for isotropic grows. More...
 

Detailed Description

A Control Object for Footprints, controlling e.g.

how they are grown

Definition at line 34 of file FootprintCtrl.h.

Constructor & Destructor Documentation

◆ FootprintControl() [1/5]

lsst::afw::detection::FootprintControl::FootprintControl ( )
inlineexplicit

Definition at line 42 of file FootprintCtrl.h.

43  : _circular(NONE_), _isotropic(NONE_), _left(NONE_), _right(NONE_), _up(NONE_), _down(NONE_) {}

◆ FootprintControl() [2/5]

lsst::afw::detection::FootprintControl::FootprintControl ( bool  circular,
bool  isotropic = false 
)
inlineexplicit

Definition at line 44 of file FootprintCtrl.h.

45  : _circular(circular ? TRUE_ : FALSE_),
46  _isotropic(isotropic ? TRUE_ : FALSE_),
47  _left(NONE_),
48  _right(NONE_),
49  _up(NONE_),
50  _down(NONE_) {}

◆ FootprintControl() [3/5]

lsst::afw::detection::FootprintControl::FootprintControl ( bool  left,
bool  right,
bool  up,
bool  down 
)
inlineexplicit

Definition at line 51 of file FootprintCtrl.h.

52  : _circular(NONE_),
53  _isotropic(NONE_),
54  _left(left ? TRUE_ : FALSE_),
55  _right(right ? TRUE_ : FALSE_),
56  _up(up ? TRUE_ : FALSE_),
57  _down(down ? TRUE_ : FALSE_) {}

◆ ~FootprintControl()

lsst::afw::detection::FootprintControl::~FootprintControl ( )
default

◆ FootprintControl() [4/5]

lsst::afw::detection::FootprintControl::FootprintControl ( FootprintControl const &  )
default

◆ FootprintControl() [5/5]

lsst::afw::detection::FootprintControl::FootprintControl ( FootprintControl &&  )
default

Member Function Documentation

◆ growCircular()

void lsst::afw::detection::FootprintControl::growCircular ( bool  val)
inline

Set whether Footprint should be grown in a circular sort of

Parameters
val!< Should grow be of type circular ?

Definition at line 73 of file FootprintCtrl.h.

82 {

◆ growDown()

void lsst::afw::detection::FootprintControl::growDown ( bool  val)
inline

Set whether Footprint should be grown in a down sort of

Parameters
val!< Should grow be of type down ?

Definition at line 78 of file FootprintCtrl.h.

82 {

◆ growIsotropic()

void lsst::afw::detection::FootprintControl::growIsotropic ( bool  val)
inline

Set whether Footprint should be grown isotropically.

Parameters
valShould grow be isotropic?

Definition at line 81 of file FootprintCtrl.h.

82  {
83  _circular = TRUE_;
84  _isotropic = val ? TRUE_ : FALSE_;
85  }
ImageT val
Definition: CR.cc:146

◆ growLeft()

void lsst::afw::detection::FootprintControl::growLeft ( bool  val)
inline

Set whether Footprint should be grown in a left sort of

Parameters
val!< Should grow be of type left ?

Definition at line 75 of file FootprintCtrl.h.

82 {

◆ growRight()

void lsst::afw::detection::FootprintControl::growRight ( bool  val)
inline

Set whether Footprint should be grown in a right sort of

Parameters
val!< Should grow be of type right ?

Definition at line 76 of file FootprintCtrl.h.

82 {

◆ growUp()

void lsst::afw::detection::FootprintControl::growUp ( bool  val)
inline

Set whether Footprint should be grown in a up sort of

Parameters
val!< Should grow be of type up ?

Definition at line 77 of file FootprintCtrl.h.

82 {

◆ isCircular()

std::pair<bool, bool> lsst::afw::detection::FootprintControl::isCircular ( ) const
inline

Return <isSet, Value> for circular grows.

Definition at line 73 of file FootprintCtrl.h.

82 {

◆ isDown()

std::pair<bool, bool> lsst::afw::detection::FootprintControl::isDown ( ) const
inline

Return <isSet, Value> for down grows.

Definition at line 78 of file FootprintCtrl.h.

82 {

◆ isIsotropic()

std::pair<bool, bool> lsst::afw::detection::FootprintControl::isIsotropic ( ) const
inline

Return <isSet, Value> for isotropic grows.

Definition at line 87 of file FootprintCtrl.h.

87 { return makePairFromTBool(_isotropic); }

◆ isLeft()

std::pair<bool, bool> lsst::afw::detection::FootprintControl::isLeft ( ) const
inline

Return <isSet, Value> for left grows.

Definition at line 75 of file FootprintCtrl.h.

82 {

◆ isRight()

std::pair<bool, bool> lsst::afw::detection::FootprintControl::isRight ( ) const
inline

Return <isSet, Value> for right grows.

Definition at line 76 of file FootprintCtrl.h.

82 {

◆ isUp()

std::pair<bool, bool> lsst::afw::detection::FootprintControl::isUp ( ) const
inline

Return <isSet, Value> for up grows.

Definition at line 77 of file FootprintCtrl.h.

82 {

◆ operator=() [1/2]

FootprintControl& lsst::afw::detection::FootprintControl::operator= ( FootprintControl &&  )
default

◆ operator=() [2/2]

FootprintControl& lsst::afw::detection::FootprintControl::operator= ( FootprintControl const &  )
default

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