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...
class	MaskDict
struct	MaskedImage_tag
	A traits class for MaskedImage. More...
struct	MaskedImagePixel_tag
	A class used to identify classes that represent MaskedImage pixels. More...
class	StorableMap
	A map of Storable supporting strongly-typed access. More...

Typedefs
using	MaskPlaneDict = std::map<std::string, int>

Functions
void	setVisitInfoMetadata (daf::base::PropertyList &metadata, VisitInfo const &visitInfo)
	Set FITS metadata from a VisitInfo.
int	stripVisitInfoKeywords (daf::base::PropertySet &metadata)
	Remove VisitInfo-related keywords from the metadata.

Variables
std::string const	wcsNameForXY0 = "A"
std::string const	fitsFile_RE = "\\.fits(\\.[fg]z)?$"
	regexp to identify when MaskedImages should be written as MEFs
std::string const	compressedFileNoMEF_RE = "(\\.gz)$"
	regexp to identify compressed files that we can't write MEFs to

Typedef Documentation

MaskPlaneDict

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

Definition at line 58 of file Mask.h.

Function Documentation

setVisitInfoMetadata()

void lsst::afw::image::detail::setVisitInfoMetadata	(	daf::base::PropertyList &	metadata,
		VisitInfo const &	visitInfo )

Set FITS metadata from a VisitInfo.

Parameters

[in,out]	metadata	FITS keyword metadata to set
[in]	visitInfo	instance of VisitInfo from which to set metadata

Definition at line 408 of file VisitInfo.cc.

                                                                                     {
    setDouble(metadata, "EXPTIME", visitInfo.getExposureTime(), "Exposure time (sec)");
    setDouble(metadata, "DARKTIME", visitInfo.getDarkTime(), "Time from CCD flush to readout (sec)");
    if (visitInfo.getDate().isValid()) {
        metadata.set("DATE-AVG", visitInfo.getDate().toString(::DateTime::TAI),
                     "TAI date at middle of observation");
        metadata.set("TIMESYS", "TAI");
    }
    setDouble(metadata, "MJD-AVG-UT1", visitInfo.getUt1(), "UT1 MJD date at ctr of obs");
    setAngle(metadata, "AVG-ERA", visitInfo.getEra(), "Earth rot ang at ctr of obs (deg)");
    auto boresightRaDec = visitInfo.getBoresightRaDec();
    setAngle(metadata, "BORE-RA", boresightRaDec[0], "ICRS RA (deg) at boresight");
    setAngle(metadata, "BORE-DEC", boresightRaDec[1], "ICRS Dec (deg) at boresight");
    auto boresightAzAlt = visitInfo.getBoresightAzAlt();
    setAngle(metadata, "BORE-AZ", boresightAzAlt[0], "Refr app topo az (deg) at bore");
    setAngle(metadata, "BORE-ALT", boresightAzAlt[1], "Refr app topo alt (deg) at bore");
    setDouble(metadata, "BORE-AIRMASS", visitInfo.getBoresightAirmass(), "Airmass at boresight");
    setAngle(metadata, "BORE-ROTANG", visitInfo.getBoresightRotAngle(), "Rotation angle (deg) at boresight");
    metadata.set("ROTTYPE", rotTypeStrFromEnum(visitInfo.getRotType()), "Type of rotation angle");
    auto observatory = visitInfo.getObservatory();
    setAngle(metadata, "OBS-LONG", observatory.getLongitude(), "Telescope longitude (+E, deg)");
    setAngle(metadata, "OBS-LAT", observatory.getLatitude(), "Telescope latitude (deg)");
    setDouble(metadata, "OBS-ELEV", observatory.getElevation(), "Telescope elevation (m)");
    auto weather = visitInfo.getWeather();
    setDouble(metadata, "AIRTEMP", weather.getAirTemperature(), "Outside air temperature (C)");
    setDouble(metadata, "AIRPRESS", weather.getAirPressure(), "Outdoor air pressure (P)");
    setDouble(metadata, "HUMIDITY", weather.getHumidity(), "Relative humidity (%)");
    setString(metadata, "INSTRUMENT", visitInfo.getInstrumentLabel(),
              "Short name of the instrument that took this data");
    if (visitInfo.getId() != 0) {
        metadata.set("IDNUM", visitInfo.getId(), "identifier of this full focal plane exposure");
    }
    setDouble(metadata, "FOCUSZ", visitInfo.getFocusZ(), "Defocal distance (mm)");
    setString(metadata, "OBSTYPE", visitInfo.getObservationType(), "Type of this observation");
    setString(metadata, "PROGRAM", visitInfo.getScienceProgram(),
              "observing program (survey or proposal) identifier");
    setString(metadata, "REASON", visitInfo.getObservationReason(),
              "reason this observation was taken, or its purpose");
    setString(metadata, "OBJECT", visitInfo.getObject(), "object of interest or field name");
    metadata.set("HAS-SIMULATED-CONTENT", visitInfo.getHasSimulatedContent(),
                 "Was any part of this observation simulated?");
}

stripVisitInfoKeywords()

int lsst::afw::image::detail::stripVisitInfoKeywords

(

daf::base::PropertySet &

metadata

)

Remove VisitInfo-related keywords from the metadata.

Parameters

[in,out]

metadata

FITS keyword metadata

Returns

Number of keywords stripped

Definition at line 389 of file VisitInfo.cc.

                                                         {
    int nstripped = 0;
 
    std::vector<std::string> keyList = {"EXPTIME",     "DARKTIME",    "DATE-AVG", "TIMESYS",
                                        "TIME-MID",    "MJD-AVG-UT1", "AVG-ERA",  "BORE-RA",
                                        "BORE-DEC",    "BORE-AZ",     "BORE-ALT", "BORE-AIRMASS",
                                        "BORE-ROTANG", "ROTTYPE",     "OBS-LONG", "OBS-LAT",
                                        "OBS-ELEV",    "AIRTEMP",     "AIRPRESS", "HUMIDITY",
                                        "INSTRUMENT",  "IDNUM",       "FOCUSZ",   "OBSTYPE",
                                        "PROGRAM",     "REASON",      "OBJECT",   "HAS-SIMULATED-CONTENT"};
    for (auto&& key : keyList) {
        if (metadata.exists(key)) {
            metadata.remove(key);
            nstripped++;
        }
    }
    return nstripped;
}

Variable Documentation

compressedFileNoMEF_RE

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

regexp to identify compressed files that we can't write MEFs to

Definition at line 58 of file MaskedImage.h.

fitsFile_RE

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

regexp to identify when MaskedImages should be written as MEFs

Definition at line 56 of file MaskedImage.h.

wcsNameForXY0

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

Definition at line 70 of file ImageBase.h.