An algorithm that computes a binary segmentation. More...

#include <teca_binary_segmentation.h>

Inheritance diagram for teca_binary_segmentation:

Collaboration diagram for teca_binary_segmentation:

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

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

	teca_binary_segmentation (const teca_binary_segmentation &src)=delete

	teca_binary_segmentation (teca_binary_segmentation &&src)=delete

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

teca_binary_segmentation &	operator= (teca_binary_segmentation &&src)=delete

const char *	get_class_name () const override

segmentation_variable
set the name of the output array to store the resulting segmentation in
void	set_segmentation_variable (const std::string &v)

const std::string &	get_segmentation_variable () const

segmentation_variable_attributes
set extra metadata for the segmentation variable
void	set_segmentation_variable_attributes (const teca_metadata &v)

const teca_metadata &	get_segmentation_variable_attributes () const

threshold_variable
set the name of the input array to segment
void	set_threshold_variable (const std::string &v)

const std::string &	get_threshold_variable () const

low_threshold_value
Set the threshold range. The defaults are (-infinity, infinity].
void	set_low_threshold_value (const double &v)

const double &	get_low_threshold_value () const

high_threshold_value
Set the threshold range. The defaults are (-infinity, infinity].
void	set_high_threshold_value (const double &v)

const double &	get_high_threshold_value () 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_binary_segmentation	New ()

Protected Member Functions
int	get_segmentation_variable (std::string &segmentation_var)

int	get_threshold_variable (std::string &threshold_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...

threshold_mode
Set the threshold mode. In BY_PERCENTILE mode low and high thresholds define the percentiles (0 to 100) between which data is in the segmentation. default is BY_VALUE.
enum	{ BY_VALUE =0 , BY_PERCENTILE =1 }

void	set_threshold_mode (const int &v)

const int &	get_threshold_mode () const

void	set_threshold_by_percentile ()
	Set the threshold_mode to percentile. More...

void	set_threshold_by_value ()
	Set the threshold_mode to value. More...

Additional Inherited Members
Protected Attributes inherited from teca_algorithm
int	verbose

Detailed Description

An algorithm that computes a binary segmentation.

an algorithm that computes a binary segmentation for 1D, 2D, and 3D data. The segmentation is computed using threshold operation where values in a range (low, high] are in the segmentation (assigned 1). Values outside the range are outside of the segmentation (assigned 0).

The algorithm has 2 modes, BY_VALUE and BY_PERCENTILE. In the BY_VALUE mode, the test for inclusion is applied on the raw data. In the BY_PERCENTILE mode the range is given in percentiles and each data point is converted to a percentile before applying the test for inclusion.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

The threshold_mode modes

Member Function Documentation

◆ get_class_name()

const char* teca_binary_segmentation::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_high_threshold_value()

const double& teca_binary_segmentation::get_high_threshold_value ( ) const

inline

Get the value of the high_threshold_value algorithm property

◆ get_low_threshold_value()

const double& teca_binary_segmentation::get_low_threshold_value ( ) const

inline

Get the value of the low_threshold_value algorithm property

◆ get_segmentation_variable()

const std::string& teca_binary_segmentation::get_segmentation_variable ( ) const

inline

Get the value of the segmentation_variable algorithm property

◆ get_segmentation_variable_attributes()

const teca_metadata& teca_binary_segmentation::get_segmentation_variable_attributes ( ) const

inline

Get the value of the segmentation_variable_attributes algorithm property

◆ get_threshold_mode()

const int& teca_binary_segmentation::get_threshold_mode ( ) const

inline

Get the value of the threshold_mode algorithm property

◆ get_threshold_variable()

const std::string& teca_binary_segmentation::get_threshold_variable ( ) const

inline

Get the value of the threshold_variable algorithm property

◆ New()

static p_teca_binary_segmentation teca_binary_segmentation::New ( )

inlinestatic

Returns an instance of teca_binary_segmentation

◆ set_high_threshold_value()

void teca_binary_segmentation::set_high_threshold_value ( const double & v )

inline

Set the value of the high_threshold_value algorithm property

◆ set_low_threshold_value()

void teca_binary_segmentation::set_low_threshold_value ( const double & v )

inline

Set the value of the low_threshold_value algorithm property

◆ set_segmentation_variable()

void teca_binary_segmentation::set_segmentation_variable ( const std::string & v )

inline

Set the value of the segmentation_variable algorithm property

◆ set_segmentation_variable_attributes()

void teca_binary_segmentation::set_segmentation_variable_attributes ( const teca_metadata & v )

inline

Set the value of the segmentation_variable_attributes algorithm property

◆ set_threshold_by_percentile()

void teca_binary_segmentation::set_threshold_by_percentile ( )

inline

Set the threshold_mode to percentile.

◆ set_threshold_by_value()

void teca_binary_segmentation::set_threshold_by_value ( )

inline

Set the threshold_mode to value.

◆ set_threshold_mode()

void teca_binary_segmentation::set_threshold_mode ( const int & v )

inline

Set the value of the threshold_mode algorithm property

◆ set_threshold_variable()

void teca_binary_segmentation::set_threshold_variable ( const std::string & v )

inline

Set the value of the threshold_variable algorithm property

◆ shared_from_this() [1/2]

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

inline

Enables the static constructor

◆ shared_from_this() [2/2]

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

inline

Enables the static constructor

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

rtdfixjuly2025/alg/teca_binary_segmentation.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

threshold_mode

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Member Function Documentation

◆ get_class_name()

◆ get_high_threshold_value()

◆ get_low_threshold_value()

◆ get_segmentation_variable()

◆ get_segmentation_variable_attributes()

◆ get_threshold_mode()

◆ get_threshold_variable()

◆ New()

◆ set_high_threshold_value()

◆ set_low_threshold_value()

◆ set_segmentation_variable()

◆ set_segmentation_variable_attributes()

◆ set_threshold_by_percentile()

◆ set_threshold_by_value()

◆ set_threshold_mode()

◆ set_threshold_variable()

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]