lsst::afw::formatters Namespace Reference

Classes
class	DecoratedImageFormatter
	Class implementing persistence and retrieval for DecoratedImages. More...
class	ExposureFormatter
	Class implementing persistence and retrieval for Exposures. More...
class	ImageFormatter
	Class implementing persistence and retrieval for Images. More...
class	KernelFormatter
class	MaskedImageFormatter
	Class implementing persistence and retrieval for MaskedImages. More...
class	MaskFormatter
	Class implementing persistence and retrieval for Masks. More...
class	TanWcsFormatter
	Class implementing persistence and retrieval for TanWcs objects. More...
class	WcsFormatter
	Class implementing persistence and retrieval for Wcs objects. More...
class	DecoratedImageFormatterTraits
class	ImageFormatterTraits
class	MaskedImageFormatterTraits
class	MaskFormatterTraits

Functions
bool	extractOptionalFlag (boost::shared_ptr< lsst::daf::base::PropertySet const > const &properties, std::string const &name)
std::string const	getItemName (boost::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
std::string const	getTableName (boost::shared_ptr< lsst::pex::policy::Policy const > const &policy, boost::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
std::vector< std::string >	getAllSliceTableNames (boost::shared_ptr< lsst::pex::policy::Policy const > const &policy, boost::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
void	createTable (lsst::daf::persistence::LogicalLocation const &location, boost::shared_ptr< lsst::pex::policy::Policy const > const &policy, boost::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
void	dropAllSliceTables (lsst::daf::persistence::LogicalLocation const &location, boost::shared_ptr< lsst::pex::policy::Policy const > const &policy, boost::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
int	extractSliceId (boost::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
int64_t	extractFpaExposureId (boost::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
int64_t	extractCcdExposureId (boost::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
int64_t	extractAmpExposureId (boost::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
int	extractVisitId (boost::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
int	extractCcdId (boost::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
int	extractAmpId (boost::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
std::string	formatFitsProperties (boost::shared_ptr< lsst::daf::base::PropertySet const > const &prop)
int	countFitsHeaderCards (boost::shared_ptr< lsst::daf::base::PropertySet const > const &prop)
int	extractSliceId (boost::shared_ptr< PropertySet const > const &properties)
int	extractVisitId (boost::shared_ptr< PropertySet const > const &properties)
int64_t	extractFpaExposureId (boost::shared_ptr< PropertySet const > const &properties)
int	extractCcdId (boost::shared_ptr< PropertySet const > const &properties)
int	extractAmpId (boost::shared_ptr< PropertySet const > const &properties)
int64_t	extractCcdExposureId (boost::shared_ptr< PropertySet const > const &properties)
int64_t	extractAmpExposureId (boost::shared_ptr< PropertySet const > const &properties)
std::string const	getItemName (boost::shared_ptr< PropertySet const > const &properties)
bool	extractOptionalFlag (boost::shared_ptr< PropertySet const > const &properties, std::string const &name)
std::string const	getTableName (boost::shared_ptr< Policy const > const &policy, boost::shared_ptr< PropertySet const > const &properties)
std::vector< std::string >	getAllSliceTableNames (boost::shared_ptr< Policy const > const &policy, boost::shared_ptr< PropertySet const > const &properties)
void	createTable (lsst::daf::persistence::LogicalLocation const &location, boost::shared_ptr< lsst::pex::policy::Policy const > const &policy, boost::shared_ptr< PropertySet const > const &properties)
void	dropAllSliceTables (lsst::daf::persistence::LogicalLocation const &location, boost::shared_ptr< lsst::pex::policy::Policy const > const &policy, boost::shared_ptr< PropertySet const > const &properties)
std::string	formatFitsProperties (boost::shared_ptr< lsst::daf::base::PropertySet const > const &prop)
int	countFitsHeaderCards (boost::shared_ptr< lsst::daf::base::PropertySet const > const &prop)

Function Documentation

int lsst::afw::formatters::countFitsHeaderCards

(

boost::shared_ptr< lsst::daf::base::PropertySet const > const &

prop

)

int lsst::afw::formatters::countFitsHeaderCards

(

boost::shared_ptr< lsst::daf::base::PropertySet const > const &

prop

)

Definition at line 328 of file Utils.cc.

                                                                        {
    return prop->paramNames(false).size();
}

void lsst::afw::formatters::createTable	(	lsst::daf::persistence::LogicalLocation const &	location,
		boost::shared_ptr< lsst::pex::policy::Policy const > const &	policy,
		boost::shared_ptr< lsst::daf::base::PropertySet const > const &	properties
	)

void lsst::afw::formatters::createTable	(	lsst::daf::persistence::LogicalLocation const &	location,
		boost::shared_ptr< lsst::pex::policy::Policy const > const &	policy,
		boost::shared_ptr< PropertySet const > const &	properties
	)

Creates the table identified by calling getTableName() with the given policy and properties. A key named "${itemName}.templateTableName" (where ${itemName} refers to the value of a property named "itemName" extracted from properties) must be available and set to the name of the template table to use for creation.

Note that the template table must exist in the database identified by location, and that if the desired table already exists, an exception is thrown.

Definition at line 257 of file Utils.cc.

  {
    std::string itemName(getItemName(properties));
    std::string name(getTableName(policy, properties));
    std::string model(policy->getString(itemName + ".templateTableName"));

    lsst::daf::persistence::DbTsvStorage db;
    db.setPersistLocation(location);
    db.createTableFromTemplate(name, model);
}

void lsst::afw::formatters::dropAllSliceTables	(	lsst::daf::persistence::LogicalLocation const &	location,
		boost::shared_ptr< lsst::pex::policy::Policy const > const &	policy,
		boost::shared_ptr< lsst::daf::base::PropertySet const > const &	properties
	)

void lsst::afw::formatters::dropAllSliceTables	(	lsst::daf::persistence::LogicalLocation const &	location,
		boost::shared_ptr< lsst::pex::policy::Policy const > const &	policy,
		boost::shared_ptr< PropertySet const > const &	properties
	)

Drops the database table(s) identified by getAllSliceTables().

Definition at line 273 of file Utils.cc.

  {
    std::vector<std::string> names = getAllSliceTableNames(policy, properties);

    lsst::daf::persistence::DbTsvStorage db;
    db.setPersistLocation(location);
    for (std::vector<std::string>::const_iterator i(names.begin()), end(names.end()); i != end; ++i) {
        db.dropTable(*i);
    }
}

int64_t lsst::afw::formatters::extractAmpExposureId

(

boost::shared_ptr< lsst::daf::base::PropertySet const > const &

properties

)

int64_t lsst::afw::formatters::extractAmpExposureId

(

boost::shared_ptr< PropertySet const > const &

properties

)

Definition at line 133 of file Utils.cc.

                                                                       {
    if (properties->isArray("ampExposureId")) {
        throw LSST_EXCEPT(ex::RuntimeError, "\"ampExposureId\" property has multiple values");
    }
    int64_t ampExposureId = properties->getAsInt64("ampExposureId");
    if (ampExposureId < 0) {
        throw LSST_EXCEPT(ex::RangeError, "negative \"ampExposureId\"");
    }
    return ampExposureId;
}

int lsst::afw::formatters::extractAmpId

(

boost::shared_ptr< lsst::daf::base::PropertySet const > const &

properties

)

int lsst::afw::formatters::extractAmpId

(

boost::shared_ptr< PropertySet const > const &

properties

)

Definition at line 108 of file Utils.cc.

                                                           {
    if (properties->isArray("ampId")) {
        throw LSST_EXCEPT(ex::RuntimeError, "\"ampId\" property has multiple values");
    }
    int ampId = properties->getAsInt("ampId");
    if (ampId < 0) {
        throw LSST_EXCEPT(ex::RangeError, "negative \"ampId\"");
    }
    if (ampId > 63) {
        throw LSST_EXCEPT(ex::RangeError, "\"ampId\" is too large");
    }
    return (extractCcdId(properties) << 6) + ampId;
}

int64_t lsst::afw::formatters::extractCcdExposureId

(

boost::shared_ptr< lsst::daf::base::PropertySet const > const &

properties

)

int64_t lsst::afw::formatters::extractCcdExposureId

(

boost::shared_ptr< PropertySet const > const &

properties

)

Definition at line 122 of file Utils.cc.

                                                                       {
    if (properties->isArray("ccdExposureId")) {
        throw LSST_EXCEPT(ex::RuntimeError, "\"ccdExposureId\" property has multiple values");
    }
    int64_t ccdExposureId = properties->getAsInt64("ccdExposureId");
    if (ccdExposureId < 0) {
        throw LSST_EXCEPT(ex::RangeError, "negative \"ccdExposureId\"");
    }
    return ccdExposureId;
}

int lsst::afw::formatters::extractCcdId

(

boost::shared_ptr< lsst::daf::base::PropertySet const > const &

properties

)

int lsst::afw::formatters::extractCcdId

(

boost::shared_ptr< PropertySet const > const &

properties

)

Definition at line 94 of file Utils.cc.

                                                           {
    if (properties->isArray("ccdId")) {
        throw LSST_EXCEPT(ex::RuntimeError, "\"ccdId\" property has multiple values");
    }
    int ccdId = properties->getAsInt("ccdId");
    if (ccdId < 0) {
        throw LSST_EXCEPT(ex::RangeError, "negative \"ccdId\"");
    }
    if (ccdId > 255) {
        throw LSST_EXCEPT(ex::RangeError, "\"ccdId\" is too large");
    }
    return static_cast<int>(ccdId);
}

int64_t lsst::afw::formatters::extractFpaExposureId

(

boost::shared_ptr< PropertySet const > const &

properties

)

Definition at line 80 of file Utils.cc.

                                                                       {
    if (properties->isArray("fpaExposureId")) {
        throw LSST_EXCEPT(ex::RuntimeError, "\"fpaExposureId\" property has multiple values");
    }
    int64_t fpaExposureId = properties->getAsInt64("fpaExposureId");
    if (fpaExposureId < 0) {
        throw LSST_EXCEPT(ex::RangeError, "negative \"fpaExposureId\"");
    }
    if ((fpaExposureId & 0xfffffffe00000000LL) != 0LL) {
        throw LSST_EXCEPT(ex::RangeError, "\"fpaExposureId\" is too large");
    }
    return fpaExposureId;
}

int64_t lsst::afw::formatters::extractFpaExposureId

(

boost::shared_ptr< lsst::daf::base::PropertySet const > const &

properties

)

bool lsst::afw::formatters::extractOptionalFlag	(	boost::shared_ptr< lsst::daf::base::PropertySet const > const &	properties,
		std::string const &	name
	)

bool lsst::afw::formatters::extractOptionalFlag	(	boost::shared_ptr< PropertySet const > const &	properties,
		std::string const &	name
	)

Returns true if and only if properties is non-null and contains a unique property with the given name that has type bool and a value of true.

Definition at line 166 of file Utils.cc.

  {
    if (properties && properties->exists(name)) {
        return properties->getAsBool(name);
    }
    return false;
}

int lsst::afw::formatters::extractSliceId

(

boost::shared_ptr< PropertySet const > const &

properties

)

Definition at line 52 of file Utils.cc.

                                                             {
    if (properties->isArray("sliceId")) {
        throw LSST_EXCEPT(ex::RuntimeError, "\"sliceId\" property has multiple values");
    }
    int sliceId = properties->getAsInt("sliceId");
    if (sliceId < 0) {
        throw LSST_EXCEPT(ex::RangeError, "negative \"sliceId\"");
    }
    if (properties->exists("universeSize") && !properties->isArray("universeSize")) {
        int universeSize = properties->getAsInt("universeSize");
        if (sliceId >= universeSize) {
            throw LSST_EXCEPT(ex::RangeError, "\"sliceId\" must be less than \"universeSize \"");
        }
    }
    return sliceId;
}

int lsst::afw::formatters::extractSliceId

(

boost::shared_ptr< lsst::daf::base::PropertySet const > const &

properties

)

int lsst::afw::formatters::extractVisitId

(

boost::shared_ptr< PropertySet const > const &

properties

)

Definition at line 69 of file Utils.cc.

                                                             {
    if (properties->isArray("visitId")) {
        throw LSST_EXCEPT(ex::RuntimeError, "\"visitId\" property has multiple values");
    }
    int visitId = properties->getAsInt("visitId");
    if (visitId < 0) {
        throw LSST_EXCEPT(ex::RangeError, "negative \"visitId\"");
    }
    return visitId;
}

int lsst::afw::formatters::extractVisitId

(

boost::shared_ptr< lsst::daf::base::PropertySet const > const &

properties

)

std::string lsst::afw::formatters::formatFitsProperties

(

boost::shared_ptr< lsst::daf::base::PropertySet const > const &

prop

)

std::string lsst::afw::formatters::formatFitsProperties

(

boost::shared_ptr< lsst::daf::base::PropertySet const > const &

prop

)

Definition at line 288 of file Utils.cc.

                                                                              {
    typedef std::vector<std::string> NameList;
    std::string sout;

    NameList paramNames = prop->paramNames(false);

    for (NameList::const_iterator i = paramNames.begin(), end = paramNames.end(); i != end; ++i) {
       std::size_t lastPeriod = i->rfind(char('.'));
       std::string name = (lastPeriod == std::string::npos) ? *i : i->substr(lastPeriod + 1);
       std::type_info const & type = prop->typeOf(*i);

       std::string out = "";
       if (name.size() > 8) {           // Oh dear; too long for a FITS keyword
           out += "HIERARCH = " + name;
       } else {
           out = (boost::format("%-8s= ") % name).str();
       }
       
       if (type == typeid(int)) {
           out += (boost::format("%20d") % prop->get<int>(*i)).str();
       } else if (type == typeid(double)) {
           out += (boost::format("%20.15g") % prop->get<double>(*i)).str();
       } else if (type == typeid(std::string)) {
           out += (boost::format("'%-67s' ") % prop->get<std::string>(*i)).str();
       }

       int const len = out.size();
       if (len < 80) {
           out += std::string(80 - len, ' ');
       } else {
           out = out.substr(0, 80);
       }

       sout += out;
    }

    return sout.c_str();
}

std::vector<std::string> lsst::afw::formatters::getAllSliceTableNames	(	boost::shared_ptr< lsst::pex::policy::Policy const > const &	policy,
		boost::shared_ptr< lsst::daf::base::PropertySet const > const &	properties
	)

std::vector<std::string> lsst::afw::formatters::getAllSliceTableNames	(	boost::shared_ptr< Policy const > const &	policy,
		boost::shared_ptr< PropertySet const > const &	properties
	)

Stores the name of the table that each slice of a pipeline involved in processing a visit used for persistence of its outputs. If slices were configured to all use the same (per-visit) table name, a single name is stored.

Parameters

[in]	policy	The Policy containing the table name pattern ("${itemName}.tableNamePattern", where ${itemName} is looked up in properties using the "itemName" key) from which the the actual table name is derived. This pattern may contain a set of parameters in %(key) format - these are interpolated by looking up "key" in the properties PropertySet.
[in]	properties	The runtime specific properties necessary to construct the table names.

string. The "visitId" property must also be present, and shall be a non-negative integer of type int64_t uniquely identifying the current LSST visit. If the "${itemName}.isPerSliceTable" property is present, is of type bool and is set to true, then it is assumed that "${itemName}.numSlices" (a positive integer of type int) output tables exist and are to be read in.

Returns

a list of table names

See Also

getTableName()

Definition at line 223 of file Utils.cc.

  {
    std::string itemName(getItemName(properties));
    std::string pattern(policy->getString(itemName + ".tableNamePattern"));
    int numSlices = 1;
    if (properties->exists(itemName + ".numSlices")) {
        numSlices = properties->getAsInt(itemName + ".numSlices");
    }
    if (numSlices <= 0) {
        throw LSST_EXCEPT(ex::RuntimeError,
                          itemName + " \".numSlices\" property value must be positive");
    }
    std::vector<std::string> names;
    names.reserve(numSlices);
    PTR(PropertySet) props = properties->deepCopy();
    for (int i = 0; i < numSlices; ++i) {
        props->set("sliceId", i);
        names.push_back(LogicalLocation(pattern, props).locString());
    }
    return names;
}

std::string const lsst::afw::formatters::getItemName

(

boost::shared_ptr< lsst::daf::base::PropertySet const > const &

properties

)

std::string const lsst::afw::formatters::getItemName

(

boost::shared_ptr< PropertySet const > const &

properties

)

Extracts and returns the string-valued "itemName" property from the given data property object.

Exceptions

lsst::pex::exceptions::InvalidParameterError

If the given pointer is null, or the PropertySet pointed to does not contain a unique property named "itemName".

Definition at line 151 of file Utils.cc.

                                                                      {
    if (!properties) {
        throw LSST_EXCEPT(ex::InvalidParameterError, "Null PropertySet::Ptr");
    }
    if (properties->isArray("itemName")) {
        throw LSST_EXCEPT(ex::InvalidParameterError, "\"itemName\" property has multiple values");
    } 
    return properties->getAsString("itemName");
}

std::string const lsst::afw::formatters::getTableName	(	boost::shared_ptr< lsst::pex::policy::Policy const > const &	policy,
		boost::shared_ptr< lsst::daf::base::PropertySet const > const &	properties
	)

std::string const lsst::afw::formatters::getTableName	(	boost::shared_ptr< Policy const > const &	policy,
		boost::shared_ptr< PropertySet const > const &	properties
	)

Returns the name of the table that a single slice of a pipeline involved in the processing of a single visit should use for persistence of a particular output. All slices can be configured to use the same (per-visit) table name using policy parameters.

Parameters

[in]	policy	The Policy containing the table name pattern ("${itemName}.tableNamePattern", where ${itemName} is looked up in properties using the "itemName" key) from which the the actual table name is derived. This pattern may contain a set of parameters in %(key) format - these are interpolated by looking up "key" in the properties PropertySet.
[in]	properties	Provides runtime specific properties necessary to construct the output table name.

Returns

table name

Definition at line 192 of file Utils.cc.

  {
    std::string itemName(getItemName(properties));
    return LogicalLocation(policy->getString(itemName + ".tableNamePattern"), properties).locString();
}