LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
Loading...
Searching...
No Matches
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.
 
std::pair< bool, bool > isCircular () const
 Return <isSet, Value> for circular grows.
 
void growLeft (bool val)
 Set whether Footprint should be grown in a left sort of.
 
std::pair< bool, bool > isLeft () const
 Return <isSet, Value> for left grows.
 
void growRight (bool val)
 Set whether Footprint should be grown in a right sort of.
 
std::pair< bool, bool > isRight () const
 Return <isSet, Value> for right grows.
 
void growUp (bool val)
 Set whether Footprint should be grown in a up sort of.
 
std::pair< bool, bool > isUp () const
 Return <isSet, Value> for up grows.
 
void growDown (bool val)
 Set whether Footprint should be grown in a down sort of.
 
std::pair< bool, bool > isDown () const
 Return <isSet, Value> for down grows.
 
void growIsotropic (bool val)
 Set whether Footprint should be grown isotropically.
 
std::pair< bool, bool > isIsotropic () const
 Return <isSet, Value> for isotropic grows.
 

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.

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

◆ 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 }

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

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

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

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

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

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

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

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

◆ 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: