lsst::afw::formatters::ExposureFormatter< ImagePixelT, MaskPixelT, VariancePixelT > Class Template Reference

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

#include <ExposureFormatter.h>

Inheritance diagram for lsst::afw::formatters::ExposureFormatter< ImagePixelT, MaskPixelT, VariancePixelT >:

Public Member Functions
virtual	~ExposureFormatter (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, 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
	ExposureFormatter (lsst::pex::policy::Policy::Ptr policy)

Private Attributes
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, typename MaskPixelT, typename VariancePixelT>
class lsst::afw::formatters::ExposureFormatter< ImagePixelT, MaskPixelT, VariancePixelT >

Class implementing persistence and retrieval for Exposures.

Definition at line 54 of file ExposureFormatter.h.

Constructor & Destructor Documentation

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >

lsst::afw::formatters::ExposureFormatter< ImagePixelT, MaskPixelT, VariancePixelT >::~ExposureFormatter ( void  )

virtual

Definition at line 124 of file ExposureFormatter.cc.

                                                                                          {
}

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >

lsst::afw::formatters::ExposureFormatter< ImagePixelT, MaskPixelT, VariancePixelT >::ExposureFormatter ( lsst::pex::policy::Policy::Ptr  policy )

explicitprivate

Definition at line 118 of file ExposureFormatter.cc.

                                   :
    lsst::daf::persistence::Formatter(typeid(this)), _policy(policy) {
}

Member Function Documentation

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >

lsst::daf::persistence::Formatter::Ptr lsst::afw::formatters::ExposureFormatter< ImagePixelT, MaskPixelT, VariancePixelT >::createInstance ( lsst::pex::policy::Policy::Ptr  policy )

static

Definition at line 474 of file ExposureFormatter.cc.

                                   {
    typedef typename lsst::daf::persistence::Formatter::Ptr FormPtr;
    return FormPtr(new afwForm::ExposureFormatter<ImagePixelT, MaskPixelT, VariancePixelT>(policy));
}

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >

template<class Archive >

void lsst::afw::formatters::ExposureFormatter< ImagePixelT, MaskPixelT, VariancePixelT >::delegateSerialize ( Archive &  ar, unsigned int const  version, lsst::daf::base::Persistable *  persistable  )

static

Definition at line 456 of file ExposureFormatter.cc.

{
    execTrace("ExposureFormatter delegateSerialize start");
    afwImg::Exposure<ImagePixelT, MaskPixelT, VariancePixelT>* ip =
        dynamic_cast<afwImg::Exposure<ImagePixelT, MaskPixelT, VariancePixelT>*>(persistable);
    if (ip == 0) {
        throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Serializing non-Exposure");
    }
    PTR(afwImg::Wcs) wcs = ip->getWcs();
    ar & *ip->getMetadata() & ip->_maskedImage & wcs;
    execTrace("ExposureFormatter delegateSerialize end");
}

template<typename ImagePixelT, typename MaskPixelT, typename VariancePixelT>

dafBase::Persistable * lsst::afw::formatters::ExposureFormatter< ImagePixelT, MaskPixelT, VariancePixelT >::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.

Todo:

Should really have FITS be a separate Storage.

Todo:

Need to implement overwriting of FITS metadata PropertySet

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

Definition at line 311 of file ExposureFormatter.cc.

                                              {
    execTrace("ExposureFormatter read start");
    if (typeid(*storage) == typeid(dafPersist::BoostStorage)) {
        execTrace("ExposureFormatter read BoostStorage");
        dafPersist::BoostStorage* boost = dynamic_cast<dafPersist::BoostStorage*>(storage.get());
        afwImg::Exposure<ImagePixelT, MaskPixelT, VariancePixelT>* ip =
            new afwImg::Exposure<ImagePixelT, MaskPixelT, VariancePixelT>;
        boost->getIArchive() & *ip;
        execTrace("ExposureFormatter read end");
        return ip;
    } else if (typeid(*storage) == typeid(dafPersist::FitsStorage)) {
        execTrace("ExposureFormatter read FitsStorage");
        dafPersist::FitsStorage* fits = dynamic_cast<dafPersist::FitsStorage*>(storage.get());
        afwGeom::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 = afwGeom::Box2I(afwGeom::Point2I(llcX, llcY), afwGeom::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 Exposure from fits")%originStr
                        
                    ).str()
                );
            }
        }
        afwImg::Exposure<ImagePixelT, MaskPixelT, VariancePixelT>* ip =
            new afwImg::Exposure<ImagePixelT, MaskPixelT, VariancePixelT>(
                fits->getPath(), box, origin);
        execTrace("ExposureFormatter read end");
        return ip;
    } else if (typeid(*storage) == typeid(dafPersist::DbStorage)) {
        execTrace("ExposureFormatter read DbStorage");
        dafPersist::DbStorage* db = dynamic_cast<dafPersist::DbStorage*>(storage.get());

        // Select a table to retrieve from based on the itemName.
        std::string itemName = additionalData->get<std::string>("itemName");
        std::string tableName = itemName;
        if (_policy->exists(itemName)) {
            lsst::pex::policy::Policy::Ptr itemPolicy =
                _policy->getPolicy(itemName);
            if (itemPolicy->exists("TableName")) {
                tableName = itemPolicy->getString("TableName");
            }
        }
        if (tableName != "Raw_Amp_Exposure" &&
            tableName != "Science_Amp_Exposure") {
            throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError,
                              "Unknown table name for retrieving Exposure from DbStorage: " +
                              tableName + " for item " + itemName);
        }
        db->setTableForQuery(tableName);

        // Set the identifier column tests.
        db->condParam<int64_t>("id", additionalData->getAsInt64("ampExposureId"));
        if (tableName == "Raw_Amp_Exposure") {
            db->setQueryWhere("rawAmpExposureId = :id");
        }
        else { // Science_Amp_Exposure
            db->setQueryWhere("scienceAmpExposureId = :id");
        }

        db->outColumn("url");

        if (tableName == "Science_Amp_Exposure") {
            // Set the Wcs information columns.
            db->outColumn("ctype1");
            db->outColumn("ctype2");
            db->outColumn("crpix1");
            db->outColumn("crpix2");
            db->outColumn("crval1");
            db->outColumn("crval2");
            db->outColumn("cd11");
            db->outColumn("cd21");
            db->outColumn("cd12");
            db->outColumn("cd22");

            // Set calibration data columns.
            db->outColumn("photoFlam");
            db->outColumn("photoZP");
        }

        // Phew!  Run the query.
        db->query();
        if (!db->next()) {
            throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Unable to retrieve row");
        }
        // ...
        if (db->next()) {
            throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Non-unique Exposure retrieved");
        }
        db->finishQuery();

        // - KTL - 2007-11-29

        // Restore image from FITS...
        afwImg::Exposure<ImagePixelT, MaskPixelT, VariancePixelT>* ip =
            new afwImg::Exposure<ImagePixelT, MaskPixelT, VariancePixelT>(db->getColumnByPos<std::string>(0));
        lsst::daf::base::PropertySet::Ptr dp = ip->getMetadata();

        // Look up the filter name given the ID.
        int filterId = db->getColumnByPos<int>(1);
        std::string filterName = lookupFilterName(db, filterId);
        dp->set("FILTER", filterName);

        // Set the image headers.
        // Set the Wcs headers in ip->_wcs.

        // with values from database. - KTL - 2007-12-18

        execTrace("ExposureFormatter read end");
        return ip;
    }
    throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Unrecognized Storage for Exposure");
}

template<typename ImagePixelT, typename MaskPixelT, typename VariancePixelT>

void lsst::afw::formatters::ExposureFormatter< ImagePixelT, MaskPixelT, VariancePixelT >::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.

Todo:

Implement update from FitsStorage, keeping DB-provided headers.

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

Definition at line 444 of file ExposureFormatter.cc.

{
    // - KTL - 2007-11-29
    throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Unexpected call to update for Exposure");
}

template<typename ImagePixelT, typename MaskPixelT, typename VariancePixelT>

void lsst::afw::formatters::ExposureFormatter< ImagePixelT, MaskPixelT, VariancePixelT >::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.

Todo:

Check that rawCCDExposureId == scienceCCDExposureId – KTL – 2008-01-25

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

Definition at line 189 of file ExposureFormatter.cc.

                                              {
    execTrace("ExposureFormatter write start");
    afwImg::Exposure<ImagePixelT, MaskPixelT, VariancePixelT> const* ip =
        dynamic_cast<afwImg::Exposure<ImagePixelT, MaskPixelT, VariancePixelT> const*>(persistable);
    if (ip == 0) {
        throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Persisting non-Exposure");
    }
    if (typeid(*storage) == typeid(dafPersist::BoostStorage)) {
        execTrace("ExposureFormatter write BoostStorage");
        dafPersist::BoostStorage* boost = dynamic_cast<dafPersist::BoostStorage*>(storage.get());
        boost->getOArchive() & *ip;
        execTrace("ExposureFormatter write end");
        return;
    }
    else if (typeid(*storage) == typeid(dafPersist::FitsStorage)) {
        execTrace("ExposureFormatter write FitsStorage");
        dafPersist::FitsStorage* fits = dynamic_cast<dafPersist::FitsStorage*>(storage.get());

        ip->writeFits(fits->getPath());
        execTrace("ExposureFormatter write end");
        return;
    } else if (typeid(*storage) == typeid(dafPersist::DbStorage)) {
        execTrace("ExposureFormatter write DbStorage");
        dafPersist::DbStorage* db = dynamic_cast<dafPersist::DbStorage*>(storage.get());

        // Get the Wcs headers.
        lsst::daf::base::PropertySet::Ptr wcsProps =
            ip->getWcs()->getFitsMetadata();

        // Get the image headers.
        lsst::daf::base::PropertySet::Ptr dp = ip->getMetadata();
        if (!dp) {
            throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError,
                              "Unable to retrieve metadata from MaskedImage's Image");
        }

        // Select a table to insert into based on the itemName.
        std::string itemName = additionalData->get<std::string>("itemName");
        std::string tableName = itemName;
        if (_policy->exists(itemName)) {
            lsst::pex::policy::Policy::Ptr itemPolicy = _policy->getPolicy(itemName);
            if (itemPolicy->exists("TableName")) {
                tableName = itemPolicy->getString("TableName");
            }
        }
        if (tableName != "Raw_Amp_Exposure" &&
            tableName != "Science_Amp_Exposure") {
            throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError,
                              "Unknown table name for persisting Exposure to DbStorage: " +
                              tableName + "for item " + itemName);
        }
        db->setTableForInsert(tableName);

        // Set the identifier columns.

        int ampId = extractAmpId(additionalData);
        // int ccdId = extractCcdId(additionalData);
        int64_t fpaExposureId = extractFpaExposureId(dp);
        int64_t ccdExposureId = extractCcdExposureId(dp);
        int64_t ampExposureId = extractAmpExposureId(dp);

        if (tableName == "Raw_Amp_Exposure") {
            db->setColumn<long long>("rawAmpExposureId", ampExposureId);
            db->setColumn<long long>("rawCCDExposureId", ccdExposureId);
            db->setColumn<long long>("rawFPAExposureId", fpaExposureId);
        }
        else { // Science_Amp_Exposure
            db->setColumn<long long>("scienceAmpExposureId", ampExposureId);
            db->setColumn<long long>("scienceCCDExposureId", ccdExposureId);
            db->setColumn<long long>("scienceFPAExposureId", fpaExposureId);
            db->setColumn<long long>("rawAmpExposureId", ampExposureId);
        }

        db->setColumn<int>("ampId", ampId);

        // Set the URL column with the location of the FITS file.
        setColumn<std::string>(db, "url",
                              additionalData, "StorageLocation.FitsStorage");


        // Set the Wcs information columns.
        setColumn<std::string>(db, "ctype1", wcsProps, "CTYPE1");
        setColumn<std::string>(db, "ctype2", wcsProps, "CTYPE2");
        setColumn<float, double>(db, "crpix1", wcsProps, "CRPIX1");
        setColumn<float, double>(db, "crpix2", wcsProps, "CRPIX2");
        setColumn<double>(db, "crval1", wcsProps, "CRVAL1");
        setColumn<double>(db, "crval2", wcsProps, "CRVAL2");
        if (tableName == "Raw_Amp_Exposure") {
            setColumn<double>(db, "cd11", wcsProps, "CD1_1");
            setColumn<double>(db, "cd21", wcsProps, "CD2_1");
            setColumn<double>(db, "cd12", wcsProps, "CD1_2");
            setColumn<double>(db, "cd22", wcsProps, "CD2_2");
        }
        else {
            setColumn<double>(db, "cd1_1", wcsProps, "CD1_1");
            setColumn<double>(db, "cd2_1", wcsProps, "CD2_1");
            setColumn<double>(db, "cd1_2", wcsProps, "CD1_2");
            setColumn<double>(db, "cd2_2", wcsProps, "CD2_2");
        }


        if (tableName == "Science_Amp_Exposure") {
            // Set calibration data columns.
            setColumn<float, double>(db, "photoFlam", dp, "PHOTFLAM");
            setColumn<float, double>(db, "photoZP", dp, "PHOTZP");
        }

        // Phew!  Insert the row now.
        db->insertRow();

        execTrace("ExposureFormatter write end");
        return;
    }
    throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Unrecognized Storage for Exposure");
}

Member Data Documentation

template<typename ImagePixelT, typename MaskPixelT, typename VariancePixelT>

lsst::pex::policy::Policy::Ptr lsst::afw::formatters::ExposureFormatter< ImagePixelT, MaskPixelT, VariancePixelT >::_policy

private

Definition at line 85 of file ExposureFormatter.h.

template<typename ImagePixelT, typename MaskPixelT, typename VariancePixelT>

lsst::daf::persistence::FormatterRegistration lsst::afw::formatters::ExposureFormatter< ImagePixelT, MaskPixelT, VariancePixelT >::registration

staticprivate

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