lsst::afw::detection::FootprintControl Class Reference

A Control Object for Footprints, controlling e.g. how they are grown. More...

#include <FootprintCtrl.h>

Public Member Functions
	FootprintControl ()
	FootprintControl (bool circular, bool isotropic=false)
	FootprintControl (bool left, bool right, bool up, bool down)
void	growCircular (bool val)
std::pair< bool, bool >	isCircular () const
void	growLeft (bool val)
std::pair< bool, bool >	isLeft () const
void	growRight (bool val)
std::pair< bool, bool >	isRight () const
void	growUp (bool val)
std::pair< bool, bool >	isUp () const
void	growDown (bool val)
std::pair< bool, bool >	isDown () const
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...

Private Types
enum	TBool { FALSE_ =false, TRUE_ =true, NONE_ }

Static Private Member Functions
static std::pair< bool, bool >	makePairFromTBool (TBool const val)

Private Attributes
TBool	_circular
TBool	_isotropic
TBool	_left
TBool	_right
TBool	_up
TBool	_down

Detailed Description

A Control Object for Footprints, controlling e.g. how they are grown.

Definition at line 36 of file FootprintCtrl.h.

Member Enumeration Documentation

enum lsst::afw::detection::FootprintControl::TBool

private

Enumerator
FALSE_
TRUE_
NONE_

Definition at line 37 of file FootprintCtrl.h.

{ FALSE_=false, TRUE_=true, NONE_ }; // ternary boolean value. N.b. _XXX is reserved

Constructor & Destructor Documentation

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

inlineexplicit

Definition at line 44 of file FootprintCtrl.h.

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

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

inlineexplicit

Definition at line 46 of file FootprintCtrl.h.

                                                                   :
        _circular(circular ? TRUE_ : FALSE_), _isotropic(isotropic ? TRUE_ : FALSE_),
        _left(NONE_), _right(NONE_), _up(NONE_), _down(NONE_) {}

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

inlineexplicit

Definition at line 49 of file FootprintCtrl.h.

                                                                         :
        _circular(NONE_), _isotropic(NONE_),
        _left(left ? TRUE_ : FALSE_), _right(right ? TRUE_ : FALSE_),
        _up(up ? TRUE_ : FALSE_), _down(down ? TRUE_ : FALSE_) {}

Member Function Documentation

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 63 of file FootprintCtrl.h.

{

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 68 of file FootprintCtrl.h.

{

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 71 of file FootprintCtrl.h.

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

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 65 of file FootprintCtrl.h.

{

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 66 of file FootprintCtrl.h.

{

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 67 of file FootprintCtrl.h.

{

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

inline

Return <isSet, Value> for circular grows

Definition at line 63 of file FootprintCtrl.h.

{

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

inline

Return <isSet, Value> for down grows

Definition at line 68 of file FootprintCtrl.h.

{

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

inline

Return <isSet, Value> for isotropic grows.

Definition at line 77 of file FootprintCtrl.h.

                                            {
        return makePairFromTBool(_isotropic);
    }

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

inline

Return <isSet, Value> for left grows

Definition at line 65 of file FootprintCtrl.h.

{

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

inline

Return <isSet, Value> for right grows

Definition at line 66 of file FootprintCtrl.h.

{

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

inline

Return <isSet, Value> for up grows

Definition at line 67 of file FootprintCtrl.h.

{

static std::pair<bool, bool> lsst::afw::detection::FootprintControl::makePairFromTBool ( TBool const  val )

inlinestaticprivate

Definition at line 39 of file FootprintCtrl.h.

    {
        return (val == NONE_) ? std::make_pair(false, false) : std::make_pair(true, val == TRUE_);
    }

Member Data Documentation

TBool lsst::afw::detection::FootprintControl::_circular

private

Definition at line 83 of file FootprintCtrl.h.

TBool lsst::afw::detection::FootprintControl::_down

private

Definition at line 85 of file FootprintCtrl.h.

TBool lsst::afw::detection::FootprintControl::_isotropic

private

Definition at line 84 of file FootprintCtrl.h.

TBool lsst::afw::detection::FootprintControl::_left

private

Definition at line 85 of file FootprintCtrl.h.

TBool lsst::afw::detection::FootprintControl::_right

private

Definition at line 85 of file FootprintCtrl.h.

TBool lsst::afw::detection::FootprintControl::_up

private

Definition at line 85 of file FootprintCtrl.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/detection/FootprintCtrl.h