teca_cartesian_mesh_coordinate_transform Class Reference

#include <teca_cartesian_mesh_coordinate_transform.h>

Inheritance diagram for teca_cartesian_mesh_coordinate_transform:

Collaboration diagram for teca_cartesian_mesh_coordinate_transform:

Public Member Functions
std::shared_ptr< teca_cartesian_mesh_coordinate_transform >	shared_from_this ()
std::shared_ptr< teca_cartesian_mesh_coordinate_transform const >	shared_from_this () const
	teca_cartesian_mesh_coordinate_transform (const teca_cartesian_mesh_coordinate_transform &src)=delete
	teca_cartesian_mesh_coordinate_transform (teca_cartesian_mesh_coordinate_transform &&src)=delete
teca_cartesian_mesh_coordinate_transform &	operator= (const teca_cartesian_mesh_coordinate_transform &src)=delete
teca_cartesian_mesh_coordinate_transform &	operator= (teca_cartesian_mesh_coordinate_transform &&src)=delete
const char *	get_class_name () const override
target_bounds
6 double precision values that define the output coordinate axis bounds, specified in the following order : [x0 x1 y0 y1 z0 z1]. The Cartesian mesh is transformed such that its coordinatres span the specified target bounds while maintaining relative spacing of original input coordinate points. Pass [1, 0] for each axis that should not be transformed.
size_t	get_number_of_target_bounds ()
void	append_target_bound (const double &v)
void	set_target_bound (const double &v)
void	set_target_bound (size_t i, const double &v)
void	set_target_bounds (const std::vector< double > &v)
void	set_target_bounds (const std::initializer_list< double > &&l)
const double &	get_target_bound (size_t i) const
const std::vector< double > &	get_target_bounds () const
void	clear_target_bounds ()
int	set_target_bounds (const teca_metadata &md)
x_axis_variable
Set the name of the variable to use for the x coordinate axis. When set to an empty string (the default) the existing name is passed through.
void	set_x_axis_variable (const std::string &v)
const std::string &	get_x_axis_variable () const
y_axis_variable
Set the name of the variable to use for the y coordinate axis. When set to an empty string (the default) the existing name is passed through. Set the name of the variable to use for the y coordinate axis. An empty string disables the renaming of this dimension passing through the original name.
void	set_y_axis_variable (const std::string &v)
const std::string &	get_y_axis_variable () const
z_axis_variable
Set the name of the variable to use for the z coordinate axis. When set to an empty string (the default) the existing name is passed through.
void	set_z_axis_variable (const std::string &v)
const std::string &	get_z_axis_variable () const
x_axis_units
Set the units for the x coordinate axis. When set to an empty string (the default) existing uints if any are passed through unmodified.
void	set_x_axis_units (const std::string &v)
const std::string &	get_x_axis_units () const
y_axis_units
Set the units for the y coordinate axis. When set to an empty string (the default) existing uints if any are passed through unmodified.
void	set_y_axis_units (const std::string &v)
const std::string &	get_y_axis_units () const
z_axis_units
Set the units for the z coordinate axis. When set to an empty string (the default) existing uints if any are passed through unmodified.
void	set_z_axis_units (const std::string &v)
const std::string &	get_z_axis_units () 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_cartesian_mesh_coordinate_transform	New ()

Protected Member Functions
void	set_modified () 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)
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 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)
	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...

Additional Inherited Members
Protected Attributes inherited from teca_algorithm
int	verbose

Detailed Description

@breif Transforms the coordinate axes of a stretched Cartesian mesh without modifying the fields on the mesh.

Transform the spatial coorindate axes of an input dataset such that a given target bounding box is covered by the output mesh. The relative spacing of the input coordinates are maintained. The target bounding box must be provided as a 6-tuple in the form [x0, x1, y0, y1, z0, z1] where 3 consecutive 2-tuples define the bounds in each coordinate direction. If any of the 2-tuples are set such that the low bound is greater than the high bound the transform is skipped in that direction and existing coordinate axis array is passed through. The transform only modifies the coodinate axis arrays, not the fields defined on the mesh. The coordinate axes may optionally be renamed and new units provided.

Member Function Documentation

append_target_bound()

void teca_cartesian_mesh_coordinate_transform::append_target_bound ( const double &  v )

inline

append to the target_bound algorithm vector property

clear_target_bounds()

void teca_cartesian_mesh_coordinate_transform::clear_target_bounds ( )

inline

clear the target_bound algorithm vector property

get_class_name()

const char* teca_cartesian_mesh_coordinate_transform::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

get_number_of_target_bounds()

size_t teca_cartesian_mesh_coordinate_transform::get_number_of_target_bounds ( )

inline

get the size of the target_bound algorithm vector property

get_target_bound()

const double& teca_cartesian_mesh_coordinate_transform::get_target_bound ( size_t  i ) const

inline

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

get_target_bounds()

const std::vector< double >& teca_cartesian_mesh_coordinate_transform::get_target_bounds ( ) const

inline

get the target_bound algorithm vector property

get_x_axis_units()

const std::string& teca_cartesian_mesh_coordinate_transform::get_x_axis_units ( ) const

inline

Get the value of the x_axis_units algorithm property

get_x_axis_variable()

const std::string& teca_cartesian_mesh_coordinate_transform::get_x_axis_variable ( ) const

inline

Get the value of the x_axis_variable algorithm property

get_y_axis_units()

const std::string& teca_cartesian_mesh_coordinate_transform::get_y_axis_units ( ) const

inline

Get the value of the y_axis_units algorithm property

get_y_axis_variable()

const std::string& teca_cartesian_mesh_coordinate_transform::get_y_axis_variable ( ) const

inline

Get the value of the y_axis_variable algorithm property

get_z_axis_units()

const std::string& teca_cartesian_mesh_coordinate_transform::get_z_axis_units ( ) const

inline

Get the value of the z_axis_units algorithm property

get_z_axis_variable()

const std::string& teca_cartesian_mesh_coordinate_transform::get_z_axis_variable ( ) const

inline

Get the value of the z_axis_variable algorithm property

New()

static p_teca_cartesian_mesh_coordinate_transform teca_cartesian_mesh_coordinate_transform::New ( )

inlinestatic

Returns an instance of teca_cartesian_mesh_coordinate_transform

set_modified()

void teca_cartesian_mesh_coordinate_transform::set_modified ( )

overrideprotectedvirtual

set the modified flag on the given output port's cache. should be called when user modifies properties on the object that require the output to be regenerated.

Reimplemented from teca_algorithm.

set_target_bound() [1/2]

void teca_cartesian_mesh_coordinate_transform::set_target_bound ( const double &  v )

inline

set the target_bound algorithm vector property to a single value

set_target_bound() [2/2]

void teca_cartesian_mesh_coordinate_transform::set_target_bound ( size_t  i, const double &  v  )

inline

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

set_target_bounds() [1/3]

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

inline

set the target_bound algorithm vector property

set_target_bounds() [2/3]

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

inline

set the target_bound algorithm vector property

set_target_bounds() [3/3]

int teca_cartesian_mesh_coordinate_transform::set_target_bounds

(

const teca_metadata &

md

)

set the target bounds from a metadata object following conventions defined by the teca_cf_reader. returns 0 if sccessful or nonzero if the metadata object is missing the requisite keys.

set_x_axis_units()

void teca_cartesian_mesh_coordinate_transform::set_x_axis_units ( const std::string &  v )

inline

Set the value of the x_axis_units algorithm property

set_x_axis_variable()

void teca_cartesian_mesh_coordinate_transform::set_x_axis_variable ( const std::string &  v )

inline

Set the value of the x_axis_variable algorithm property

set_y_axis_units()

void teca_cartesian_mesh_coordinate_transform::set_y_axis_units ( const std::string &  v )

inline

Set the value of the y_axis_units algorithm property

set_y_axis_variable()

void teca_cartesian_mesh_coordinate_transform::set_y_axis_variable ( const std::string &  v )

inline

Set the value of the y_axis_variable algorithm property

set_z_axis_units()

void teca_cartesian_mesh_coordinate_transform::set_z_axis_units ( const std::string &  v )

inline

Set the value of the z_axis_units algorithm property

set_z_axis_variable()

void teca_cartesian_mesh_coordinate_transform::set_z_axis_variable ( const std::string &  v )

inline

Set the value of the z_axis_variable algorithm property

shared_from_this() [1/2]

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

inline

Enables the static constructor

shared_from_this() [2/2]

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

inline

Enables the static constructor

---

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

• develop/alg/teca_cartesian_mesh_coordinate_transform.h