Threshold.h

Go to the documentation of this file.

/*
 * 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/>.
 */

#if !defined(LSST_DETECTION_THRESHOLD_H)
#define LSST_DETECTION_THRESHOLD_H

namespace lsst {
namespace afw {
namespace detection {

class Threshold {
public:
    enum ThresholdType {
        VALUE,               
        BITMASK,             
        STDEV,               
        VARIANCE,            
        PIXEL_STDEV          
    };

    Threshold(
        double const value,               
        ThresholdType const type = VALUE, 
        bool const polarity = true,       
        double const includeMultiplier = 1.0 
             ) : _value(value), _type(type), _polarity(polarity),
                 _includeMultiplier(includeMultiplier) {}

    ThresholdType getType() const { return _type; }

    static ThresholdType parseTypeString(std::string const & typeStr);
    static std::string getTypeString(ThresholdType const & type);

    double getValue(const double param = -1) const;

    template<typename ImageT>
    double getValue(ImageT const& image) const;

    bool getPolarity() const { return _polarity; }
    void setPolarity(bool const polarity 
                    ) { _polarity = polarity; }

    double getIncludeMultiplier() const { return _includeMultiplier; }
    void setIncludeMultiplier(double const includeMultiplier 
                             ) { _includeMultiplier = includeMultiplier; }

private:
    double _value;                      
    ThresholdType _type;                
    bool _polarity;                     
    double _includeMultiplier;          
};

// brief Factory method for creating Threshold objects
Threshold createThreshold(const double value,
                          const std::string type = "value",
                          const bool polarity = true);
}}}

#endif