TTK
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 Member Functions

 vtkTypeMacro (ttkContinuousScatterPlot, ttkAlgorithm)
 
 vtkSetMacro (WithDummyValue, bool)
 
 vtkGetMacro (WithDummyValue, bool)
 
 vtkSetMacro (DummyValue, double)
 
 vtkGetMacro (DummyValue, double)
 
 vtkSetMacro (ProjectImageSupport, bool)
 
 vtkGetMacro (ProjectImageSupport, bool)
 
void SetScatterplotResolution (int N, int M)
 
- Public Member Functions inherited from ttkAlgorithm
 vtkTypeMacro (ttkAlgorithm, vtkAlgorithm)
 
void UpdateThreadNumber ()
 
void SetThreadNumber (int threadNumber)
 
void SetUseAllCores (bool useAllCores)
 
void SetDebugLevel (int debugLevel)
 
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, const int orderArrayIdx=0, const bool enforceOrderArrayIdx=false)
 
ttk::SimplexIdGetIdentifierArrayPtr (const bool &enforceArrayIndex, const int &arrayIndex, const std::string &arrayName, vtkDataSet *const inputData, std::vector< ttk::SimplexId > &spareStorage, const int inputPort=0)
 
ttk::TriangulationGetTriangulation (vtkDataSet *object)
 
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 *)
 
- Public Member Functions inherited from ttk::Debug
 Debug ()
 
virtual ~Debug ()
 
virtual int setDebugLevel (const int &debugLevel)
 
virtual int setWrapper (const Wrapper *wrapper)
 
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 Public Member Functions inherited from ttkAlgorithm
static ttkAlgorithmNew ()
 
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 ()
 
virtual ~ttkAlgorithm ()
 
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))
 
virtual int FillInputPortInformation (int ttkNotUsed(port), vtkInformation *ttkNotUsed(info)) override
 
virtual 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 ()
 
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 (double *scalarMin)
 
int setScalarMax (double *scalarMax)
 
int setOutputDensity (std::vector< std::vector< double >> *density)
 
int setOutputMask (std::vector< std::vector< char >> *mask)
 

Additional Inherited Members

- Protected Attributes inherited from ttk::Debug
int debugLevel_
 
std::string debugMsgPrefix_
 
- 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]
 
double * scalarMin_
 
double * scalarMax_
 
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

Definition at line 52 of file ttkContinuousScatterPlot.h.

Constructor & Destructor Documentation

◆ ttkContinuousScatterPlot()

ttkContinuousScatterPlot::ttkContinuousScatterPlot ( )
protected

Definition at line 18 of file ttkContinuousScatterPlot.cpp.

◆ ~ttkContinuousScatterPlot()

ttkContinuousScatterPlot::~ttkContinuousScatterPlot ( )
overrideprotected

Definition at line 23 of file ttkContinuousScatterPlot.cpp.

Member Function Documentation

◆ FillInputPortInformation()

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

Definition at line 26 of file ttkContinuousScatterPlot.cpp.

◆ FillOutputPortInformation()

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

Definition at line 35 of file ttkContinuousScatterPlot.cpp.

◆ New()

static ttkContinuousScatterPlot* ttkContinuousScatterPlot::New ( )
static

◆ RequestData()

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

Definition at line 58 of file ttkContinuousScatterPlot.cpp.

◆ SetScatterplotResolution()

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

Definition at line 70 of file ttkContinuousScatterPlot.h.

◆ vtkGetMacro() [1/3]

ttkContinuousScatterPlot::vtkGetMacro ( DummyValue  ,
double   
)

◆ vtkGetMacro() [2/3]

ttkContinuousScatterPlot::vtkGetMacro ( ProjectImageSupport  ,
bool   
)

◆ vtkGetMacro() [3/3]

ttkContinuousScatterPlot::vtkGetMacro ( WithDummyValue  ,
bool   
)

◆ vtkSetMacro() [1/3]

ttkContinuousScatterPlot::vtkSetMacro ( DummyValue  ,
double   
)

◆ vtkSetMacro() [2/3]

ttkContinuousScatterPlot::vtkSetMacro ( ProjectImageSupport  ,
bool   
)

◆ vtkSetMacro() [3/3]

ttkContinuousScatterPlot::vtkSetMacro ( WithDummyValue  ,
bool   
)

◆ vtkTypeMacro()

ttkContinuousScatterPlot::vtkTypeMacro ( ttkContinuousScatterPlot  ,
ttkAlgorithm   
)

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