Utils.h

Go to the documentation of this file.

// -*- lsst-c++ -*-

/*
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */

//
//##====----------------                                ----------------====##/
//
//        Formatting utilities
//
//##====----------------                                ----------------====##/

#ifndef LSST_AFW_FORMATTERS_UTILS_H
#define LSST_AFW_FORMATTERS_UTILS_H

#include <set>
#include <string>

#include "lsst/base.h"
#include "lsst/daf/base.h"

namespace lsst {
namespace daf {
namespace base {
class PropertySet;
}
namespace persistence {
class LogicalLocation;
}
}
namespace pex {
namespace policy {
class Policy;
}
}
namespace afw {
namespace formatters {

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

std::string const getItemName(std::shared_ptr<lsst::daf::base::PropertySet const> const& properties);

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

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

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

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

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);

std::string formatFitsProperties(lsst::daf::base::PropertySet const& prop);
std::string formatFitsProperties(lsst::daf::base::PropertyList const& prop,
                                 std::set<std::string> const& excludeNames = {});
int countFitsHeaderCards(lsst::daf::base::PropertySet const& prop);

}
}
}  // namespace lsst::afw::formatters

#endif  // LSST_AFW_FORMATTERS_UTILS_H