lsst::afw::image::detail Namespace Reference

Classes
struct	basic_tag
	Base image tag. More...
struct	Image_tag
	tag for an Image More...
struct	image_traits
	traits class for image categories More...
struct	Mask_tag
	tag for a Mask More...
struct	MaskedImage_tag
	A traits class for MaskedImage. More...
struct	MaskedImagePixel_tag
	A class used to identify classes that represent MaskedImage pixels. More...
class	MaskDict

Typedefs
typedef std::map< std::string, int >	MaskPlaneDict

Functions
int	stripCalibKeywords (boost::shared_ptr< lsst::daf::base::PropertySet > metadata)
int	stripFilterKeywords (boost::shared_ptr< lsst::daf::base::PropertySet > metadata)
boost::shared_ptr < lsst::daf::base::PropertyList >	createTrivialWcsAsPropertySet (std::string const &wcsName, int const x0=0, int const y0=0)
geom::Point2I	getImageXY0FromMetadata (std::string const &wcsName, lsst::daf::base::PropertySet *metadata)
int	stripWcsKeywords (boost::shared_ptr< lsst::daf::base::PropertySet > const &metadata, boost::shared_ptr< Wcs const > const &wcs)

Variables
std::string const	wcsNameForXY0 = "A"
std::string const	fitsFile_RE = "\\.fits(\\.[fg]z)?$"
std::string const	compressedFileNoMEF_RE = "(\\.gz)$"
	be written as MEFs More...

Typedef Documentation

typedef std::map<std::string, int> lsst::afw::image::detail::MaskPlaneDict

Definition at line 65 of file Mask.h.

Function Documentation

lsst::daf::base::PropertyList::Ptr lsst::afw::image::detail::createTrivialWcsAsPropertySet	(	std::string const &	wcsName,
		int const	x0,
		int const	y0
	)

Define a trivial WCS that maps the lower left corner (LLC) pixel of an image to a given value

Parameters

wcsName	Name of desired WCS
x0	Column coordinate of LLC pixel
y0	Row coordinate of LLC pixel

Definition at line 1187 of file Wcs.cc.

                               {
    lsst::daf::base::PropertyList::Ptr wcsMetaData(new lsst::daf::base::PropertyList);

    wcsMetaData->set("CRVAL1" + wcsName, x0, "Column pixel of Reference Pixel");
    wcsMetaData->set("CRVAL2" + wcsName, y0, "Row pixel of Reference Pixel");
    wcsMetaData->set("CRPIX1" + wcsName, 1, "Column Pixel Coordinate of Reference");
    wcsMetaData->set("CRPIX2" + wcsName, 1, "Row Pixel Coordinate of Reference");
    wcsMetaData->set("CTYPE1" + wcsName, "LINEAR", "Type of projection");
    wcsMetaData->set("CTYPE2" + wcsName, "LINEAR", "Type of projection");
    wcsMetaData->set("CUNIT1" + wcsName, "PIXEL", "Column unit");
    wcsMetaData->set("CUNIT2" + wcsName, "PIXEL", "Row unit");

    return wcsMetaData;
}

afwGeom::Point2I lsst::afw::image::detail::getImageXY0FromMetadata	(	std::string const &	wcsName,
		lsst::daf::base::PropertySet *	metadata
	)

Return a Point2I(x0, y0) given a PropertySet containing a suitable WCS (e.g. "A")

The WCS must have CRPIX[12] == 1 and CRVAL[12] must be present. If this is true, the WCS cards are removed from the metadata

Parameters

wcsName	the WCS to search (E.g. "A")
metadata	the metadata, maybe containing the WCS

Definition at line 1210 of file Wcs.cc.

                                       {
        
    int x0 = 0;                         // Our value of X0
    int y0 = 0;                         // Our value of Y0
    
    try {
        //
        // Only use WCS if CRPIX[12] == 1 and CRVAL[12] is present
        //
        if (metadata->getAsDouble("CRPIX1" + wcsName) == 1 &&
            metadata->getAsDouble("CRPIX2" + wcsName) == 1) {
            
            x0 = metadata->getAsInt("CRVAL1" + wcsName);
            y0 = metadata->getAsInt("CRVAL2" + wcsName);
            //
            // OK, we've got it.  Remove it from the header
            //
            metadata->remove("CRVAL1" + wcsName);
            metadata->remove("CRVAL2" + wcsName);
            metadata->remove("CRPIX1" + wcsName);
            metadata->remove("CRPIX2" + wcsName);
            metadata->remove("CTYPE1" + wcsName);
            metadata->remove("CTYPE1" + wcsName);
            metadata->remove("CUNIT1" + wcsName);
            metadata->remove("CUNIT2" + wcsName);
        }
    } catch(lsst::pex::exceptions::NotFoundError &) {
        ;                               // OK, not present
    }

    return afwGeom::Point2I(x0, y0);
}

int lsst::afw::image::detail::stripCalibKeywords

(

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

metadata

)

Remove Calib-related keywords from the metadata

Returns

Number of keywords stripped

Parameters

metadata

Metadata to be stripped

Definition at line 159 of file Calib.cc.

{
    int nstripped = 0;

    std::string key = "TIME-MID";
    if (metadata->exists(key)) {
        metadata->remove(key);
        nstripped++;
    }

    key = "EXPTIME";
    if (metadata->exists(key)) {
        metadata->remove(key);
        nstripped++;
    }

    key = "FLUXMAG0";
    if (metadata->exists(key)) {
        metadata->remove(key);
        nstripped++;
    }
        
    key = "FLUXMAG0ERR";
    if (metadata->exists(key)) {
        metadata->remove(key);
        nstripped++;
    }

    return nstripped;
}

int lsst::afw::image::detail::stripFilterKeywords

(

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

metadata

)

Remove Filter-related keywords from the metadata

Returns

Number of keywords stripped

Parameters

metadata

Metadata to be stripped

Definition at line 167 of file Filter.cc.

{
    int nstripped = 0;

    std::string key = "FILTER";
    if (metadata->exists(key)) {
        metadata->remove(key);
        nstripped++;
    }

    return nstripped;
}

int lsst::afw::image::detail::stripWcsKeywords	(	boost::shared_ptr< lsst::daf::base::PropertySet > const &	metadata,
		boost::shared_ptr< Wcs const > const &	wcs
	)

Strip keywords from the input metadata that are related to the generated Wcs

It isn't entirely obvious that this is enough — e.g. if the input metadata has deprecated WCS keywords such as CDELT[12] they won't be stripped. Well, actually we catch CDELT[12], LTV[12], and PC00[12]00[12] but there may be others

Parameters

metadata	Metadata to be stripped
wcs	A Wcs with (implied) keywords

Definition at line 1253 of file Wcs.cc.

{
    PTR(lsst::daf::base::PropertySet) wcsMetadata = wcs->getFitsMetadata();
    std::vector<std::string> paramNames = wcsMetadata->paramNames();
    paramNames.push_back("CDELT1");
    paramNames.push_back("CDELT2");
    paramNames.push_back("LTV1");
    paramNames.push_back("LTV2");
    paramNames.push_back("PC001001");
    paramNames.push_back("PC001002");
    paramNames.push_back("PC002001");
    paramNames.push_back("PC002002");
    for (std::vector<std::string>::const_iterator ptr = paramNames.begin(); ptr != paramNames.end(); ++ptr) {
        metadata->remove(*ptr);
    }

    return 0;                           // would be ncard if remove returned a status
}

Variable Documentation

std::string const lsst::afw::image::detail::compressedFileNoMEF_RE = "(\\.gz)$"

be written as MEFs

regexp to identify when MaskedImages should

Definition at line 59 of file MaskedImage.h.

std::string const lsst::afw::image::detail::fitsFile_RE = "\\.fits(\\.[fg]z)?$"

Definition at line 57 of file MaskedImage.h.

std::string const lsst::afw::image::detail::wcsNameForXY0 = "A"

Definition at line 82 of file Image.h.