#include <KernelFormatter.h>

Inheritance diagram for lsst::afw::formatters::KernelFormatter:

Public Member Functions
virtual	~KernelFormatter (void)

virtual void	write (lsst::daf::base::Persistable const *persistable, lsst::daf::persistence::Storage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)

virtual lsst::daf::base::Persistable *	read (lsst::daf::persistence::Storage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)

virtual void	update (lsst::daf::base::Persistable *persistable, lsst::daf::persistence::Storage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)

Public Member Functions inherited from lsst::daf::persistence::Formatter
virtual	~Formatter (void)

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

Static Public Member Functions
template<class Archive >
static void	delegateSerialize (Archive &ar, unsigned int const version, lsst::daf::base::Persistable *persistable)

Static Public Member Functions inherited from lsst::daf::persistence::Formatter
static Formatter::Ptr	lookupFormatter (std::string const &persistableType, lsst::pex::policy::Policy::Ptr policy)

static Formatter::Ptr	lookupFormatter (std::type_info const &persistableType, lsst::pex::policy::Policy::Ptr policy)

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

Private Member Functions
	KernelFormatter (lsst::pex::policy::Policy::Ptr policy)

Static Private Member Functions
static lsst::daf::persistence::Formatter::Ptr	createInstance (lsst::pex::policy::Policy::Ptr policy)

Private Attributes
lsst::pex::policy::Policy::Ptr	_policy

Static Private Attributes
static lsst::daf::persistence::FormatterRegistration	kernelRegistration

static lsst::daf::persistence::FormatterRegistration	fixedKernelRegistration

static lsst::daf::persistence::FormatterRegistration	analyticKernelRegistration

static lsst::daf::persistence::FormatterRegistration	deltaFunctionKernelRegistration

static lsst::daf::persistence::FormatterRegistration	linearCombinationKernelRegistration

static lsst::daf::persistence::FormatterRegistration	separableKernelRegistration

Additional Inherited Members
Public Types inherited from lsst::daf::persistence::Formatter
typedef boost::shared_ptr < Formatter >	Ptr

typedef Ptr(*	FactoryPtr )(lsst::pex::policy::Policy::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)

Protected Member Functions inherited from lsst::daf::persistence::Formatter
	Formatter (std::type_info const &type)

Detailed Description

Definition at line 54 of file KernelFormatter.h.

Constructor & Destructor Documentation

lsst::afw::formatters::KernelFormatter::~KernelFormatter ( void )

virtual

Minimal destructor.

Definition at line 157 of file KernelFormatter.cc.

157 {

158 }

lsst::afw::formatters::KernelFormatter::KernelFormatter ( lsst::pex::policy::Policy::Ptr policy )

explicitprivate

Constructor.

Parameters

[in] policy Policy for configuring this Formatter

Definition at line 150 of file KernelFormatter.cc.

                                :
     dafPersist::Formatter(typeid(this)), _policy(policy) {
 }

Member Function Documentation

dafPersist::Formatter::Ptr lsst::afw::formatters::KernelFormatter::createInstance ( lsst::pex::policy::Policy::Ptr policy )

staticprivate

Factory method for KernelFormatter.

Parameters

[in] policy Policy for configuring the KernelFormatter

Returns: Shared pointer to a new instance

Definition at line 263 of file KernelFormatter.cc.

                                {
     return dafPersist::Formatter::Ptr(new afwForm::KernelFormatter(policy));
 }

template<class Archive >

template void lsst::afw::formatters::KernelFormatter::delegateSerialize	(	Archive &	ar,
		unsigned int const	version,
		lsst::daf::base::Persistable *	persistable
	)

static

Serialize a Kernel to a Boost archive. Handles text or XML archives, input or output.

Parameters

[in,out]	ar	Boost archive
[in]	version	Version of the Kernel class
[in,out]	persistable	Pointer to the Kernel as a Persistable

Definition at line 225 of file KernelFormatter.cc.

                                                                       {
     execTrace("KernelFormatter delegateSerialize start");
     afwMath::Kernel* kp =
         dynamic_cast<afwMath::Kernel*>(persistable);
     if (kp == 0) {
         throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Serializing non-Kernel");
     }
     ar & make_nvp("base",
                   boost::serialization::base_object<dafBase::Persistable>(*kp));
     ar & make_nvp("width", kp->_width);
     ar & make_nvp("height", kp->_height);
     ar & make_nvp("ctrX", kp->_ctrX);
     ar & make_nvp("ctrY", kp->_ctrY);
     ar & make_nvp("nParams", kp->_nKernelParams);
     ar & make_nvp("spatialFunctionList", kp->_spatialFunctionList);
                   
     execTrace("KernelFormatter delegateSerialize end");
 }

dafBase::Persistable * lsst::afw::formatters::KernelFormatter::read	(	lsst::daf::persistence::Storage::Ptr	storage,
		lsst::daf::base::PropertySet::Ptr	additionalData
	)

virtual

Read a Persistable instance from a Storage instance.

Parameters

[in]	storage	Pointer to the Storage instance.
[in]	additionalData	Additional data used to find the proper instance within the Storage.

Returns: Shared pointer to the new Persistable instance.

Implements lsst::daf::persistence::Formatter.

Definition at line 189 of file KernelFormatter.cc.

                                                          {
     execTrace("KernelFormatter read start");
     afwMath::Kernel* kp;
     if (typeid(*storage) == typeid(dafPersist::BoostStorage)) {
         execTrace("KernelFormatter read BoostStorage");
         dafPersist::BoostStorage* boost =
             dynamic_cast<dafPersist::BoostStorage*>(storage.get());
         boost->getIArchive() & kp;
         execTrace("KernelFormatter read end");
         return kp;
     }
     else if (typeid(*storage) == typeid(dafPersist::XmlStorage)) {
         execTrace("KernelFormatter read XmlStorage");
         dafPersist::XmlStorage* xml =
             dynamic_cast<dafPersist::XmlStorage*>(storage.get());
         xml->getIArchive() & make_nvp("ptr", kp);
         execTrace("KernelFormatter read end");
         return kp;
     }
     throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Unrecognized Storage for Kernel");
 }

void lsst::afw::formatters::KernelFormatter::update	(	lsst::daf::base::Persistable *	persistable,
		lsst::daf::persistence::Storage::Ptr	storage,
		lsst::daf::base::PropertySet::Ptr	additionalData
	)

virtual

Update an existing Persistable instance with information from an additional Storage instance.

Parameters

[in,out]	persistable	Pointer to the Persistable instance.
[in]	storage	Shared pointer to the additional Storage instance.
[in]	additionalData	Additional data used to find the proper instance within the Storage.

Implements lsst::daf::persistence::Formatter.

Definition at line 212 of file KernelFormatter.cc.

                                                           {
     throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Unexpected call to update for Kernel");
 }

void lsst::afw::formatters::KernelFormatter::write	(	lsst::daf::base::Persistable const *	persistable,
		lsst::daf::persistence::Storage::Ptr	storage,
		lsst::daf::base::PropertySet::Ptr	additionalData
	)

virtual

Write a Persistable instance to a Storage instance.

Parameters

[in]	persistable	Pointer to the Persistable instance.
[in]	storage	Shared pointer to the Storage instance.
[in]	additionalData	Additional data used to find the proper place to put the instance into the Storage.

Implements lsst::daf::persistence::Formatter.

Definition at line 160 of file KernelFormatter.cc.

                            {
     execTrace("KernelFormatter write start");
     afwMath::Kernel const* kp =
         dynamic_cast<afwMath::Kernel const*>(persistable);
     if (kp == 0) {
         throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Persisting non-Kernel");
     }
     if (typeid(*storage) == typeid(dafPersist::BoostStorage)) {
         execTrace("KernelFormatter write BoostStorage");
         dafPersist::BoostStorage* boost =
             dynamic_cast<dafPersist::BoostStorage*>(storage.get());
         boost->getOArchive() & kp;
         execTrace("KernelFormatter write end");
         return;
     }
     else if (typeid(*storage) == typeid(dafPersist::XmlStorage)) {
         execTrace("KernelFormatter write XmlStorage");
         dafPersist::XmlStorage* xml =
             dynamic_cast<dafPersist::XmlStorage*>(storage.get());
         xml->getOArchive() & make_nvp("ptr", kp);
         execTrace("KernelFormatter write end");
         return;
     }
     throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Unrecognized Storage for Kernel");
 }

Member Data Documentation

lsst::pex::policy::Policy::Ptr lsst::afw::formatters::KernelFormatter::_policy

private

Definition at line 76 of file KernelFormatter.h.

dafPersist::FormatterRegistration lsst::afw::formatters::KernelFormatter::analyticKernelRegistration

staticprivate

Definition at line 83 of file KernelFormatter.h.

dafPersist::FormatterRegistration lsst::afw::formatters::KernelFormatter::deltaFunctionKernelRegistration

staticprivate

Definition at line 84 of file KernelFormatter.h.

dafPersist::FormatterRegistration lsst::afw::formatters::KernelFormatter::fixedKernelRegistration

staticprivate

Definition at line 82 of file KernelFormatter.h.

dafPersist::FormatterRegistration lsst::afw::formatters::KernelFormatter::kernelRegistration

staticprivate

Register this Formatter subclass through a static instance of FormatterRegistration.

Definition at line 81 of file KernelFormatter.h.

dafPersist::FormatterRegistration lsst::afw::formatters::KernelFormatter::linearCombinationKernelRegistration

staticprivate

Definition at line 86 of file KernelFormatter.h.

dafPersist::FormatterRegistration lsst::afw::formatters::KernelFormatter::separableKernelRegistration

staticprivate

Definition at line 87 of file KernelFormatter.h.

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

/home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/formatters/KernelFormatter.h
/home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/src/formatters/KernelFormatter.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation