Class BackgroundControl

• Defined in File Background.h

Class Documentation

class BackgroundControl

Pass parameters to a Background object

Public Functions

BackgroundControl(int const nxSample, int const nySample, StatisticsControl const sctrl = StatisticsControl(), Property const prop = MEANCLIP, ApproximateControl const actrl = ApproximateControl(ApproximateControl::UNKNOWN, ))

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

BackgroundControl(int const nxSample, int const nySample, StatisticsControl const &sctrl, std::string const &prop, ApproximateControl const actrl = ApproximateControl(ApproximateControl::UNKNOWN, ))

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

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, ))

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

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, ))

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

BackgroundControl(BackgroundControl const&)

BackgroundControl(BackgroundControl&&)

BackgroundControl &operator=(BackgroundControl const&)

BackgroundControl &operator=(BackgroundControl&&)

virtual ~BackgroundControl()

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