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

#include <teca_table_region_mask.h>

Inheritance diagram for teca_table_region_mask:
teca_algorithm

Public Member Functions

std::shared_ptr< teca_table_region_mask > shared_from_this ()
 
std::shared_ptr< teca_table_region_mask const > shared_from_this () const
 
 teca_table_region_mask (const teca_table_region_mask &src)=delete
 
 teca_table_region_mask (teca_table_region_mask &&src)=delete
 
teca_table_region_mask & operator= (const teca_table_region_mask &src)=delete
 
teca_table_region_mask & operator= (teca_table_region_mask &&src)=delete
 
const char * get_class_name () const override
 
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
 
void set_result_column (const std::string &v)
 
const std::string & get_result_column () const
 
size_t get_number_of_region_sizes ()
 
void append_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)
 
void set_region_sizes (const const_p_teca_variant_array &v)
 
const unsigned long & get_region_size (size_t i) const
 
void get_region_sizes (std::vector< unsigned long > &v) const
 
void get_region_sizes (const p_teca_variant_array &v) const
 
void clear_region_sizes ()
 
size_t get_number_of_region_starts ()
 
void append_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)
 
void set_region_starts (const const_p_teca_variant_array &v)
 
const unsigned long & get_region_start (size_t i) const
 
void get_region_starts (std::vector< unsigned long > &v) const
 
void get_region_starts (const p_teca_variant_array &v) 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 (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)
 
void set_region_x_coordinates (const const_p_teca_variant_array &v)
 
const double & get_region_x_coordinate (size_t i) const
 
void get_region_x_coordinates (std::vector< double > &v) const
 
void get_region_x_coordinates (const p_teca_variant_array &v) 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 (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)
 
void set_region_y_coordinates (const const_p_teca_variant_array &v)
 
const double & get_region_y_coordinate (size_t i) const
 
void get_region_y_coordinates (std::vector< double > &v) const
 
void get_region_y_coordinates (const p_teca_variant_array &v) const
 
void clear_region_y_coordinates ()
 
void clear_regions ()
 
int load_cyclone_basin (const std::string &name)
 
void set_invert (const int &v)
 
const int & get_invert () const
 
- 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 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 to_stream (std::ostream &s) const
 
virtual void from_stream (std::istream &s)
 

Static Public Member Functions

static p_teca_table_region_mask 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)
 
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)
 
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

an algorithm that identifies rows in the table that are inside the list of regions provided. a new column, called the mask column is created. It has 1's if the row is in the set of regions, otherwise 0's. The invert property can be used to invert the result.

The documentation for this class was generated from the following files:
Generated by doxygen 1.8.20