TECA
Public Types | Public Member Functions | Static Public Member Functions | List of all members
teca_temporal_average Class Reference

an algorithm that averages data in time More...

#include <teca_temporal_average.h>

Inheritance diagram for teca_temporal_average:
teca_algorithm

Public Types

enum  { backward, centered, forward }
 

Public Member Functions

std::shared_ptr< teca_temporal_averageshared_from_this ()
 
std::shared_ptr< teca_temporal_average const > shared_from_this () const
 
 teca_temporal_average (const teca_temporal_average &src)=delete
 
 teca_temporal_average (teca_temporal_average &&src)=delete
 
teca_temporal_averageoperator= (const teca_temporal_average &src)=delete
 
teca_temporal_averageoperator= (teca_temporal_average &&src)=delete
 
const char * get_class_name () const override
 
void set_filter_width (const unsigned int &v)
 
const unsigned int & get_filter_width () const
 
void set_filter_type (const int &v)
 
const int & get_filter_type () const
 
- Public Member Functions inherited from teca_algorithm
 teca_algorithm (const teca_algorithm &src)=delete
 
 teca_algorithm (teca_algorithm &&src)=delete
 
teca_algorithmoperator= (const teca_algorithm &src)=delete
 
teca_algorithmoperator= (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_temporal_average 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)
 
virtual teca_metadata get_output_metadata (unsigned int port, const std::vector< teca_metadata > &input_md)
 
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)
 
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

an algorithm that averages data in time

an algorithm that averages data in time. filter_width controls the number of time steps to average over. all arrays in the input data are processed.


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