Loading [MathJax]/extensions/tex2jax.js
LSST Applications g0000d66e7c+ce78115f25,g0485b4d2cb+c8d56b10d4,g0fba68d861+fcbc158cd0,g1ec0fe41b4+3e153770da,g1fd858c14a+57ee4e1624,g2440f9efcc+8c5ae1fdc5,g35bb328faa+8c5ae1fdc5,g4d2262a081+1e04cc5a47,g53246c7159+8c5ae1fdc5,g55585698de+7a33f081c8,g56a49b3a55+b9d5cac73f,g60b5630c4e+7a33f081c8,g67b6fd64d1+035c836e50,g78460c75b0+7e33a9eb6d,g786e29fd12+668abc6043,g7ac00fbb6c+b938379438,g8352419a5c+8c5ae1fdc5,g8852436030+5ba78a36c9,g89139ef638+035c836e50,g94187f82dc+7a33f081c8,g989de1cb63+035c836e50,g9d31334357+7a33f081c8,g9f33ca652e+e34120223a,ga815be3f0b+911242149a,gabe3b4be73+8856018cbb,gabf8522325+21619da9f3,gb1101e3267+0b44b44611,gb89ab40317+035c836e50,gc91f06edcd+e59fb3c9bc,gcf25f946ba+5ba78a36c9,gd6cbbdb0b4+958adf5c1f,gde0f65d7ad+6c98dcc924,ge278dab8ac+83c63f4893,ge410e46f29+035c836e50,gf35d7ec915+97dd712d81,gf5e32f922b+8c5ae1fdc5,gf67bdafdda+035c836e50,gf6800124b1+1714c04baa,w.2025.19
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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: