lsst::afw::detection::HeavyFootprintCtrl Class Reference

A control object for HeavyFootprints. More...

#include <FootprintCtrl.h>

Public Types
enum	ModifySource { NONE , SET }

Public Member Functions
	HeavyFootprintCtrl (ModifySource modifySource=NONE)
	~HeavyFootprintCtrl ()=default
	HeavyFootprintCtrl (HeavyFootprintCtrl const &)=default
	HeavyFootprintCtrl (HeavyFootprintCtrl &&)=default
HeavyFootprintCtrl &	operator= (HeavyFootprintCtrl const &)=default
HeavyFootprintCtrl &	operator= (HeavyFootprintCtrl &&)=default
ModifySource	getModifySource () const
void	setModifySource (ModifySource modifySource)
double	getImageVal () const
void	setImageVal (double imageVal)
long	getMaskVal () const
void	setMaskVal (long maskVal)
double	getVarianceVal () const
void	setVarianceVal (double varianceVal)

Detailed Description

A control object for HeavyFootprints.

Definition at line 99 of file FootprintCtrl.h.

Member Enumeration Documentation

ModifySource

enum lsst::afw::detection::HeavyFootprintCtrl::ModifySource

Enumerator
NONE
SET

Definition at line 101 of file FootprintCtrl.h.

                      {
        NONE,
        SET,
    };

Constructor & Destructor Documentation

HeavyFootprintCtrl() [1/3]

lsst::afw::detection::HeavyFootprintCtrl::HeavyFootprintCtrl ( ModifySource modifySource = NONE )

inlineexplicit

Definition at line 106 of file FootprintCtrl.h.

            : _modifySource(modifySource), _imageVal(0.0), _maskVal(0), _varianceVal(0.0) {}

~HeavyFootprintCtrl()

lsst::afw::detection::HeavyFootprintCtrl::~HeavyFootprintCtrl ( )

default

HeavyFootprintCtrl() [2/3]

lsst::afw::detection::HeavyFootprintCtrl::HeavyFootprintCtrl ( HeavyFootprintCtrl const & )

default

HeavyFootprintCtrl() [3/3]

lsst::afw::detection::HeavyFootprintCtrl::HeavyFootprintCtrl ( HeavyFootprintCtrl && )

default

Member Function Documentation

getImageVal()

double lsst::afw::detection::HeavyFootprintCtrl::getImageVal ( ) const

inline

Definition at line 118 of file FootprintCtrl.h.

{ return _imageVal; }

getMaskVal()

long lsst::afw::detection::HeavyFootprintCtrl::getMaskVal ( ) const

inline

Definition at line 120 of file FootprintCtrl.h.

{ return _maskVal; }

getModifySource()

ModifySource lsst::afw::detection::HeavyFootprintCtrl::getModifySource ( ) const

inline

Definition at line 115 of file FootprintCtrl.h.

{ return _modifySource; }

getVarianceVal()

double lsst::afw::detection::HeavyFootprintCtrl::getVarianceVal ( ) const

inline

Definition at line 122 of file FootprintCtrl.h.

{ return _varianceVal; }

operator=() [1/2]

HeavyFootprintCtrl & lsst::afw::detection::HeavyFootprintCtrl::operator= ( HeavyFootprintCtrl && )

default

operator=() [2/2]

HeavyFootprintCtrl & lsst::afw::detection::HeavyFootprintCtrl::operator= ( HeavyFootprintCtrl const & )

default

setImageVal()

void lsst::afw::detection::HeavyFootprintCtrl::setImageVal ( double imageVal )

inline

Definition at line 119 of file FootprintCtrl.h.

{ _imageVal = imageVal; }

setMaskVal()

void lsst::afw::detection::HeavyFootprintCtrl::setMaskVal ( long maskVal )

inline

Definition at line 121 of file FootprintCtrl.h.

{ _maskVal = maskVal; }

setModifySource()

void lsst::afw::detection::HeavyFootprintCtrl::setModifySource ( ModifySource modifySource )

inline

Definition at line 116 of file FootprintCtrl.h.

{ _modifySource = modifySource; }

setVarianceVal()

void lsst::afw::detection::HeavyFootprintCtrl::setVarianceVal ( double varianceVal )

inline

Definition at line 123 of file FootprintCtrl.h.

{ _varianceVal = varianceVal; }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/afw/g5a012ec0e7+ac98094cfc/include/lsst/afw/detection/FootprintCtrl.h