teca_table_region_mask Class Reference

An algorithm that identifies rows in the table that are inside the list of regions provided. More...

#include <teca_table_region_mask.h>

Inheritance diagram for teca_table_region_mask:

Collaboration diagram for teca_table_region_mask:

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 (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 ()
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 ()
	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_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)
	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 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.

Member Function Documentation

append_region_size()

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

inline

append to the region_size algorithm vector property

append_region_start()

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

inline

append to the region_start algorithm vector property

append_region_x_coordinate()

void teca_table_region_mask::append_region_x_coordinate ( const double &  v )

inline

append to the region_x_coordinate algorithm vector property

append_region_y_coordinate()

void teca_table_region_mask::append_region_y_coordinate ( const double &  v )

inline

append to the region_y_coordinate algorithm vector property

clear_region_sizes()

void teca_table_region_mask::clear_region_sizes ( )

inline

clear the region_size algorithm vector property

clear_region_starts()

void teca_table_region_mask::clear_region_starts ( )

inline

clear the region_start algorithm vector property

clear_region_x_coordinates()

void teca_table_region_mask::clear_region_x_coordinates ( )

inline

clear the region_x_coordinate algorithm vector property

clear_region_y_coordinates()

void teca_table_region_mask::clear_region_y_coordinates ( )

inline

clear the region_y_coordinate algorithm vector property

get_class_name()

const char* teca_table_region_mask::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

get_invert()

const int& teca_table_region_mask::get_invert ( ) const

inline

Get the value of the invert algorithm property

get_number_of_region_sizes()

size_t teca_table_region_mask::get_number_of_region_sizes ( )

inline

get the size of the region_size algorithm vector property

get_number_of_region_starts()

size_t teca_table_region_mask::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_table_region_mask::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_table_region_mask::get_number_of_region_y_coordinates ( )

inline

get the size of the region_y_coordinate algorithm vector property

get_region_size()

const unsigned long& teca_table_region_mask::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_table_region_mask::get_region_sizes ( ) const

inline

get the region_size algorithm vector property

get_region_start()

const unsigned long& teca_table_region_mask::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_table_region_mask::get_region_starts ( ) const

inline

get the region_start algorithm vector property

get_region_x_coordinate()

const double& teca_table_region_mask::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_table_region_mask::get_region_x_coordinates ( ) const

inline

get the region_x_coordinate algorithm vector property

get_region_y_coordinate()

const double& teca_table_region_mask::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_table_region_mask::get_region_y_coordinates ( ) const

inline

get the region_y_coordinate algorithm vector property

get_result_column()

const std::string& teca_table_region_mask::get_result_column ( ) const

inline

Get the value of the result_column algorithm property

get_x_coordinate_column()

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

inline

Get the value of the x_coordinate_column algorithm property

get_y_coordinate_column()

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

inline

Get the value of the y_coordinate_column algorithm property

New()

static p_teca_table_region_mask teca_table_region_mask::New ( )

inlinestatic

Returns an instance of teca_table_region_mask

set_invert()

void teca_table_region_mask::set_invert ( const int &  v )

inline

Set the value of the invert algorithm property

set_region_size() [1/2]

void teca_table_region_mask::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_table_region_mask::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_table_region_mask::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_table_region_mask::set_region_sizes ( const std::vector< unsigned long > &  v )

inline

set the region_size algorithm vector property

set_region_start() [1/2]

void teca_table_region_mask::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_table_region_mask::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_table_region_mask::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_table_region_mask::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_table_region_mask::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_table_region_mask::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_table_region_mask::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_table_region_mask::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_table_region_mask::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_table_region_mask::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_table_region_mask::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_table_region_mask::set_region_y_coordinates ( const std::vector< double > &  v )

inline

set the region_y_coordinate algorithm vector property

set_result_column()

void teca_table_region_mask::set_result_column ( const std::string &  v )

inline

Set the value of the result_column algorithm property

set_x_coordinate_column()

void teca_table_region_mask::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_table_region_mask::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_table_region_mask > teca_table_region_mask::shared_from_this ( )

inline

Enables the static constructor

shared_from_this() [2/2]

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

inline

Enables the static constructor

---

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

• rtdfixjuly2025/alg/teca_table_region_mask.h