ttkCinemaWriter Class Reference

TTK VTK-filter that writes input to disk. More...

#include <ttkCinemaWriter.h>

Inheritance diagram for ttkCinemaWriter:

Public Types
enum class	FORMAT { VTK = 0 , PNG = 1 , TTK = 2 }
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	SetDatabasePath (const std::string &)
virtual std::string	GetDatabasePath ()
virtual void	SetFormat (int _arg)
virtual void	SetFormat (FORMAT)
virtual FORMAT	GetFormat () const
virtual void	SetCompressionLevel (int)
virtual int	GetCompressionLevel ()
virtual void	SetIterateMultiBlock (bool)
virtual bool	GetIterateMultiBlock ()
virtual void	SetForwardInput (bool)
virtual bool	GetForwardInput ()
virtual double	GetTolerance ()
virtual void	SetTolerance (double)
virtual double	GetMaximumError ()
virtual void	SetMaximumError (double)
virtual double	GetZFPTolerance ()
virtual void	SetZFPTolerance (double)
virtual bool	GetZFPOnly ()
virtual void	SetZFPOnly (bool)
virtual int	GetCompressionType ()
virtual void	SetCompressionType (int)
virtual bool	GetSubdivide ()
virtual void	SetSubdivide (bool)
virtual bool	GetUseTopologicalSimplification ()
virtual void	SetUseTopologicalSimplification (bool)
virtual void	SetSQMethodPV (int)
int	DeleteDatabase ()
int	GetLockFilePath (std::string &path)
int	InitializeLockFile ()
Public Member Functions inherited from ttkAlgorithm
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
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, const int orderArrayIdx=0, const bool enforceOrderArrayIdx=false)
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)
virtual int	setWrapper (const Wrapper *wrapper)

Static Public Member Functions
static ttkCinemaWriter *	New ()
static int	IsTypeOf (const char *type)
static ttkCinemaWriter *	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
	ttkCinemaWriter ()
	~ttkCinemaWriter () override
int	ValidateDatabasePath ()
int	ProcessDataProduct (vtkDataObject *input)
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, 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)
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)

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_
Static Protected Attributes inherited from ttk::Debug
static COMMON_EXPORTS debug::LineMode	lastLineMode = ttk::debug::LineMode::NEW

Detailed Description

TTK VTK-filter that writes input to disk.

Author

Jonas Lukasczyk jl@jl.nosp@m.uk.d.nosp@m.e

Date

01.09.2018

This filter stores the input as a VTK dataset to disk and updates the data.csv file of a Cinema Spec D database.

Parameters

Input

vtkDataSet to be stored (vtkDataSet)

Online examples:

• Cinema IO example
  

Definition at line 29 of file ttkCinemaWriter.h.

Member Typedef Documentation

Superclass

typedef ttkAlgorithm ttkCinemaWriter::Superclass

Definition at line 53 of file ttkCinemaWriter.h.

Member Enumeration Documentation

FORMAT

enum class ttkCinemaWriter::FORMAT

strong

Enumerator
VTK
PNG
TTK

Definition at line 31 of file ttkCinemaWriter.h.

Constructor & Destructor Documentation

ttkCinemaWriter()

ttkCinemaWriter::ttkCinemaWriter ( )

protected

Definition at line 34 of file ttkCinemaWriter.cpp.

~ttkCinemaWriter()

ttkCinemaWriter::~ttkCinemaWriter ( )

overrideprotecteddefault

Member Function Documentation

DeleteDatabase()

int ttkCinemaWriter::DeleteDatabase

(

)

Definition at line 82 of file ttkCinemaWriter.cpp.

FillInputPortInformation()

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

overrideprotected

Definition at line 43 of file ttkCinemaWriter.cpp.

FillOutputPortInformation()

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

overrideprotected

Definition at line 52 of file ttkCinemaWriter.cpp.

GetClassName()

virtual const char * ttkCinemaWriter::GetClassName ( )

virtual

Reimplemented from ttkAlgorithm.

GetCompressionLevel()

virtual int ttkCinemaWriter::GetCompressionLevel ( )

virtual

GetCompressionType()

virtual int ttkCinemaWriter::GetCompressionType ( )

virtual

GetDatabasePath()

virtual std::string ttkCinemaWriter::GetDatabasePath ( )

virtual

GetFormat()

virtual FORMAT ttkCinemaWriter::GetFormat ( ) const

virtual

GetForwardInput()

virtual bool ttkCinemaWriter::GetForwardInput ( )

virtual

GetIterateMultiBlock()

virtual bool ttkCinemaWriter::GetIterateMultiBlock ( )

virtual

GetLockFilePath()

int ttkCinemaWriter::GetLockFilePath

(

std::string &

path

)

Definition at line 97 of file ttkCinemaWriter.cpp.

GetMaximumError()

virtual double ttkCinemaWriter::GetMaximumError ( )

virtual

GetSubdivide()

virtual bool ttkCinemaWriter::GetSubdivide ( )

virtual

GetTolerance()

virtual double ttkCinemaWriter::GetTolerance ( )

virtual

GetUseTopologicalSimplification()

virtual bool ttkCinemaWriter::GetUseTopologicalSimplification ( )

virtual

GetZFPOnly()

virtual bool ttkCinemaWriter::GetZFPOnly ( )

virtual

GetZFPTolerance()

virtual double ttkCinemaWriter::GetZFPTolerance ( )

virtual

InitializeLockFile()

int ttkCinemaWriter::InitializeLockFile

(

)

Definition at line 106 of file ttkCinemaWriter.cpp.

IsA()

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

virtual

Reimplemented from ttkAlgorithm.

IsTypeOf()

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

static

New()

static ttkCinemaWriter * ttkCinemaWriter::New ( )

static

ProcessDataProduct()

int ttkCinemaWriter::ProcessDataProduct ( vtkDataObject *  input )

protected

Definition at line 120 of file ttkCinemaWriter.cpp.

RequestData()

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

overrideprotected

Definition at line 531 of file ttkCinemaWriter.cpp.

SafeDownCast()

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

static

SetCompressionLevel()

virtual void ttkCinemaWriter::SetCompressionLevel ( int  )

virtual

SetCompressionType()

virtual void ttkCinemaWriter::SetCompressionType ( int  )

virtual

SetDatabasePath()

virtual void ttkCinemaWriter::SetDatabasePath ( const std::string &  )

virtual

SetFormat() [1/2]

virtual void ttkCinemaWriter::SetFormat ( FORMAT  )

virtual

SetFormat() [2/2]

virtual void ttkCinemaWriter::SetFormat ( int  _arg )

virtual

SetForwardInput()

virtual void ttkCinemaWriter::SetForwardInput ( bool  )

virtual

SetIterateMultiBlock()

virtual void ttkCinemaWriter::SetIterateMultiBlock ( bool  )

virtual

SetMaximumError()

virtual void ttkCinemaWriter::SetMaximumError ( double  )

virtual

SetSQMethodPV()

virtual void ttkCinemaWriter::SetSQMethodPV ( int  )

virtual

SetSubdivide()

virtual void ttkCinemaWriter::SetSubdivide ( bool  )

virtual

SetTolerance()

virtual void ttkCinemaWriter::SetTolerance ( double  )

virtual

SetUseTopologicalSimplification()

virtual void ttkCinemaWriter::SetUseTopologicalSimplification ( bool  )

virtual

SetZFPOnly()

virtual void ttkCinemaWriter::SetZFPOnly ( bool  )

virtual

SetZFPTolerance()

virtual void ttkCinemaWriter::SetZFPTolerance ( double  )

virtual

ValidateDatabasePath()

int ttkCinemaWriter::ValidateDatabasePath ( )

protected

Definition at line 70 of file ttkCinemaWriter.cpp.

---

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

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