TECA
The Toolkit for Extreme Climate Analysis
teca_bayesian_ar_detect_parameters.h
1 #ifndef teca_bayesian_ar_detect_parameters_h
2 #define teca_bayesian_ar_detect_parameters_h
3 
4 #include "teca_algorithm.h"
5 
6 TECA_SHARED_OBJECT_FORWARD_DECL(teca_bayesian_ar_detect_parameters)
7 
8 /** @brief
9  * An algorithm that constructs and serves up the parameter
10  * table needed to run the Bayesian AR detector.
11  */
13 {
14 public:
15  TECA_ALGORITHM_STATIC_NEW(teca_bayesian_ar_detect_parameters)
16  TECA_ALGORITHM_DELETE_COPY_ASSIGN(teca_bayesian_ar_detect_parameters)
17  TECA_ALGORITHM_CLASS_NAME(teca_bayesian_ar_detect_parameters)
19 
20  // report/initialize to/from Boost program options
21  // objects.
22  TECA_GET_ALGORITHM_PROPERTIES_DESCRIPTION()
23  TECA_SET_ALGORITHM_PROPERTIES()
24 
25  /** @name number_of_rows
26  * control the number of rows copied into the table. The rows are copied
27  * in sequential order starting from row zero. The default value of -1 is
28  * used to serve all rows. See also get_parameter_table_size.
29  */
30  ///@{
31  TECA_ALGORITHM_PROPERTY(long, number_of_rows)
32  ///@}
33 
34  /// return the number of rows in the internal parameter table.
35  unsigned long get_parameter_table_size();
36 
37 protected:
39 
40 private:
41  teca_metadata get_output_metadata(unsigned int port,
42  const std::vector<teca_metadata> &input_md) override;
43 
44  const_p_teca_dataset execute(unsigned int port,
45  const std::vector<const_p_teca_dataset> &input_data,
46  const teca_metadata &request) override;
47 
48  void set_modified() override;
49 
50 private:
51  long number_of_rows;
52 
53  struct internals_t;
54  internals_t *internals;
55 };
56 
57 #endif
teca_metadata
A generic container for meta data in the form of name=value pairs.
Definition: teca_metadata.h:18
teca_bayesian_ar_detect_parameters
An algorithm that constructs and serves up the parameter table needed to run the Bayesian AR detector...
Definition: teca_bayesian_ar_detect_parameters.h:12
teca_algorithm
The interface to TECA pipeline architecture.
Definition: teca_algorithm.h:237