An algorithm that computes the areas of labeled regions. More...

#include <teca_2d_component_area.h>

Inheritance diagram for teca_2d_component_area:

Collaboration 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

component_variable
Sets the name of the array containing component labels to compute the area of.
void	set_component_variable (const std::string &v)

const std::string &	get_component_variable () const

contiguous_component_ids
set this only if you know for certain that label ids are contiguous and start at 0. this enables use of a faster implementation.
void	set_contiguous_component_ids (const int &v)

const int &	get_contiguous_component_ids () const

background_id
set this to override the component label used for background. By default this is set to -1 to indicate that the value should be obtained from the metadata key `background_id`. Note that TECA's connected component labeler uses the id 0 for the background and passes this in a metadata key and as a result no action is required.
void	set_background_id (const long &v)

const long &	get_background_id () const

output_metadata_prefix
set this to a prefix for the metadata keys used to store the component ids and areas. By default this is emtpy, i.e. no prefix.
void	set_output_metadata_prefix (const std::string &v)

const std::string &	get_output_metadata_prefix () 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_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)
	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

An algorithm that computes the areas 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:

name	description
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.

Member Function Documentation

◆ get_background_id()

const long& teca_2d_component_area::get_background_id ( ) const

inline

Get the value of the background_id algorithm property

◆ get_class_name()

const char* teca_2d_component_area::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_component_variable()

const std::string& teca_2d_component_area::get_component_variable ( ) const

inline

Get the value of the component_variable algorithm property

◆ get_contiguous_component_ids()

const int& teca_2d_component_area::get_contiguous_component_ids ( ) const

inline

Get the value of the contiguous_component_ids algorithm property

◆ get_output_metadata_prefix()

const std::string& teca_2d_component_area::get_output_metadata_prefix ( ) const

inline

Get the value of the output_metadata_prefix algorithm property

◆ New()

static p_teca_2d_component_area teca_2d_component_area::New ( )

inlinestatic

Returns an instance of teca_2d_component_area

◆ set_background_id()

void teca_2d_component_area::set_background_id ( const long & v )

inline

Set the value of the background_id algorithm property

◆ set_component_variable()

void teca_2d_component_area::set_component_variable ( const std::string & v )

inline

Set the value of the component_variable algorithm property

◆ set_contiguous_component_ids()

void teca_2d_component_area::set_contiguous_component_ids ( const int & v )

inline

Set the value of the contiguous_component_ids algorithm property

◆ set_output_metadata_prefix()

void teca_2d_component_area::set_output_metadata_prefix ( const std::string & v )

inline

Set the value of the output_metadata_prefix algorithm property

◆ shared_from_this() [1/2]

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

inline

Enables the static constructor

◆ shared_from_this() [2/2]

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

inline

Enables the static constructor

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

develop/alg/teca_2d_component_area.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_background_id()

◆ get_class_name()

◆ get_component_variable()

◆ get_contiguous_component_ids()

◆ get_output_metadata_prefix()

◆ New()

◆ set_background_id()

◆ set_component_variable()

◆ set_contiguous_component_ids()

◆ set_output_metadata_prefix()

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]