an algorithm that unpacks NetCDF packed values More...
#include <teca_unpack_data.h>
Public Member Functions | |
| std::shared_ptr< teca_unpack_data > | shared_from_this () |
| std::shared_ptr< teca_unpack_data const > | shared_from_this () const |
| teca_unpack_data (const teca_unpack_data &src)=delete | |
| teca_unpack_data (teca_unpack_data &&src)=delete | |
| teca_unpack_data & | operator= (const teca_unpack_data &src)=delete |
| teca_unpack_data & | operator= (teca_unpack_data &&src)=delete |
| const char * | get_class_name () const override |
output_data_type | |
set the output data type. use teca_variant_array_code<T>::get() to get the numeric code corresponding to the data type T. The default output data type is single precision floating point. | |
| void | set_output_data_type (const int &v) |
| const int & | get_output_data_type () const |
| void | set_output_data_type_to_float () |
| set the output data type to double precision floating point More... | |
| void | set_output_data_type_to_double () |
| set the output data type to single precision floating point More... | |
 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_unpack_data | 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 unpacks NetCDF packed values
Applies a data transform according to the NetCDF attribute conventions for packed data values. https://www.unidata.ucar.edu/software/netcdf/docs/attribute_conventions.html
Variables in the input dataset are scanned for the presence of the scale_factor and add_offset attributes. When both are present an element wise transformation is applied such that
out[i] = scale_factor * in[i] + add_offset
The input array is expected to be an integer type while the type of the output array may be either float or double. Valid value masks may be necessary for correct results, see teca_valid_value_mask.
Member Function Documentation
◆ get_class_name()
|
inlineoverridevirtual |
returns the name of the class
Implements teca_algorithm.
◆ get_output_data_type()
|
inline |
Get the value of the output_data_type algorithm property
◆ New()
|
inlinestatic |
Returns an instance of teca_unpack_data
◆ set_output_data_type()
|
inline |
Set the value of the output_data_type algorithm property
◆ set_output_data_type_to_double()
|
inline |
set the output data type to single precision floating point
◆ set_output_data_type_to_float()
|
inline |
set the output data type to double precision floating point
◆ 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_unpack_data.h
