TECA
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
teca_ar_detect Class Reference

#include <teca_ar_detect.h>

Inheritance diagram for teca_ar_detect:
teca_algorithm

Public Member Functions

std::shared_ptr< teca_ar_detectshared_from_this ()
 
std::shared_ptr< teca_ar_detect const > shared_from_this () const
 
 teca_ar_detect (const teca_ar_detect &src)=delete
 
 teca_ar_detect (teca_ar_detect &&src)=delete
 
teca_ar_detectoperator= (const teca_ar_detect &src)=delete
 
teca_ar_detectoperator= (teca_ar_detect &&src)=delete
 
const char * get_class_name () const override
 
void set_water_vapor_variable (const std::string &v)
 
const std::string & get_water_vapor_variable () const
 
void set_low_water_vapor_threshold (const double &v)
 
const double & get_low_water_vapor_threshold () const
 
void set_high_water_vapor_threshold (const double &v)
 
const double & get_high_water_vapor_threshold () const
 
void set_search_lat_low (const double &v)
 
const double & get_search_lat_low () const
 
void set_search_lon_low (const double &v)
 
const double & get_search_lon_low () const
 
void set_search_lat_high (const double &v)
 
const double & get_search_lat_high () const
 
void set_search_lon_high (const double &v)
 
const double & get_search_lon_high () const
 
void set_river_start_lat_low (const double &v)
 
const double & get_river_start_lat_low () const
 
void set_river_start_lon_low (const double &v)
 
const double & get_river_start_lon_low () const
 
void set_river_end_lat_low (const double &v)
 
const double & get_river_end_lat_low () const
 
void set_river_end_lon_low (const double &v)
 
const double & get_river_end_lon_low () const
 
void set_river_end_lat_high (const double &v)
 
const double & get_river_end_lat_high () const
 
void set_river_end_lon_high (const double &v)
 
const double & get_river_end_lon_high () const
 
void set_percent_in_mesh (const double &v)
 
const double & get_percent_in_mesh () const
 
void set_river_width (const double &v)
 
const double & get_river_width () const
 
void set_river_length (const double &v)
 
const double & get_river_length () const
 
void set_land_sea_mask_variable (const std::string &v)
 
const std::string & get_land_sea_mask_variable () const
 
void set_land_threshold_low (const double &v)
 
const double & get_land_threshold_low () const
 
void set_land_threshold_high (const double &v)
 
const double & get_land_threshold_high () const
 
virtual void to_stream (std::ostream &os) const override
 
- Public Member Functions inherited from teca_algorithm
 teca_algorithm (const teca_algorithm &src)=delete
 
 teca_algorithm (teca_algorithm &&src)=delete
 
teca_algorithmoperator= (const teca_algorithm &src)=delete
 
teca_algorithmoperator= (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 set_input_connection (unsigned int id, 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 from_stream (std::istream &s)
 

Static Public Member Functions

static p_teca_ar_detect New ()
 

Protected Member Functions

int get_active_extent (p_teca_variant_array lat, p_teca_variant_array lon, std::vector< unsigned long > &extent) const
 
- 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)
 
virtual void set_modified ()
 
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 &current)
 
virtual const_p_teca_dataset request_data (teca_algorithm_output_port &port, const teca_metadata &request)
 
virtual int validate_cache (teca_algorithm_output_port &current)
 
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

Suren and Junmin's atmospheric river detector.

The algorithm searches for atmospheric rivers that end on the California coast in water vapor data over a specific subset of the input data. A river is detected based on it's length, width, and percent area of the search space. The algorithm can optionally use a land-sea mask to increase accuracy of the California coast. Without the land-sea mask a box is used.


The documentation for this class was generated from the following files: