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 Member Functions
virtual	~ImageFormatter (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
static lsst::daf::persistence::Formatter::Ptr	createInstance (lsst::pex::policy::Policy::Ptr policy)
template<class Archive >
static void	delegateSerialize (Archive &ar, 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
	ImageFormatter (lsst::pex::policy::Policy::Ptr policy)

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

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

template<typename ImagePixelT>
class lsst::afw::formatters::ImageFormatter< ImagePixelT >

Class implementing persistence and retrieval for Images.

Definition at line 54 of file ImageFormatter.h.

Constructor & Destructor Documentation

template<typename ImagePixelT >

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

virtual

Definition at line 123 of file ImageFormatter.cc.

{
}

template<typename ImagePixelT >

lsst::afw::formatters::ImageFormatter< ImagePixelT >::ImageFormatter ( lsst::pex::policy::Policy::Ptr  policy )

explicitprivate

Definition at line 114 of file ImageFormatter.cc.

    :
    lsst::daf::persistence::Formatter(typeid(this))
{
}

Member Function Documentation

template<typename ImagePixelT >

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

static

Definition at line 280 of file ImageFormatter.cc.

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

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 250 of file ImageFormatter.cc.

                                                      {
    execTrace("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) {
        boost::scoped_ptr<Image<ImagePixelT> > ni(
            new Image<ImagePixelT>(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()));
    }
}

template<typename ImagePixelT >

Persistable * lsst::afw::formatters::ImageFormatter< ImagePixelT >::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 173 of file ImageFormatter.cc.

                                                                                         {
    execTrace("ImageFormatter read start");
    if (typeid(*storage) == typeid(BoostStorage)) {
        execTrace("ImageFormatter read BoostStorage");
        BoostStorage* boost = dynamic_cast<BoostStorage*>(storage.get());
        Image<ImagePixelT>* ip = new Image<ImagePixelT>;
        boost->getIArchive() & *ip;
        execTrace("ImageFormatter read end");
        return ip;
    }
    else if (typeid(*storage) == typeid(XmlStorage)) {
        execTrace("ImageFormatter read XmlStorage");
        XmlStorage* boost = dynamic_cast<XmlStorage*>(storage.get());
        Image<ImagePixelT>* ip = new Image<ImagePixelT>;
        boost->getIArchive() & make_nvp("img", *ip);
        execTrace("ImageFormatter read end");
        return ip;
    }
    else if(typeid(*storage) == typeid(FitsStorage)) {

        execTrace("ImageFormatter read FitsStorage");
        FitsStorage* fits = dynamic_cast<FitsStorage*>(storage.get());
        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 = geom::Box2I(
                geom::Point2I(llcX, llcY), 
                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()
                );
            }
        }
        lsst::daf::base::PropertySet::Ptr metadata;

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

template<typename ImagePixelT >

void lsst::afw::formatters::ImageFormatter< ImagePixelT >::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 242 of file ImageFormatter.cc.

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

template<typename ImagePixelT >

void lsst::afw::formatters::ImageFormatter< ImagePixelT >::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 133 of file ImageFormatter.cc.

                               {

    execTrace("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");
    }
    if (typeid(*storage) == typeid(BoostStorage)) {
        execTrace("ImageFormatter write BoostStorage");
        BoostStorage* boost = dynamic_cast<BoostStorage*>(storage.get());
        boost->getOArchive() & *ip;
        execTrace("ImageFormatter write end");
        return;
    }
    else if (typeid(*storage) == typeid(XmlStorage)) {
        execTrace("ImageFormatter write XmlStorage");
        XmlStorage* boost = dynamic_cast<XmlStorage*>(storage.get());
        boost->getOArchive() & make_nvp("img", *ip);
        execTrace("ImageFormatter write end");
        return;
    }
    else if (typeid(*storage) == typeid(FitsStorage)) {
        execTrace("ImageFormatter write FitsStorage");
        FitsStorage* fits = dynamic_cast<FitsStorage*>(storage.get());
        typedef Image<ImagePixelT> Image;

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

Member Data Documentation

template<typename ImagePixelT >

lsst::daf::persistence::FormatterRegistration lsst::afw::formatters::ImageFormatter< ImagePixelT >::registration

staticprivate

Definition at line 87 of file ImageFormatter.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/ImageFormatter.h
• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/src/formatters/ImageFormatter.cc