CASCADE BARD atmospheric river detector. More...
#include <teca_bayesian_ar_detect.h>
Inheritance diagram for teca_bayesian_ar_detect:
Classes | |
| struct | internals_t |
Public Member Functions | |
| std::shared_ptr< teca_bayesian_ar_detect > | shared_from_this () |
| std::shared_ptr< teca_bayesian_ar_detect const > | shared_from_this () const |
| teca_bayesian_ar_detect (const teca_bayesian_ar_detect &src)=delete | |
| teca_bayesian_ar_detect (teca_bayesian_ar_detect &&src)=delete | |
| teca_bayesian_ar_detect & | operator= (const teca_bayesian_ar_detect &src)=delete |
| teca_bayesian_ar_detect & | operator= (teca_bayesian_ar_detect &&src)=delete |
| const char * | get_class_name () const override |
| void | set_ivt_variable (const std::string &v) |
| const std::string & | get_ivt_variable () const |
| void | set_min_ivt_variable (const std::string &v) |
| const std::string & | get_min_ivt_variable () const |
| void | set_min_component_area_variable (const std::string &v) |
| const std::string & | get_min_component_area_variable () const |
| void | set_hwhm_latitude_variable (const std::string &v) |
| const std::string & | get_hwhm_latitude_variable () const |
| void | set_verbose (const int &v) |
| const int & | get_verbose () const |
| void | set_thread_pool_size (int n_threads) |
| unsigned int | get_thread_pool_size () const noexcept |
| void | set_input_connection (unsigned int id, const teca_algorithm_output_port &port) override |
 Public Member Functions inherited from teca_algorithm | |
| teca_algorithm (const teca_algorithm &src)=delete | |
| teca_algorithm (teca_algorithm &&src)=delete | |
| teca_algorithm & | operator= (const teca_algorithm &src)=delete |
| teca_algorithm & | operator= (teca_algorithm &&src)=delete |
| void | set_communicator (MPI_Comm comm) |
| MPI_Comm | get_communicator () |
| virtual teca_algorithm_output_port | get_output_port (unsigned int port=0) |
| void | set_input_connection (const teca_algorithm_output_port &port) |
| virtual void | remove_input_connection (unsigned int id) |
| void | clear_input_connections () |
| const_p_teca_dataset | get_output_data (unsigned int port=0) |
| void | pop_cache (unsigned int port=0, int top=0) |
| void | set_cache_size (unsigned int n) |
| virtual int | update () |
| virtual int | update (unsigned int port) |
| virtual teca_metadata | update_metadata (unsigned int port=0) |
| void | set_executive (p_teca_algorithm_executive exe) |
| p_teca_algorithm_executive | get_executive () |
| virtual void | to_stream (std::ostream &s) const |
| virtual void | from_stream (std::istream &s) |
Static Public Member Functions | |
| static p_teca_bayesian_ar_detect | New () |
Protected Member Functions | |
| std::string | get_label_variable (const teca_metadata &request) |
| Protected Member Functions inherited from teca_algorithm | |
| void | set_number_of_input_connections (unsigned int n) |
| void | set_number_of_output_ports (unsigned int n) |
| void | set_modified (unsigned int port) |
| virtual teca_metadata | get_cache_key (unsigned int port, const teca_metadata &request) const |
| virtual teca_metadata | get_output_metadata (teca_algorithm_output_port ¤t) |
| virtual const_p_teca_dataset | request_data (teca_algorithm_output_port &port, const teca_metadata &request) |
| virtual int | validate_cache (teca_algorithm_output_port ¤t) |
| virtual void | clear_modified (teca_algorithm_output_port current) |
| const_p_teca_dataset | get_output_data (unsigned int port, const teca_metadata &request) |
| int | cache_output_data (unsigned int port, const teca_metadata &request, const_p_teca_dataset &data) |
| void | clear_cache (unsigned int port) |
| unsigned int | get_number_of_input_connections () |
| teca_algorithm_output_port & | get_input_connection (unsigned int i) |
| void | clear_modified (unsigned int port) |
| int | get_modified (unsigned int port) const |
Detailed Description
CASCADE BARD atmospheric river detector.
Given a point wise IVT (integrated vapor transport) field and a training parameter table computes the point wise probability of an atmospheric river using the CASCADE BARD algorithm.
Required inputs:
1. IVT (integrated vapor transport) array on a Cartesian nesh. 2. a compatible parameter table. columns of which are : min IVT, component area, HWHM lattitude
The names of the input varibale and columns can be specified at run time through algorithm properties.
Produces:
A Cartesian mesh with probability of an AR stored in the point centered array named "ar_probability". The diagnostic quantites "ar_count" amd "parameter_table_row" are stored in information arrays.
For more information see:
Detection of Atmospheric Rivers with Inline Uncertainty Quantification: TECA-BARD v1.0 O'Brien, T. A et al. Geoscientific Model Development, 2020
The documentation for this class was generated from the following files:
- TECA/alg/teca_bayesian_ar_detect.h
- TECA/alg/teca_bayesian_ar_detect.cxx
