TTK VTK-filter 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 <ttkUncertainDataEstimator.h>

Inheritance diagram for ttkUncertainDataEstimator:

Public Types
typedef ttkAlgorithm	Superclass

Public Types inherited from ttkAlgorithm
typedef vtkAlgorithm	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

virtual bool	GetComputeLowerBound ()

virtual void	SetComputeLowerBound (bool)

virtual bool	GetComputeUpperBound ()

virtual void	SetComputeUpperBound (bool)

virtual int	GetBinCount ()

virtual void	SetBinCount (int)

void	SetBoundToCompute (int value)

Public Member Functions inherited from ttkAlgorithm
void	UpdateThreadNumber ()

void	SetThreadNumber (int threadNumber)

void	SetUseAllCores (bool useAllCores)

void	SetDebugLevel (int debugLevel)

void	SetCompactTriangulationCacheSize (float cacheSize)

vtkDataArray *	GetOptionalArray (const bool &enforceArrayIndex, const int &arrayIndex, const std::string &arrayName, vtkDataSet *const inputData, const int &inputPort=0)

vtkDataArray *	GetOrderArray (vtkDataSet const inputData, const int scalarArrayIdx, ttk::Triangulation triangulation, const bool getGlobalOrder=false, const int orderArrayIdx=0, const bool enforceOrderArrayIdx=false)

vtkDataArray *	checkForGlobalAndComputeOrderArray (vtkDataSet const inputData, vtkDataArray scalarArray, const int scalarArrayIdx, const bool getGlobalOrder, vtkDataArray orderArray, ttk::Triangulation triangulation, const bool enforceOrderArrayIdx)

vtkDataArray *	ComputeOrderArray (vtkDataSet const inputData, vtkDataArray scalarArray, const int scalarArrayIdx, const bool getGlobalOrder, vtkDataArray oldOrderArray, ttk::Triangulation triangulation)

ttk::SimplexId *	GetIdentifierArrayPtr (const bool &enforceArrayIndex, const int &arrayIndex, const std::string &arrayName, vtkDataSet *const inputData, std::vector< ttk::SimplexId > &spareStorage, const int inputPort=0, const bool printErr=true)

ttk::Triangulation *	GetTriangulation (vtkDataSet *dataSet)

int	ProcessRequest (vtkInformation request, vtkInformationVector inputVectors, vtkInformationVector outputVector) override

vtkDataSet *	GetOutput ()

vtkDataSet *	GetOutput (int)

void	SetInputData (vtkDataSet *)

void	SetInputData (int, vtkDataSet *)

void	AddInputData (vtkDataSet *)

void	AddInputData (int, vtkDataSet *)

template<typename inputType >
int	checkEmptyMPIInput (inputType *input)
	This method tests whether the input is a nullptr. If the computation is being done on multiple processes, it is possible that the domain of one process or more is empty, but not others, therefore in that particular case the rest of the filter will not be computed but an error message will not be sent.

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)

Static Public Member Functions
static ttkUncertainDataEstimator *	New ()

static int	IsTypeOf (const char *type)

static ttkUncertainDataEstimator *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from ttkAlgorithm
static ttkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static ttkAlgorithm *	SafeDownCast (vtkObject *o)

static std::string	GetOrderArrayName (vtkDataArray *const array)

static vtkInformationIntegerKey *	SAME_DATA_TYPE_AS_INPUT_PORT ()

Protected Member Functions
	ttkUncertainDataEstimator ()

int	FillInputPortInformation (int port, vtkInformation *info) override

int	FillOutputPortInformation (int port, vtkInformation *info) override

int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override

Protected Member Functions inherited from ttkAlgorithm
	ttkAlgorithm ()

	~ttkAlgorithm () override

void	MPIGhostPipelinePreconditioning (vtkDataSet *input)

void	MPIPipelinePreconditioning (vtkDataSet input, std::vector< int > &neighbors, std::map< int, int > &neighToId, ttk::Triangulation triangulation=nullptr)

bool	checkGlobalIdValidity (ttk::LongSimplexId globalIds, ttk::SimplexId simplexNumber, unsigned char ghost, int *rankArray)

int	GenerateGlobalIds (vtkDataSet *input, std::unordered_map< ttk::SimplexId, ttk::SimplexId > &vertGtoL, std::vector< int > &neighborRanks, std::map< int, int > &neighborsToId)

void	MPITriangulationPreconditioning (ttk::Triangulation triangulation, vtkDataSet input)

virtual int	RequestDataObject (vtkInformation request, vtkInformationVector inputVectors, vtkInformationVector outputVector)

virtual int	RequestInformation (vtkInformation ttkNotUsed(request), vtkInformationVector ttkNotUsed(inputVectors), vtkInformationVector ttkNotUsed(outputVector))

virtual int	RequestUpdateTime (vtkInformation ttkNotUsed(request), vtkInformationVector ttkNotUsed(inputVectors), vtkInformationVector ttkNotUsed(outputVector))

virtual int	RequestUpdateTimeDependentInformation (vtkInformation ttkNotUsed(request), vtkInformationVector ttkNotUsed(inputVectors), vtkInformationVector ttkNotUsed(outputVector))

virtual int	RequestUpdateExtent (vtkInformation ttkNotUsed(request), vtkInformationVector ttkNotUsed(inputVectors), vtkInformationVector ttkNotUsed(outputVector))

virtual int	RequestDataNotGenerated (vtkInformation ttkNotUsed(request), vtkInformationVector ttkNotUsed(inputVectors), vtkInformationVector ttkNotUsed(outputVector))

virtual int	RequestData (vtkInformation ttkNotUsed(request), vtkInformationVector ttkNotUsed(inputVectors), vtkInformationVector ttkNotUsed(outputVector))

int	FillInputPortInformation (int ttkNotUsed(port), vtkInformation *ttkNotUsed(info)) override

int	FillOutputPortInformation (int ttkNotUsed(port), vtkInformation *ttkNotUsed(info)) override

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)

Protected Member Functions inherited from ttk::UncertainDataEstimator
	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)

Additional Inherited Members
Protected Attributes inherited from ttkAlgorithm
float	CompactTriangulationCacheSize {0.2f}

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_

Protected Attributes inherited from ttk::UncertainDataEstimator
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_ {}

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

Detailed Description

TTK VTK-filter 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.

Parameters

Input0	Input ensemble scalar field #0 (vtkDataSet)
Input1	Input ensemble scalar field #1 (vtkDataSet) ...
InputN	Input ensemble scalar field #N (vtkDataSet)
Output0	Lower and upper bound fields (vtkDataSet)
Output1	Histogram estimations of the vertex probability density functions (vtkDataSet)
Output2	Mean field (vtkDataSet)

This filter can be used as any other VTK filter (for instance, by using the sequence of calls SetInputData(), Update(), GetOutput()).

See the corresponding ParaView state file example for a usage example within a VTK pipeline.

See also: vtkMandatoryCriticalPoints; ttk::UncertainDataEstimator

Definition at line 37 of file ttkUncertainDataEstimator.h.

Member Typedef Documentation

◆ Superclass

typedef ttkAlgorithm ttkUncertainDataEstimator::Superclass

Definition at line 44 of file ttkUncertainDataEstimator.h.

Constructor & Destructor Documentation

◆ ttkUncertainDataEstimator()

ttkUncertainDataEstimator::ttkUncertainDataEstimator ( )

protected

Definition at line 14 of file ttkUncertainDataEstimator.cpp.

Member Function Documentation

◆ FillInputPortInformation()

int ttkUncertainDataEstimator::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)

overrideprotected

Definition at line 19 of file ttkUncertainDataEstimator.cpp.

◆ FillOutputPortInformation()

int ttkUncertainDataEstimator::FillOutputPortInformation	(	int	port,
		vtkInformation *	info
	)

overrideprotected

Definition at line 29 of file ttkUncertainDataEstimator.cpp.

◆ GetBinCount()

virtual int ttkUncertainDataEstimator::GetBinCount ( )

virtual

◆ GetClassName()

virtual const char * ttkUncertainDataEstimator::GetClassName ( )

virtual

Reimplemented from ttkAlgorithm.

◆ GetComputeLowerBound()

virtual bool ttkUncertainDataEstimator::GetComputeLowerBound ( )

virtual

◆ GetComputeUpperBound()

virtual bool ttkUncertainDataEstimator::GetComputeUpperBound ( )

virtual

◆ IsA()

virtual int ttkUncertainDataEstimator::IsA ( const char * type )

virtual

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

static int ttkUncertainDataEstimator::IsTypeOf ( const char * type )

static

◆ New()

static ttkUncertainDataEstimator * ttkUncertainDataEstimator::New ( )

static

◆ RequestData()

int ttkUncertainDataEstimator::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)

overrideprotected

Definition at line 39 of file ttkUncertainDataEstimator.cpp.

◆ SafeDownCast()

static ttkUncertainDataEstimator * ttkUncertainDataEstimator::SafeDownCast ( vtkObject * o )

static

◆ SetBinCount()

virtual void ttkUncertainDataEstimator::SetBinCount ( int )

virtual

◆ SetBoundToCompute()

void ttkUncertainDataEstimator::SetBoundToCompute ( int value )

inline

Definition at line 55 of file ttkUncertainDataEstimator.h.

◆ SetComputeLowerBound()

virtual void ttkUncertainDataEstimator::SetComputeLowerBound ( bool )

virtual

◆ SetComputeUpperBound()

virtual void ttkUncertainDataEstimator::SetComputeUpperBound ( bool )

virtual

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

/home/julien/Pro/git/github/ttk-tierny/core/vtk/ttkUncertainDataEstimator/ttkUncertainDataEstimator.h
/home/julien/Pro/git/github/ttk-tierny/core/vtk/ttkUncertainDataEstimator/ttkUncertainDataEstimator.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ ttkUncertainDataEstimator()

Member Function Documentation

◆ FillInputPortInformation()

◆ FillOutputPortInformation()

◆ GetBinCount()

◆ GetClassName()

◆ GetComputeLowerBound()

◆ GetComputeUpperBound()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ RequestData()

◆ SafeDownCast()

◆ SetBinCount()

◆ SetBoundToCompute()

◆ SetComputeLowerBound()

◆ SetComputeUpperBound()