Formatter for persistence of Psf instances. More...

#include <PsfFormatter.h>

Inheritance diagram for lsst::afw::detection::PsfFormatter:

Public Member Functions
virtual	~PsfFormatter (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
	PsfFormatter (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	registration

static lsst::daf::persistence::FormatterRegistration	doubleGaussianPsfRegistration

static lsst::daf::persistence::FormatterRegistration	pcaPsfRegistration

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

Formatter for persistence of Psf instances.

Definition at line 30 of file PsfFormatter.h.

Constructor & Destructor Documentation

lsst::afw::detection::PsfFormatter::~PsfFormatter ( void )

virtual

Minimal destructor.

Definition at line 58 of file PsfFormatter.cc.

58 {}

lsst::afw::detection::PsfFormatter::PsfFormatter ( lsst::pex::policy::Policy::Ptr policy )

explicitprivate

Constructor.

Parameters

[in] policy Policy for configuring this Formatter

Definition at line 52 of file PsfFormatter.cc.

53 :

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

lsst::afw::detection::PsfFormatter::_policy

lsst::pex::policy::Policy::Ptr _policy

Definition: PsfFormatter.h:52

lsst::daf::persistence::Formatter

Abstract base class for all formatters.

Definition: Formatter.h:79

Member Function Documentation

dafPersist::Formatter::Ptr lsst::afw::detection::PsfFormatter::createInstance ( lsst::pex::policy::Policy::Ptr policy )

staticprivate

Factory method for PsfFormatter.

Parameters

[in] policy Policy for configuring the PsfFormatter

Returns: Shared pointer to a new instance

Definition at line 143 of file PsfFormatter.cc.

                                {
     return dafPersist::Formatter::Ptr(new afwDetect::PsfFormatter(policy));
 }

template<class Archive >

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

static

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

Parameters

ar	Boost archive
version	Version of the Psf class
persistable	persistable Pointer to the Psf as a Persistable

Definition at line 121 of file PsfFormatter.cc.

                                                  {
     execTrace("PsfFormatter delegateSerialize start");
     afwDetect::Psf* ps = dynamic_cast<afwDetect::Psf*>(persistable);
     if (ps == 0) {
         throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Serializing non-Psf");
     }
 #if 0                                   // not present in baseclass
     ar & make_nvp("width", ps->_width) & make_nvp("height", ps->_height);
     ar & make_nvp("k", ps->_kernel);
 #endif
 
     execTrace("PsfFormatter delegateSerialize end");
 }

dafBase::Persistable * lsst::afw::detection::PsfFormatter::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 88 of file PsfFormatter.cc.

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

void lsst::afw::detection::PsfFormatter::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 111 of file PsfFormatter.cc.

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

void lsst::afw::detection::PsfFormatter::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 60 of file PsfFormatter.cc.

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

Member Data Documentation

lsst::pex::policy::Policy::Ptr lsst::afw::detection::PsfFormatter::_policy

private

Definition at line 52 of file PsfFormatter.h.

lsst::daf::persistence::FormatterRegistration lsst::afw::detection::PsfFormatter::doubleGaussianPsfRegistration

staticprivate

Definition at line 58 of file PsfFormatter.h.

lsst::daf::persistence::FormatterRegistration lsst::afw::detection::PsfFormatter::pcaPsfRegistration

staticprivate

Definition at line 59 of file PsfFormatter.h.

dafPersist::FormatterRegistration lsst::afw::detection::PsfFormatter::registration

staticprivate

Register this Formatter subclass through a static instance of FormatterRegistration.

Definition at line 57 of file PsfFormatter.h.

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

/home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/detection/PsfFormatter.h
/home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/src/detection/PsfFormatter.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