Pass parameters to a Background object.
More...
#include <Background.h>
|
| 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)) |
| Overload constructor to provide interp style. More...
|
|
| 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 |
|
BackgroundControl & | operator= (BackgroundControl const &)=default |
|
BackgroundControl & | operator= (BackgroundControl &&)=default |
|
| ~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< StatisticsControl > | getStatisticsControl () |
|
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< ApproximateControl > | getApproximateControl () |
|
std::shared_ptr< ApproximateControl const > | getApproximateControl () const |
|
Pass parameters to a Background object.
Definition at line 56 of file Background.h.
◆ BackgroundControl() [1/6]
- Parameters
-
nxSample | Num. grid samples in x |
nySample | Num. grid samples in y |
sctrl | Configuration for Stats to be computed |
prop | statistical property to use for grid points |
actrl | configuration for approx to be computed |
Definition at line 65 of file Background.h.
◆ BackgroundControl() [2/6]
Overload constructor to handle string for statistical operator.
- Parameters
-
nxSample | num. grid samples in x |
nySample | num. grid samples in y |
sctrl | configuration for stats to be computed |
prop | statistical property to use for grid points |
actrl | configuration for approx to be computed |
Definition at line 91 of file Background.h.
◆ BackgroundControl() [3/6]
Overload constructor to provide interp style.
- Parameters
-
style | Style of the interpolation |
nxSample | Num. grid samples in x |
nySample | Num. grid samples in y |
undersampleStyle | Behaviour if there are too few points |
sctrl | Configuration for Stats to be computed |
prop | statistical property to use for grid points |
actrl | configuration for approx to be computed |
Definition at line 118 of file Background.h.
◆ BackgroundControl() [4/6]
Overload constructor to handle strings for both interp and undersample styles.
- Parameters
-
style | Style of the interpolation |
nxSample | num. grid samples in x |
nySample | num. grid samples in y |
undersampleStyle | behaviour if there are too few points |
sctrl | configuration for stats to be computed |
prop | statistical property to use for grid points |
actrl | configuration for approx to be computed |
Definition at line 149 of file Background.h.
◆ BackgroundControl() [5/6]
◆ BackgroundControl() [6/6]
◆ ~BackgroundControl()
lsst::afw::math::BackgroundControl::~BackgroundControl |
( |
| ) |
|
|
default |
◆ getApproximateControl() [1/2]
◆ getApproximateControl() [2/2]
◆ getInterpStyle()
◆ getNxSample()
int lsst::afw::math::BackgroundControl::getNxSample |
( |
| ) |
const |
|
inline |
◆ getNySample()
int lsst::afw::math::BackgroundControl::getNySample |
( |
| ) |
const |
|
inline |
◆ getStatisticsControl() [1/2]
◆ getStatisticsControl() [2/2]
◆ getStatisticsProperty()
Property lsst::afw::math::BackgroundControl::getStatisticsProperty |
( |
| ) |
const |
|
inline |
◆ getUndersampleStyle()
UndersampleStyle lsst::afw::math::BackgroundControl::getUndersampleStyle |
( |
| ) |
const |
|
inline |
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ setApproximateControl()
◆ setInterpStyle() [1/2]
◆ setInterpStyle() [2/2]
void lsst::afw::math::BackgroundControl::setInterpStyle |
( |
std::string const & |
style | ) |
|
|
inline |
◆ setNxSample()
void lsst::afw::math::BackgroundControl::setNxSample |
( |
int |
nxSample | ) |
|
|
inline |
◆ setNySample()
void lsst::afw::math::BackgroundControl::setNySample |
( |
int |
nySample | ) |
|
|
inline |
◆ setStatisticsProperty() [1/2]
void lsst::afw::math::BackgroundControl::setStatisticsProperty |
( |
Property |
prop | ) |
|
|
inline |
◆ setStatisticsProperty() [2/2]
void lsst::afw::math::BackgroundControl::setStatisticsProperty |
( |
std::string |
prop | ) |
|
|
inline |
◆ setUndersampleStyle() [1/2]
void lsst::afw::math::BackgroundControl::setUndersampleStyle |
( |
std::string const & |
undersampleStyle | ) |
|
|
inline |
◆ setUndersampleStyle() [2/2]
void lsst::afw::math::BackgroundControl::setUndersampleStyle |
( |
UndersampleStyle const |
undersampleStyle | ) |
|
|
inline |
The documentation for this class was generated from the following file: