Generates a valid value mask defined by regions in the given ESRI shape file. More...

#include <teca_shape_file_mask.h>

Inheritance diagram for teca_shape_file_mask:

Collaboration diagram for teca_shape_file_mask:

Public Member Functions
std::shared_ptr< teca_shape_file_mask >	shared_from_this ()

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

	teca_shape_file_mask (const teca_shape_file_mask &src)=delete

	teca_shape_file_mask (teca_shape_file_mask &&src)=delete

teca_shape_file_mask &	operator= (const teca_shape_file_mask &src)=delete

teca_shape_file_mask &	operator= (teca_shape_file_mask &&src)=delete

const char *	get_class_name () const override

shape_file
Set the path to the shape file. This file is read by MPI rank 0 and distributed to the others in parallel runs
void	set_shape_file (const std::string &v)

const std::string &	get_shape_file () const

mask_variables
set the names of the variables to store the generated mask in each variable will contain a reference to the mask
size_t	get_number_of_mask_variables ()

void	append_mask_variable (const std::string &v)

void	set_mask_variable (const std::string &v)

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

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

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

const std::string &	get_mask_variable (size_t i) const

const std::vector< std::string > &	get_mask_variables () const

void	clear_mask_variables ()

normalize_coordinates
set this flag to transform the x coordinates from [-180, 180] to [0, 360]
void	set_normalize_coordinates (const int &v)

const int &	get_normalize_coordinates () const

number_of_cuda_streams
sets the number of streams to use when searching the mesh for polygon intersections.
void	set_number_of_cuda_streams (const int &v)

const int &	get_number_of_cuda_streams () 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_shape_file_mask	New ()

Protected Member Functions
void	set_modified () override
	overriden so that cached data is cleared More...

teca_metadata	get_mask_array_attributes (unsigned long size)
	generate attributes for the output arrays More...

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)

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_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

Generates a valid value mask defined by regions in the given ESRI shape file.

The teca_shape_file_mask generates a mask on a 2D mesh where mesh points are assigned a value of 1 where they fall inside any one of the polygons defined in the named ESRI shape file, and 0 everywhere else. The input mesh is passed through to the output with the mask added. By default a transform on the x coordinates of the polygons from [-180, 180] to [0, 360] is applied. If this is undesirable it can be disabled by setting the normalize_coordinates property to 0.

Attention: Currently there is no check on the coordinate system specified in the shapefile. This could result in a mask of all zeros when the shapefile and input mesh use a different coodinate system.

Member Function Documentation

◆ append_mask_variable()

void teca_shape_file_mask::append_mask_variable ( const std::string & v )

inline

append to the mask_variable algorithm vector property

◆ clear_mask_variables()

void teca_shape_file_mask::clear_mask_variables ( )

inline

clear the mask_variable algorithm vector property

◆ get_class_name()

const char* teca_shape_file_mask::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_mask_array_attributes()

teca_metadata teca_shape_file_mask::get_mask_array_attributes ( unsigned long size )

protected

generate attributes for the output arrays

◆ get_mask_variable()

const std::string& teca_shape_file_mask::get_mask_variable ( size_t i ) const

inline

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

◆ get_mask_variables()

const std::vector< std::string >& teca_shape_file_mask::get_mask_variables ( ) const

inline

get the mask_variable algorithm vector property

◆ get_normalize_coordinates()

const int& teca_shape_file_mask::get_normalize_coordinates ( ) const

inline

Get the value of the normalize_coordinates algorithm property

◆ get_number_of_cuda_streams()

const int& teca_shape_file_mask::get_number_of_cuda_streams ( ) const

inline

Get the value of the number_of_cuda_streams algorithm property

◆ get_number_of_mask_variables()

size_t teca_shape_file_mask::get_number_of_mask_variables ( )

inline

get the size of the mask_variable algorithm vector property

◆ get_shape_file()

const std::string& teca_shape_file_mask::get_shape_file ( ) const

inline

Get the value of the shape_file algorithm property

◆ New()

static p_teca_shape_file_mask teca_shape_file_mask::New ( )

inlinestatic

Returns an instance of teca_shape_file_mask

◆ set_mask_variable() [1/2]

void teca_shape_file_mask::set_mask_variable ( const std::string & v )

inline

set the mask_variable algorithm vector property to a single value

◆ set_mask_variable() [2/2]

void teca_shape_file_mask::set_mask_variable	(	size_t	i,
		const std::string &	v
	)

inline

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

◆ set_mask_variables() [1/2]

void teca_shape_file_mask::set_mask_variables ( const std::initializer_list< std::string > && l )

inline

set the mask_variable algorithm vector property

◆ set_mask_variables() [2/2]

void teca_shape_file_mask::set_mask_variables ( const std::vector< std::string > & v )

inline

set the mask_variable algorithm vector property

◆ set_modified()

void teca_shape_file_mask::set_modified ( )

overrideprotectedvirtual

overriden so that cached data is cleared

Reimplemented from teca_algorithm.

◆ set_normalize_coordinates()

void teca_shape_file_mask::set_normalize_coordinates ( const int & v )

inline

Set the value of the normalize_coordinates algorithm property

◆ set_number_of_cuda_streams()

void teca_shape_file_mask::set_number_of_cuda_streams ( const int & v )

inline

Set the value of the number_of_cuda_streams algorithm property

◆ set_shape_file()

void teca_shape_file_mask::set_shape_file ( const std::string & v )

inline

Set the value of the shape_file algorithm property

◆ shared_from_this() [1/2]

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

inline

Enables the static constructor

◆ shared_from_this() [2/2]

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

inline

Enables the static constructor

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

rtdfixjuly2025/io/teca_shape_file_mask.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ append_mask_variable()

◆ clear_mask_variables()

◆ get_class_name()

◆ get_mask_array_attributes()

◆ get_mask_variable()

◆ get_mask_variables()

◆ get_normalize_coordinates()

◆ get_number_of_cuda_streams()

◆ get_number_of_mask_variables()

◆ get_shape_file()

◆ New()

◆ set_mask_variable() [1/2]

◆ set_mask_variable() [2/2]

◆ set_mask_variables() [1/2]

◆ set_mask_variables() [2/2]

◆ set_modified()

◆ set_normalize_coordinates()

◆ set_number_of_cuda_streams()

◆ set_shape_file()

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]