lsst::ap::match Namespace Reference

Namespaces
	config
	detail

Classes
class	BBox
struct	CatalogControl
class	ExposureInfo
class	ExposureInfoMap
class	ReferencePosition

Functions
void	readExposureInfos (std::vector< ExposureInfo::Ptr > &exposures, std::string const &csvFile, CsvControl const &control, std::string const &idColumn)
void	referenceMatch (std::string const &refFile, CatalogControl const &refControl, CsvControl const &refDialect, std::string const &posFile, CatalogControl const &posControl, CsvControl const &posDialect, std::string const &outFile, CsvControl const &outDialect, lsst::afw::geom::Angle const radius, lsst::afw::geom::Angle const parallaxThresh, bool outputRefExtras, bool truncateOutFile)
void	referenceFilter (std::vector< ExposureInfo::Ptr > &exposures, std::string const &refFile, CatalogControl const &refControl, CsvControl const &refDialect, std::string const &outFile, CsvControl const &outDialect, lsst::afw::geom::Angle const parallaxThresh, bool truncateOutFile)

Function Documentation

void lsst::ap::match::readExposureInfos	(	std::vector< ExposureInfo::Ptr > &	exposures,
		std::string const &	csvFile,
		lsst::ap::utils::CsvControl const &	control,
		std::string const &	idColumn
	)

Reads an exposure metadata key-value CSV file (where metadata keys must have been grouped by exposure id). An ExposureInfo object is created for each input exposure and appended to exposures.

Parameters

[in,out]	exposures	ExposureInfo objects are appended to this vector.
[in]	csvFile	Metadata table path.
[in]	control	Metadata table CSV format.
[in]	idColumn	Name of ID column, e.g. "scienceCcdExposureId".

Definition at line 307 of file ExposureInfo.cc.

  {
    typedef std::tr1::unordered_map<std::string, int> FkMap;
    typedef FkMap::const_iterator FkIter;

    static boost::regex const sipRegex("^[AB]P?_[0-9]+_[0-9]+$");

    Log log(Log::getDefaultLog(), "lsst.ap.match");
    log.log(Log::INFO, "Reading exposure metadata from " + csvFile);

    FkMap const & fkMap = fitsKeyMap();
    // open CSV file and get column indexes
    CsvReader reader(csvFile, control, true);
    int const idCol = reader.getIndexOf(idColumn);
    int const keyCol = reader.getIndexOf("metadataKey");
    int const intCol = reader.getIndexOf("intValue");
    int const doubleCol = reader.getIndexOf("doubleValue");
    int const stringCol = reader.getIndexOf("stringValue");
    if (idCol == -1) {
        throw LSST_EXCEPT(RuntimeError, "Exposure metadata table "
                          "has no column named " + idColumn);
    }
    if (keyCol == -1) {
        throw LSST_EXCEPT(RuntimeError, "Exposure metadata table "
                          "has no column named metadataKey");
    }
    if (intCol == -1) {
        throw LSST_EXCEPT(RuntimeError, "Exposure metadata table "
                          "has no column named intValue");
    }
    if (doubleCol == -1) {
        throw LSST_EXCEPT(RuntimeError, "Exposure metadata table "
                          "has no column named doubleValue");
    }
    if (stringCol == -1) {
        throw LSST_EXCEPT(RuntimeError, "Exposure metadata table "
                          "has no column named stringValue");
    }
    PropertySet::Ptr ps;
    int64_t lastId = reader.get<int64_t>(idCol) - 1;
    for (; !reader.isDone(); reader.nextRecord()) {
        int64_t id = reader.get<int64_t>(idCol);
        if (id != lastId) {
            if (ps) {
                exposures.push_back(ExposureInfo::Ptr(
                    new ExposureInfo(ps, lastId)));
            }
            ps.reset(new PropertySet());
            lastId = id;
        }
        std::string const key = reader.get(keyCol);
        FkIter k = fkMap.find(key);
        if (k != fkMap.end()) {
            if (k->second == INT_T) { // integer-valued key
                ps->set(key, reader.get<int>(intCol));
            } else if (k->second == DOUBLE_T) { // double-valued key
                ps->set(key, reader.get<double>(doubleCol));
            } else { // string-valued key
                ps->set(key, reader.get(stringCol));
            }
        } else if (boost::regex_search(key.begin(), key.end(), sipRegex)) {
            // key is a SIP coefficient
            ps->set(key, reader.get<double>(doubleCol));
        }
    }
    if (ps) {
        exposures.push_back(ExposureInfo::Ptr(
            new ExposureInfo(ps, lastId)));
    }
}

void lsst::ap::match::referenceFilter	(	std::vector< ExposureInfo::Ptr > &	exposures,
		std::string const &	refFile,
		CatalogControl const &	refControl,
		lsst::ap::utils::CsvControl const &	refDialect,
		std::string const &	outFile,
		lsst::ap::utils::CsvControl const &	outDialect,
		lsst::afw::geom::Angle const	parallaxThresh = 0.01 *lsst::afw::geom::arcseconds,
		bool	truncateOutFile = false
	)

Computes the number of times a reference catalog should have been observed in each filter with an ideal observatory, given a set of exposures. The per-filter observation counts are appended as columns "<filter>Cov", in order of filter ID. Note that filter IDs are required to be contiguous integers 0, 1, .... N - 1.

Reference catalog entries not falling on any of the given exposures are dropped from the output.

Note that a reduction for parallax from barycentric to geocentric place is applied to reference catalog entries with parallax above parallaxThresh. To disable this reduction, use a large threshold (e.g. +Inf).

Parameters

[in]	exposures	Exposures to filter against - reordered by the call.
[in]	refFile	Declination sorted reference catalog CSV file name.
[in]	refControl	CSV dialect of reference catalog CSV file.
[in]	refDialect	CSV dialect of reference catalog CSV file.
[in]	outFile	Output file name.
[in]	outDialect	Output file CSV dialect.
[in]	parallaxThresh	Parallax threshold
[in]	truncateOutFile	Truncate outFile before appending to it?

Definition at line 1671 of file ReferenceMatch.cc.

  {
    typedef std::vector<ExposureInfo::Ptr>::const_iterator Iter;
    if (exposures.empty()) {
        throw LSST_EXCEPT(pexExcept::InvalidParameterError,
                          "no input exposure information");
    }
    checkFilters();

    Log log(Log::getDefaultLog(), "lsst.ap.match");
    log.log(Log::INFO, "Filtering out reference catalog entries not "
            "observable in any exposure...");

    // determine min/max epoch of exposures
    Iter i = exposures.begin();
    double minEpoch = (*i)->getEpoch();
    double maxEpoch = minEpoch;
    ++i;
    for (Iter e = exposures.end(); i != e; ++i) {
        double epoch = (*i)->getEpoch();
        if (epoch < minEpoch) {
            minEpoch = epoch;
        } else if (epoch > maxEpoch) {
            maxEpoch = epoch;
        }
    }
    log.format(Log::INFO, "Time range of exposures is [%.3f, %.3f] MJD",
               minEpoch, maxEpoch);

    // Create reader, writer and matcher
    RefReader<RefWithCov> refReader(
        refFile, refControl, refDialect, outDialect,
        minEpoch, maxEpoch, parallaxThresh);
    CsvWriter writer(outFile, outDialect, truncateOutFile);
    RefExpMatcher matcher;

    log.log(Log::INFO, "Starting reference catalog to exposure match");
    matcher.match(writer, refReader, exposures);
    log.format(Log::INFO, "Wrote %llu records to output match table %s",
               static_cast<unsigned long long>(writer.getNumRecords()),
               outFile.c_str());
}

void lsst::ap::match::referenceMatch	(	std::string const &	refFile,
		CatalogControl const &	refControl,
		lsst::ap::utils::CsvControl const &	refDialect,
		std::string const &	posFile,
		CatalogControl const &	posControl,
		lsst::ap::utils::CsvControl const &	posDialect,
		std::string const &	outFile,
		lsst::ap::utils::CsvControl const &	outDialect,
		lsst::afw::geom::Angle const	radius = 2.0 *lsst::afw::geom::arcseconds,
		lsst::afw::geom::Angle const	parallaxThresh = 0.01 *lsst::afw::geom::arcseconds,
		bool	outputRefExtras = true,
		bool	truncateOutFile = false
	)

Matches a declination sorted reference catalog (stored as a CSV file) to a table of positions.

Note that a reduction for parallax from barycentric to geocentric place is applied to reference catalog entries with parallax above parallaxThresh. To disable this reduction, use a large threshold (e.g. +Inf).

Parameters

[in]	refFile	Declination sorted reference catalog CSV file name.
[in]	refControl	Reference catalog CSV file properties.
[in]	refDialect	CSV dialect of reference catalog CSV file.
[in]	posFile	Declination sorted position CSV file name.
[in]	posControl	Position CSV file properties.
[in]	posDialect	CSV dialect of position CSV file.
[in]	outFile	Output file name.
[in]	outDialect	Output file CSV dialect.
[in]	radius	Match radius.
[in]	parallaxThresh	Parallax threshold.
[in]	outputRefExtras	Output proper-motion/parallax corrected reference object position and associated flags in match records?
[in]	truncateOutFile	Truncate outFile before appending to it?

Definition at line 1637 of file ReferenceMatch.cc.

  {
    Log log(Log::getDefaultLog(), "lsst.ap.match");
    log.log(Log::INFO, "Matching reference catalog to position table...");

    // Create readers, writer and matcher
    MatchablePosReader posReader(
        posFile, posControl, posDialect, outDialect, radius);
    RefReader<MatchableRef> refReader(
        refFile, refControl, refDialect, outDialect,
        posReader.getMinEpoch(), posReader.getMaxEpoch(), parallaxThresh);
    CsvWriter writer(outFile, outDialect, truncateOutFile);
    RefPosMatcher matcher(outputRefExtras);

    log.log(Log::INFO, "Starting reference catalog to position table match");
    matcher.match(writer, refReader, posReader);
    log.format(Log::INFO, "Wrote %llu records to output match table %s",
               static_cast<unsigned long long>(writer.getNumRecords()),
               outFile.c_str());
}