ParaView/Users Guide/List of writers

From KitwarePublic
Jump to: navigation, search

ParaViewUsersGuide


CSVWriter

Writer to write CSV files from table.
In parallel, it delivers the table to the root node and then saves the
CSV. For composite datasets, it saves multiple csv files.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected object must be the result of the following: sources (includes readers), filters.


The selected dataset must be one of the following types (or a subclass of one of them): vtkTable.

Write All Time Steps
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.


DataSetCSVWriter

Writer to write CSV files from any dataset. Set FieldAssociation to
choose whether cell data/point data needs to be saved.
In parallel, it delivers the table to the root node and then saves the
CSV. For composite datasets, it saves multiple csv files.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected object must be the result of the following: sources (includes readers), filters.


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.

Write All Time Steps
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.

Field Association
(FieldAssociation)

Select the attribute data to pass.

0

The value must be one of the following: Points (0), Cells (1), Field Data (2).


DataSetWriter

Writer to write any type of data object in a legacy vtk data file.
Cannot be used for parallel writing.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected object must be the result of the following: sources (includes readers), filters.


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataObject.

Write all timesteps as file-series
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.

File Type
(FileType)

The type for the data file (i.e. ascii or binary).

2

The value must be one of the following: Ascii (1), Binary (2).


EnSightWriter

Writer to write unstructured grid data as an EnSight file. Binary files
written on one system may not be readable on other systems. Be sure to
specify the endian-ness of the file when reading it into EnSight.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Ghost Level
(GhostLevel)

The number of ghost levels to include in the output file(s). Note that some writers (such as ExodusIIWriter) may not support writing ghost levels.

0

The value must be greater than or equal to 0.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected object must be the result of the following: sources (includes readers), filters.


The selected dataset must be one of the following types (or a subclass of one of them): vtkUnstructuredGrid.


ExodusIIWriter

Writer to write Exodus II files. Refere to http://endo.sandia.gov/SEACAS/
for more information about the Exodus II format.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Ghost Level
(GhostLevel)

The number of ghost levels to include in the output file(s). Note that some writers (such as ExodusIIWriter) may not support writing ghost levels.

0

The value must be greater than or equal to 0.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected object must be the result of the following: sources (includes readers), filters.


The selected dataset must be one of the following types (or a subclass of one of them): vtkCompositeDataSet, vtkDataSet.

Write All Time Steps
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.


MetaImageWriter

Writer to write a binary UNC meta image data. This is a fairly simple
yet powerful format consisting of a text header and a binary data
section.
MetaImage headers are expected to have extension: ".mha" or ".mhd"

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected object must be the result of the following: sources (includes readers), filters.


The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData.


PDataSetWriter

Writer to write any type of data object in a legacy vtk data file.
This version is used when running in parallel. It gathers data to
first node and saves 1 file.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected object must be the result of the following: sources (includes readers), filters.


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataObject.

Write All Time Steps
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.

File Type
(FileType)

The type for the data file (i.e. ascii or binary).

2

The value must be one of the following: Ascii (1), Binary (2).


PNGWriter

Writer to write image data as a PNG file. It supports 1 to 4 component
data of unsigned char or unsigned short.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected object must be the result of the following: sources (includes readers), filters.


The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData.


PPLYWriter

Writer to write polygonal data in Stanford University PLY format. The
data can be written in either binary (little or big endian) or ASCII
representation. As for PointData and CellData, vtkPLYWriter cannot
handle normals or vectors. It only handles RGB PointData and CellData.
This version is used when running in parallel. It gathers data to
first node and saves 1 file.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected object must be the result of the following: sources (includes readers), filters.


The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.

File Type
(FileType)

The type for the data file (i.e. ascii or binary).

2

The value must be one of the following: Ascii (1), Binary (2).


PSTLWriter

STLWriter writes stereo lithography (.stl) files in either ASCII or
binary form. Stereo lithography files only contain triangles. If
polygons with more than 3 vertices are present, only the first 3
vertices are written. Use TriangleFilter to convert polygons to
triangles. This version of the reader is used when running in
parallel. It gathers all the geometry to first node and saves 1 file.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected object must be the result of the following: sources (includes readers), filters.


The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.

File Type
(FileType)

The type for the data file (i.e. ascii or binary).

2

The value must be one of the following: Ascii (1), Binary (2).


XMLHierarchicalBoxDataWriter

Writer to write a hierarchical box in a xml-based vtk data file. Can be used
for parallel writing as well as serial writing.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected dataset must be one of the following types (or a subclass of one of them): vtkHierarchicalBoxDataSet.

Write all timesteps as file-series
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.

Compressor Type
(CompressorType)

The compression algorithm used to compress binary data (appended mode only).

0

The value must be one of the following: None (0), ZLib (1).

Data Mode
(DataMode)

The mode uses for writing the file's data i.e. ascii, binary, appended binary.

2

The value must be one of the following: Ascii (0), Binary (1), Appended (2).

Encode Appended Data
(EncodeAppendedData)

When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).

0

Only the values 0 and 1 are accepted.


XMLHyperOctreeWriter

Writer to write unstructured grid in a xml-based vtk data file. Cannot be used
for parallel writing.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected dataset must be one of the following types (or a subclass of one of them): vtkHyperOctree.

Write all timesteps as file-series
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.

Compressor Type
(CompressorType)

The compression algorithm used to compress binary data (appended mode only).

0

The value must be one of the following: None (0), ZLib (1).

Data Mode
(DataMode)

The mode uses for writing the file's data i.e. ascii, binary, appended binary.

2

The value must be one of the following: Ascii (0), Binary (1), Appended (2).

Encode Appended Data
(EncodeAppendedData)

When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).

0

Only the values 0 and 1 are accepted.


XMLImageDataWriter

Writer to write image data in a xml-based vtk data file. Cannot be used
for parallel writing.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData.

Write all timesteps as file-series
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.

Compressor Type
(CompressorType)

The compression algorithm used to compress binary data (appended mode only).

0

The value must be one of the following: None (0), ZLib (1).

Data Mode
(DataMode)

The mode uses for writing the file's data i.e. ascii, binary, appended binary.

2

The value must be one of the following: Ascii (0), Binary (1), Appended (2).

Encode Appended Data
(EncodeAppendedData)

When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).

0

Only the values 0 and 1 are accepted.


XMLMultiBlockDataWriter

Writer to write a multiblock dataset in a xml-based vtk data file. Can be used
for parallel writing as well as serial writing.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected dataset must be one of the following types (or a subclass of one of them): vtkMultiBlockDataSet.

Write all timesteps as file-series
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.

Compressor Type
(CompressorType)

The compression algorithm used to compress binary data (appended mode only).

0

The value must be one of the following: None (0), ZLib (1).

Data Mode
(DataMode)

The mode uses for writing the file's data i.e. ascii, binary, appended binary.

2

The value must be one of the following: Ascii (0), Binary (1), Appended (2).

Encode Appended Data
(EncodeAppendedData)

When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).

0

Only the values 0 and 1 are accepted.


XMLPImageDataWriter

Writer to write image data in a xml-based vtk data file. Can be used
for parallel writing.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData.

Write all timesteps as file-series
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.

Compressor Type
(CompressorType)

The compression algorithm used to compress binary data (appended mode only).

0

The value must be one of the following: None (0), ZLib (1).

Data Mode
(DataMode)

The mode uses for writing the file's data i.e. ascii, binary, appended binary.

2

The value must be one of the following: Ascii (0), Binary (1), Appended (2).

Encode Appended Data
(EncodeAppendedData)

When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).

0

Only the values 0 and 1 are accepted.


XMLPPolyDataWriter

Writer to write polydata in a xml-based vtk data file. Can be used
for parallel writing.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.

Write all timesteps as file-series
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.

Compressor Type
(CompressorType)

The compression algorithm used to compress binary data (appended mode only).

0

The value must be one of the following: None (0), ZLib (1).

Data Mode
(DataMode)

The mode uses for writing the file's data i.e. ascii, binary, appended binary.

2

The value must be one of the following: Ascii (0), Binary (1), Appended (2).

Encode Appended Data
(EncodeAppendedData)

When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).

0

Only the values 0 and 1 are accepted.


XMLPRectilinearGridWriter

Writer to write rectilinear grid in a xml-based vtk data file. Can be used
for parallel writing.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected dataset must be one of the following types (or a subclass of one of them): vtkRectilinearGrid.

Write all timesteps as file-series
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.

Compressor Type
(CompressorType)

The compression algorithm used to compress binary data (appended mode only).

0

The value must be one of the following: None (0), ZLib (1).

Data Mode
(DataMode)

The mode uses for writing the file's data i.e. ascii, binary, appended binary.

2

The value must be one of the following: Ascii (0), Binary (1), Appended (2).

Encode Appended Data
(EncodeAppendedData)

When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).

0

Only the values 0 and 1 are accepted.


XMLPStructuredGridWriter

Writer to write structured grid in a xml-based vtk data file. Can be used
for parallel writing.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected dataset must be one of the following types (or a subclass of one of them): vtkStructuredGrid.

Write all timesteps as file-series
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.

Compressor Type
(CompressorType)

The compression algorithm used to compress binary data (appended mode only).

0

The value must be one of the following: None (0), ZLib (1).

Data Mode
(DataMode)

The mode uses for writing the file's data i.e. ascii, binary, appended binary.

2

The value must be one of the following: Ascii (0), Binary (1), Appended (2).

Encode Appended Data
(EncodeAppendedData)

When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).

0

Only the values 0 and 1 are accepted.


XMLPUnstructuredGridWriter

Writer to write unstructured grid in a xml-based vtk data file. Can be used
for parallel writing.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected dataset must be one of the following types (or a subclass of one of them): vtkUnstructuredGrid.

Write all timesteps as file-series
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.

Compressor Type
(CompressorType)

The compression algorithm used to compress binary data (appended mode only).

0

The value must be one of the following: None (0), ZLib (1).

Data Mode
(DataMode)

The mode uses for writing the file's data i.e. ascii, binary, appended binary.

2

The value must be one of the following: Ascii (0), Binary (1), Appended (2).

Encode Appended Data
(EncodeAppendedData)

When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).

0

Only the values 0 and 1 are accepted.


XMLPVDWriter

Writer to write ParaView data files (pvd). It is used to save all pieces
of a source/filter to a file with pieces spread across the server
processes.

Property Description Default Value(s) Restrictions
Compressor Type
(CompressorType)

The compression algorithm used to compress binary data (appended mode only).

0

The value must be one of the following: None (0), ZLib (1).

Data Mode
(DataMode)

The mode uses for writing the file's data i.e. ascii, binary, appended binary.

2

The value must be one of the following: Ascii (0), Binary (1), Appended (2).

Encode Appended Data
(EncodeAppendedData)

When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).

0

Only the values 0 and 1 are accepted.

File Name
(FileName)

The name of the file to be written.

Ghost Level
(GhostLevel)

The number of ghost levels to include in the output file(s). Note that some writers (such as ExodusIIWriter) may not support writing ghost levels.

0

The value must be greater than or equal to 0.

Input
(Input)

The input filter/source whose output dataset is to written to the files.

The selected object must be the result of the following: sources (includes readers), filters.


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.


XMLPolyDataWriter

Writer to write poly data in a xml-based vtk data file. Cannot be used
for parallel writing.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.

Write all timesteps as file-series
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.

Compressor Type
(CompressorType)

The compression algorithm used to compress binary data (appended mode only).

0

The value must be one of the following: None (0), ZLib (1).

Data Mode
(DataMode)

The mode uses for writing the file's data i.e. ascii, binary, appended binary.

2

The value must be one of the following: Ascii (0), Binary (1), Appended (2).

Encode Appended Data
(EncodeAppendedData)

When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).

0

Only the values 0 and 1 are accepted.


XMLRectilinearGridWriter

Writer to write rectilinear grid in a xml-based vtk data file. Cannot be used
for parallel writing.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected dataset must be one of the following types (or a subclass of one of them): vtkRectilinearGrid.

Write all timesteps as file-series
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.

Compressor Type
(CompressorType)

The compression algorithm used to compress binary data (appended mode only).

0

The value must be one of the following: None (0), ZLib (1).

Data Mode
(DataMode)

The mode uses for writing the file's data i.e. ascii, binary, appended binary.

2

The value must be one of the following: Ascii (0), Binary (1), Appended (2).

Encode Appended Data
(EncodeAppendedData)

When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).

0

Only the values 0 and 1 are accepted.


XMLStructuredGridWriter

Writer to write structured grid in a xml-based vtk data file. Cannot be used
for parallel writing.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected dataset must be one of the following types (or a subclass of one of them): vtkStructuredGrid.

Write all timesteps as file-series
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.

Compressor Type
(CompressorType)

The compression algorithm used to compress binary data (appended mode only).

0

The value must be one of the following: None (0), ZLib (1).

Data Mode
(DataMode)

The mode uses for writing the file's data i.e. ascii, binary, appended binary.

2

The value must be one of the following: Ascii (0), Binary (1), Appended (2).

Encode Appended Data
(EncodeAppendedData)

When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).

0

Only the values 0 and 1 are accepted.


XMLUnstructuredGridWriter

Writer to write unstructured grid in a xml-based vtk data file. Cannot be used
for parallel writing.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.

Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected dataset must be one of the following types (or a subclass of one of them): vtkUnstructuredGrid.

Write all timesteps as file-series
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

0

Only the values 0 and 1 are accepted.

Compressor Type
(CompressorType)

The compression algorithm used to compress binary data (appended mode only).

0

The value must be one of the following: None (0), ZLib (1).

Data Mode
(DataMode)

The mode uses for writing the file's data i.e. ascii, binary, appended binary.

2

The value must be one of the following: Ascii (0), Binary (1), Appended (2).

Encode Appended Data
(EncodeAppendedData)

When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).

0

Only the values 0 and 1 are accepted.


XdmfWriter

Writer to write data in eXtensible Data Model and Format *(XDMF) files.

Property Description Default Value(s) Restrictions
File Name
(FileName)
Input
(Input)

The input filter/source whose output dataset is to written to the file.

The selected object must be the result of the following: sources (includes readers), filters.


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.