Filter.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/>.
 */
 
//
//##====----------------                                ----------------====##/
//
//         Class encapsulating an identifier for an LSST filter.
//
//##====----------------                                ----------------====##/
 
#ifndef LSST_AFW_IMAGE_FILTER_H
#define LSST_AFW_IMAGE_FILTER_H
 
#include <cmath>
#include <string>
#include <unordered_map>
#include <vector>
#include <memory>
#include "lsst/base.h"
#include "lsst/daf/base/PropertySet.h"
#include "lsst/afw/typehandling/Storable.h"
 
namespace lsst {
namespace afw {
namespace image {
 
class[
        [deprecated("Removed with no replacement (but see lsst::afw::image::TransmissionCurve). Will be "
                    "removed after v22.")]] FilterProperty final {
public:
    explicit FilterProperty(std::string const& name, double lambdaEff, double lambdaMin = NAN,
                            double lambdaMax = NAN, bool force = false)
            : _name(name), _lambdaEff(lambdaEff), _lambdaMin(lambdaMin), _lambdaMax(lambdaMax) {
        _insert(force);
    }
    explicit FilterProperty(std::string const& name,
                            lsst::daf::base::PropertySet const& prop = lsst::daf::base::PropertySet(),
                            bool force = false);
 
    FilterProperty(FilterProperty const&) = default;
    FilterProperty(FilterProperty &&) noexcept = default;
    FilterProperty& operator=(FilterProperty const&) = default;
    FilterProperty& operator=(FilterProperty&&) noexcept = default;
    ~FilterProperty() noexcept = default;
 
    std::string const& getName() const noexcept { return _name; }
    double getLambdaEff() const noexcept { return _lambdaEff; }
    double getLambdaMin() const noexcept { return _lambdaMin; }
    double getLambdaMax() const noexcept { return _lambdaMax; }
    bool operator==(FilterProperty const& rhs) const noexcept;
    bool operator!=(FilterProperty const& rhs  
                    ) const noexcept {
        return !(*this == rhs);
    }
    std::size_t hash_value() const noexcept;
    static void reset() { _initRegistry(); }
 
    static FilterProperty const& lookup(std::string const& name);
 
private:
    using PropertyMap = std::unordered_map<std::string, FilterProperty>;
 
    static void _initRegistry();
    void _insert(bool force = false);
 
    std::string _name;  // name of filter
    double _lambdaEff;  // effective wavelength (nm)
    double _lambdaMin;  // minimum wavelength (nm)
    double _lambdaMax;  // maximum wavelength (nm)
 
    static PropertyMap* _propertyMap;  // mapping from name -> FilterProperty
};
 
class[[deprecated("Replaced with FilterLabel. Will be removed after v22.")]] Filter final
        : public typehandling::Storable {
public:
    static int const AUTO;
    static int const UNKNOWN;
 
    explicit Filter(std::string const& name,  
                    bool const force = false  
                    )
            : _id(_lookup(name, force)), _name(name) {}
    explicit Filter(int id = UNKNOWN  
                    )
            : _id(id), _name(_lookup(id)) {}
    explicit Filter(std::shared_ptr<lsst::daf::base::PropertySet const> metadata, bool const force = false);
 
    Filter(Filter const&) = default;
    Filter(Filter &&) noexcept = default;
    Filter& operator=(Filter const&) = default;
    Filter& operator=(Filter&&) noexcept = default;
    ~Filter() noexcept = default;
 
    bool operator==(Filter const& rhs) const noexcept;
    bool operator!=(Filter const& rhs) const noexcept { return !(*this == rhs); }
 
    std::size_t hash_value() const noexcept override;
 
    int getId() const noexcept { return _id; }
    std::string const& getName() const noexcept { return _name; }
    std::string const& getCanonicalName() const { return _lookup(_id); }
    std::vector<std::string> getAliases() const;
 
    FilterProperty const& getFilterProperty() const;
    static void reset() { _initRegistry(); }
    static int define(FilterProperty const& filterProperty, int id = AUTO, bool force = false);
    static int defineAlias(std::string const& oldName, std::string const& newName, bool force = false);
 
    static std::vector<std::string> getNames();
 
    std::shared_ptr<typehandling::Storable> cloneStorable() const override;
 
    bool equals(typehandling::Storable const& other) const noexcept override;
 
    bool isPersistable() const noexcept override;
 
protected:
    std::string getPersistenceName() const override;
    std::string getPythonModule() const override;
    void write(OutputArchiveHandle & handle) const override;
 
private:
    using AliasMap = std::unordered_map<std::string, const std::string>;
    using NameMap = std::unordered_map<std::string, const unsigned int>;
    using IdMap = std::unordered_map<unsigned int, const std::string>;
 
    static void _initRegistry();
    static int _lookup(std::string const& name, bool const force = false);
    static std::string const& _lookup(int id);
 
    int _id;
    std::string _name;
 
    static int _id0;             // next Id to use
    static AliasMap* _aliasMap;  // mapping from alias -> name
    static IdMap* _idMap;        // mapping from id -> name
    static NameMap* _nameMap;    // mapping from name -> id
};
 
namespace detail {
int stripFilterKeywords(std::shared_ptr<lsst::daf::base::PropertySet> metadata);
}  // namespace detail
}  // namespace image
}  // namespace afw
}  // namespace lsst
 
namespace std {
template <>
struct hash<lsst::afw::image::FilterProperty> {
    using argument_type = lsst::afw::image::FilterProperty;
    using result_type = size_t;
    size_t operator()(argument_type const& obj) const noexcept { return obj.hash_value(); }
};
 
template <>
struct hash<lsst::afw::image::Filter> {
    using argument_type = lsst::afw::image::Filter;
    using result_type = size_t;
    size_t operator()(argument_type const& obj) const noexcept { return obj.hash_value(); }
};
}  // namespace std
 
#endif  // LSST_AFW_IMAGE_FILTER_H