lsst::afw::formatters::ImageFormatter< ImagePixelT > Class Template Reference

Class implementing persistence and retrieval for Images. More...

#include <ImageFormatter.h>

Inheritance diagram for lsst::afw::formatters::ImageFormatter< ImagePixelT >:

Public Types
typedef std::shared_ptr< Formatter >	Ptr
typedef Ptr(*	FactoryPtr) (lsst::pex::policy::Policy::Ptr)
	Pointer to a (static) factory function for a Formatter subclass. More...
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
	~ImageFormatter () override
	ImageFormatter (ImageFormatter const &)=default
	ImageFormatter (ImageFormatter &&)=default
ImageFormatter &	operator= (ImageFormatter const &)=default
ImageFormatter &	operator= (ImageFormatter &&)=default
void	write (lsst::daf::base::Persistable const *persistable, std::shared_ptr< lsst::daf::persistence::FormatterStorage > storage, std::shared_ptr< lsst::daf::base::PropertySet > additionalData) override
lsst::daf::base::Persistable *	read (std::shared_ptr< lsst::daf::persistence::FormatterStorage > storage, std::shared_ptr< lsst::daf::base::PropertySet > additionalData) override
void	update (lsst::daf::base::Persistable *persistable, std::shared_ptr< lsst::daf::persistence::FormatterStorage > storage, std::shared_ptr< lsst::daf::base::PropertySet > additionalData) override
virtual void	write (lsst::daf::base::Persistable const *persistable, FormatterStorage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)=0
	Write a Persistable instance to a FormatterStorage instance. More...
virtual lsst::daf::base::Persistable *	read (FormatterStorage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)=0
	Read a Persistable instance from a FormatterStorage instance. More...
virtual void	update (lsst::daf::base::Persistable *persistable, FormatterStorage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)=0
	Update an existing Persistable instance with information from an additional FormatterStorage instance. More...
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
static std::shared_ptr< lsst::daf::persistence::Formatter >	createInstance (std::shared_ptr< lsst::pex::policy::Policy > policy)
template<class Archive >
static void	delegateSerialize (Archive &ar, int const version, lsst::daf::base::Persistable *persistable)
static Formatter::Ptr	lookupFormatter (std::string const &persistableType, lsst::pex::policy::Policy::Ptr policy)
	Lookup Formatter subclass by name of Persistable subclass. More...
static Formatter::Ptr	lookupFormatter (std::type_info const &persistableType, lsst::pex::policy::Policy::Ptr policy)
	Lookup Formatter subclass by its type_info from typeid(). More...
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...
Census
Provide a list of current Citizens
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...
callbackIDs
Set callback Ids. The old Id is returned
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...
callbacks
Set the New/Delete callback functions; in each case the previously installed callback is returned. These callback functions return a value which is Added to the previously registered id. The default callback functions are called default{New,Delete}Callback; you may want to set a break point in these callbacks from your favourite debugger
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 ImagePixelT>
class lsst::afw::formatters::ImageFormatter< ImagePixelT >

Class implementing persistence and retrieval for Images.

Definition at line 44 of file ImageFormatter.h.

Member Typedef Documentation

FactoryPtr

typedef Ptr(* lsst::daf::persistence::Formatter::FactoryPtr) (lsst::pex::policy::Policy::Ptr)

inherited

Pointer to a (static) factory function for a Formatter subclass.

Definition at line 85 of file Formatter.h.

memCallback

typedef memId(* lsst::daf::base::Citizen::memCallback) (const Citizen *ptr)

inherited

Definition at line 59 of file Citizen.h.

memId

typedef unsigned long lsst::daf::base::Citizen::memId

inherited

Type of the block's ID.

Definition at line 56 of file Citizen.h.

memNewCallback

typedef memId(* lsst::daf::base::Citizen::memNewCallback) (const memId cid)

inherited

A function used to register a callback.

Definition at line 58 of file Citizen.h.

Ptr

typedef std::shared_ptr<Formatter> lsst::daf::persistence::Formatter::Ptr

inherited

Definition at line 81 of file Formatter.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

Enumerator
magicSentinel

Definition at line 86 of file Citizen.h.

{ magicSentinel = 0xdeadbeef };  

Constructor & Destructor Documentation

~ImageFormatter()

template<typename ImagePixelT >

lsst::afw::formatters::ImageFormatter< ImagePixelT >::~ImageFormatter ( )

overridedefault

ImageFormatter() [1/2]

template<typename ImagePixelT >

lsst::afw::formatters::ImageFormatter< ImagePixelT >::ImageFormatter ( ImageFormatter< ImagePixelT > const &  )

default

ImageFormatter() [2/2]

template<typename ImagePixelT >

lsst::afw::formatters::ImageFormatter< ImagePixelT >::ImageFormatter ( ImageFormatter< ImagePixelT > &&  )

default

Member Function Documentation

census() [1/3]

int lsst::daf::base::Citizen::census ( int  , memId  startingMemId = 0  )

staticinherited

How many active Citizens are there?

Parameters

startingMemId

Don't print Citizens with lower IDs

Definition at line 238 of file Citizen.cc.

  {
    if (startingMemId == 0) {  // easy
        ReadGuard guard(citizenLock);
        return _activeCitizens.size();
    }

    int n = 0;
    ReadGuard guard(citizenLock);
    for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
        if (cur->first->_CitizenId >= startingMemId) {
            n++;
        }
    }

    return n;
}

census() [2/3]

void lsst::daf::base::Citizen::census ( std::ostream &  stream, memId  startingMemId = 0  )

staticinherited

Print a list of all active Citizens to stream, sorted by ID.

Parameters

stream	stream to print to
startingMemId	Don't print Citizens with lower IDs

Definition at line 259 of file Citizen.cc.

  {
    ReadGuard guard(citizenLock);

    std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census());

    for (std::vector<Citizen const*>::const_iterator citizen = leaks->begin(), end = leaks->end();
         citizen != end; ++citizen) {
        if ((*citizen)->getId() >= startingMemId) {
            stream << (*citizen)->repr() << "\n";
        }
    }
}

census() [3/3]

std::vector< dafBase::Citizen const * > const * lsst::daf::base::Citizen::census ( )

staticinherited

Return a (newly allocated) std::vector of active Citizens sorted by ID.

You are responsible for deleting it; or you can say std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census()); and not bother (that becomes std::unique_ptr in C++11)

Definition at line 287 of file Citizen.cc.

                                                               {
    std::vector<Citizen const*>* vec = new std::vector<Citizen const*>(0);
    ReadGuard guard(citizenLock);
    vec->reserve(_activeCitizens.size());

    for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
        vec->push_back(dynamic_cast<Citizen const*>(cur->first));
    }

    std::sort(vec->begin(), vec->end(), cmpId);

    return vec;
}

createInstance()

template<typename ImagePixelT >

std::shared_ptr< lsst::daf::persistence::Formatter > lsst::afw::formatters::ImageFormatter< ImagePixelT >::createInstance ( std::shared_ptr< lsst::pex::policy::Policy >  policy )

static

Definition at line 262 of file ImageFormatter.cc.

                                                   {
    return std::shared_ptr<lsst::daf::persistence::Formatter>(new ImageFormatter<ImagePixelT>(policy));
}

delegateSerialize()

template<typename ImagePixelT >

template<class Archive >

template void lsst::afw::formatters::ImageFormatter< ImagePixelT >::delegateSerialize ( Archive &  ar, int const  version, lsst::daf::base::Persistable *  persistable  )

static

Definition at line 237 of file ImageFormatter.cc.

                                                                                                    {
    LOGL_DEBUG(_log, "ImageFormatter delegateSerialize start");
    Image<ImagePixelT>* ip = dynamic_cast<Image<ImagePixelT>*>(persistable);
    if (ip == 0) {
        throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Serializing non-Image");
    }
    int width, height;
    if (Archive::is_saving::value) {
        width = ip->getWidth();
        height = ip->getHeight();
    }
    ar& make_nvp("width", width) & make_nvp("height", height);
    if (Archive::is_loading::value) {
        std::unique_ptr<Image<ImagePixelT> > ni(new Image<ImagePixelT>(lsst::geom::Extent2I(width, height)));
        typename Image<ImagePixelT>::Array array = ni->getArray();
        ar& make_nvp("array", boost::serialization::make_array(array.getData(), array.getNumElements()));
        ip->swap(*ni);
    } else {
        ndarray::Array<ImagePixelT, 2, 2> array = ndarray::dynamic_dimension_cast<2>(ip->getArray());
        if (array.empty()) array = ndarray::copy(ip->getArray());
        ar& make_nvp("array", boost::serialization::make_array(array.getData(), array.getNumElements()));
    }
}

getId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getId ( ) const

inherited

Return the Citizen's ID.

Definition at line 206 of file Citizen.cc.

{ return _CitizenId; }

getNextMemId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getNextMemId ( )

staticinherited

Return the memId of the next object to be allocated.

Definition at line 209 of file Citizen.cc.

{ return _nextMemId(); }

hasBeenCorrupted()

bool lsst::daf::base::Citizen::hasBeenCorrupted ( )

staticinherited

Check all allocated blocks for corruption.

Definition at line 316 of file Citizen.cc.

                                      {
    ReadGuard guard(citizenLock);
    for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
        if (cur->first->_hasBeenCorrupted()) {
            return true;
        }
    }
    for (table::iterator cur = _persistentCitizens.begin(); cur != _persistentCitizens.end(); cur++) {
        if (cur->first->_hasBeenCorrupted()) {
            return true;
        }
    }

    return false;
}

init()

int lsst::daf::base::Citizen::init ( )

staticinherited

Called once when the memory system is being initialised.

Definition at line 196 of file Citizen.cc.

                         {
    volatile int dummy = 1;
    return dummy;
}

lookupFormatter() [1/2]

Formatter::Ptr lsst::daf::persistence::Formatter::lookupFormatter ( std::string const &  name, lsst::pex::policy::Policy::Ptr  policy  )

staticinherited

Lookup Formatter subclass by name of Persistable subclass.

Parameters

[in]	name	Name of Persistable subclass
[in]	policy	Policy for configuring the Formatter

Returns

Shared pointer to Formatter instance

Returned pointer is not owned and should not be deleted.

Definition at line 84 of file Formatter.cc.

                                                          {
    return FormatterRegistry::getInstance().lookupFormatter(name, policy);
}

lookupFormatter() [2/2]

Formatter::Ptr lsst::daf::persistence::Formatter::lookupFormatter ( std::type_info const &  type, lsst::pex::policy::Policy::Ptr  policy  )

staticinherited

Lookup Formatter subclass by its type_info from typeid().

Parameters

[in]	type	std::type_info of Formatter subclass from typeid()
[in]	policy	Policy for configuring the Formatter

Returns

Shared pointer to Formatter instance

Definition at line 94 of file Formatter.cc.

                                                             {
    return FormatterRegistry::getInstance().lookupFormatter(type, policy);
}

markPersistent()

void lsst::daf::base::Citizen::markPersistent ( void  )

inherited

Mark a Citizen as persistent and not destroyed until process end.

Definition at line 225 of file Citizen.cc.

                                        {
    WriteGuard guard(citizenLock);
    _persistentCitizens[this] = _activeCitizens[this];
    _activeCitizens.erase(this);
}

operator=() [1/2]

template<typename ImagePixelT >

ImageFormatter& lsst::afw::formatters::ImageFormatter< ImagePixelT >::operator= ( ImageFormatter< ImagePixelT > const &  )

default

operator=() [2/2]

template<typename ImagePixelT >

ImageFormatter& lsst::afw::formatters::ImageFormatter< ImagePixelT >::operator= ( ImageFormatter< ImagePixelT > &&  )

default

read() [1/2]

template<typename ImagePixelT >

Persistable * lsst::afw::formatters::ImageFormatter< ImagePixelT >::read ( std::shared_ptr< lsst::daf::persistence::FormatterStorage >  storage, std::shared_ptr< lsst::daf::base::PropertySet >  additionalData  )

override

Definition at line 168 of file ImageFormatter.cc.

                                                                                                     {
    LOGL_DEBUG(_log, "ImageFormatter read start");
    // TODO: Replace this with something better in DM-10776
    auto boost = std::dynamic_pointer_cast<BoostStorage>(storage);
    if (boost) {
        LOGL_DEBUG(_log, "ImageFormatter read BoostStorage");
        Image<ImagePixelT>* ip = new Image<ImagePixelT>;
        boost->getIArchive() & *ip;
        LOGL_DEBUG(_log, "ImageFormatter read end");
        return ip;
    }
    auto xml = std::dynamic_pointer_cast<XmlStorage>(storage);
    if (xml) {
        LOGL_DEBUG(_log, "ImageFormatter read XmlStorage");
        Image<ImagePixelT>* ip = new Image<ImagePixelT>;
        xml->getIArchive() & make_nvp("img", *ip);
        LOGL_DEBUG(_log, "ImageFormatter read end");
        return ip;
    }
    auto fits = std::dynamic_pointer_cast<FitsStorage>(storage);
    if (fits) {
        LOGL_DEBUG(_log, "ImageFormatter read FitsStorage");
        lsst::geom::Box2I box;
        if (additionalData->exists("llcX")) {
            int llcX = additionalData->get<int>("llcX");
            int llcY = additionalData->get<int>("llcY");
            int width = additionalData->get<int>("width");
            int height = additionalData->get<int>("height");
            box = lsst::geom::Box2I(lsst::geom::Point2I(llcX, llcY), lsst::geom::Extent2I(width, height));
        }
        afwImg::ImageOrigin origin = afwImg::PARENT;
        if (additionalData->exists("imageOrigin")) {
            std::string originStr = additionalData->get<std::string>("imageOrigin");
            if (originStr == "LOCAL") {
                origin = afwImg::LOCAL;
            } else if (originStr == "PARENT") {
                origin = afwImg::PARENT;
            } else {
                throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError,
                                  (boost::format("Unknown ImageOrigin type  %s specified in additional"
                                                 "data for retrieving Image from fits") %
                                   originStr)
                                          .str());
            }
        }
        std::shared_ptr<lsst::daf::base::PropertySet> metadata;

        Image<ImagePixelT>* ip =
                new Image<ImagePixelT>(fits->getPath(), fits->getHdu(),
                                       std::shared_ptr<lsst::daf::base::PropertySet>(), box, origin);
        // @note We're throwing away the metadata
        // @todo Do something with these fields?
        // int _X0;
        // int _Y0;
        LOGL_DEBUG(_log, "ImageFormatter read end");
        return ip;
    }
    throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Unrecognized FormatterStorage for Image");
}

read() [2/2]

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

pure virtualinherited

Read a Persistable instance from a FormatterStorage instance.

Parameters

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

Returns

Shared pointer to the new Persistable instance.

repr()

std::string lsst::daf::base::Citizen::repr ( ) const

inherited

Return a string representation of a Citizen.

Definition at line 219 of file Citizen.cc.

                                     {
    return boost::str(boost::format("%d: %08x %s") % _CitizenId % this %
                      lsst::utils::demangleType(_typeName));
}

setCorruptionCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setCorruptionCallback ( Citizen::memCallback  func )

staticinherited

Set the CorruptionCallback function.

Parameters

func	function be called when block is found to be corrupted

Definition at line 391 of file Citizen.cc.

  {
    Citizen::memCallback old = _corruptionCallback;
    _corruptionCallback = func;

    return old;
}

setDeleteCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setDeleteCallback ( Citizen::memCallback  func )

staticinherited

Set the DeleteCallback function.

Parameters

func	function be called when desired block is deleted

Definition at line 381 of file Citizen.cc.

  {
    Citizen::memCallback old = _deleteCallback;
    _deleteCallback = func;

    return old;
}

setDeleteCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setDeleteCallbackId ( Citizen::memId  id )

staticinherited

Call the current DeleteCallback when block is deleted.

Parameters

id	Desired ID

Definition at line 347 of file Citizen.cc.

  {
    WriteGuard guard(citizenLock);
    Citizen::memId oldId = _deleteId;
    _deleteId = id;

    return oldId;
}

setNewCallback()

dafBase::Citizen::memNewCallback lsst::daf::base::Citizen::setNewCallback ( Citizen::memNewCallback  func )

staticinherited

Set the NewCallback function.

Parameters

func	The new function to be called when a designated block is allocated

Definition at line 371 of file Citizen.cc.

  {
    Citizen::memNewCallback old = _newCallback;
    _newCallback = func;

    return old;
}

setNewCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setNewCallbackId ( Citizen::memId  id )

staticinherited

Call the NewCallback when block is allocated.

Parameters

id	Desired ID

Definition at line 337 of file Citizen.cc.

  {
    WriteGuard guard(citizenLock);
    Citizen::memId oldId = _newId;
    _newId = id;

    return oldId;
}

update() [1/2]

template<typename ImagePixelT >

void lsst::afw::formatters::ImageFormatter< ImagePixelT >::update ( lsst::daf::base::Persistable *  persistable, std::shared_ptr< lsst::daf::persistence::FormatterStorage >  storage, std::shared_ptr< lsst::daf::base::PropertySet >  additionalData  )

override

Definition at line 230 of file ImageFormatter.cc.

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

update() [2/2]

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

pure virtualinherited

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

Parameters

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

write() [1/2]

template<typename ImagePixelT >

void lsst::afw::formatters::ImageFormatter< ImagePixelT >::write ( lsst::daf::base::Persistable const *  persistable, std::shared_ptr< lsst::daf::persistence::FormatterStorage >  storage, std::shared_ptr< lsst::daf::base::PropertySet >  additionalData  )

override

Definition at line 120 of file ImageFormatter.cc.

                                                                                              {
    LOGL_DEBUG(_log, "ImageFormatter write start");
    Image<ImagePixelT> const* ip = dynamic_cast<Image<ImagePixelT> const*>(persistable);
    if (ip == 0) {
        throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Persisting non-Image");
    }
    // TODO: Replace this with something better in DM-10776
    auto boost = std::dynamic_pointer_cast<BoostStorage>(storage);
    if (boost) {
        LOGL_DEBUG(_log, "ImageFormatter write BoostStorage");
        boost->getOArchive() & *ip;
        LOGL_DEBUG(_log, "ImageFormatter write end");
        return;
    }
    auto xml = std::dynamic_pointer_cast<XmlStorage>(storage);
    if (xml) {
        LOGL_DEBUG(_log, "ImageFormatter write XmlStorage");
        xml->getOArchive() & make_nvp("img", *ip);
        LOGL_DEBUG(_log, "ImageFormatter write end");
        return;
    }
    auto fits = std::dynamic_pointer_cast<FitsStorage>(storage);
    if (fits) {
        LOGL_DEBUG(_log, "ImageFormatter write FitsStorage");

        fits::ImageWriteOptions options;
        if (additionalData) {
            try {
                options = fits::ImageWriteOptions(*additionalData->getAsPropertySetPtr("image"));
            } catch (std::exception const& exc) {
                LOGLS_WARN(_log, "Unable to construct image write options ("
                                         << exc.what() << "); writing with default options");
            }
        }

        ip->writeFits(fits->getPath(), options);
        // @todo Do something with these fields?
        // int _X0;
        // int _Y0;
        LOGL_DEBUG(_log, "ImageFormatter write end");
        return;
    }
    throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Unrecognized FormatterStorage for Image");
}

write() [2/2]

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

pure virtualinherited

Write a Persistable instance to a FormatterStorage instance.

Parameters

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

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/afw/16.0-35-g34c7dfe62+1/include/lsst/afw/formatters/ImageFormatter.h
• /j/snowflake/release/lsstsw/stack/Linux64/afw/16.0-35-g34c7dfe62+1/src/formatters/ImageFormatter.cc