TECA
teca_valid_value_mask.h
1 #ifndef teca_valid_value_mask_h
2 #define teca_valid_value_mask_h
3 
4 #include "teca_shared_object.h"
5 #include "teca_algorithm.h"
6 #include "teca_metadata.h"
7 
8 #include <string>
9 #include <vector>
10 
11 TECA_SHARED_OBJECT_FORWARD_DECL(teca_valid_value_mask)
12 
13 
39 {
40 public:
41  TECA_ALGORITHM_STATIC_NEW(teca_valid_value_mask)
42  TECA_ALGORITHM_DELETE_COPY_ASSIGN(teca_valid_value_mask)
43  TECA_ALGORITHM_CLASS_NAME(teca_valid_value_mask)
45 
46  // report/initialize to/from Boost program options
47  // objects.
48  TECA_GET_ALGORITHM_PROPERTIES_DESCRIPTION()
49  TECA_SET_ALGORITHM_PROPERTIES()
50 
51 
57  TECA_ALGORITHM_VECTOR_PROPERTY(std::string, mask_array)
60 
66  TECA_ALGORITHM_PROPERTY(int, enable_valid_range)
69 
75  TECA_ALGORITHM_PROPERTY(int, verbose)
78 
79 protected:
81 
82 private:
83  teca_metadata get_output_metadata(unsigned int port,
84  const std::vector<teca_metadata> &input_md) override;
85 
86  std::vector<teca_metadata> get_upstream_request(
87  unsigned int port, const std::vector<teca_metadata> &input_md,
88  const teca_metadata &request) override;
89 
90  const_p_teca_dataset execute(unsigned int port,
91  const std::vector<const_p_teca_dataset> &input_data,
92  const teca_metadata &request) override;
93 
94 private:
95  std::vector<std::string> mask_arrays;
96  int enable_valid_range;
97  int verbose;
98 };
99 
100 #endif
teca_metadata
Definition: teca_metadata.h:17
teca_valid_value_mask
an algorithm that computes a mask identifying valid values
Definition: teca_valid_value_mask.h:39
teca_algorithm
Definition: teca_algorithm.h:25