an algorithm that computes a mask identifying valid values More...
#include <teca_valid_value_mask.h>
Public Member Functions | |
| std::shared_ptr< teca_valid_value_mask > | shared_from_this () |
| std::shared_ptr< teca_valid_value_mask const > | shared_from_this () const |
| teca_valid_value_mask (const teca_valid_value_mask &src)=delete | |
| teca_valid_value_mask (teca_valid_value_mask &&src)=delete | |
| teca_valid_value_mask & | operator= (const teca_valid_value_mask &src)=delete |
| teca_valid_value_mask & | operator= (teca_valid_value_mask &&src)=delete |
| const char * | get_class_name () const override |
mask_arrays | |
explicitly set a list of input arrays to process. By default all arrays are processed. Use this property to compute masks for a subset of the arrays, | |
| size_t | get_number_of_mask_arrays () |
| void | append_mask_array (const std::string &v) |
| void | set_mask_array (size_t i, const std::string &v) |
| void | set_mask_arrays (const std::vector< std::string > &v) |
| void | set_mask_arrays (const std::initializer_list< std::string > &&l) |
| const std::string & | get_mask_array (size_t i) const |
| const std::vector< std::string > & | get_mask_arrays () const |
| void | clear_mask_arrays () |
enable_valid_range | |
enable the use of valid_range, valid_min, valid_max attributes. by default this is off. | |
| void | set_enable_valid_range (const int &v) |
| const int & | get_enable_valid_range () 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_valid_value_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 ¤t) |
| virtual const_p_teca_dataset | request_data (teca_algorithm_output_port &port, const teca_metadata &request) |
| virtual int | validate_cache (teca_algorithm_output_port ¤t) |
| 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 computes a mask identifying valid values
For each requested mask, from its associated input array, compute a mask set to 1 where the data is valid and 0 everywhere else. Downstream algorithms then may look for the mask array and process the data in such a way as to produce valid results in the presence of missing data.
Validity is determined by comparing the array's elements to the fill value as specified in the array's attributes _FillValue or missing_value field. If neither of these attribute fields are present then no mask is computed.
The masks generated are stored in the output mesh with the same centering as the input variable they were generated from, and named using the variable's name with the string "_valid" appended. For example if a mask was generated for a variable named "V" it will be named "V_valid".
Masks are requested for specific arrays in one of two ways. One may use the mask_arrays algorithm property to explicitly name the list of variables to compute masks for. Alternatively, a heuristic applied to incoming requests determines if masks should be generated. Specifically the string "_valid" is looked for at the end of each requested array. If it is found then the mask for the variable named by removing "_valid" is generated. For example the request for "V_valid" would result in the mask being generated for the variable "V".
Member Function Documentation
◆ append_mask_array()
|
inline |
append to the mask_array algorithm vector property
◆ clear_mask_arrays()
|
inline |
clear the mask_array algorithm vector property
◆ get_class_name()
|
inlineoverridevirtual |
returns the name of the class
Implements teca_algorithm.
◆ get_enable_valid_range()
|
inline |
Get the value of the enable_valid_range algorithm property
◆ get_mask_array()
|
inline |
get the i-th element of the mask_array algorithm vector property
◆ get_mask_arrays()
|
inline |
get the mask_array algorithm vector property
◆ get_number_of_mask_arrays()
|
inline |
get the size of the mask_array algorithm vector property
◆ New()
|
inlinestatic |
Returns an instance of teca_valid_value_mask
◆ set_enable_valid_range()
|
inline |
Set the value of the enable_valid_range algorithm property
◆ set_mask_array()
|
inline |
set the i-th element of the mask_array algorithm vector property
◆ set_mask_arrays() [1/2]
|
inline |
set the mask_array algorithm vector property
◆ set_mask_arrays() [2/2]
|
inline |
set the mask_array algorithm vector property
◆ shared_from_this() [1/2]
|
inline |
Enables the static constructor
◆ shared_from_this() [2/2]
|
inline |
Enables the static constructor
The documentation for this class was generated from the following file:
- rtd_doxygen/alg/teca_valid_value_mask.h
