LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
Public Member Functions | List of all members
lsst.afw.math::Covariogram< T > Class Template Reference

The parent class of covariogram functions for use in Gaussian Process interpolation. More...

#include <GaussianProcess.h>

Inheritance diagram for lsst.afw.math::Covariogram< T >:
lsst::daf::base::Citizen lsst.afw.math::NeuralNetCovariogram< T > lsst.afw.math::SquaredExpCovariogram< T >

Public Member Functions

virtual ~Covariogram ()
 
 Covariogram ()
 construct a Covariogram assigning default values to the hyper parameters More...
 
virtual T operator() (ndarray::Array< const T, 1, 1 > const &p1, ndarray::Array< const T, 1, 1 > const &p2) const
 Actually evaluate the covariogram function relating two points you want to interpolate from. More...
 
- Public Member Functions inherited from lsst::daf::base::Citizen
 Citizen (const std::type_info &)
 
 Citizen (Citizen const &)
 
 ~Citizen ()
 
Citizenoperator= (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...
 

Additional Inherited Members

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

Detailed Description

template<typename T>
class lsst.afw.math::Covariogram< T >

The parent class of covariogram functions for use in Gaussian Process interpolation.

Each instantiation of a Covariogram will store its own hyper parameters

Definition at line 131 of file GaussianProcess.h.

Constructor & Destructor Documentation

template<typename T >
lsst.afw.math::Covariogram< T >::~Covariogram ( )
virtual

Definition at line 1821 of file GaussianProcess.cc.

1821 {};
template<typename T >
lsst.afw.math::Covariogram< T >::Covariogram ( )
inlineexplicit

construct a Covariogram assigning default values to the hyper parameters

Definition at line 142 of file GaussianProcess.h.

142 :lsst::daf::base::Citizen(typeid(this)){};
Citizen is a class that should be among all LSST classes base classes, and handles basic memory manag...
Definition: Citizen.h:56

Member Function Documentation

template<typename T >
T lsst.afw.math::Covariogram< T >::operator() ( ndarray::Array< const T, 1, 1 > const &  p1,
ndarray::Array< const T, 1, 1 > const &  p2 
) const
virtual

Actually evaluate the covariogram function relating two points you want to interpolate from.

Parameters
[in]p1the first point
[in]p2the second point

Reimplemented in lsst.afw.math::NeuralNetCovariogram< T >, and lsst.afw.math::SquaredExpCovariogram< T >.

Definition at line 1824 of file GaussianProcess.cc.

1826 {
1827  std::cout << "by the way, you are calling the wrong operator\n";
1828  exit(1);
1829  return T(1.0);
1830 }

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