lsst.afw  tickets.DM-23835-g31c64b24f1
Public Member Functions | List of all members
lsst::afw::math::BackgroundControl Class Reference

Pass parameters to a Background object. More...

#include <Background.h>

Public Member Functions

 BackgroundControl (int const nxSample, int const nySample, StatisticsControl const sctrl=StatisticsControl(), Property const prop=MEANCLIP, ApproximateControl const actrl=ApproximateControl(ApproximateControl::UNKNOWN, 1))
 
 BackgroundControl (int const nxSample, int const nySample, StatisticsControl const &sctrl, std::string const &prop, ApproximateControl const actrl=ApproximateControl(ApproximateControl::UNKNOWN, 1))
 Overload constructor to handle string for statistical operator. More...
 
 BackgroundControl (Interpolate::Style const style, int const nxSample=10, int const nySample=10, UndersampleStyle const undersampleStyle=THROW_EXCEPTION, StatisticsControl const sctrl=StatisticsControl(), Property const prop=MEANCLIP, ApproximateControl const actrl=ApproximateControl(ApproximateControl::UNKNOWN, 1))
 
 BackgroundControl (std::string const &style, int const nxSample=10, int const nySample=10, std::string const &undersampleStyle="THROW_EXCEPTION", StatisticsControl const sctrl=StatisticsControl(), std::string const &prop="MEANCLIP", ApproximateControl const actrl=ApproximateControl(ApproximateControl::UNKNOWN, 1))
 Overload constructor to handle strings for both interp and undersample styles. More...
 
 BackgroundControl (BackgroundControl const &)=default
 
 BackgroundControl (BackgroundControl &&)=default
 
BackgroundControloperator= (BackgroundControl const &)=default
 
BackgroundControloperator= (BackgroundControl &&)=default
 
virtual ~BackgroundControl ()=default
 
void setNxSample (int nxSample)
 
void setNySample (int nySample)
 
void setInterpStyle (Interpolate::Style const style)
 
void setInterpStyle (std::string const &style)
 
void setUndersampleStyle (UndersampleStyle const undersampleStyle)
 
void setUndersampleStyle (std::string const &undersampleStyle)
 
int getNxSample () const
 
int getNySample () const
 
Interpolate::Style getInterpStyle () const
 
UndersampleStyle getUndersampleStyle () const
 
std::shared_ptr< StatisticsControlgetStatisticsControl ()
 
std::shared_ptr< StatisticsControl const > getStatisticsControl () const
 
Property getStatisticsProperty () const
 
void setStatisticsProperty (Property prop)
 
void setStatisticsProperty (std::string prop)
 
void setApproximateControl (std::shared_ptr< ApproximateControl > actrl)
 
std::shared_ptr< ApproximateControlgetApproximateControl ()
 
std::shared_ptr< ApproximateControl const > getApproximateControl () const
 

Detailed Description

Pass parameters to a Background object.

Definition at line 56 of file Background.h.

Constructor & Destructor Documentation

◆ BackgroundControl() [1/6]

lsst::afw::math::BackgroundControl::BackgroundControl ( int const  nxSample,
int const  nySample,
StatisticsControl const  sctrl = StatisticsControl(),
Property const  prop = MEANCLIP,
ApproximateControl const  actrl = ApproximateControl(ApproximateControl::UNKNOWN, 1) 
)
inline
Parameters
nxSampleNum. grid samples in x
nySampleNum. grid samples in y
sctrlConfiguration for Stats to be computed
propstatistical property to use for grid points
actrlconfiguration for approx to be computed

Definition at line 65 of file Background.h.

◆ BackgroundControl() [2/6]

lsst::afw::math::BackgroundControl::BackgroundControl ( int const  nxSample,
int const  nySample,
StatisticsControl const &  sctrl,
std::string const &  prop,
ApproximateControl const  actrl = ApproximateControl(ApproximateControl::UNKNOWN, 1) 
)
inline

Overload constructor to handle string for statistical operator.

Parameters
nxSamplenum. grid samples in x
nySamplenum. grid samples in y
sctrlconfiguration for stats to be computed
propstatistical property to use for grid points
actrlconfiguration for approx to be computed

Definition at line 91 of file Background.h.

◆ BackgroundControl() [3/6]

lsst::afw::math::BackgroundControl::BackgroundControl ( Interpolate::Style const  style,
int const  nxSample = 10,
int const  nySample = 10,
UndersampleStyle const  undersampleStyle = THROW_EXCEPTION,
StatisticsControl const  sctrl = StatisticsControl(),
Property const  prop = MEANCLIP,
ApproximateControl const  actrl = ApproximateControl(ApproximateControl::UNKNOWN, 1) 
)
inline
Deprecated:
New code should specify the interpolation style in getImage, not the BackgroundControl ctor
Parameters
styleStyle of the interpolation
nxSampleNum. grid samples in x
nySampleNum. grid samples in y
undersampleStyleBehaviour if there are too few points
sctrlConfiguration for Stats to be computed
propstatistical property to use for grid points
actrlconfiguration for approx to be computed

Definition at line 122 of file Background.h.

◆ BackgroundControl() [4/6]

lsst::afw::math::BackgroundControl::BackgroundControl ( std::string const &  style,
int const  nxSample = 10,
int const  nySample = 10,
std::string const &  undersampleStyle = "THROW_EXCEPTION",
StatisticsControl const  sctrl = StatisticsControl(),
std::string const &  prop = "MEANCLIP",
ApproximateControl const  actrl = ApproximateControl(ApproximateControl::UNKNOWN,                                                                                  1) 
)
inline

Overload constructor to handle strings for both interp and undersample styles.

Deprecated:
New code should specify the interpolation style in getImage, not the BackgroundControl ctor
Parameters
styleStyle of the interpolation
nxSamplenum. grid samples in x
nySamplenum. grid samples in y
undersampleStylebehaviour if there are too few points
sctrlconfiguration for stats to be computed
propstatistical property to use for grid points
actrlconfiguration for approx to be computed

Definition at line 159 of file Background.h.

◆ BackgroundControl() [5/6]

lsst::afw::math::BackgroundControl::BackgroundControl ( BackgroundControl const &  )
default

◆ BackgroundControl() [6/6]

lsst::afw::math::BackgroundControl::BackgroundControl ( BackgroundControl &&  )
default

◆ ~BackgroundControl()

virtual lsst::afw::math::BackgroundControl::~BackgroundControl ( )
virtualdefault

Member Function Documentation

◆ getApproximateControl() [1/2]

std::shared_ptr<ApproximateControl> lsst::afw::math::BackgroundControl::getApproximateControl ( )
inline

Definition at line 243 of file Background.h.

◆ getApproximateControl() [2/2]

std::shared_ptr<ApproximateControl const> lsst::afw::math::BackgroundControl::getApproximateControl ( ) const
inline

Definition at line 244 of file Background.h.

◆ getInterpStyle()

Interpolate::Style lsst::afw::math::BackgroundControl::getInterpStyle ( ) const
inline

Definition at line 227 of file Background.h.

◆ getNxSample()

int lsst::afw::math::BackgroundControl::getNxSample ( ) const
inline

Definition at line 222 of file Background.h.

◆ getNySample()

int lsst::afw::math::BackgroundControl::getNySample ( ) const
inline

Definition at line 223 of file Background.h.

◆ getStatisticsControl() [1/2]

std::shared_ptr<StatisticsControl> lsst::afw::math::BackgroundControl::getStatisticsControl ( )
inline

Definition at line 235 of file Background.h.

◆ getStatisticsControl() [2/2]

std::shared_ptr<StatisticsControl const> lsst::afw::math::BackgroundControl::getStatisticsControl ( ) const
inline

Definition at line 236 of file Background.h.

◆ getStatisticsProperty()

Property lsst::afw::math::BackgroundControl::getStatisticsProperty ( ) const
inline

Definition at line 238 of file Background.h.

◆ getUndersampleStyle()

UndersampleStyle lsst::afw::math::BackgroundControl::getUndersampleStyle ( ) const
inline

Definition at line 234 of file Background.h.

◆ operator=() [1/2]

BackgroundControl& lsst::afw::math::BackgroundControl::operator= ( BackgroundControl &&  )
default

◆ operator=() [2/2]

BackgroundControl& lsst::afw::math::BackgroundControl::operator= ( BackgroundControl const &  )
default

◆ setApproximateControl()

void lsst::afw::math::BackgroundControl::setApproximateControl ( std::shared_ptr< ApproximateControl actrl)
inline

Definition at line 242 of file Background.h.

◆ setInterpStyle() [1/2]

void lsst::afw::math::BackgroundControl::setInterpStyle ( Interpolate::Style const  style)
inline

Definition at line 203 of file Background.h.

◆ setInterpStyle() [2/2]

void lsst::afw::math::BackgroundControl::setInterpStyle ( std::string const &  style)
inline

Definition at line 210 of file Background.h.

◆ setNxSample()

void lsst::afw::math::BackgroundControl::setNxSample ( int  nxSample)
inline

Definition at line 185 of file Background.h.

◆ setNySample()

void lsst::afw::math::BackgroundControl::setNySample ( int  nySample)
inline

Definition at line 192 of file Background.h.

◆ setStatisticsProperty() [1/2]

void lsst::afw::math::BackgroundControl::setStatisticsProperty ( Property  prop)
inline

Definition at line 239 of file Background.h.

◆ setStatisticsProperty() [2/2]

void lsst::afw::math::BackgroundControl::setStatisticsProperty ( std::string  prop)
inline

Definition at line 240 of file Background.h.

◆ setUndersampleStyle() [1/2]

void lsst::afw::math::BackgroundControl::setUndersampleStyle ( std::string const &  undersampleStyle)
inline

Definition at line 218 of file Background.h.

◆ setUndersampleStyle() [2/2]

void lsst::afw::math::BackgroundControl::setUndersampleStyle ( UndersampleStyle const  undersampleStyle)
inline

Definition at line 214 of file Background.h.


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