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
FootprintControl &	operator= (FootprintControl const &)=default
FootprintControl &	operator= (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.

            : _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.

            : _circular(circular ? TRUE_ : FALSE_),
              _isotropic(isotropic ? TRUE_ : FALSE_),
              _left(NONE_),
              _right(NONE_),
              _up(NONE_),
              _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.

            : _circular(NONE_),
              _isotropic(NONE_),
              _left(left ? TRUE_ : FALSE_),
              _right(right ? TRUE_ : FALSE_),
              _up(up ? TRUE_ : FALSE_),
              _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

val	Should grow be isotropic?

Definition at line 81 of file FootprintCtrl.h.

      {
        _circular = TRUE_;
        _isotropic = val ? TRUE_ : FALSE_;
    }

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.

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.1.0/Linux/afw/g4595892280+fef73a337f/include/lsst/afw/detection/FootprintCtrl.h