an algorithm that computes the area of labeled regions More...

#include <teca_2d_component_area.h>

Inheritance diagram for teca_2d_component_area:

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

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

	teca_2d_component_area (const teca_2d_component_area &src)=delete

	teca_2d_component_area (teca_2d_component_area &&src)=delete

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

teca_2d_component_area &	operator= (teca_2d_component_area &&src)=delete

const char *	get_class_name () const override

void	set_component_variable (const std::string &v)

const std::string &	get_component_variable () const

void	set_contiguous_component_ids (const int &v)

const int &	get_contiguous_component_ids () const

void	set_background_id (const long &v)

const long &	get_background_id () 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_2d_component_area	New ()

Protected Member Functions
int	get_component_variable (std::string &component_var)

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 &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 computes the area of labeled regions

Given a set of labels on a Cartesian mesh, the algorithm computes the area of each region. Regions are identified by assigning a unique integer value to each mesh point that belongs in the region. The component_variable property names the variable containing the region labels.

if the region labels start at 0 and are contiguous then an optimization can be used. Set contiguous_component_ids property to enable the optimization. Note that TECA's connected component labeler assigns the background (i.e. cells not inside the segmentation) the label 0. One can identify the background region and area via this label. When processing data generated outside of TECA it might be necessary to supply the background label. Use -2 if there is no background.

the input dataset is passed through and the results of the calculations are stored in the output dataset metadata in the following keys:

number_of_components - number of component ids for which area was
                       computed. Note that this can include a background
                       component i.e. for cells outside of the segmentation.

component_ids - a vector containing the label of each component. This is
                always starts with 0, where the label 0 identifies cells
                out side of the segmentation, and ranges up to
                number_of_components - 1, where the labels from 1 up to
                number_of_components - 1 identify connected regions of
                cells inside the segmentation.

component_area - a vector containing the area for the corresponding entry
                 in the component_ids array.

background_id - the label used for cells outside of the segmentation,
                i.e. the background. This can be used to skip processing
                of the background when desirable.

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

TECA/alg/teca_2d_component_area.h
TECA/alg/teca_2d_component_area.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description