teca_binary_segmentation.h

#ifndef teca_binary_segmentation_h
#define teca_binary_segmentation_h
 
#include "teca_shared_object.h"
#include "teca_algorithm.h"
#include "teca_metadata.h"
 
#include <string>
#include <vector>
 
TECA_SHARED_OBJECT_FORWARD_DECL(teca_binary_segmentation)
 
 
class teca_binary_segmentation : public teca_algorithm
{
public:
    TECA_ALGORITHM_STATIC_NEW(teca_binary_segmentation)
    TECA_ALGORITHM_DELETE_COPY_ASSIGN(teca_binary_segmentation)
    TECA_ALGORITHM_CLASS_NAME(teca_binary_segmentation)
    ~teca_binary_segmentation();
 
    // set the name of the output array to store the resulting segmentation in
    TECA_ALGORITHM_PROPERTY(std::string, segmentation_variable)
 
    // set extra metadata for the segmentation variable
    TECA_ALGORITHM_PROPERTY(teca_metadata, segmentation_variable_attributes)
 
    // set the name of the input array to segment
    TECA_ALGORITHM_PROPERTY(std::string, threshold_variable)
 
    // Set the threshold range. The defaults are (-infinity, infinity].
    TECA_ALGORITHM_PROPERTY(double, low_threshold_value)
    TECA_ALGORITHM_PROPERTY(double, high_threshold_value)
 
    // Set the threshold mode. In BY_PERCENTILE mode low and high thresholds
    // define the percentiles (0 to 100) between which data is in the
    // segmentation. default is BY_VALUE.
    enum {BY_VALUE=0, BY_PERCENTILE=1};
    TECA_ALGORITHM_PROPERTY(int, threshold_mode);
 
    void set_threshold_by_percentile() { set_threshold_mode(BY_PERCENTILE); }
    void set_threshold_by_value() { set_threshold_mode(BY_VALUE); }
 
protected:
    teca_binary_segmentation();
 
    int get_segmentation_variable(std::string &segmentation_var);
    int get_threshold_variable(std::string &threshold_var);
 
private:
    teca_metadata get_output_metadata(unsigned int port,
        const std::vector<teca_metadata> &input_md) override;
 
    std::vector<teca_metadata> get_upstream_request(
        unsigned int port, const std::vector<teca_metadata> &input_md,
        const teca_metadata &request) override;
 
    const_p_teca_dataset execute(unsigned int port,
        const std::vector<const_p_teca_dataset> &input_data,
        const teca_metadata &request) override;
 
private:
    std::string segmentation_variable;
    teca_metadata segmentation_variable_attributes;
    std::string threshold_variable;
    double low_threshold_value;
    double high_threshold_value;
    int threshold_mode;
};
 
#endif