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