lsst::afw::formatters Namespace Reference

Functions
bool	extractOptionalFlag (std::shared_ptr< lsst::daf::base::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. More...
std::string const	getItemName (std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
	Extracts and returns the string-valued "itemName" property from the given data property object. More...
int	extractSliceId (std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
int64_t	extractFpaExposureId (std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
int64_t	extractCcdExposureId (std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
int64_t	extractAmpExposureId (std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
int	extractVisitId (std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
int	extractCcdId (std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
int	extractAmpId (std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
int	countFitsHeaderCards (lsst::daf::base::PropertySet const &prop)
ndarray::Array< std::uint8_t, 1, 1 >	stringToBytes (std::string const &str)
	Encode a std::string as a vector of uint8. More...
std::string	bytesToString (ndarray::Array< std::uint8_t const, 1, 1 > const &bytes)
	Decode a std::string from a vector of uint8 returned by stringToBytes. More...

Function Documentation

bytesToString()

std::string lsst::afw::formatters::bytesToString

(

ndarray::Array< std::uint8_t const, 1, 1 > const &

bytes

)

Decode a std::string from a vector of uint8 returned by stringToBytes.

Definition at line 173 of file Utils.cc.

                                                                           {
    auto nchars = bytes.size() * sizeof(std::uint8_t) / sizeof(char);
    char const* charCArr = reinterpret_cast<char const*>(bytes.getData());
    return std::string(charCArr, nchars);
}

countFitsHeaderCards()

int lsst::afw::formatters::countFitsHeaderCards

(

lsst::daf::base::PropertySet const &

prop

)

Definition at line 160 of file Utils.cc.

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

extractAmpExposureId()

int64_t lsst::afw::formatters::extractAmpExposureId

(

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

properties

)

Definition at line 132 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;
}

extractAmpId()

int lsst::afw::formatters::extractAmpId

(

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

properties

)

Definition at line 107 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;
}

extractCcdExposureId()

int64_t lsst::afw::formatters::extractCcdExposureId

(

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

properties

)

Definition at line 121 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;
}

extractCcdId()

int lsst::afw::formatters::extractCcdId

(

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

properties

)

Definition at line 93 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);
}

extractFpaExposureId()

int64_t lsst::afw::formatters::extractFpaExposureId

(

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

properties

)

Definition at line 79 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;
}

extractOptionalFlag()

bool lsst::afw::formatters::extractOptionalFlag	(	std::shared_ptr< lsst::daf::base::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 153 of file Utils.cc.

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

extractSliceId()

int lsst::afw::formatters::extractSliceId

(

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

properties

)

Definition at line 51 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;
}

extractVisitId()

int lsst::afw::formatters::extractVisitId

(

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

properties

)

Definition at line 68 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;
}

getItemName()

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

(

std::shared_ptr< lsst::daf::base::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 143 of file Utils.cc.

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

stringToBytes()

ndarray::Array< std::uint8_t, 1, 1 > lsst::afw::formatters::stringToBytes

(

std::string const &

str

)

Encode a std::string as a vector of uint8.

Definition at line 162 of file Utils.cc.

                                                                   {
    auto nbytes = str.size() * sizeof(char) / sizeof(std::uint8_t);
    std::uint8_t const* byteCArr = reinterpret_cast<std::uint8_t const*>(str.data());
    auto shape = ndarray::makeVector(nbytes);
    auto strides = ndarray::makeVector(1);
    // Make an Array that shares memory with `str` (and does not free that memory when destroyed),
    // then return a copy; this is simpler than manually copying the data into a newly allocated array
    ndarray::Array<std::uint8_t const, 1, 1> localArray = ndarray::external(byteCArr, shape, strides);
    return ndarray::copy(localArray);
}