Difference between revisions of "ParaView/Users Guide/List of writers"

From KitwarePublic
Jump to navigationJump to search
 
(20 intermediate revisions by 5 users not shown)
Line 1: Line 1:
[[ParaViewUsersGuide]]


==AnimationSceneImageWriter==


 
Internal writer to used paraview uses when it disconnects
 
the GUI.
==CSVWriter==
 
 
 
 
 
Writer to write CSV files from table.<br>
 
In parallel, it delivers the table to the root node and then saves the<br>
 
CSV. For composite datasets, it saves multiple csv files.<br>
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Magnification''' (Magnification)
| '''File Name'''<br>''(FileName)''
|
 
The magnification factor to use for the saved
animation.
|
1
|
|
The name of the file to be written.
| �
| �


|-
|-
 
|'''FileName''' (FileName)
| '''Input'''<br>''(Input)''
|
 
The name of the file to save the animation
into.
|
|
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.


|-
|-
 
|'''FrameRate''' (FrameRate)
| '''Write All Time Steps'''<br>''(WriteAllTimeSteps)''
|
 
Get/Set the frame rate to use for saving the animation.
This frame rate is the frame rate that gets saved in the movie file
generated, if applicable. If does not affect the FrameRate set on the
animation scene at all. In other words, this is the playback frame rate
and not the animation generation frame rate.
|
|
 
0
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<br>
choose whether cell data/point data needs to be saved.<br>
In parallel, it delivers the table to the root node and then saves the<br>
CSV. For composite datasets, it saves multiple csv files.<br>
{| class="PropertiesTable" border="1" cellpadding="5"


|-
|-
 
|'''PlaybackTimeWindow''' (PlaybackTimeWindow)
| '''Property'''
 
| '''Description'''
 
| '''Default Value(s)'''
 
| '''Restrictions'''
 
|-
 
| '''File Name'''<br>''(FileName)''
 
|
|
 
Time range to write
The name of the file to be written.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
 
-1 1
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.


|-
|-
 
|'''Compression''' (Compression)
| '''Write All Time Steps'''<br>''(WriteAllTimeSteps)''
|
Turns on(the default) or off compression for FFMEG
(AVI on Linux and Mac) backend.


|
|
 
1
When WriteAllTimeSteps is turned ON, the writer is executed
 
once for each timestep available from the reader.
 
 
| 0
 
|
|
 
Accepts boolean values (0 or 1).
Only the values 0 and 1 are accepted.
 
 
 
|-
|-
 
|'''StartFileCount''' (StartFileCount)
| '''Field Association'''<br>''(FieldAssociation)''
|


|
|
 
0
Select the attribute data to pass.
 
 
| 0
 
|
|


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


|}
|}


==CSVWriter==


 
Writer to write CSV filesWriter to write CSV
==DataSetWriter==
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.
 
 
 
Writer to write any type of data object in a legacy vtk data file. <br>
 
Cannot be used for parallel writing.<br>
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''File Name'''<br>''(FileName)''
 
|
|
 
The input filter/source whose output dataset is to
The name of the file to be written.
written to the file.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
The input filter/source whose output dataset is to written to the
file.
| �


|
|
 
Accepts input of following types:
The selected object must be the result of the following: sources (includes readers), filters.
* vtkTable
 
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataObject.
 
 
 
|-
|-
 
|'''FileName''' (FileName)
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
|
 
The name of the file to be written.
|
|
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.


|-
|-
 
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
| '''File Type'''<br>''(FileType)''
|
 
When WriteAllTimeSteps is turned ON, the writer is
executed once for each time step available from the
reader.
|
|
 
0
The type for the data file (i.e. ascii or binary).
 
 
| 2
 
|
|
 
Accepts boolean values (0 or 1).
The value must be one of the following: Ascii (1), Binary (2).
 
 


|}
|}


==DataSetCSVWriter==


 
Writer to write CSV filesWriter to write CSV
==EnSightWriter==
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.
 
 
Writer to write unstructured grid data as an EnSight file. Binary files <br>
 
written on one system may not be readable on other systems. Be sure to <br>
 
specify the endian-ness of the file when reading it into EnSight.<br>
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
|'''Input''' (Input)
|
The input filter/source whose output dataset is to
written to the file.
|


| '''File Name'''<br>''(FileName)''
|
|
 
Accepts input of following types:
* vtkDataSet
|-
|'''FileName''' (FileName)
|
The name of the file to be written.
The name of the file to be written.
| �
| �
|-
| '''Ghost Level'''<br>''(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.


|-
|-
 
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
| '''Input'''<br>''(Input)''
|
 
When WriteAllTimeSteps is turned ON, the writer is
executed once for each timestep available from the
reader.
|
|
 
0
The input filter/source whose output dataset is to written to the
 
file.
 
 
| �
 
|
|
 
Accepts boolean values (0 or 1).
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.
 
 


|}
|}


==DataSetWriter==


 
Write any type of data object in a legacy vtk data file.
==ExodusIIWriter==
Writer to write any type of data object in a legacy vtk data file. Cannot
 
be used for parallel writing.
 
 
 
 
Writer to write Exodus II files. Refere to http://endo.sandia.gov/SEACAS/ <br>
 
for more information about the Exodus II format.<br>
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''File Name'''<br>''(FileName)''
 
|
|
 
The input filter/source whose output dataset is to
The name of the file to be written.
written to the file.
 
 
| �
 
| �
 
|-
 
| '''Ghost Level'''<br>''(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


|
|
 
Accepts input of following types:
The value must be greater than or equal to 0.
* vtkDataObject
 
 
 
|-
 
| '''Input'''<br>''(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'''<br>''(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.
 
 


|}
|}


==EnSightWriter==


 
Write unstructured grid data as an EnSight file.
==MetaImageWriter==
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.
 
 
Writer to write a binary UNC meta image data. This is a fairly simple <br>
 
yet powerful format consisting of a text header and a binary data <br>
 
section. <br>
 
MetaImage headers are expected to have extension: ".mha" or ".mhd"<br>
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''File Name'''<br>''(FileName)''
 
|
|
 
The input filter/source whose output dataset is to
The name of the file to be written.
written to the file.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
The input filter/source whose output dataset is to written to the
file.
| �


|
|
 
Accepts input of following types:
The selected object must be the result of the following: sources (includes readers), filters.
* vtkUnstructuredGrid
 
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData.
 
 


|}
|}


==ExodusIIWriter==


 
Write Exodus II files.Writer to write Exodus
==PDataSetWriter==
II files. Refere to http://endo.sandia.gov/SEACAS/ for more information
 
about the Exodus II format.
 
 
 
 
Writer to write any type of data object in a legacy vtk data file. <br>
 
This version is used when running in parallel. It gathers data to<br>
 
first node and saves 1 file.<br>
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''File Name'''<br>''(FileName)''
 
|
|
 
The input filter/source whose output dataset is to
The name of the file to be written.
written to the file.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
The input filter/source whose output dataset is to written to the
file.
| �


|
|
 
Accepts input of following types:
The selected object must be the result of the following: sources (includes readers), filters.
* vtkCompositeDataSet
 
* vtkDataSet
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataObject.
 
 
 
|-
|-
 
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
| '''Write All Time Steps'''<br>''(WriteAllTimeSteps)''
 
|
 
When WriteAllTimeSteps is turned ON, the writer is executed
 
once for each timestep available from the reader.
 
 
| 0
 
|
|
 
When WriteAllTimeSteps is turned ON, the writer is
Only the values 0 and 1 are accepted.
executed once for each time step available from the
 
reader.
 
 
|-
 
| '''File Type'''<br>''(FileType)''
 
|
|
 
0
The type for the data file (i.e. ascii or binary).
 
 
| 2
 
|
|
 
Accepts boolean values (0 or 1).
The value must be one of the following: Ascii (1), Binary (2).
 
 


|}
|}


==JPEGWriter==


 
Write image data as a JPEG file.
==PNGWriter==
Writer to write image data as a JPEG file. It supports 1 to 3 component
 
data of unsigned char or unsigned short.
 
This Writer can also generate a stack of images when the FileName is in
 
the form of /path/file_%03d.jpg and that the input data is a 3D image
data.
 
 
Writer to write image data as a PNG file. It supports 1 to 4 component<br>
 
data of unsigned char or unsigned short.<br>




{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
|'''Input''' (Input)
|
The input filter/source whose output dataset is to
written to the file.
|


| '''File Name'''<br>''(FileName)''
|
|
 
Accepts input of following types:
* vtkImageData
|-
|'''FileName''' (FileName)
|
The name of the file to be written.
The name of the file to be written.
| �
| �
|-
| '''Input'''<br>''(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.


|}
|}


==JSONImageWriter==


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
|'''Input''' (Input)
|
The input filter/source whose output dataset is to
written to the file.
|


| '''File Name'''<br>''(FileName)''
|
|
 
Accepts input of following types:
* vtkImageData
|-
|'''FileName''' (FileName)
|
The name of the file to be written.
The name of the file to be written.
|


 
|
|
 
| �


|-
|-
 
|'''ArrayName''' (ArrayName)
| '''Input'''<br>''(Input)''
|
 
The name of the field to export. If Empty all fields will be saved.
|
|
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.


|-
|-
 
|'''Slice''' (Slice)
| '''File Type'''<br>''(FileType)''
|
 
Write only one slice if slice &gt;= 0
|
|
 
-1
The type for the data file (i.e. ascii or binary).
 
 
| 2
 
|
|


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


|}
|}


==MetaImageWriter==


 
Write a binary UNC meta image data.Writer to
==PSTLWriter==
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"
 
 
 
STLWriter writes stereo lithography (.stl) files in either ASCII or<br>
 
binary form. Stereo lithography files only contain triangles. If<br>
 
polygons with more than 3 vertices are present, only the first 3<br>
 
vertices are written. Use TriangleFilter to convert polygons to<br>
 
triangles. This version of the reader is used when running in<br>
 
parallel. It gathers all the geometry to first node and saves 1 file.<br>
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''File Name'''<br>''(FileName)''
 
|
|
 
The input filter/source whose output dataset is to
The name of the file to be written.
written to the file.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
The input filter/source whose output dataset is to written to the
file.
| �


|
|
 
Accepts input of following types:
The selected object must be the result of the following: sources (includes readers), filters.
* vtkImageData
 
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
 
 
|-
|-
 
|'''FileName''' (FileName)
| '''File Type'''<br>''(FileType)''
|
 
The name of the file to be written.
|
|
The type for the data file (i.e. ascii or binary).
| 2


|
|


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


|}
|}


==PDataSetWriter==


 
Writer that writes polydata as legacy vtk files.
==XMLHierarchicalBoxDataWriter==
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 one file.
 
 
 
Writer to write a hierarchical box in a xml-based vtk data file. Can be used<br>
 
for parallel writing as well as serial writing.<br>
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''File Name'''<br>''(FileName)''
 
|
|
 
The input filter/source whose output dataset is to
The name of the file to be written.
written to the file.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
The input filter/source whose output dataset is to written to the
file.
| �


|
|
 
Accepts input of following types:
The selected dataset must be one of the following types (or a subclass of one of them): vtkHierarchicalBoxDataSet.
* vtkDataObject
 
 
 
|-
|-
 
|'''FileName''' (FileName)
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
 
|
|
 
The name of the file to be written.
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'''<br>''(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).


|-
|-
 
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
| '''Data Mode'''<br>''(DataMode)''
 
|
 
The mode uses for writing the file's data i.e. ascii, binary, appended
 
binary.
 
 
| 2
 
|
|
 
When WriteAllTimeSteps is turned ON, the writer is
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
executed once for each timestep available from the
 
reader.
 
 
|-
 
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
 
|
|
 
0
When EncodeAppendedData is turned ON, the writer uses base64 encoding
 
when writing binary data (only if appended mode is selected).
 
 
| 0
 
|
|
 
Accepts boolean values (0 or 1).
Only the values 0 and 1 are accepted.
 
 


|}
|}


==PNGWriter==


 
Write image data as a PNG file.Writer to
==XMLHyperOctreeWriter==
write image data as a PNG file. It supports 1 to 4 component data of
 
unsigned char or unsigned short.
 
This Writer can also generate a stack of images when the FileName is in
 
the form of /path/file_%03d.png and that the input data is a 3D image
data.
 
 
Writer to write unstructured grid in a xml-based vtk data file. Cannot be used<br>
 
for parallel writing.<br>




{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''File Name'''<br>''(FileName)''
 
|
|
 
The input filter/source whose output dataset is to
The name of the file to be written.
written to the file.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
The input filter/source whose output dataset is to written to the
file.
| �


|
|
 
Accepts input of following types:
The selected dataset must be one of the following types (or a subclass of one of them): vtkHyperOctree.
* vtkImageData
 
 
 
|-
|-
 
|'''FileName''' (FileName)
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
 
|
|
 
The name of the file to be written.
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'''<br>''(CompressorType)''


|
|


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


|}


| 0
==PPLYWriter==


|
Write polygonal data in Stanford University PLY format.
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 one file.


The value must be one of the following: None (0), ZLib (1).
{| class="PropertiesTable" border="1" cellpadding="5"
 
|-
 
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''Data Mode'''<br>''(DataMode)''
|
 
The input filter/source whose output dataset is to
written to the file.
|
|
The mode uses for writing the file's data i.e. ascii, binary, appended
binary.
| 2


|
|
 
Accepts input of following types:
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
* vtkPolyData
 
 
 
|-
|-
 
|'''FileName''' (FileName)
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
|
 
The name of the file to be written.
|
|
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.


|}
|}


==PSTLWriter==


 
Write stereo lithography files.STLWriter
==XMLImageDataWriter==
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.
 
Writer to write image data in a xml-based vtk data file. Cannot be used<br>
 
for parallel writing.<br>
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''File Name'''<br>''(FileName)''
 
|
|
 
The input filter/source whose output dataset is to
The name of the file to be written.
written to the file.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
The input filter/source whose output dataset is to written to the
file.
| �


|
|
 
Accepts input of following types:
The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData.
* vtkPolyData
 
 
 
|-
|-
 
|'''FileName''' (FileName)
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
 
|
|
 
The name of the file to be written.
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'''<br>''(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).


|-
|-
 
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
| '''Data Mode'''<br>''(DataMode)''
 
|
|
 
When WriteAllTimeSteps is turned ON, the writer is
The mode uses for writing the file's data i.e. ascii, binary, appended
executed once for each timestep available from the reader.
 
binary.
 
 
| 2


|
|
 
0
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
 
 
 
|-
 
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
 
|
 
When EncodeAppendedData is turned ON, the writer uses base64 encoding
 
when writing binary data (only if appended mode is selected).
 
 
| 0
 
|
|
 
Accepts boolean values (0 or 1).
Only the values 0 and 1 are accepted.
 
 


|}
|}


==TIFFWriter==


 
Write image data as a TIFF file.Writer to
==XMLMultiBlockDataWriter==
write image data as a TIFF file.
 
 
 
 
 
Writer to write a multiblock dataset in a xml-based vtk data file. Can be used<br>
 
for parallel writing as well as serial writing.<br>




{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''File Name'''<br>''(FileName)''
 
|
|
 
The input filter/source whose output dataset is to be
The name of the file to be written.
written to the file.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
The input filter/source whose output dataset is to written to the
file.
| �


|
|
 
Accepts input of following types:
The selected dataset must be one of the following types (or a subclass of one of them): vtkMultiBlockDataSet.
* vtkImageData
 
 
 
|-
|-
 
|'''FileName''' (FileName)
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
 
|
|
 
The name of the file to be written.
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'''<br>''(CompressorType)''


|
|


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


|}


| 0
==XMLDataSetWriterBase==


|
Base for all XML-based file-series
 
writers.
The value must be one of the following: None (0), ZLib (1).
 
 


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


| '''Data Mode'''<br>''(DataMode)''


|
|}


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


binary.
(DEPRECATED) Write a hierarchical box dataset in a xml-based vtk data file.
(DEPRECATED) Writer to write a hierarchical box in a xml-based vtk data file. Can be
used for parallel writing as well as serial writing. This is deprecated.
Use XMLUniformGridAMRWriter instead.




| 2
{| class="PropertiesTable" border="1" cellpadding="5"
 
|
 
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
 
 
 
|-
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


| '''Encode Appended Data'''<br>''(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==


 
Write unstructured grid in a xml-based vtk data file.
==XMLPImageDataWriter==
Writer to write unstructured grid in a xml-based vtk data file. Cannot be
 
used for parallel writing.
 
 
 
 
Writer to write image data in a xml-based vtk data file. Can be used<br>
 
for parallel writing.<br>
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''File Name'''<br>''(FileName)''
 
|
|
 
The input filter/source whose output dataset is to
The name of the file to be written.
written to the file.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
The input filter/source whose output dataset is to written to the
file.
| �


|
|
Accepts input of following types:
* vtkHyperOctree


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


==XMLImageDataWriter==


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


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
 
| '''Property'''
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
| '''Description'''
 
| '''Default Value(s)'''
|
| '''Restrictions'''
 
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.
 
 


|-
|-
 
|'''Input''' (Input)
| '''Compressor Type'''<br>''(CompressorType)''
 
|
|
 
The input filter/source whose output dataset is to
The compression algorithm used to compress binary data (appended mode only).
written to the file.
 
 
| 0
 
|
|
The value must be one of the following: None (0), ZLib (1).
|-
| '''Data Mode'''<br>''(DataMode)''


|
|
 
Accepts input of following types:
The mode uses for writing the file's data i.e. ascii, binary, appended
* vtkImageData
 
binary.
 
 
| 2
 
|
 
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
 
 
 
|-
 
| '''Encode Appended Data'''<br>''(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==


 
Write a multiblock in a xml-based vtk data file.
==XMLPPolyDataWriter==
Writer to write a multiblock dataset in a xml-based vtk data file. Can be
 
used for parallel writing as well as serial writing.
 
 
 
 
Writer to write polydata in a xml-based vtk data file. Can be used<br>
 
for parallel writing.<br>
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''File Name'''<br>''(FileName)''
 
|
|
 
The input filter/source whose output dataset is to
The name of the file to be written.
written to the file.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
The input filter/source whose output dataset is to written to the
file.
| �


|
|
Accepts input of following types:
* vtkMultiBlockDataSet


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


==XMLPImageDataWriter==


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


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
 
| '''Property'''
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
| '''Description'''
 
| '''Default Value(s)'''
|
| '''Restrictions'''
 
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.
 
 


|-
|-
 
|'''Input''' (Input)
| '''Compressor Type'''<br>''(CompressorType)''
 
|
|
 
The input filter/source whose output dataset is to
The compression algorithm used to compress binary data (appended mode only).
written to the file.
 
 
| 0
 
|
|
The value must be one of the following: None (0), ZLib (1).
|-
| '''Data Mode'''<br>''(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'''<br>''(EncodeAppendedData)''


|
|
 
Accepts input of following types:
When EncodeAppendedData is turned ON, the writer uses base64 encoding
* vtkImageData
 
when writing binary data (only if appended mode is selected).
 
 
| 0
 
|
 
Only the values 0 and 1 are accepted.
 
 


|}
|}


==XMLPPolyDataWriter==


 
Write polydata in a xml-based vtk data file.
==XMLPRectilinearGridWriter==
Writer to write polydata in a xml-based vtk data file. Can be used for
 
parallel writing.
 
 
 
 
Writer to write rectilinear grid in a xml-based vtk data file. Can be used<br>
 
for parallel writing.<br>
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''File Name'''<br>''(FileName)''
 
|
|
 
The input filter/source whose output dataset is to
The name of the file to be written.
written to the file.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
The input filter/source whose output dataset is to written to the
file.
| �


|
|
Accepts input of following types:
* vtkPolyData


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


==XMLPRectilinearGridWriter==


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


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
 
| '''Property'''
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
| '''Description'''
 
| '''Default Value(s)'''
|
| '''Restrictions'''
 
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'''<br>''(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).
 
 


|-
|-
 
|'''Input''' (Input)
| '''Data Mode'''<br>''(DataMode)''
 
|
|
 
The input filter/source whose output dataset is to
The mode uses for writing the file's data i.e. ascii, binary, appended
written to the file.
 
binary.
 
 
| 2
 
|
|
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''


|
|
 
Accepts input of following types:
When EncodeAppendedData is turned ON, the writer uses base64 encoding
* vtkRectilinearGrid
 
when writing binary data (only if appended mode is selected).
 
 
| 0
 
|
 
Only the values 0 and 1 are accepted.
 
 


|}
|}


==XMLPStructuredGridWriter==
==XMLPStructuredGridWriter==


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''File Name'''<br>''(FileName)''
 
|
|
 
The input filter/source whose output dataset is to
The name of the file to be written.
written to the file.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
The input filter/source whose output dataset is to written to the
file.
| �


|
|
Accepts input of following types:
* vtkStructuredGrid


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


==XMLPUnstructuredGridWriter==


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


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
 
| '''Property'''
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
| '''Description'''
 
| '''Default Value(s)'''
|
| '''Restrictions'''
 
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.
 
 


|-
|-
 
|'''Input''' (Input)
| '''Compressor Type'''<br>''(CompressorType)''
 
|
|
 
The input filter/source whose output dataset is to
The compression algorithm used to compress binary data (appended mode only).
written to the file.
 
 
| 0
 
|
 
The value must be one of the following: None (0), ZLib (1).
 
 
 
|-
 
| '''Data Mode'''<br>''(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'''<br>''(EncodeAppendedData)''


|
|
 
Accepts input of following types:
When EncodeAppendedData is turned ON, the writer uses base64 encoding
* vtkUnstructuredGrid
 
when writing binary data (only if appended mode is selected).
 
 
| 0
 
|
 
Only the values 0 and 1 are accepted.
 
 


|}
|}


==XMLPVAnimationWriter==


 
Internal writer proxy used when saving animation geometry
==XMLPUnstructuredGridWriter==
to save all parts of the current source to the file with pieces spread
 
across the server processes.
 
 
 
 
Writer to write unstructured grid in a xml-based vtk data file. Can be used<br>
 
for parallel writing.<br>
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Representations''' (Representations)
| '''File Name'''<br>''(FileName)''
 
|
|
 
The input filter/source whose output dataset is to
The name of the file to be written.
written to the file.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(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.


|-
|-
 
|'''FileName''' (FileName)
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
|
 
Name of the file to write.
|
|
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.


|-
|-
 
|'''WriteTime''' (WriteTime)
| '''Compressor Type'''<br>''(CompressorType)''
|
 
Write each time step in the animation
|
|
 
0.0
The compression algorithm used to compress binary data (appended mode only).
 
 
| 0
 
|
|
The value must be one of the following: None (0), ZLib (1).


|-
|-
 
|'''ErrorCode''' (ErrorCode)
| '''Data Mode'''<br>''(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'''<br>''(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==
==XMLPVDWriter==


 
Write ParaView data files (pvd).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.
 
Writer to write ParaView data files (pvd). It is used to save all pieces<br>
 
of a source/filter to a file with pieces spread across the server<br>
 
processes. <br>
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''Compressor Type'''<br>''(CompressorType)''
|
 
The input filter/source whose output dataset is to
written to the files.
|
|
The compression algorithm used to compress binary data (appended mode only).
| 0


|
|
 
Accepts input of following types:
The value must be one of the following: None (0), ZLib (1).
* vtkDataSet
 
 
 
|-
|-
 
|'''HeaderType''' (HeaderType)
| '''Data Mode'''<br>''(DataMode)''
|
Set the binary data header word type. The default is
UInt32. Set to UInt64 when storing arrays requiring 64-bit indexing.


|
|
 
64
The mode uses for writing the file's data i.e. ascii, binary, appended
 
binary.
 
 
| 2
 
|
|
 
The value(s) is an enumeration of the following:
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
* UInt32 (32)
 
* UInt64 (64)
 
 
|-
|-
 
|'''DataMode''' (DataMode)
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
|
 
The mode uses for writing the file's data i.e. ascii,
binary, appended binary.
|
|
 
2
When EncodeAppendedData is turned ON, the writer uses base64 encoding
 
when writing binary data (only if appended mode is selected).
 
 
| 0
 
|
|
 
The value(s) is an enumeration of the following:
Only the values 0 and 1 are accepted.
* Ascii (0)
 
* Binary (1)
 
* Appended (2)
 
|-
|-
 
|'''EncodeAppendedData''' (EncodeAppendedData)
| '''File Name'''<br>''(FileName)''
 
|
|
 
When EncodeAppendedData is turned ON, the writer uses
The name of the file to be written.
base64 encoding when writing binary data (only if appended mode is
 
selected).
 
| �
 
| �
 
|-
 
| '''Ghost Level'''<br>''(GhostLevel)''
 
|
|
 
0
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
 
|
|
 
Accepts boolean values (0 or 1).
The value must be greater than or equal to 0.
 
 
 
|-
|-
 
|'''CompressorType''' (CompressorType)
| '''Input'''<br>''(Input)''
|
 
The compression algorithm used to compress binary data
(appended mode only).
|
|
 
0
The input filter/source whose output dataset is to written to the
 
files.
 
 
| �
 
|
|
 
The value(s) is an enumeration of the following:
The selected object must be the result of the following: sources (includes readers), filters.
* None (0)
 
* ZLib (1)
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 


|}
|}


==XMLPolyDataWriter==
==XMLPolyDataWriter==


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''File Name'''<br>''(FileName)''
 
|
|
 
The input filter/source whose output dataset is to
The name of the file to be written.
written to the file.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
The input filter/source whose output dataset is to written to the
file.
| �


|
|
 
Accepts input of following types:
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
* vtkPolyData
 
 
 
|-
 
| '''Write all timesteps as file-series'''<br>''(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'''<br>''(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'''<br>''(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'''<br>''(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==
==XMLRectilinearGridWriter==


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''File Name'''<br>''(FileName)''
 
|
 
The name of the file to be written.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
 
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'''<br>''(WriteAllTimeSteps)''


|
|
Accepts input of following types:
* vtkRectilinearGrid


When WriteAllTimeSteps is turned ON, the writer is executed
|}


once for each timestep available from the reader.
==XMLStructuredGridWriter==


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


| 0
{| class="PropertiesTable" border="1" cellpadding="5"
 
|
 
Only the values 0 and 1 are accepted.
 
 
 
|-
|-
 
| '''Property'''
| '''Compressor Type'''<br>''(CompressorType)''
| '''Description'''
 
| '''Default Value(s)'''
|
| '''Restrictions'''
 
The compression algorithm used to compress binary data (appended mode only).
 
 
| 0
 
|
 
The value must be one of the following: None (0), ZLib (1).
 
 


|-
|-
 
|'''Input''' (Input)
| '''Data Mode'''<br>''(DataMode)''
 
|
|
 
The input filter/source whose output dataset is to
The mode uses for writing the file's data i.e. ascii, binary, appended
written to the file.
 
binary.
 
 
| 2
 
|
 
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
 
 
 
|-
 
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
 
|
|
When EncodeAppendedData is turned ON, the writer uses base64 encoding
when writing binary data (only if appended mode is selected).
| 0


|
|
 
Accepts input of following types:
Only the values 0 and 1 are accepted.
* vtkStructuredGrid
 
 


|}
|}


==XMLUniformGridAMRWriter==


 
Write a amr dataset in a xml-based vtk data file.
==XMLStructuredGridWriter==
Writer to write an AMR data-set (overlapping/non-overlapping)
 
in a xml-based vtk data file. Can be used for parallel writing as well as
 
serial writing.
 
 
 
Writer to write structured grid in a xml-based vtk data file. Cannot be used<br>
 
for parallel writing.<br>
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''File Name'''<br>''(FileName)''
 
|
|
 
The input filter/source whose output dataset is to
The name of the file to be written.
written to the file.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
The input filter/source whose output dataset is to written to the
file.
| �


|
|
Accepts input of following types:
* vtkUniformGridAMR


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


==XMLUnstructuredGridWriter==


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


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
 
| '''Property'''
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
| '''Description'''
 
| '''Default Value(s)'''
|
| '''Restrictions'''
 
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.
 
 


|-
|-
 
|'''Input''' (Input)
| '''Compressor Type'''<br>''(CompressorType)''
 
|
|
 
The input filter/source whose output dataset is to
The compression algorithm used to compress binary data (appended mode only).
written to the file.
 
 
| 0
 
|
|
The value must be one of the following: None (0), ZLib (1).
|-
| '''Data Mode'''<br>''(DataMode)''


|
|
 
Accepts input of following types:
The mode uses for writing the file's data i.e. ascii, binary, appended
* vtkUnstructuredGrid
 
binary.
 
 
| 2
 
|
 
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
 
 
 
|-
 
| '''Encode Appended Data'''<br>''(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==


 
Write data in Xdmf files.Writer to write
==XMLUnstructuredGridWriter==
data in eXtensible Data Model and Format *(XDMF) files.
 
 
 
 
 
Writer to write unstructured grid in a xml-based vtk data file. Cannot be used<br>
 
for parallel writing.<br>
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


|-
|-
 
|'''Input''' (Input)
| '''File Name'''<br>''(FileName)''
 
|
|
 
The input filter/source whose output dataset is to
The name of the file to be written.
written to the file.
 
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
The input filter/source whose output dataset is to written to the
file.
| �


|
|
 
Accepts input of following types:
The selected dataset must be one of the following types (or a subclass of one of them): vtkUnstructuredGrid.
* vtkDataSet
 
 
 
|-
|-
 
|'''FileName''' (FileName)
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
|
 
The name of the file to be written.
|
|
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.


|-
|-
 
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
| '''Compressor Type'''<br>''(CompressorType)''
 
|
|
 
When WriteAllTimeSteps is turned ON, the writer is
The compression algorithm used to compress binary data (appended mode only).
executed once for each timestep available from the reader.
 
 
| 0
 
|
 
The value must be one of the following: None (0), ZLib (1).
 
 
 
|-
 
| '''Data Mode'''<br>''(DataMode)''


|
|
 
0
The mode uses for writing the file's data i.e. ascii, binary, appended
 
binary.
 
 
| 2
 
|
|
 
Accepts boolean values (0 or 1).
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
 
 
 
|-
|-
 
|'''MeshStaticOverTime''' (MeshStaticOverTime)
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
 
|
|
 
When MeshStaticOverTime is turned ON, only the mesh
When EncodeAppendedData is turned ON, the writer uses base64 encoding
topology and geometry at the first time step will be written in the
 
heavy data file. All time steps will reference them in the Xdmf file.
when writing binary data (only if appended mode is selected).
 
 
| 0


|
|
 
0
Only the values 0 and 1 are accepted.
 
 
 
|}
 
 
 
==XdmfWriter==
 
 
 
 
 
Writer to write data in eXtensible Data Model and Format *(XDMF) files.<br>
 
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
|-
 
| '''Property'''
 
| '''Description'''
 
| '''Default Value(s)'''
 
| '''Restrictions'''
 
|-
 
| '''File Name'''<br>''(FileName)''
 
| �
 
| �
 
| �
 
|-
 
| '''Input'''<br>''(Input)''
 
|
|
 
Accepts boolean values (0 or 1).
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.
 
 


|}
|}

Latest revision as of 13:07, 26 January 2016

AnimationSceneImageWriter

Internal writer to used paraview uses when it disconnects the GUI.

Property Description Default Value(s) Restrictions
Magnification (Magnification)

The magnification factor to use for the saved animation.

1

FileName (FileName)

The name of the file to save the animation into.

FrameRate (FrameRate)

Get/Set the frame rate to use for saving the animation. This frame rate is the frame rate that gets saved in the movie file generated, if applicable. If does not affect the FrameRate set on the animation scene at all. In other words, this is the playback frame rate and not the animation generation frame rate.

0

PlaybackTimeWindow (PlaybackTimeWindow)

Time range to write

-1 1

Compression (Compression)

Turns on(the default) or off compression for FFMEG (AVI on Linux and Mac) backend.

1

Accepts boolean values (0 or 1).

StartFileCount (StartFileCount)

0


CSVWriter

Writer to write CSV filesWriter 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
Input (Input)

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

Accepts input of following types:

  • vtkTable
FileName (FileName)

The name of the file to be written.

WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

DataSetCSVWriter

Writer to write CSV filesWriter 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
Input (Input)

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

Accepts input of following types:

  • vtkDataSet
FileName (FileName)

The name of the file to be written.

WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

DataSetWriter

Write any type of data object in a legacy vtk data file. 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
Input (Input)

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

Accepts input of following types:

  • vtkDataObject

EnSightWriter

Write unstructured grid data as an EnSight file. 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
Input (Input)

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

Accepts input of following types:

  • vtkUnstructuredGrid

ExodusIIWriter

Write Exodus II files.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
Input (Input)

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

Accepts input of following types:

  • vtkCompositeDataSet
  • vtkDataSet
WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

JPEGWriter

Write image data as a JPEG file. Writer to write image data as a JPEG file. It supports 1 to 3 component data of unsigned char or unsigned short. This Writer can also generate a stack of images when the FileName is in the form of /path/file_%03d.jpg and that the input data is a 3D image data.


Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkImageData
FileName (FileName)

The name of the file to be written.


JSONImageWriter

Write image data as a JSON file.

Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkImageData
FileName (FileName)

The name of the file to be written.

ArrayName (ArrayName)

The name of the field to export. If Empty all fields will be saved.

Slice (Slice)

Write only one slice if slice >= 0

-1


MetaImageWriter

Write a binary UNC meta image data.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
Input (Input)

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

Accepts input of following types:

  • vtkImageData
FileName (FileName)

The name of the file to be written.


PDataSetWriter

Writer that writes polydata as legacy vtk files. 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 one file.

Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkDataObject
FileName (FileName)

The name of the file to be written.

WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

PNGWriter

Write image data as a PNG file.Writer to write image data as a PNG file. It supports 1 to 4 component data of unsigned char or unsigned short. This Writer can also generate a stack of images when the FileName is in the form of /path/file_%03d.png and that the input data is a 3D image data.


Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkImageData
FileName (FileName)

The name of the file to be written.


PPLYWriter

Write polygonal data in Stanford University PLY format. 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 one file.

Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkPolyData
FileName (FileName)

The name of the file to be written.


PSTLWriter

Write stereo lithography files.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
Input (Input)

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

Accepts input of following types:

  • vtkPolyData
FileName (FileName)

The name of the file to be written.

WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

TIFFWriter

Write image data as a TIFF file.Writer to write image data as a TIFF file.


Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkImageData
FileName (FileName)

The name of the file to be written.


XMLDataSetWriterBase

Base for all XML-based file-series writers.

Property Description Default Value(s) Restrictions


XMLHierarchicalBoxDataWriter

(DEPRECATED) Write a hierarchical box dataset in a xml-based vtk data file. (DEPRECATED) Writer to write a hierarchical box in a xml-based vtk data file. Can be used for parallel writing as well as serial writing. This is deprecated. Use XMLUniformGridAMRWriter instead.


Property Description Default Value(s) Restrictions


XMLHyperOctreeWriter

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

Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkHyperOctree

XMLImageDataWriter

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

Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkImageData

XMLMultiBlockDataWriter

Write a multiblock in a xml-based vtk data file. 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
Input (Input)

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

Accepts input of following types:

  • vtkMultiBlockDataSet

XMLPImageDataWriter

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

Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkImageData

XMLPPolyDataWriter

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

Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkPolyData

XMLPRectilinearGridWriter

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

Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkRectilinearGrid

XMLPStructuredGridWriter

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

Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkStructuredGrid

XMLPUnstructuredGridWriter

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

Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkUnstructuredGrid

XMLPVAnimationWriter

Internal writer proxy used when saving animation geometry to save all parts of the current source to the file with pieces spread across the server processes.

Property Description Default Value(s) Restrictions
Representations (Representations)

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

FileName (FileName)

Name of the file to write.

WriteTime (WriteTime)

Write each time step in the animation

0.0

ErrorCode (ErrorCode)


XMLPVDWriter

Write ParaView data files (pvd).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
Input (Input)

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

Accepts input of following types:

  • vtkDataSet
HeaderType (HeaderType)

Set the binary data header word type. The default is UInt32. Set to UInt64 when storing arrays requiring 64-bit indexing.

64

The value(s) is an enumeration of the following:

  • UInt32 (32)
  • UInt64 (64)
DataMode (DataMode)

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

2

The value(s) is an enumeration of the following:

  • Ascii (0)
  • Binary (1)
  • Appended (2)
EncodeAppendedData (EncodeAppendedData)

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

0

Accepts boolean values (0 or 1).

CompressorType (CompressorType)

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

0

The value(s) is an enumeration of the following:

  • None (0)
  • ZLib (1)

XMLPolyDataWriter

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

Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkPolyData

XMLRectilinearGridWriter

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

Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkRectilinearGrid

XMLStructuredGridWriter

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

Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkStructuredGrid

XMLUniformGridAMRWriter

Write a amr dataset in a xml-based vtk data file. Writer to write an AMR data-set (overlapping/non-overlapping) in a xml-based vtk data file. Can be used for parallel writing as well as serial writing.

Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkUniformGridAMR

XMLUnstructuredGridWriter

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

Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkUnstructuredGrid

XdmfWriter

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

Property Description Default Value(s) Restrictions
Input (Input)

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

Accepts input of following types:

  • vtkDataSet
FileName (FileName)

The name of the file to be written.

WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

MeshStaticOverTime (MeshStaticOverTime)

When MeshStaticOverTime is turned ON, only the mesh topology and geometry at the first time step will be written in the heavy data file. All time steps will reference them in the Xdmf file.

0

Accepts boolean values (0 or 1).