TTK processing package that takes an input ensemble data set (represented by a list of scalar fields) and which computes various vertexwise statistics (PDF estimation, bounds, moments, etc.) More...

#include <UncertainDataEstimator.h>

Inheritance diagram for ttk::UncertainDataEstimator:

Public Member Functions
	UncertainDataEstimator ()

template<class dataType >
int	execute ()

int	setInputDataPointer (const int idx, void *const data)

void	setOutputLowerBoundField (void *const data)

void	setOutputUpperBoundField (void *const data)

void	setOutputProbability (const int idx, double *const data)

void	setOutputMeanField (void *const data)

void	setComputeLowerBound (const bool state)

void	setComputeUpperBound (const bool state)

void	setVertexNumber (const SimplexId &vertexNumber)

void	setBinCount (const int binCount)

void	setNumberOfInputs (const int numberOfInputs)

double	getBinValue (int b)

Public Member Functions inherited from ttk::Debug
	Debug ()

	~Debug () override

virtual int	setDebugLevel (const int &debugLevel)

int	setWrapper (const Wrapper *wrapper) override

int	printMsg (const std::string &msg, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printMsg (const std::vector< std::string > &msgs, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printErr (const std::string &msg, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cerr) const

int	printWrn (const std::string &msg, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cerr) const

int	printMsg (const std::string &msg, const double &progress, const double &time, const int &threads, const double &memory, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const

int	printMsg (const std::string &msg, const double &progress, const double &time, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const

int	printMsg (const std::string &msg, const double &progress, const double &time, const int &threads, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const

int	printMsg (const std::string &msg, const double &progress, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const

int	printMsg (const std::string &msg, const double &progress, const debug::Priority &priority, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printMsg (const std::vector< std::vector< std::string > > &rows, const debug::Priority &priority=debug::Priority::INFO, const bool hasHeader=true, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printMsg (const debug::Separator &separator, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::INFO, std::ostream &stream=std::cout) const

int	printMsg (const debug::Separator &separator, const debug::Priority &priority, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printMsg (const std::string &msg, const debug::Separator &separator, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::INFO, std::ostream &stream=std::cout) const

void	setDebugMsgPrefix (const std::string &prefix)

Public Member Functions inherited from ttk::BaseClass
	BaseClass ()

virtual	~BaseClass ()=default

int	getThreadNumber () const

virtual int	setThreadNumber (const int threadNumber)

Protected Attributes
SimplexId	vertexNumber_ {0}

int	numberOfInputs_ {0}

int	BinCount {0}

std::vector< double >	binValues_ {}

bool	ComputeLowerBound {}

bool	ComputeUpperBound {}

std::vector< void * >	inputData_ {}

void *	outputLowerBoundField_ {}

void *	outputUpperBoundField_ {}

std::vector< double * >	outputProbability_ {}

void *	outputMeanField_ {}

Protected Attributes inherited from ttk::Debug
int	debugLevel_

std::string	debugMsgPrefix_

std::string	debugMsgNamePrefix_

Protected Attributes inherited from ttk::BaseClass
bool	lastObject_

int	threadNumber_

Wrapper *	wrapper_

Additional Inherited Members
Protected Member Functions inherited from ttk::Debug
int	printMsgInternal (const std::string &msg, const std::string &right, const std::string &filler, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printMsgInternal (const std::string &msg, const debug::Priority &priority, const debug::LineMode &lineMode, std::ostream &stream=std::cout) const

int	welcomeMsg (std::ostream &stream)

Static Protected Attributes inherited from ttk::Debug
static COMMON_EXPORTS debug::LineMode	lastLineMode = ttk::debug::LineMode::NEW

Detailed Description

TTK processing package that takes an input ensemble data set (represented by a list of scalar fields) and which computes various vertexwise statistics (PDF estimation, bounds, moments, etc.)

Author: Michael Michaux micha.nosp@m.uxmi.nosp@m.chael.nosp@m.89@g.nosp@m.mail..nosp@m.com

Date: August 2016.

See also: ttkUncertainDataEstimator.cpp for a usage example.

Definition at line 185 of file UncertainDataEstimator.h.

Constructor & Destructor Documentation

◆ UncertainDataEstimator()

ttk::UncertainDataEstimator::UncertainDataEstimator ( )

Definition at line 3 of file UncertainDataEstimator.cpp.

Member Function Documentation

◆ execute()

template<class dataType >

int ttk::UncertainDataEstimator::execute ( )

Execute the package.

Returns: Returns 0 upon success, negative values otherwise.

Definition at line 288 of file UncertainDataEstimator.h.

◆ getBinValue()

double ttk::UncertainDataEstimator::getBinValue ( int b )

inline

Definition at line 266 of file UncertainDataEstimator.h.

◆ setBinCount()

void ttk::UncertainDataEstimator::setBinCount ( const int binCount )

inline

Definition at line 249 of file UncertainDataEstimator.h.

◆ setComputeLowerBound()

void ttk::UncertainDataEstimator::setComputeLowerBound ( const bool state )

inline

Definition at line 234 of file UncertainDataEstimator.h.

◆ setComputeUpperBound()

void ttk::UncertainDataEstimator::setComputeUpperBound ( const bool state )

inline

Definition at line 238 of file UncertainDataEstimator.h.

◆ setInputDataPointer()

int ttk::UncertainDataEstimator::setInputDataPointer	(	const int	idx,
		void *const	data
	)

inline

Pass a pointer to an input array representing a scalarfield. The array is expected to be correctly allocated. idx in [0,numberOfInputs_[

Parameters

idx	Index of the input scalar field.
data	Pointer to the data array.

Returns: Returns 0 upon success, negative values otherwise.

See also: setNumberOfInputs() and setVertexNumber().

Definition at line 199 of file UncertainDataEstimator.h.

◆ setNumberOfInputs()

void ttk::UncertainDataEstimator::setNumberOfInputs ( const int numberOfInputs )

inline

Set the number of input scalar fields

Parameters

numberOfInputs Number of input scalar fields.

Returns: Returns 0 upon success, negative values otherwise

Definition at line 260 of file UncertainDataEstimator.h.

◆ setOutputLowerBoundField()

void ttk::UncertainDataEstimator::setOutputLowerBoundField ( void *const data )

inline

Pass a pointer to an output array representing the lower bound scalar field. The array is expected to be correctly allocated.

Parameters

data	Pointer to the data array.

Returns: Returns 0 upon success, negative values otherwise.

See also: setVertexNumber()

Definition at line 212 of file UncertainDataEstimator.h.

◆ setOutputMeanField()

void ttk::UncertainDataEstimator::setOutputMeanField ( void *const data )

inline

Definition at line 230 of file UncertainDataEstimator.h.

◆ setOutputProbability()

void ttk::UncertainDataEstimator::setOutputProbability	(	const int	idx,
		double *const	data
	)

inline

Definition at line 224 of file UncertainDataEstimator.h.

◆ setOutputUpperBoundField()

void ttk::UncertainDataEstimator::setOutputUpperBoundField ( void *const data )

inline

Pass a pointer to an output array representing the upper bound scalar field. The array is expected to be correctly allocated.

Parameters

data	Pointer to the data array.

Returns: Returns 0 upon success, negative values otherwise.

See also: setVertexNumber()

Definition at line 220 of file UncertainDataEstimator.h.

◆ setVertexNumber()

void ttk::UncertainDataEstimator::setVertexNumber ( const SimplexId & vertexNumber )

inline

Set the number of vertices in the scalar field.

Parameters

vertexNumber Number of vertices in the data-set.

Returns: Returns 0 upon success, negative values otherwise.

Definition at line 245 of file UncertainDataEstimator.h.

Member Data Documentation

◆ BinCount

int ttk::UncertainDataEstimator::BinCount {0}

protected

Definition at line 275 of file UncertainDataEstimator.h.

◆ binValues_

std::vector<double> ttk::UncertainDataEstimator::binValues_ {}

protected

Definition at line 276 of file UncertainDataEstimator.h.

◆ ComputeLowerBound

bool ttk::UncertainDataEstimator::ComputeLowerBound {}

protected

Definition at line 277 of file UncertainDataEstimator.h.

◆ ComputeUpperBound

bool ttk::UncertainDataEstimator::ComputeUpperBound {}

protected

Definition at line 278 of file UncertainDataEstimator.h.

◆ inputData_

std::vector<void *> ttk::UncertainDataEstimator::inputData_ {}

protected

Definition at line 279 of file UncertainDataEstimator.h.

◆ numberOfInputs_

int ttk::UncertainDataEstimator::numberOfInputs_ {0}

protected

Definition at line 274 of file UncertainDataEstimator.h.

◆ outputLowerBoundField_

void* ttk::UncertainDataEstimator::outputLowerBoundField_ {}

protected

Definition at line 280 of file UncertainDataEstimator.h.

◆ outputMeanField_

void* ttk::UncertainDataEstimator::outputMeanField_ {}

protected

Definition at line 283 of file UncertainDataEstimator.h.

◆ outputProbability_

std::vector<double *> ttk::UncertainDataEstimator::outputProbability_ {}

protected

Definition at line 282 of file UncertainDataEstimator.h.

◆ outputUpperBoundField_

void* ttk::UncertainDataEstimator::outputUpperBoundField_ {}

protected

Definition at line 281 of file UncertainDataEstimator.h.

◆ vertexNumber_

SimplexId ttk::UncertainDataEstimator::vertexNumber_ {0}

protected

Definition at line 273 of file UncertainDataEstimator.h.

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

/home/julien/Pro/git/github/ttk-tierny/core/base/uncertainDataEstimator/UncertainDataEstimator.h
/home/julien/Pro/git/github/ttk-tierny/core/base/uncertainDataEstimator/UncertainDataEstimator.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UncertainDataEstimator()

Member Function Documentation

◆ execute()

◆ getBinValue()

◆ setBinCount()

◆ setComputeLowerBound()

◆ setComputeUpperBound()

◆ setInputDataPointer()

◆ setNumberOfInputs()

◆ setOutputLowerBoundField()

◆ setOutputMeanField()

◆ setOutputProbability()

◆ setOutputUpperBoundField()

◆ setVertexNumber()

Member Data Documentation

◆ BinCount

◆ binValues_

◆ ComputeLowerBound

◆ ComputeUpperBound

◆ inputData_

◆ numberOfInputs_

◆ outputLowerBoundField_

◆ outputMeanField_

◆ outputProbability_

◆ outputUpperBoundField_

◆ vertexNumber_