a reader for data stored in NetCDF CF format More...

#include <teca_cf_reader.h>

Inheritance diagram for teca_cf_reader:

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

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

	teca_cf_reader (const teca_cf_reader &src)=delete

	teca_cf_reader (teca_cf_reader &&src)=delete

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

teca_cf_reader &	operator= (teca_cf_reader &&src)=delete

const char *	get_class_name () const override

size_t	get_number_of_file_names ()

void	append_file_name (const std::string &v)

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

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

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

void	set_file_names (const const_p_teca_variant_array &v)

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

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

void	get_file_names (const p_teca_variant_array &v) const

void	clear_file_names ()

void	set_files_regex (const std::string &v)

const std::string &	get_files_regex () const

void	set_periodic_in_x (const int &v)

const int &	get_periodic_in_x () const

void	set_periodic_in_y (const int &v)

const int &	get_periodic_in_y () const

void	set_periodic_in_z (const int &v)

const int &	get_periodic_in_z () const

void	set_x_axis_variable (const std::string &v)

const std::string &	get_x_axis_variable () const

void	set_y_axis_variable (const std::string &v)

const std::string &	get_y_axis_variable () const

void	set_z_axis_variable (const std::string &v)

const std::string &	get_z_axis_variable () const

void	set_t_axis_variable (const std::string &v)

const std::string &	get_t_axis_variable () const

void	set_t_calendar (const std::string &v)

const std::string &	get_t_calendar () const

void	set_t_units (const std::string &v)

const std::string &	get_t_units () const

void	set_filename_time_template (const std::string &v)

const std::string &	get_filename_time_template () const

size_t	get_number_of_t_values ()

void	append_t_value (const double &v)

void	set_t_value (size_t i, const double &v)

void	set_t_values (const std::vector< double > &v)

void	set_t_values (const std::initializer_list< double > &&l)

void	set_t_values (const const_p_teca_variant_array &v)

const double &	get_t_value (size_t i) const

void	get_t_values (std::vector< double > &v) const

void	get_t_values (const p_teca_variant_array &v) const

void	clear_t_values ()

void	set_max_metadata_ranks (const int &v)

const int &	get_max_metadata_ranks () 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_cf_reader	New ()

Protected Member Functions
void	clear_cached_metadata ()

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)

void	set_modified (unsigned int port)

virtual std::vector< teca_metadata >	get_upstream_request (unsigned int port, const std::vector< teca_metadata > &input_md, const teca_metadata &request)

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

a reader for data stored in NetCDF CF format

reads a set of arrays from single time step into a cartesian mesh. the mesh is optionally subset.

metadata keys: variables - a list of all available variables. - a metadata object holding all NetCDF attributes for the variable named time variables - a list of all variables with time as the only dimension coordinates - a metadata object holding names and arrays of the coordinate axes x_axis_variable - name of x axis variable y_axis_variable - name of y axis variable z_axis_variable - name of z axis variable t_axis_variable - name of t axis variable x - array of x coordinates y - array of y coordinates z - array of z coordinates t - array of t coordinates files - list of files in this dataset step_count - list of the number of steps in each file number_of_time_steps - total number of time steps in all files whole_extent - index space extent describing (nodal) dimensions of the mesh

request keys: time_step - the time step to read arrays - list of arrays to read extent - index space extents describing the subset of data to read

output: generates a 1,2 or 3D cartesian mesh for the requested timestep on the requested extent with the requested point based arrays and value at this timestep for all time variables.

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

TECA/io/teca_cf_reader.h
TECA/io/teca_cf_reader.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description