#include <teca_temporal_reduction.h>

Inheritance diagram for teca_cpp_temporal_reduction:

Collaboration diagram for teca_cpp_temporal_reduction:

Public Member Functions
std::shared_ptr< teca_cpp_temporal_reduction >	shared_from_this ()

std::shared_ptr< teca_cpp_temporal_reduction const >	shared_from_this () const

	teca_cpp_temporal_reduction (const teca_cpp_temporal_reduction &src)=delete

	teca_cpp_temporal_reduction (teca_cpp_temporal_reduction &&src)=delete

teca_cpp_temporal_reduction &	operator= (const teca_cpp_temporal_reduction &src)=delete

teca_cpp_temporal_reduction &	operator= (teca_cpp_temporal_reduction &&src)=delete

const char *	get_class_name () const override

point_arrays
Set the list of arrays to reduce
size_t	get_number_of_point_arrays ()

void	append_point_array (const std::string &v)

void	set_point_array (const std::string &v)

void	set_point_array (size_t i, const std::string &v)

void	set_point_arrays (const std::vector< std::string > &v)

void	set_point_arrays (const std::initializer_list< std::string > &&l)

const std::string &	get_point_array (size_t i) const

const std::vector< std::string > &	get_point_arrays () const

void	clear_point_arrays ()


void	set_number_of_steps (const long &v)

const long &	get_number_of_steps () const

fill_value
Set the _FillValue attribute for the output data default -1
void	set_fill_value (const double &v)

const double &	get_fill_value () const


void	set_steps_per_request (const long &v)

const long &	get_steps_per_request () const

Public Member Functions inherited from teca_threaded_algorithm
std::shared_ptr< teca_threaded_algorithm >	shared_from_this ()

std::shared_ptr< teca_threaded_algorithm const >	shared_from_this () const

	teca_threaded_algorithm (const teca_threaded_algorithm &src)=delete

	teca_threaded_algorithm (teca_threaded_algorithm &&src)=delete

teca_threaded_algorithm &	operator= (const teca_threaded_algorithm &src)=delete

teca_threaded_algorithm &	operator= (teca_threaded_algorithm &&src)=delete

const char *	get_class_name () const override

void	set_thread_pool_size (int n_threads)

unsigned int	get_thread_pool_size () const noexcept
	Get the number of threads in the pool. More...

void	set_data_request_queue (const p_teca_data_request_queue &queue)
	explicitly set the thread pool to submit requests to More...

void	set_bind_threads (const int &v)

const int &	get_bind_threads () const

void	set_stream_size (const int &v)

const int &	get_stream_size () const

void	set_poll_interval (const long long &v)

const long long &	get_poll_interval () const

void	set_threads_per_device (const int &v)

const int &	get_threads_per_device () const

void	set_ranks_per_device (const int &v)

const int &	get_ranks_per_device () const

void	set_propagate_device_assignment (const int &v)

const int &	get_propagate_device_assignment () 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_cpp_temporal_reduction	New ()

Static Public Member Functions inherited from teca_threaded_algorithm
static p_teca_threaded_algorithm	New ()

operation
Set the reduction operation default average
enum	{ average , summation , minimum , maximum }

void	set_operation (const int &v)

const int &	get_operation () const

int	set_operation (const std::string &operation)

std::string	get_operation_name ()

interval
Set the type of interval iterator to create default monthly
enum	{ daily = 2 , monthly = 3 , seasonal = 4 , yearly = 5 , n_steps = 6 , all = 7 }

void	set_interval (const int &v)

const int &	get_interval () const

int	set_interval (const std::string &interval)

std::string	get_interval_name ()

Additional Inherited Members
Protected Member Functions inherited from teca_threaded_algorithm
const_p_teca_dataset	execute (unsigned int port, const std::vector< const_p_teca_dataset > &input_data, const teca_metadata &request) override

const_p_teca_dataset	request_data (teca_algorithm_output_port &port, const teca_metadata &request) override

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 &current)

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)
	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

Reduce a mesh across the time dimensions by a defined increment using a defined operation.

time increments: daily, monthly, seasonal, yearly, n_steps, all
reduction operations: average, summation, minimum, maximum

The output time axis will be defined using the selected increment. The output data will be accumulated/reduced using the selected operation.

By default the fill value will be obtained from metadata stored in the NetCDF CF file (_FillValue). One may override this by explicitly calling set_fill_value method with the desired fill value.

For minimum and maximum operations, at given grid point only valid values over the interval are used in the calculation. If there are no valid values over the interval at the grid point it is set to the fill_value.

For the averaging operation, during summation missing values are treated as 0.0 and a per-grid point count of valid values over the interval is maintained and used in the average. Grid points with no valid values over the interval are set to the fill value.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
average	Set the reduction operation to average.
summation	Set the reduction operation to summation.
minimum	Set the reduction operation to minimum.
maximum	Set the reduction operation to maximum.

◆ anonymous enum

anonymous enum

Enumerator
daily	Set the time increment to daily.
monthly	Set the time increment to monthly.
seasonal	Set the time increment to seasonal.
yearly	Set the time increment to yearly.
n_steps	Set the time increment to n steps.
all	Set the time increment to all.

Member Function Documentation

◆ append_point_array()

void teca_cpp_temporal_reduction::append_point_array ( const std::string & v )

inline

append to the point_array algorithm vector property

◆ clear_point_arrays()

void teca_cpp_temporal_reduction::clear_point_arrays ( )

inline

clear the point_array algorithm vector property

◆ get_class_name()

const char* teca_cpp_temporal_reduction::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_fill_value()

const double& teca_cpp_temporal_reduction::get_fill_value ( ) const

inline

Get the value of the fill_value algorithm property

◆ get_interval()

const int& teca_cpp_temporal_reduction::get_interval ( ) const

inline

Get the value of the interval algorithm property

◆ get_number_of_point_arrays()

size_t teca_cpp_temporal_reduction::get_number_of_point_arrays ( )

inline

get the size of the point_array algorithm vector property

◆ get_number_of_steps()

const long& teca_cpp_temporal_reduction::get_number_of_steps ( ) const

inline

Get the value of the number_of_steps algorithm property

◆ get_operation()

const int& teca_cpp_temporal_reduction::get_operation ( ) const

inline

Get the value of the operation algorithm property

◆ get_point_array()

const std::string& teca_cpp_temporal_reduction::get_point_array ( size_t i ) const

inline

get the i-th element of the point_array algorithm vector property

◆ get_point_arrays()

const std::vector< std::string >& teca_cpp_temporal_reduction::get_point_arrays ( ) const

inline

get the point_array algorithm vector property

◆ get_steps_per_request()

const long& teca_cpp_temporal_reduction::get_steps_per_request ( ) const

inline

Get the value of the steps_per_request algorithm property

◆ New()

static p_teca_cpp_temporal_reduction teca_cpp_temporal_reduction::New ( )

inlinestatic

Returns an instance of teca_cpp_temporal_reduction

◆ set_fill_value()

void teca_cpp_temporal_reduction::set_fill_value ( const double & v )

inline

Set the value of the fill_value algorithm property

◆ set_interval()

void teca_cpp_temporal_reduction::set_interval ( const int & v )

inline

Set the value of the interval algorithm property

◆ set_number_of_steps()

void teca_cpp_temporal_reduction::set_number_of_steps ( const long & v )

inline

@number_of_steps For n_steps interval iterator, the desired number of steps should be set. default 0 Set the value of the number_of_steps algorithm property

◆ set_operation()

void teca_cpp_temporal_reduction::set_operation ( const int & v )

inline

Set the value of the operation algorithm property

◆ set_point_array() [1/2]

void teca_cpp_temporal_reduction::set_point_array ( const std::string & v )

inline

set the point_array algorithm vector property to a single value

◆ set_point_array() [2/2]

void teca_cpp_temporal_reduction::set_point_array	(	size_t	i,
		const std::string &	v
	)

inline

set the i-th element of the point_array algorithm vector property

◆ set_point_arrays() [1/2]

void teca_cpp_temporal_reduction::set_point_arrays ( const std::initializer_list< std::string > && l )

inline

set the point_array algorithm vector property

◆ set_point_arrays() [2/2]

void teca_cpp_temporal_reduction::set_point_arrays ( const std::vector< std::string > & v )

inline

set the point_array algorithm vector property

◆ set_steps_per_request()

void teca_cpp_temporal_reduction::set_steps_per_request ( const long & v )

inline

@step_per_request Set the number of time steps per request default 1 Set the value of the steps_per_request algorithm property

◆ shared_from_this() [1/2]

std::shared_ptr< teca_cpp_temporal_reduction > teca_cpp_temporal_reduction::shared_from_this ( )

inline

Enables the static constructor

◆ shared_from_this() [2/2]

std::shared_ptr< teca_cpp_temporal_reduction const> teca_cpp_temporal_reduction::shared_from_this ( ) const

inline

Enables the static constructor

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

rtdfixjuly2025/alg/teca_temporal_reduction.h

Public Member Functions

Static Public Member Functions

operation

interval

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Member Function Documentation

◆ append_point_array()

◆ clear_point_arrays()

◆ get_class_name()

◆ get_fill_value()

◆ get_interval()

◆ get_number_of_point_arrays()

◆ get_number_of_steps()

◆ get_operation()

◆ get_point_array()

◆ get_point_arrays()

◆ get_steps_per_request()

◆ New()

◆ set_fill_value()

◆ set_interval()

◆ set_number_of_steps()

◆ set_operation()

◆ set_point_array() [1/2]

◆ set_point_array() [2/2]

◆ set_point_arrays() [1/2]

◆ set_point_arrays() [2/2]

◆ set_steps_per_request()

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]