lsst::afw::formatters::WcsFormatter Class Reference

Class implementing persistence and retrieval for Wcs objects. More...

#include <WcsFormatter.h>

Inheritance diagram for lsst::afw::formatters::WcsFormatter:

Public Member Functions
virtual	~WcsFormatter (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::base::PropertyList::Ptr	generatePropertySet (lsst::afw::image::Wcs const &wcs)
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
	WcsFormatter (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

Class implementing persistence and retrieval for Wcs objects.

Definition at line 55 of file WcsFormatter.h.

Constructor & Destructor Documentation

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

virtual

Definition at line 84 of file WcsFormatter.cc.

                                       {
}

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

explicitprivate

Definition at line 79 of file WcsFormatter.cc.

                        :
    dafPersist::Formatter(typeid(this)) {
}

Member Function Documentation

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

static

Definition at line 245 of file WcsFormatter.cc.

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

template<class Archive >

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

static

Definition at line 179 of file WcsFormatter.cc.

                                                             {
    execTrace("WcsFormatter delegateSerialize start");
    afwImg::Wcs* ip = dynamic_cast<afwImg::Wcs*>(persistable);
    if (ip == 0) {
        throw LSST_EXCEPT(pexExcept::RuntimeError, "Serializing non-Wcs");
    }

    // Serialize most fields normally
    ar & ip->_nWcsInfo & ip->_relax;
    ar & ip->_wcsfixCtrl & ip->_wcshdrCtrl & ip->_nReject;
    ar & ip->_coordSystem;

    
    // If we are loading, create the array of Wcs parameter structs
    if (Archive::is_loading::value) {
        ip->_wcsInfo =
            reinterpret_cast<wcsprm*>(malloc(ip->_nWcsInfo * sizeof(wcsprm)));
    }


    for (int i = 0; i < ip->_nWcsInfo; ++i) {
        // If we are loading, initialize the struct first
        if (Archive::is_loading::value) {
            ip->_wcsInfo[i].flag = -1;
            wcsini(1, 2, &(ip->_wcsInfo[i]));
        }

        // Serialize only critical Wcs parameters
        //wcslib provides support for arrays of wcs', but we only
        //implement support for one.
        ar & ip->_wcsInfo[i].naxis;
        ar & ip->_wcsInfo[i].equinox;
        ar & ip->_wcsInfo[i].radesys;
        ar & ip->_wcsInfo[i].crpix[0];
        ar & ip->_wcsInfo[i].crpix[1];
        ar & ip->_wcsInfo[i].cd[0];
        ar & ip->_wcsInfo[i].cd[1];
        ar & ip->_wcsInfo[i].cd[2];
        ar & ip->_wcsInfo[i].cd[3];
        ar & ip->_wcsInfo[i].crval[0];
        ar & ip->_wcsInfo[i].crval[1];
        ar & ip->_wcsInfo[i].cunit[0];
        ar & ip->_wcsInfo[i].cunit[1];
        ar & ip->_wcsInfo[i].ctype[0];
        ar & ip->_wcsInfo[i].ctype[1];
        ar & ip->_wcsInfo[i].altlin;

        // If we are loading, compute intermediate values given those above
        if (Archive::is_loading::value) {
            ip->_wcsInfo[i].flag = 0;
            wcsset(&(ip->_wcsInfo[i]));
        }
    }
    execTrace("WcsFormatter delegateSerialize end");
}

dafBase::PropertyList::Ptr lsst::afw::formatters::WcsFormatter::generatePropertySet ( lsst::afw::image::Wcs const &  wcs )

static

Definition at line 140 of file WcsFormatter.cc.

                                                             {
    // Only generates properties for the first wcsInfo.
    dafBase::PropertyList::Ptr wcsProps(new dafBase::PropertyList());

    assert(wcs._wcsInfo); // default ctor is private, so an uninitialized Wcs should not exist in the wild

    wcsProps->add("NAXIS", wcs._wcsInfo[0].naxis, "number of data axes");
    wcsProps->add("EQUINOX", wcs._wcsInfo[0].equinox, "Equinox of coordinates");
    wcsProps->add("RADESYS", std::string(wcs._wcsInfo[0].radesys), "Coordinate system for equinox");
    wcsProps->add("CRPIX1", wcs._wcsInfo[0].crpix[0], "WCS Coordinate reference pixel");
    wcsProps->add("CRPIX2", wcs._wcsInfo[0].crpix[1], "WCS Coordinate reference pixel");
    wcsProps->add("CD1_1", wcs._wcsInfo[0].cd[0], "WCS Coordinate scale matrix");
    wcsProps->add("CD1_2", wcs._wcsInfo[0].cd[1], "WCS Coordinate scale matrix");
    wcsProps->add("CD2_1", wcs._wcsInfo[0].cd[2], "WCS Coordinate scale matrix");
    wcsProps->add("CD2_2", wcs._wcsInfo[0].cd[3], "WCS Coordinate scale matrix");
    wcsProps->add("CRVAL1", wcs._wcsInfo[0].crval[0], "WCS Ref value (RA in decimal degrees)");
    wcsProps->add("CRVAL2", wcs._wcsInfo[0].crval[1], "WCS Ref value (DEC in decimal degrees)");
    wcsProps->add("CUNIT1", std::string(wcs._wcsInfo[0].cunit[0]));
    wcsProps->add("CUNIT2", std::string(wcs._wcsInfo[0].cunit[1]));
    //
    // Some projections need PVi_j keywords.  Add them.
    //
    for (int i = 0; i != wcs._wcsInfo[0].npv; ++i) {
        auto const pv = wcs._wcsInfo[0].pv[i];
        int const ii = pv.i > 0 ? pv.i : (wcs._wcsInfo[0].lat + 1); // 0 => latitude axis (see wcslib/wsc.h)
        char key[20];
        sprintf(key, "PV%d_%d", ii, pv.m);
        wcsProps->add(key, pv.value);
    }

    std::string ctype1(wcs._wcsInfo[0].ctype[0]);
    std::string ctype2(wcs._wcsInfo[0].ctype[1]);
    wcsProps->add("CTYPE1", ctype1, "WCS Coordinate type");
    wcsProps->add("CTYPE2", ctype2, "WCS Coordinate type");

    return wcsProps;
}

dafBase::Persistable * lsst::afw::formatters::WcsFormatter::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 107 of file WcsFormatter.cc.

                                          {
    execTrace("WcsFormatter read start");
    if (typeid(*storage) == typeid(dafPersist::BoostStorage)) {
        afwImg::Wcs* ip = new afwImg::Wcs;
        execTrace("WcsFormatter read BoostStorage");
        dafPersist::BoostStorage* boost = dynamic_cast<dafPersist::BoostStorage*>(storage.get());
        boost->getIArchive() & *ip;
        execTrace("WcsFormatter read end");
        return ip;
    }
    else if (typeid(*storage) == typeid(dafPersist::FitsStorage)) {
        execTrace("WcsFormatter read FitsStorage");
        dafPersist::FitsStorage* fits = dynamic_cast<dafPersist::FitsStorage*>(storage.get());
        int hdu = additionalData->get<int>("hdu", 0);
        dafBase::PropertySet::Ptr md =
            afwImg::readMetadata(fits->getPath(), hdu);
        afwImg::Wcs* ip = new afwImg::Wcs(md);
        execTrace("WcsFormatter read end");
        return ip;
    }
    throw LSST_EXCEPT(pexExcept::RuntimeError, "Unrecognized Storage for Wcs");
}

void lsst::afw::formatters::WcsFormatter::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 132 of file WcsFormatter.cc.

                           {
    throw LSST_EXCEPT(pexExcept::RuntimeError, "Unexpected call to update for Wcs");
}

void lsst::afw::formatters::WcsFormatter::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 87 of file WcsFormatter.cc.

                           {
    execTrace("WcsFormatter write start");
    afwImg::Wcs const* ip =
        dynamic_cast<afwImg::Wcs const*>(persistable);
    if (ip == 0) {
        throw LSST_EXCEPT(pexExcept::RuntimeError, "Persisting non-Wcs");
    }
    if (typeid(*storage) == typeid(dafPersist::BoostStorage)) {
        execTrace("WcsFormatter write BoostStorage");
        dafPersist::BoostStorage* boost = dynamic_cast<dafPersist::BoostStorage*>(storage.get());
        boost->getOArchive() & *ip;
        execTrace("WcsFormatter write end");
        return;
    }
    throw LSST_EXCEPT(pexExcept::RuntimeError, "Unrecognized Storage for Wcs");
}

Member Data Documentation

dafPersist::FormatterRegistration lsst::afw::formatters::WcsFormatter::registration

staticprivate

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