GFDL tropical storms detection algorithm. More...
#include <teca_tc_candidates.h>
Public Member Functions | |
| std::shared_ptr< teca_tc_candidates > | shared_from_this () |
| std::shared_ptr< teca_tc_candidates const > | shared_from_this () const |
| teca_tc_candidates (const teca_tc_candidates &src)=delete | |
| teca_tc_candidates (teca_tc_candidates &&src)=delete | |
| teca_tc_candidates & | operator= (const teca_tc_candidates &src)=delete |
| teca_tc_candidates & | operator= (teca_tc_candidates &&src)=delete |
| const char * | get_class_name () const override |
| void | set_surface_wind_speed_variable (const std::string &v) |
| const std::string & | get_surface_wind_speed_variable () const |
| void | set_vorticity_850mb_variable (const std::string &v) |
| const std::string & | get_vorticity_850mb_variable () const |
| void | set_sea_level_pressure_variable (const std::string &v) |
| const std::string & | get_sea_level_pressure_variable () const |
| void | set_core_temperature_variable (const std::string &v) |
| const std::string & | get_core_temperature_variable () const |
| void | set_thickness_variable (const std::string &v) |
| const std::string & | get_thickness_variable () const |
| void | set_max_core_radius (const double &v) |
| const double & | get_max_core_radius () const |
| void | set_min_vorticity_850mb (const double &v) |
| const double & | get_min_vorticity_850mb () const |
| void | set_vorticity_850mb_window (const double &v) |
| const double & | get_vorticity_850mb_window () const |
| void | set_max_pressure_delta (const double &v) |
| const double & | get_max_pressure_delta () const |
| void | set_max_pressure_radius (const double &v) |
| const double & | get_max_pressure_radius () const |
| void | set_max_core_temperature_delta (const double &v) |
| const double & | get_max_core_temperature_delta () const |
| void | set_max_core_temperature_radius (const double &v) |
| const double & | get_max_core_temperature_radius () const |
| void | set_max_thickness_delta (const double &v) |
| const double & | get_max_thickness_delta () const |
| void | set_max_thickness_radius (const double &v) |
| const double & | get_max_thickness_radius () const |
| void | set_search_lat_low (const double &v) |
| const double & | get_search_lat_low () const |
| void | set_search_lat_high (const double &v) |
| const double & | get_search_lat_high () const |
| void | set_search_lon_low (const double &v) |
| const double & | get_search_lon_low () const |
| void | set_search_lon_high (const double &v) |
| const double & | get_search_lon_high () const |
| void | set_minimizer_iterations (const int &v) |
| const int & | get_minimizer_iterations () 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_algorithm & | operator= (const teca_algorithm &src)=delete |
| teca_algorithm & | operator= (teca_algorithm &&src)=delete |
| void | set_communicator (MPI_Comm comm) |
| MPI_Comm | get_communicator () |
| get the active communicator More... | |
| virtual teca_algorithm_output_port | get_output_port (unsigned int port=0) |
| void | set_input_connection (const teca_algorithm_output_port &port) |
| set an input to this algorithm More... | |
| virtual void | set_input_connection (unsigned int id, const teca_algorithm_output_port &port) |
| set an input to this algorithm More... | |
| virtual void | remove_input_connection (unsigned int id) |
| remove input connections More... | |
| void | clear_input_connections () |
| remove all input connections More... | |
| 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) |
| set the cache size. the default is 1. (threadsafe) More... | |
| virtual int | update () |
| execute the pipeline from this instance up. More... | |
| virtual int | update (unsigned int port) |
| execute the pipeline from this instance up. More... | |
| virtual teca_metadata | update_metadata (unsigned int port=0) |
| get meta data considering this instance up. More... | |
| void | set_executive (p_teca_algorithm_executive exe) |
| set the executive More... | |
| p_teca_algorithm_executive | get_executive () |
| get the executive More... | |
| virtual void | from_stream (std::istream &s) |
| deserialize from the stream. More... | |
| void | set_verbose (const int &v) |
| const int & | get_verbose () const |
Static Public Member Functions | |
| static p_teca_tc_candidates | New () |
Protected Member Functions | |
| int | get_active_extent (const const_p_teca_variant_array &lat, const const_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) |
| an overload to set_modified by port More... | |
| 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) |
| clear the cache on the given output port More... | |
| unsigned int | get_number_of_input_connections () |
| get the number of input connections More... | |
| teca_algorithm_output_port & | get_input_connection (unsigned int i) |
| void | clear_modified (unsigned int port) |
| clear the modified flag on the i'th output More... | |
| int | get_modified (unsigned int port) const |
| return the output port's modified flag value More... | |
Additional Inherited Members | |
| Protected Attributes inherited from teca_algorithm | |
| int | verbose |
Detailed Description
GFDL tropical storms detection algorithm.
For more information see "Seasonal forecasting of tropical storms using coupled GCM integrations"
— INPUT Gwind - wind speed at 850 mb Gvort - vorticity_850mb at 850 mb Gtbar - mean core_temperature for warm core layer Gpsl - sea level sea_level_pressure Gthick - thickness of 200 to 1000 mb layer Grlon - longitudes Grlat - latitudes iyear - year imon - month iday - day of month ihour - hour iucy - unit for output
— OUTPUT — record # 1 num0 - day imon0 - month iyear - year number - number of cyclones found — records # 2...number+1 idex, jdex - (i,j) index of cyclone svort_max - max vorticity_850mb swind_max - max wind spsl_min - min sea level sea_level_pressure svort_lon, svort_lat - longitude & latitude of max vorticity_850mb spsl_lon, spsl_lat - longitude & latitude of min slp stemperature_lon, stemperature_lat - longitude & latitude of warm core sthick_lon, sthick_lat - longitude & latitude of max thickness
Member Function Documentation
◆ get_class_name()
|
inlineoverridevirtual |
returns the name of the class
Implements teca_algorithm.
◆ get_core_temperature_variable()
|
inline |
Get the value of the core_temperature_variable algorithm property
◆ get_max_core_radius()
|
inline |
Get the value of the max_core_radius algorithm property
◆ get_max_core_temperature_delta()
|
inline |
Get the value of the max_core_temperature_delta algorithm property
◆ get_max_core_temperature_radius()
|
inline |
Get the value of the max_core_temperature_radius algorithm property
◆ get_max_pressure_delta()
|
inline |
Get the value of the max_pressure_delta algorithm property
◆ get_max_pressure_radius()
|
inline |
Get the value of the max_pressure_radius algorithm property
◆ get_max_thickness_delta()
|
inline |
Get the value of the max_thickness_delta algorithm property
◆ get_max_thickness_radius()
|
inline |
Get the value of the max_thickness_radius algorithm property
◆ get_min_vorticity_850mb()
|
inline |
Get the value of the min_vorticity_850mb algorithm property
◆ get_minimizer_iterations()
|
inline |
Get the value of the minimizer_iterations algorithm property
◆ get_sea_level_pressure_variable()
|
inline |
Get the value of the sea_level_pressure_variable algorithm property
◆ get_search_lat_high()
|
inline |
Get the value of the search_lat_high algorithm property
◆ get_search_lat_low()
|
inline |
Get the value of the search_lat_low algorithm property
◆ get_search_lon_high()
|
inline |
Get the value of the search_lon_high algorithm property
◆ get_search_lon_low()
|
inline |
Get the value of the search_lon_low algorithm property
◆ get_surface_wind_speed_variable()
|
inline |
Get the value of the surface_wind_speed_variable algorithm property
◆ get_thickness_variable()
|
inline |
Get the value of the thickness_variable algorithm property
◆ get_vorticity_850mb_variable()
|
inline |
Get the value of the vorticity_850mb_variable algorithm property
◆ get_vorticity_850mb_window()
|
inline |
Get the value of the vorticity_850mb_window algorithm property
◆ New()
|
inlinestatic |
Returns an instance of teca_tc_candidates
◆ set_core_temperature_variable()
|
inline |
Set the value of the core_temperature_variable algorithm property
◆ set_max_core_radius()
|
inline |
Set the value of the max_core_radius algorithm property
◆ set_max_core_temperature_delta()
|
inline |
Set the value of the max_core_temperature_delta algorithm property
◆ set_max_core_temperature_radius()
|
inline |
Set the value of the max_core_temperature_radius algorithm property
◆ set_max_pressure_delta()
|
inline |
Set the value of the max_pressure_delta algorithm property
◆ set_max_pressure_radius()
|
inline |
Set the value of the max_pressure_radius algorithm property
◆ set_max_thickness_delta()
|
inline |
Set the value of the max_thickness_delta algorithm property
◆ set_max_thickness_radius()
|
inline |
Set the value of the max_thickness_radius algorithm property
◆ set_min_vorticity_850mb()
|
inline |
Set the value of the min_vorticity_850mb algorithm property
◆ set_minimizer_iterations()
|
inline |
Set the value of the minimizer_iterations algorithm property
◆ set_sea_level_pressure_variable()
|
inline |
Set the value of the sea_level_pressure_variable algorithm property
◆ set_search_lat_high()
|
inline |
Set the value of the search_lat_high algorithm property
◆ set_search_lat_low()
|
inline |
Set the value of the search_lat_low algorithm property
◆ set_search_lon_high()
|
inline |
Set the value of the search_lon_high algorithm property
◆ set_search_lon_low()
|
inline |
Set the value of the search_lon_low algorithm property
◆ set_surface_wind_speed_variable()
|
inline |
Set the value of the surface_wind_speed_variable algorithm property
◆ set_thickness_variable()
|
inline |
Set the value of the thickness_variable algorithm property
◆ set_vorticity_850mb_variable()
|
inline |
Set the value of the vorticity_850mb_variable algorithm property
◆ set_vorticity_850mb_window()
|
inline |
Set the value of the vorticity_850mb_window algorithm property
◆ shared_from_this() [1/2]
|
inline |
Enables the static constructor
◆ shared_from_this() [2/2]
|
inline |
Enables the static constructor
◆ to_stream()
|
overridevirtual |
serialize the configuration to a stream. this should store the public user modifiable properties so that runtime configuration may be saved and restored.
Reimplemented from teca_algorithm.
The documentation for this class was generated from the following file:
- stable/alg/teca_tc_candidates.h
