ApCorrMap.h

Go to the documentation of this file.

// -*- LSST-C++ -*-
/*
 * LSST Data Management System
 * Copyright 2008-2014 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/>.
 */
 
#ifndef LSST_AFW_IMAGE_ApCorrMap_h_INCLUDED
#define LSST_AFW_IMAGE_ApCorrMap_h_INCLUDED
 
#include <string>
#include <map>
 
#include "lsst/afw/table/io/Persistable.h"
#include "lsst/afw/typehandling/Storable.h"
#include "lsst/afw/math/BoundedField.h"
 
namespace lsst {
namespace afw {
namespace image {

class ApCorrMap final : public table::io::PersistableFacade<ApCorrMap>, public typehandling::Storable {
    using Internal = std::map<std::string, std::shared_ptr<math::BoundedField>>;
 
public:
    static std::size_t const MAX_NAME_LENGTH = 64;

    using Iterator = Internal::const_iterator;
 
    ApCorrMap() = default;
    ApCorrMap(ApCorrMap const&) = default;
    ApCorrMap(ApCorrMap&&) = default;
    ApCorrMap& operator=(ApCorrMap const&) = default;
    ApCorrMap& operator=(ApCorrMap&&) = default;
    ~ApCorrMap() override = default;
 
    Iterator begin() const { return _internal.begin(); }
    Iterator end() const { return _internal.end(); }
 
    std::size_t size() const { return _internal.size(); }

    std::shared_ptr<math::BoundedField> const operator[](std::string const& name) const;

    std::shared_ptr<math::BoundedField> const get(std::string const& name) const;

    void set(std::string const& name, std::shared_ptr<math::BoundedField> field);

    bool isPersistable() const noexcept override;

    ApCorrMap& operator*=(double const scale);
    ApCorrMap& operator/=(double const scale) { return *this *= 1.0 / scale; }

    std::shared_ptr<typehandling::Storable> cloneStorable() const override;
 
private:
    std::string getPersistenceName() const override;
 
    std::string getPythonModule() const override;
 
    void write(OutputArchiveHandle& handle) const override;
 
    Internal _internal;
};
}  // namespace image
}  // namespace afw
}  // namespace lsst
 
#endif  // !LSST_AFW_IMAGE_ApCorrMap_h_INCLUDED