LSSTApplications
10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
|
double Guassian (sum of two Gaussians) More...
#include <FunctionLibrary.h>
Public Types | |
typedef Function2< ReturnT >::Ptr | Function2Ptr |
Public Types inherited from lsst::afw::math::Function2< ReturnT > | |
typedef boost::shared_ptr < Function2< ReturnT > > | Ptr |
Public Types inherited from lsst::daf::base::Citizen | |
enum | { magicSentinel = 0xdeadbeef } |
typedef unsigned long | memId |
Type of the block's ID. More... | |
typedef memId(* | memNewCallback )(const memId cid) |
A function used to register a callback. More... | |
typedef memId(* | memCallback )(const Citizen *ptr) |
Public Member Functions | |
DoubleGaussianFunction2 (double sigma1, double sigma2=0, double ampl2=0) | |
Construct a Gaussian function with specified x and y sigma. More... | |
virtual | ~DoubleGaussianFunction2 () |
virtual Function2Ptr | clone () const |
Return a pointer to a deep copy of this function. More... | |
virtual ReturnT | operator() (double x, double y) const |
virtual std::string | toString (std::string const &prefix) const |
Return a string representation of the function. More... | |
virtual bool | isPersistable () const |
Return true if this particular object can be persisted using afw::table::io. More... | |
Public Member Functions inherited from lsst::afw::math::Function2< ReturnT > | |
Function2 (unsigned int nParams) | |
Construct a Function2 given the number of function parameters. More... | |
Function2 (std::vector< double > const ¶ms) | |
Construct a Function2 given the function parameters. More... | |
virtual | ~Function2 () |
virtual std::vector< double > | getDFuncDParameters (double, double) const |
Public Member Functions inherited from lsst::afw::math::Function< ReturnT > | |
Function (unsigned int nParams) | |
Construct a Function given the number of function parameters. More... | |
Function (std::vector< double > const ¶ms) | |
Construct a Function given the function parameters. More... | |
virtual | ~Function () |
unsigned int | getNParameters () const |
Return the number of function parameters. More... | |
virtual double | getParameter (unsigned int ind) const |
Get one function parameter without range checking. More... | |
std::vector< double > const & | getParameters () const |
Return all function parameters. More... | |
virtual bool | isLinearCombination () const |
Is the function a linear combination of its parameters? More... | |
void | setParameter (unsigned int ind, double newValue) |
Set one function parameter without range checking. More... | |
void | setParameters (std::vector< double > const ¶ms) |
Set all function parameters. More... | |
Public Member Functions inherited from lsst::daf::base::Citizen | |
Citizen (const std::type_info &) | |
Citizen (Citizen const &) | |
~Citizen () | |
Citizen & | operator= (Citizen const &) |
std::string | repr () const |
Return a string representation of a Citizen. More... | |
void | markPersistent (void) |
Mark a Citizen as persistent and not destroyed until process end. More... | |
memId | getId () const |
Return the Citizen's ID. More... | |
Public Member Functions inherited from lsst::afw::table::io::Persistable | |
void | writeFits (std::string const &fileName, std::string const &mode="w") const |
Write the object to a regular FITS file. More... | |
void | writeFits (fits::MemFileManager &manager, std::string const &mode="w") const |
Write the object to a FITS image in memory. More... | |
void | writeFits (fits::Fits &fitsfile) const |
Write the object to an already-open FITS object. More... | |
virtual | ~Persistable () |
Protected Member Functions | |
virtual std::string | getPersistenceName () const |
Return the unique name used to persist this object and look up its factory. More... | |
virtual void | write (afw::table::io::OutputArchiveHandle &handle) const |
Write the object to one or more catalogs. More... | |
DoubleGaussianFunction2 () | |
Protected Member Functions inherited from lsst::afw::math::Function2< ReturnT > | |
Function2 () | |
Protected Member Functions inherited from lsst::afw::math::Function< ReturnT > | |
virtual std::string | getPythonModule () const |
Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More... | |
Function () | |
Protected Member Functions inherited from lsst::afw::table::io::Persistable | |
Persistable () | |
Persistable (Persistable const &other) | |
void | operator= (Persistable const &other) |
Private Member Functions | |
template<class Archive > | |
void | serialize (Archive &ar, unsigned int const version) |
Private Attributes | |
const double | _multFac |
precomputed scale factor More... | |
Friends | |
class | boost::serialization::access |
Additional Inherited Members | |
Static Public Member Functions inherited from lsst::afw::table::io::PersistableFacade< Function2< ReturnT > > | |
static boost::shared_ptr < Function2< ReturnT > > | readFits (fits::Fits &fitsfile) |
Read an object from an already open FITS object. More... | |
static boost::shared_ptr < Function2< ReturnT > > | readFits (std::string const &fileName, int hdu=0) |
Read an object from a regular FITS file. More... | |
static boost::shared_ptr < Function2< ReturnT > > | readFits (fits::MemFileManager &manager, int hdu=0) |
Read an object from a FITS file in memory. More... | |
Static Public Member Functions inherited from lsst::daf::base::Citizen | |
static bool | hasBeenCorrupted () |
Check all allocated blocks for corruption. More... | |
static memId | getNextMemId () |
Return the memId of the next object to be allocated. More... | |
static int | init () |
Called once when the memory system is being initialised. More... | |
static int | census (int, memId startingMemId=0) |
How many active Citizens are there? More... | |
static void | census (std::ostream &stream, memId startingMemId=0) |
Print a list of all active Citizens to stream, sorted by ID. More... | |
static const std::vector < const Citizen * > * | census () |
Return a (newly allocated) std::vector of active Citizens sorted by ID. More... | |
static memId | setNewCallbackId (memId id) |
Call the NewCallback when block is allocated. More... | |
static memId | setDeleteCallbackId (memId id) |
Call the current DeleteCallback when block is deleted. More... | |
static memNewCallback | setNewCallback (memNewCallback func) |
Set the NewCallback function. More... | |
static memCallback | setDeleteCallback (memCallback func) |
Set the DeleteCallback function. More... | |
static memCallback | setCorruptionCallback (memCallback func) |
Set the CorruptionCallback function. More... | |
Static Public Member Functions inherited from lsst::afw::table::io::PersistableFacade< Function< ReturnT > > | |
static boost::shared_ptr < Function< ReturnT > > | readFits (fits::Fits &fitsfile) |
Read an object from an already open FITS object. More... | |
static boost::shared_ptr < Function< ReturnT > > | readFits (std::string const &fileName, int hdu=0) |
Read an object from a regular FITS file. More... | |
static boost::shared_ptr < Function< ReturnT > > | readFits (fits::MemFileManager &manager, int hdu=0) |
Read an object from a FITS file in memory. More... | |
Protected Types inherited from lsst::afw::table::io::Persistable | |
typedef io::OutputArchiveHandle | OutputArchiveHandle |
Protected Attributes inherited from lsst::afw::math::Function< ReturnT > | |
std::vector< double > | _params |
bool | _isCacheValid |
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:
Definition at line 359 of file FunctionLibrary.h.
typedef Function2<ReturnT>::Ptr lsst::afw::math::DoubleGaussianFunction2< ReturnT >::Function2Ptr |
Definition at line 361 of file FunctionLibrary.h.
|
inlineexplicit |
Construct a Gaussian function with specified x and y sigma.
sigma1 | sigma of main Gaussian |
sigma2 | sigma of second Gaussian |
ampl2 | amplitude of second Gaussian as a fraction of main Gaussian at peak |
Definition at line 366 of file FunctionLibrary.h.
|
inlinevirtual |
Definition at line 379 of file FunctionLibrary.h.
|
inlineexplicitprotected |
Definition at line 417 of file FunctionLibrary.h.
|
inlinevirtual |
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.
Implements lsst::afw::math::Function2< ReturnT >.
Definition at line 381 of file FunctionLibrary.h.
|
protectedvirtual |
Return the unique name used to persist this object and look up its factory.
Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.
Reimplemented from lsst::afw::table::io::Persistable.
|
inlinevirtual |
Return true if this particular object can be persisted using afw::table::io.
Reimplemented from lsst::afw::table::io::Persistable.
Definition at line 404 of file FunctionLibrary.h.
|
inlinevirtual |
Implements lsst::afw::math::Function2< ReturnT >.
Definition at line 386 of file FunctionLibrary.h.
|
inlineprivate |
Definition at line 422 of file FunctionLibrary.h.
|
inlinevirtual |
Return a string representation of the function.
Reimplemented from lsst::afw::math::Function2< ReturnT >.
Definition at line 397 of file FunctionLibrary.h.
|
protectedvirtual |
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.
Reimplemented from lsst::afw::table::io::Persistable.
|
friend |
Definition at line 420 of file FunctionLibrary.h.
|
private |
precomputed scale factor
Definition at line 413 of file FunctionLibrary.h.