an algorithm that masks a range of values More...

#include <teca_mask.h>

Inheritance diagram for teca_mask:

Collaboration diagram for teca_mask:

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

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

	teca_mask (const teca_mask &src)=delete

	teca_mask (teca_mask &&src)=delete

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

teca_mask &	operator= (teca_mask &&src)=delete

const char *	get_class_name () const override

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

void	set_low_threshold_value (const double &v)

const double &	get_low_threshold_value () const

void	set_high_threshold_value (const double &v)

const double &	get_high_threshold_value () const

void	set_mask_value (const double &v)

const double &	get_mask_value () 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_mask	New ()

Protected Member Functions
std::vector< std::string >	get_mask_variables (const teca_metadata &request)

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

an algorithm that masks a range of values

An algorithm to mask a range of values in an array. Values in the range are replaced with the mask value.

Member Function Documentation

◆ append_mask_variable()

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

inline

append to the mask_variable algorithm vector property

◆ clear_mask_variables()

void teca_mask::clear_mask_variables ( )

inline

clear the mask_variable algorithm vector property

◆ get_class_name()

const char* teca_mask::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_high_threshold_value()

const double& teca_mask::get_high_threshold_value ( ) const

inline

Get the value of the high_threshold_value algorithm property

◆ get_low_threshold_value()

const double& teca_mask::get_low_threshold_value ( ) const

inline

Get the value of the low_threshold_value algorithm property

◆ get_mask_value()

const double& teca_mask::get_mask_value ( ) const

inline

Get the value of the mask_value algorithm property

◆ get_mask_variable()

const std::string& teca_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_mask::get_mask_variables ( ) const

inline

get the mask_variable algorithm vector property

◆ get_number_of_mask_variables()

size_t teca_mask::get_number_of_mask_variables ( )

inline

get the size of the mask_variable algorithm vector property

◆ New()

static p_teca_mask teca_mask::New ( )

inlinestatic

Returns an instance of teca_mask

◆ set_high_threshold_value()

void teca_mask::set_high_threshold_value ( const double & v )

inline

Set the value of the high_threshold_value algorithm property

◆ set_low_threshold_value()

void teca_mask::set_low_threshold_value ( const double & v )

inline

Set the value of the low_threshold_value algorithm property

◆ set_mask_value()

void teca_mask::set_mask_value ( const double & v )

inline

Set the value of the mask_value algorithm property

◆ set_mask_variable() [1/2]

void teca_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_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_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_mask::set_mask_variables ( const std::vector< std::string > & v )

inline

set the mask_variable algorithm vector property

◆ shared_from_this() [1/2]

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

inline

Enables the static constructor

◆ shared_from_this() [2/2]

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

inline

Enables the static constructor

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

rtdfixjuly2025/alg/teca_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_high_threshold_value()

◆ get_low_threshold_value()

◆ get_mask_value()

◆ get_mask_variable()

◆ get_mask_variables()

◆ get_number_of_mask_variables()

◆ New()

◆ set_high_threshold_value()

◆ set_low_threshold_value()

◆ set_mask_value()

◆ set_mask_variable() [1/2]

◆ set_mask_variable() [2/2]

◆ set_mask_variables() [1/2]

◆ set_mask_variables() [2/2]

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]