teca_tc_classify Class Reference

an algorithm that classifies storms using Saphire-Simpson scale More...

#include <teca_tc_classify.h>

Inheritance diagram for teca_tc_classify:

Collaboration diagram for teca_tc_classify:

Public Member Functions
std::shared_ptr< teca_tc_classify >	shared_from_this ()
std::shared_ptr< teca_tc_classify const >	shared_from_this () const
	teca_tc_classify (const teca_tc_classify &src)=delete
	teca_tc_classify (teca_tc_classify &&src)=delete
teca_tc_classify &	operator= (const teca_tc_classify &src)=delete
teca_tc_classify &	operator= (teca_tc_classify &&src)=delete
const char *	get_class_name () const override
void	set_track_id_column (const std::string &v)
const std::string &	get_track_id_column () const
void	set_time_column (const std::string &v)
const std::string &	get_time_column () const
void	set_surface_wind_column (const std::string &v)
const std::string &	get_surface_wind_column () const
void	set_sea_level_pressure_column (const std::string &v)
const std::string &	get_sea_level_pressure_column () const
void	set_x_coordinate_column (const std::string &v)
const std::string &	get_x_coordinate_column () const
void	set_y_coordinate_column (const std::string &v)
const std::string &	get_y_coordinate_column () const
size_t	get_number_of_region_sizes ()
void	append_region_size (const unsigned long &v)
void	set_region_size (const unsigned long &v)
void	set_region_size (size_t i, const unsigned long &v)
void	set_region_sizes (const std::vector< unsigned long > &v)
void	set_region_sizes (const std::initializer_list< unsigned long > &&l)
const unsigned long &	get_region_size (size_t i) const
const std::vector< unsigned long > &	get_region_sizes () const
void	clear_region_sizes ()
size_t	get_number_of_region_starts ()
void	append_region_start (const unsigned long &v)
void	set_region_start (const unsigned long &v)
void	set_region_start (size_t i, const unsigned long &v)
void	set_region_starts (const std::vector< unsigned long > &v)
void	set_region_starts (const std::initializer_list< unsigned long > &&l)
const unsigned long &	get_region_start (size_t i) const
const std::vector< unsigned long > &	get_region_starts () const
void	clear_region_starts ()
size_t	get_number_of_region_x_coordinates ()
void	append_region_x_coordinate (const double &v)
void	set_region_x_coordinate (const double &v)
void	set_region_x_coordinate (size_t i, const double &v)
void	set_region_x_coordinates (const std::vector< double > &v)
void	set_region_x_coordinates (const std::initializer_list< double > &&l)
const double &	get_region_x_coordinate (size_t i) const
const std::vector< double > &	get_region_x_coordinates () const
void	clear_region_x_coordinates ()
size_t	get_number_of_region_y_coordinates ()
void	append_region_y_coordinate (const double &v)
void	set_region_y_coordinate (const double &v)
void	set_region_y_coordinate (size_t i, const double &v)
void	set_region_y_coordinates (const std::vector< double > &v)
void	set_region_y_coordinates (const std::initializer_list< double > &&l)
const double &	get_region_y_coordinate (size_t i) const
const std::vector< double > &	get_region_y_coordinates () const
void	clear_region_y_coordinates ()
size_t	get_number_of_region_ids ()
void	append_region_id (const int &v)
void	set_region_id (const int &v)
void	set_region_id (size_t i, const int &v)
void	set_region_ids (const std::vector< int > &v)
void	set_region_ids (const std::initializer_list< int > &&l)
const int &	get_region_id (size_t i) const
const std::vector< int > &	get_region_ids () const
void	clear_region_ids ()
size_t	get_number_of_region_names ()
void	append_region_name (const std::string &v)
void	set_region_name (const std::string &v)
void	set_region_name (size_t i, const std::string &v)
void	set_region_names (const std::vector< std::string > &v)
void	set_region_names (const std::initializer_list< std::string > &&l)
const std::string &	get_region_name (size_t i) const
const std::vector< std::string > &	get_region_names () const
void	clear_region_names ()
size_t	get_number_of_region_long_names ()
void	append_region_long_name (const std::string &v)
void	set_region_long_name (const std::string &v)
void	set_region_long_name (size_t i, const std::string &v)
void	set_region_long_names (const std::vector< std::string > &v)
void	set_region_long_names (const std::initializer_list< std::string > &&l)
const std::string &	get_region_long_name (size_t i) const
const std::vector< std::string > &	get_region_long_names () const
void	clear_region_long_names ()
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	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_classify	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_output_metadata (unsigned int port, const std::vector< teca_metadata > &input_md)
virtual std::vector< teca_metadata >	get_upstream_request (unsigned int port, const std::vector< teca_metadata > &input_md, const teca_metadata &request)
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_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...
Protected Attributes inherited from teca_algorithm
int	verbose

Detailed Description

an algorithm that classifies storms using Saphire-Simpson scale

An algorithm that classifies storms using Saphire-Simpson scale a column containing the classification is added to the output

An algorithm that sorts the storms by geographic region and category. tyhe output is a table where regions is mapped to columns and category is mapped to rows.

Member Function Documentation

append_region_id()

void teca_tc_classify::append_region_id ( const int &  v )

inline

append to the region_id algorithm vector property

append_region_long_name()

void teca_tc_classify::append_region_long_name ( const std::string &  v )

inline

append to the region_long_name algorithm vector property

append_region_name()

void teca_tc_classify::append_region_name ( const std::string &  v )

inline

append to the region_name algorithm vector property

append_region_size()

void teca_tc_classify::append_region_size ( const unsigned long &  v )

inline

append to the region_size algorithm vector property

append_region_start()

void teca_tc_classify::append_region_start ( const unsigned long &  v )

inline

append to the region_start algorithm vector property

append_region_x_coordinate()

void teca_tc_classify::append_region_x_coordinate ( const double &  v )

inline

append to the region_x_coordinate algorithm vector property

append_region_y_coordinate()

void teca_tc_classify::append_region_y_coordinate ( const double &  v )

inline

append to the region_y_coordinate algorithm vector property

clear_region_ids()

void teca_tc_classify::clear_region_ids ( )

inline

clear the region_id algorithm vector property

clear_region_long_names()

void teca_tc_classify::clear_region_long_names ( )

inline

clear the region_long_name algorithm vector property

clear_region_names()

void teca_tc_classify::clear_region_names ( )

inline

clear the region_name algorithm vector property

clear_region_sizes()

void teca_tc_classify::clear_region_sizes ( )

inline

clear the region_size algorithm vector property

clear_region_starts()

void teca_tc_classify::clear_region_starts ( )

inline

clear the region_start algorithm vector property

clear_region_x_coordinates()

void teca_tc_classify::clear_region_x_coordinates ( )

inline

clear the region_x_coordinate algorithm vector property

clear_region_y_coordinates()

void teca_tc_classify::clear_region_y_coordinates ( )

inline

clear the region_y_coordinate algorithm vector property

get_class_name()

const char* teca_tc_classify::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

get_number_of_region_ids()

size_t teca_tc_classify::get_number_of_region_ids ( )

inline

get the size of the region_id algorithm vector property

get_number_of_region_long_names()

size_t teca_tc_classify::get_number_of_region_long_names ( )

inline

get the size of the region_long_name algorithm vector property

get_number_of_region_names()

size_t teca_tc_classify::get_number_of_region_names ( )

inline

get the size of the region_name algorithm vector property

get_number_of_region_sizes()

size_t teca_tc_classify::get_number_of_region_sizes ( )

inline

get the size of the region_size algorithm vector property

get_number_of_region_starts()

size_t teca_tc_classify::get_number_of_region_starts ( )

inline

get the size of the region_start algorithm vector property

get_number_of_region_x_coordinates()

size_t teca_tc_classify::get_number_of_region_x_coordinates ( )

inline

get the size of the region_x_coordinate algorithm vector property

get_number_of_region_y_coordinates()

size_t teca_tc_classify::get_number_of_region_y_coordinates ( )

inline

get the size of the region_y_coordinate algorithm vector property

get_region_id()

const int& teca_tc_classify::get_region_id ( size_t  i ) const

inline

get the i-th element of the region_id algorithm vector property

get_region_ids()

const std::vector< int >& teca_tc_classify::get_region_ids ( ) const

inline

get the region_id algorithm vector property

get_region_long_name()

const std::string& teca_tc_classify::get_region_long_name ( size_t  i ) const

inline

get the i-th element of the region_long_name algorithm vector property

get_region_long_names()

const std::vector< std::string >& teca_tc_classify::get_region_long_names ( ) const

inline

get the region_long_name algorithm vector property

get_region_name()

const std::string& teca_tc_classify::get_region_name ( size_t  i ) const

inline

get the i-th element of the region_name algorithm vector property

get_region_names()

const std::vector< std::string >& teca_tc_classify::get_region_names ( ) const

inline

get the region_name algorithm vector property

get_region_size()

const unsigned long& teca_tc_classify::get_region_size ( size_t  i ) const

inline

get the i-th element of the region_size algorithm vector property

get_region_sizes()

const std::vector< unsigned long >& teca_tc_classify::get_region_sizes ( ) const

inline

get the region_size algorithm vector property

get_region_start()

const unsigned long& teca_tc_classify::get_region_start ( size_t  i ) const

inline

get the i-th element of the region_start algorithm vector property

get_region_starts()

const std::vector< unsigned long >& teca_tc_classify::get_region_starts ( ) const

inline

get the region_start algorithm vector property

get_region_x_coordinate()

const double& teca_tc_classify::get_region_x_coordinate ( size_t  i ) const

inline

get the i-th element of the region_x_coordinate algorithm vector property

get_region_x_coordinates()

const std::vector< double >& teca_tc_classify::get_region_x_coordinates ( ) const

inline

get the region_x_coordinate algorithm vector property

get_region_y_coordinate()

const double& teca_tc_classify::get_region_y_coordinate ( size_t  i ) const

inline

get the i-th element of the region_y_coordinate algorithm vector property

get_region_y_coordinates()

const std::vector< double >& teca_tc_classify::get_region_y_coordinates ( ) const

inline

get the region_y_coordinate algorithm vector property

get_sea_level_pressure_column()

const std::string& teca_tc_classify::get_sea_level_pressure_column ( ) const

inline

Get the value of the sea_level_pressure_column algorithm property

get_surface_wind_column()

const std::string& teca_tc_classify::get_surface_wind_column ( ) const

inline

Get the value of the surface_wind_column algorithm property

get_time_column()

const std::string& teca_tc_classify::get_time_column ( ) const

inline

Get the value of the time_column algorithm property

get_track_id_column()

const std::string& teca_tc_classify::get_track_id_column ( ) const

inline

Get the value of the track_id_column algorithm property

get_x_coordinate_column()

const std::string& teca_tc_classify::get_x_coordinate_column ( ) const

inline

Get the value of the x_coordinate_column algorithm property

get_y_coordinate_column()

const std::string& teca_tc_classify::get_y_coordinate_column ( ) const

inline

Get the value of the y_coordinate_column algorithm property

New()

static p_teca_tc_classify teca_tc_classify::New ( )

inlinestatic

Returns an instance of teca_tc_classify

set_region_id() [1/2]

void teca_tc_classify::set_region_id ( const int &  v )

inline

set the region_id algorithm vector property to a single value

set_region_id() [2/2]

void teca_tc_classify::set_region_id ( size_t  i, const int &  v  )

inline

set the i-th element of the region_id algorithm vector property

set_region_ids() [1/2]

void teca_tc_classify::set_region_ids ( const std::initializer_list< int > &&  l )

inline

set the region_id algorithm vector property

set_region_ids() [2/2]

void teca_tc_classify::set_region_ids ( const std::vector< int > &  v )

inline

set the region_id algorithm vector property

set_region_long_name() [1/2]

void teca_tc_classify::set_region_long_name ( const std::string &  v )

inline

set the region_long_name algorithm vector property to a single value

set_region_long_name() [2/2]

void teca_tc_classify::set_region_long_name ( size_t  i, const std::string &  v  )

inline

set the i-th element of the region_long_name algorithm vector property

set_region_long_names() [1/2]

void teca_tc_classify::set_region_long_names ( const std::initializer_list< std::string > &&  l )

inline

set the region_long_name algorithm vector property

set_region_long_names() [2/2]

void teca_tc_classify::set_region_long_names ( const std::vector< std::string > &  v )

inline

set the region_long_name algorithm vector property

set_region_name() [1/2]

void teca_tc_classify::set_region_name ( const std::string &  v )

inline

set the region_name algorithm vector property to a single value

set_region_name() [2/2]

void teca_tc_classify::set_region_name ( size_t  i, const std::string &  v  )

inline

set the i-th element of the region_name algorithm vector property

set_region_names() [1/2]

void teca_tc_classify::set_region_names ( const std::initializer_list< std::string > &&  l )

inline

set the region_name algorithm vector property

set_region_names() [2/2]

void teca_tc_classify::set_region_names ( const std::vector< std::string > &  v )

inline

set the region_name algorithm vector property

set_region_size() [1/2]

void teca_tc_classify::set_region_size ( const unsigned long &  v )

inline

set the region_size algorithm vector property to a single value

set_region_size() [2/2]

void teca_tc_classify::set_region_size ( size_t  i, const unsigned long &  v  )

inline

set the i-th element of the region_size algorithm vector property

set_region_sizes() [1/2]

void teca_tc_classify::set_region_sizes ( const std::initializer_list< unsigned long > &&  l )

inline

set the region_size algorithm vector property

set_region_sizes() [2/2]

void teca_tc_classify::set_region_sizes ( const std::vector< unsigned long > &  v )

inline

set the region_size algorithm vector property

set_region_start() [1/2]

void teca_tc_classify::set_region_start ( const unsigned long &  v )

inline

set the region_start algorithm vector property to a single value

set_region_start() [2/2]

void teca_tc_classify::set_region_start ( size_t  i, const unsigned long &  v  )

inline

set the i-th element of the region_start algorithm vector property

set_region_starts() [1/2]

void teca_tc_classify::set_region_starts ( const std::initializer_list< unsigned long > &&  l )

inline

set the region_start algorithm vector property

set_region_starts() [2/2]

void teca_tc_classify::set_region_starts ( const std::vector< unsigned long > &  v )

inline

set the region_start algorithm vector property

set_region_x_coordinate() [1/2]

void teca_tc_classify::set_region_x_coordinate ( const double &  v )

inline

set the region_x_coordinate algorithm vector property to a single value

set_region_x_coordinate() [2/2]

void teca_tc_classify::set_region_x_coordinate ( size_t  i, const double &  v  )

inline

set the i-th element of the region_x_coordinate algorithm vector property

set_region_x_coordinates() [1/2]

void teca_tc_classify::set_region_x_coordinates ( const std::initializer_list< double > &&  l )

inline

set the region_x_coordinate algorithm vector property

set_region_x_coordinates() [2/2]

void teca_tc_classify::set_region_x_coordinates ( const std::vector< double > &  v )

inline

set the region_x_coordinate algorithm vector property

set_region_y_coordinate() [1/2]

void teca_tc_classify::set_region_y_coordinate ( const double &  v )

inline

set the region_y_coordinate algorithm vector property to a single value

set_region_y_coordinate() [2/2]

void teca_tc_classify::set_region_y_coordinate ( size_t  i, const double &  v  )

inline

set the i-th element of the region_y_coordinate algorithm vector property

set_region_y_coordinates() [1/2]

void teca_tc_classify::set_region_y_coordinates ( const std::initializer_list< double > &&  l )

inline

set the region_y_coordinate algorithm vector property

set_region_y_coordinates() [2/2]

void teca_tc_classify::set_region_y_coordinates ( const std::vector< double > &  v )

inline

set the region_y_coordinate algorithm vector property

set_sea_level_pressure_column()

void teca_tc_classify::set_sea_level_pressure_column ( const std::string &  v )

inline

Set the value of the sea_level_pressure_column algorithm property

set_surface_wind_column()

void teca_tc_classify::set_surface_wind_column ( const std::string &  v )

inline

Set the value of the surface_wind_column algorithm property

set_time_column()

void teca_tc_classify::set_time_column ( const std::string &  v )

inline

Set the value of the time_column algorithm property

set_track_id_column()

void teca_tc_classify::set_track_id_column ( const std::string &  v )

inline

Set the value of the track_id_column algorithm property

set_x_coordinate_column()

void teca_tc_classify::set_x_coordinate_column ( const std::string &  v )

inline

Set the value of the x_coordinate_column algorithm property

set_y_coordinate_column()

void teca_tc_classify::set_y_coordinate_column ( const std::string &  v )

inline

Set the value of the y_coordinate_column algorithm property

shared_from_this() [1/2]

std::shared_ptr< teca_tc_classify > teca_tc_classify::shared_from_this ( )

inline

Enables the static constructor

shared_from_this() [2/2]

std::shared_ptr< teca_tc_classify const> teca_tc_classify::shared_from_this ( ) const

inline

Enables the static constructor

---

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

• develop/alg/teca_tc_classify.h