TECA
The Toolkit for Extreme Climate Analysis
teca_tc_trajectory Class Reference

GFDL tropical storms trajectory tracking algorithm. More...

#include <teca_tc_trajectory.h>

Inheritance diagram for teca_tc_trajectory:
Collaboration diagram for teca_tc_trajectory:

Public Member Functions

std::shared_ptr< teca_tc_trajectoryshared_from_this ()
 
std::shared_ptr< teca_tc_trajectory const > shared_from_this () const
 
 teca_tc_trajectory (const teca_tc_trajectory &src)=delete
 
 teca_tc_trajectory (teca_tc_trajectory &&src)=delete
 
teca_tc_trajectoryoperator= (const teca_tc_trajectory &src)=delete
 
teca_tc_trajectoryoperator= (teca_tc_trajectory &&src)=delete
 
const char * get_class_name () const override
 
void set_max_daily_distance (const double &v)
 
const double & get_max_daily_distance () const
 
void set_min_wind_speed (const double &v)
 
const double & get_min_wind_speed () const
 
void set_min_wind_duration (const double &v)
 
const double & get_min_wind_duration () const
 
void set_step_interval (const unsigned long &v)
 
const unsigned long & get_step_interval () const
 
- 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 ()
 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 to_stream (std::ostream &s) const
 
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_trajectory New ()
 

Additional Inherited Members

- 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 &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)
 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_portget_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...
 
- Protected Attributes inherited from teca_algorithm
int verbose
 

Detailed Description

GFDL tropical storms trajectory tracking algorithm.

for more information see "Seasonal forecasting of tropical storms using coupled GCM integrations"

computes trajectories from table of detections. trajectories are stored in a table.

the trajectory computation makes use of the following paramteters:

max_daily_distance (1600 km) event must be within this distance on the following day to be considered as part of the trajectory.

min_wind_speed (17 m/s) 850 mb wind sped must be above this value.

min_wind_duration (2 days) criteria must be satisfied for this many days to be a candidate

Member Function Documentation

◆ get_class_name()

const char* teca_tc_trajectory::get_class_name ( ) const
inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_max_daily_distance()

const double& teca_tc_trajectory::get_max_daily_distance ( ) const
inline

Get the value of the max_daily_distance algorithm property

◆ get_min_wind_duration()

const double& teca_tc_trajectory::get_min_wind_duration ( ) const
inline

Get the value of the min_wind_duration algorithm property

◆ get_min_wind_speed()

const double& teca_tc_trajectory::get_min_wind_speed ( ) const
inline

Get the value of the min_wind_speed algorithm property

◆ get_step_interval()

const unsigned long& teca_tc_trajectory::get_step_interval ( ) const
inline

Get the value of the step_interval algorithm property

◆ New()

static p_teca_tc_trajectory teca_tc_trajectory::New ( )
inlinestatic

Returns an instance of teca_tc_trajectory

◆ set_max_daily_distance()

void teca_tc_trajectory::set_max_daily_distance ( const double &  v)
inline

Set the value of the max_daily_distance algorithm property

◆ set_min_wind_duration()

void teca_tc_trajectory::set_min_wind_duration ( const double &  v)
inline

Set the value of the min_wind_duration algorithm property

◆ set_min_wind_speed()

void teca_tc_trajectory::set_min_wind_speed ( const double &  v)
inline

Set the value of the min_wind_speed algorithm property

◆ set_step_interval()

void teca_tc_trajectory::set_step_interval ( const unsigned long &  v)
inline

Set the value of the step_interval algorithm property

◆ shared_from_this() [1/2]

std::shared_ptr< teca_tc_trajectory > teca_tc_trajectory::shared_from_this ( )
inline

Enables the static constructor

◆ shared_from_this() [2/2]

std::shared_ptr< teca_tc_trajectory const> teca_tc_trajectory::shared_from_this ( ) const
inline

Enables the static constructor


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