TTK
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
ttkContinuousScatterPlot Class Reference

TTK VTK-filter that computes the continuous scatterplot of bivariate volumetric data. More...

#include <ttkContinuousScatterPlot.h>

Inheritance diagram for ttkContinuousScatterPlot:
ttkAlgorithm ttk::ContinuousScatterPlot ttk::Debug ttk::Debug ttk::BaseClass ttk::BaseClass

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 void SetWithDummyValue (bool)
 
virtual bool GetWithDummyValue ()
 
virtual void SetDummyValue (double)
 
virtual double GetDummyValue ()
 
virtual void SetProjectImageSupport (bool)
 
virtual bool GetProjectImageSupport ()
 
void SetScatterplotResolution (int N, int M)
 
- 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::SimplexIdGetIdentifierArrayPtr (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::TriangulationGetTriangulation (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 ttkContinuousScatterPlotNew ()
 
static int IsTypeOf (const char *type)
 
static ttkContinuousScatterPlotSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from ttkAlgorithm
static ttkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static ttkAlgorithmSafeDownCast (vtkObject *o)
 
static std::string GetOrderArrayName (vtkDataArray *const array)
 
static vtkInformationIntegerKey * SAME_DATA_TYPE_AS_INPUT_PORT ()
 

Protected Member Functions

 ttkContinuousScatterPlot ()
 
 ~ttkContinuousScatterPlot () override
 
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::ContinuousScatterPlot
 ContinuousScatterPlot ()
 
 ~ContinuousScatterPlot () override
 
template<typename dataType1 , typename dataType2 , class triangulationType = AbstractTriangulation>
int execute (const dataType1 *, const dataType2 *, const triangulationType *) const
 
int setVertexNumber (const SimplexId &vertexNumber)
 
int setDummyValue (bool withDummyValue, double dummyValue)
 
int setResolutions (const SimplexId &resolutionX, const SimplexId &resolutionY)
 
int setScalarMin (const std::array< double, 2 > &scalarMin)
 
int setScalarMax (const std::array< double, 2 > &scalarMax)
 
int setOutputDensity (std::vector< std::vector< double > > *density)
 
int setOutputMask (std::vector< std::vector< char > > *mask)
 

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_
 
Wrapperwrapper_
 
- Protected Attributes inherited from ttk::ContinuousScatterPlot
SimplexId vertexNumber_
 
bool withDummyValue_
 
double dummyValue_
 
SimplexId resolutions_ [2]
 
std::array< double, 2 > scalarMin_ {0, 0}
 
std::array< double, 2 > scalarMax_ {0, 0}
 
std::vector< std::vector< double > > * density_
 
std::vector< std::vector< char > > * validPointMask_
 
- Static Protected Attributes inherited from ttk::Debug
static COMMON_EXPORTS debug::LineMode lastLineMode = ttk::debug::LineMode::NEW
 

Detailed Description

TTK VTK-filter that computes the continuous scatterplot of bivariate volumetric data.

Author
Guillaume Favelier guill.nosp@m.aume.nosp@m..fave.nosp@m.lier.nosp@m.@lip6.nosp@m..fr
Julien Tierny julie.nosp@m.n.ti.nosp@m.erny@.nosp@m.lip6.nosp@m..fr
Date
March 2016

This filter produces a 2D vtkUnstructuredGrid with a scalar field (named "Density") representing the continuous scatter plot (attached to the 2D geometry as point data). A point mask is also attached to the 2D geometry as point data.

The components of the input bivariate data must be specified as independent scalar fields attached to the input geometry as point data.

Parameters
InputInput bivariate volumetric data-set, either regular grids or tetrahedral meshes (vtkDataSet)
OutputOutput 2D continuous scatter plot (vtkUnstructuredGrid)

This module respects the following convention regarding the order of the input arrays to process (SetInputArrayToProcess()):

Parameters
idx0: first scalar array.
idx1: second scalar array.

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

See the related ParaView example state files for usage examples within a VTK pipeline.

Related publication
"Continuous Scatterplots"
Sven Bachthaler, Daniel Weiskopf
Proc. of IEEE VIS 2008.
IEEE Transactions on Visualization and Computer Graphics, 2008.

See also
ttk::ContinuousScatterPlot

Online examples:

Definition at line 56 of file ttkContinuousScatterPlot.h.

Member Typedef Documentation

◆ Superclass

Definition at line 63 of file ttkContinuousScatterPlot.h.

Constructor & Destructor Documentation

◆ ttkContinuousScatterPlot()

ttkContinuousScatterPlot::ttkContinuousScatterPlot ( )
protected

Definition at line 18 of file ttkContinuousScatterPlot.cpp.

◆ ~ttkContinuousScatterPlot()

ttkContinuousScatterPlot::~ttkContinuousScatterPlot ( )
overrideprotecteddefault

Member Function Documentation

◆ FillInputPortInformation()

int ttkContinuousScatterPlot::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
overrideprotected

Definition at line 25 of file ttkContinuousScatterPlot.cpp.

◆ FillOutputPortInformation()

int ttkContinuousScatterPlot::FillOutputPortInformation ( int  port,
vtkInformation *  info 
)
overrideprotected

Definition at line 34 of file ttkContinuousScatterPlot.cpp.

◆ GetClassName()

virtual const char * ttkContinuousScatterPlot::GetClassName ( )
virtual

Reimplemented from ttkAlgorithm.

◆ GetDummyValue()

virtual double ttkContinuousScatterPlot::GetDummyValue ( )
virtual

◆ GetProjectImageSupport()

virtual bool ttkContinuousScatterPlot::GetProjectImageSupport ( )
virtual

◆ GetWithDummyValue()

virtual bool ttkContinuousScatterPlot::GetWithDummyValue ( )
virtual

◆ IsA()

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

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

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

◆ New()

static ttkContinuousScatterPlot * ttkContinuousScatterPlot::New ( )
static

◆ RequestData()

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

Definition at line 57 of file ttkContinuousScatterPlot.cpp.

◆ SafeDownCast()

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

◆ SetDummyValue()

virtual void ttkContinuousScatterPlot::SetDummyValue ( double  )
virtual

◆ SetProjectImageSupport()

virtual void ttkContinuousScatterPlot::SetProjectImageSupport ( bool  )
virtual

◆ SetScatterplotResolution()

void ttkContinuousScatterPlot::SetScatterplotResolution ( int  N,
int  M 
)
inline

Definition at line 74 of file ttkContinuousScatterPlot.h.

◆ SetWithDummyValue()

virtual void ttkContinuousScatterPlot::SetWithDummyValue ( bool  )
virtual

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