Applies a mask to a given list of variables. More...

#include <teca_apply_binary_mask.h>

Inheritance diagram for teca_apply_binary_mask:

Collaboration diagram for teca_apply_binary_mask:

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

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

	teca_apply_binary_mask (const teca_apply_binary_mask &src)=delete

	teca_apply_binary_mask (teca_apply_binary_mask &&src)=delete

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

teca_apply_binary_mask &	operator= (teca_apply_binary_mask &&src)=delete

const char *	get_class_name () const override

void	get_output_variable_names (std::vector< std::string > &names)

mask_variable
set the name of the variable containing the mask values
void	set_mask_variable (const std::string &v)

const std::string &	get_mask_variable () const

masked_variable
A list of of variables to apply the mask to. If empty no arrays will be requested, and no variables will be masked
size_t	get_number_of_masked_variables ()

void	append_masked_variable (const std::string &v)

void	set_masked_variable (const std::string &v)

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

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

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

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

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

void	clear_masked_variables ()

output_variable_prefix
A prefix for the names of the variables that have been masked. If this is empty masked data replaces its input, otherwise input data is preserved and masked data is added.
void	set_output_variable_prefix (const std::string &v)

const std::string &	get_output_variable_prefix () 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_apply_binary_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_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

Applies a mask to a given list of variables.

Given a mask variable, this routine applies the mask to a list of input variables.

The mask variable can either be binary, or it can represent a probability ranging from 0 to 1. For mask variable mask and input variable var, this algorithm computes mask * var and sends the resulting array downstream; this masking operation is applied for all variables in the input list.

A potential use-case for this algorithm is masking quantities like precipitation by the probability of atmospheric river presence; the average of this masked precipitation variable gives the average precipitation due to atmospheric rivers.

The output variable names are given a prefix to distinguish them from the upstream versions. E.g., if the algorithm property output_variable_prefix is set to 'ar_', and the variable being masked is 'precip', then the output array name is 'ar_precip'.

Member Function Documentation

◆ append_masked_variable()

void teca_apply_binary_mask::append_masked_variable ( const std::string & v )

inline

append to the masked_variable algorithm vector property

◆ clear_masked_variables()

void teca_apply_binary_mask::clear_masked_variables ( )

inline

clear the masked_variable algorithm vector property

◆ get_class_name()

const char* teca_apply_binary_mask::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_mask_variable()

const std::string& teca_apply_binary_mask::get_mask_variable ( ) const

inline

Get the value of the mask_variable algorithm property

◆ get_masked_variable()

const std::string& teca_apply_binary_mask::get_masked_variable ( size_t i ) const

inline

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

◆ get_masked_variables()

const std::vector< std::string >& teca_apply_binary_mask::get_masked_variables ( ) const

inline

get the masked_variable algorithm vector property

◆ get_number_of_masked_variables()

size_t teca_apply_binary_mask::get_number_of_masked_variables ( )

inline

get the size of the masked_variable algorithm vector property

◆ get_output_variable_names()

void teca_apply_binary_mask::get_output_variable_names ( std::vector< std::string > & names )

helper that constructs and returns the result variable names taking into account he list of masked_variables and the output_variable_prefix. use this to know what variables will be produced.

◆ get_output_variable_prefix()

const std::string& teca_apply_binary_mask::get_output_variable_prefix ( ) const

inline

Get the value of the output_variable_prefix algorithm property

◆ New()

static p_teca_apply_binary_mask teca_apply_binary_mask::New ( )

inlinestatic

Returns an instance of teca_apply_binary_mask

◆ set_mask_variable()

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

inline

Set the value of the mask_variable algorithm property

◆ set_masked_variable() [1/2]

void teca_apply_binary_mask::set_masked_variable ( const std::string & v )

inline

set the masked_variable algorithm vector property to a single value

◆ set_masked_variable() [2/2]

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

inline

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

◆ set_masked_variables() [1/2]

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

inline

set the masked_variable algorithm vector property

◆ set_masked_variables() [2/2]

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

inline

set the masked_variable algorithm vector property

◆ set_output_variable_prefix()

void teca_apply_binary_mask::set_output_variable_prefix ( const std::string & v )

inline

Set the value of the output_variable_prefix algorithm property

◆ shared_from_this() [1/2]

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

inline

Enables the static constructor

◆ shared_from_this() [2/2]

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

inline

Enables the static constructor

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

rtdfixjuly2025/alg/teca_apply_binary_mask.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ append_masked_variable()

◆ clear_masked_variables()

◆ get_class_name()

◆ get_mask_variable()

◆ get_masked_variable()

◆ get_masked_variables()

◆ get_number_of_masked_variables()

◆ get_output_variable_names()

◆ get_output_variable_prefix()

◆ New()

◆ set_mask_variable()

◆ set_masked_variable() [1/2]

◆ set_masked_variable() [2/2]

◆ set_masked_variables() [1/2]

◆ set_masked_variables() [2/2]

◆ set_output_variable_prefix()

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]