An algorithm to ensure that Cartesian mesh coordinates follow conventions. More...
#include <teca_normalize_coordinates.h>
Public Member Functions | |
| std::shared_ptr< teca_normalize_coordinates > | shared_from_this () |
| std::shared_ptr< teca_normalize_coordinates const > | shared_from_this () const |
| teca_normalize_coordinates (const teca_normalize_coordinates &src)=delete | |
| teca_normalize_coordinates (teca_normalize_coordinates &&src)=delete | |
| teca_normalize_coordinates & | operator= (const teca_normalize_coordinates &src)=delete |
| teca_normalize_coordinates & | operator= (teca_normalize_coordinates &&src)=delete |
| const char * | get_class_name () const override |
enable_periodic_shift_x | |
If set, this enables an automatic transformation of the x-axis coordinates and data from [-180, 180] to [0, 360]. When enabled, the transformation is applied if the lowest x coordinate is less than 0 and skipped otherwise. | |
| void | set_enable_periodic_shift_x (const int &v) |
| const int & | get_enable_periodic_shift_x () const |
enable_y_axis_ascending | |
If set, this enables an automatic transformation of the y-axis coordinates and data from descending to ascending order. The transformation is applied if the lowest y coordinate is greater than the highest y coordinate skipped otherwise. Many TECA algorithms are written to process data with y-axis coordinates in ascending order, thus the transform is enabled by default. Setting this to 0 disables the transform for cases where it is desirable to pass data through unmodified. | |
| void | set_enable_y_axis_ascending (const int &v) |
| const int & | get_enable_y_axis_ascending () const |
enable_unit_conversions | |
If set, this enables an automatic conversions of units of the axes. | |
| void | set_enable_unit_conversions (const int &v) |
| const int & | get_enable_unit_conversions () 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_normalize_coordinates | 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 to ensure that Cartesian mesh coordinates follow conventions.
When enabled, transformations of coordinates and data are applied such that Cartesian meshes are follow the conventions:
- the x-axis coordinates are in the range of 0 to 360.
- the y-axis coordinate are in ascending order.
- the z-axis units are in Pa. Conversion from hPa is supported.
These transformations are automatically applied and can be enabled or disbaled as needed. The properties enable_unit_conversions, enable_periodic_shift and enable_y_axis_ascending provide a way to enable/disable the transforms.
Subset requests are not implemented when the periodic shift is enabled. When a request is made for data that crosses the periodic boundary, the request is modified to request the entire x-axis.
If data point opn the periodic boundary is duplicated, the data at 180 is dropped and a warning is issued.g
Member Function Documentation
◆ get_class_name()
|
inlineoverridevirtual |
returns the name of the class
Implements teca_algorithm.
◆ get_enable_periodic_shift_x()
|
inline |
Get the value of the enable_periodic_shift_x algorithm property
◆ get_enable_unit_conversions()
|
inline |
Get the value of the enable_unit_conversions algorithm property
◆ get_enable_y_axis_ascending()
|
inline |
Get the value of the enable_y_axis_ascending algorithm property
◆ New()
|
inlinestatic |
Returns an instance of teca_normalize_coordinates
◆ set_enable_periodic_shift_x()
|
inline |
Set the value of the enable_periodic_shift_x algorithm property
◆ set_enable_unit_conversions()
|
inline |
Set the value of the enable_unit_conversions algorithm property
◆ set_enable_y_axis_ascending()
|
inline |
Set the value of the enable_y_axis_ascending algorithm 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:
- develop/alg/teca_normalize_coordinates.h
