#include <teca_latitude_damper.h>
Inheritance diagram for teca_latitude_damper:
Public Member Functions | |
| std::shared_ptr< teca_latitude_damper > | shared_from_this () |
| std::shared_ptr< teca_latitude_damper const > | shared_from_this () const |
| teca_latitude_damper (const teca_latitude_damper &src)=delete | |
| teca_latitude_damper (teca_latitude_damper &&src)=delete | |
| teca_latitude_damper & | operator= (const teca_latitude_damper &src)=delete |
| teca_latitude_damper & | operator= (teca_latitude_damper &&src)=delete |
| const char * | get_class_name () const override |
| void | set_center (const double &v) |
| const double & | get_center () const |
| void | set_half_width_at_half_max (const double &v) |
| const double & | get_half_width_at_half_max () const |
| size_t | get_number_of_damped_variables () |
| void | append_damped_variable (const std::string &v) |
| void | set_damped_variable (size_t i, const std::string &v) |
| void | set_damped_variables (const std::vector< std::string > &v) |
| void | set_damped_variables (const std::initializer_list< std::string > &&l) |
| void | set_damped_variables (const const_p_teca_variant_array &v) |
| const std::string & | get_damped_variable (size_t i) const |
| void | get_damped_variables (std::vector< std::string > &v) const |
| void | get_damped_variables (const p_teca_variant_array &v) const |
| void | clear_damped_variables () |
| void | set_variable_post_fix (const std::string &v) |
| const std::string & | get_variable_post_fix () 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 () |
| virtual teca_algorithm_output_port | get_output_port (unsigned int port=0) |
| void | set_input_connection (const teca_algorithm_output_port &port) |
| virtual void | set_input_connection (unsigned int id, const teca_algorithm_output_port &port) |
| virtual void | remove_input_connection (unsigned int id) |
| void | clear_input_connections () |
| 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) |
| virtual int | update () |
| virtual int | update (unsigned int port) |
| virtual teca_metadata | update_metadata (unsigned int port=0) |
| void | set_executive (p_teca_algorithm_executive exe) |
| p_teca_algorithm_executive | get_executive () |
| virtual void | to_stream (std::ostream &s) const |
| virtual void | from_stream (std::istream &s) |
Static Public Member Functions | |
| static p_teca_latitude_damper | New () |
Protected Member Functions | |
| int | get_sigma (const teca_metadata &request, double &sigma) |
| int | get_mu (const teca_metadata &request, double &mu) |
| int | get_damped_variables (std::vector< std::string > &vars) |
| 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) |
| 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) |
| unsigned int | get_number_of_input_connections () |
| teca_algorithm_output_port & | get_input_connection (unsigned int i) |
| void | clear_modified (unsigned int port) |
| int | get_modified (unsigned int port) const |
Detailed Description
damps the specified scalar field(s) using an inverted Gaussian centered on a given latitude with a half width specified in degrees latitude. The paramters defining the Gaussian (center, half width at half max) can be specified by the user directly or by down stream algorithm via the following keys in the request.
request keys:
teca_latitude_damper::damped_variables teca_latitude_damper::half_width_at_half_max teca_latitude_damper::center
note that user specified values take precedence over request keys. When using request keys be sure to include the variable post-fix.
The documentation for this class was generated from the following files:
- TECA/alg/teca_latitude_damper.h
- TECA/alg/teca_latitude_damper.cxx
