Template Class DoubleGaussianFunction2

Inheritance Relationships

Base Type

Class Documentation

template<typename ReturnT>
class DoubleGaussianFunction2 : public lsst::afw::math::Function2<ReturnT>

double Guassian (sum of two Gaussians)

Intended for use as a PSF model: the main Gaussian represents the core and the second Gaussian represents the wings.

f(x,y) = A (e^(-r^2 / 2 sigma1^2) + ampl2 e^(-r^2 / 2 sigma2^2)) where:

  • A = 1 / (2 pi (sigma1^2 + ampl2 sigma2^2))

  • r^2 = x^2 + y^2 coefficients c[0] = sigma1, c[1] = sigma2, c[2] = ampl2

Public Functions

DoubleGaussianFunction2(double sigma1, double sigma2 = 0, double ampl2 = 0)

Parameters

  • sigma1: sigma of main Gaussian

  • sigma2: sigma of second Gaussian

  • ampl2: amplitude of second Gaussian as a fraction of main Gaussian at peak

Construct a Gaussian function with specified x and y sigma

DoubleGaussianFunction2(DoubleGaussianFunction2 const&)
DoubleGaussianFunction2(DoubleGaussianFunction2&&)
DoubleGaussianFunction2 &operator=(DoubleGaussianFunction2 const&)
DoubleGaussianFunction2 &operator=(DoubleGaussianFunction2&&)
~DoubleGaussianFunction2()
std::shared_ptr<Function2<ReturnT>> clone() const

Return a pointer to a deep copy of this function

This function exists instead of a copy constructor so one can obtain a copy of an actual function instead of a useless copy of the base class.

Every non-virtual function must override this method.

Return

a pointer to a deep copy of the function

ReturnT operator()(double x, double y) const
std::string toString(std::string const&) const

Return a string representation of the function

Return

a string representation of the function

bool isPersistable() const

Return true if this particular object can be persisted using afw::table::io.

Protected Functions

std::string getPersistenceName() const

Return the unique name used to persist this object and look up its factory.

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

void write(afw::table::io::OutputArchiveHandle &handle) const

Write the object to one or more catalogs.

The handle object passed to this function provides an interface for adding new catalogs and adding nested objects to the same archive (while checking for duplicates). See OutputArchiveHandle for more information.

DoubleGaussianFunction2()