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

From KitwarePublic
Jump to navigationJump to search
 
(18 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=
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


 
|-
 
|'''Magnification''' (Magnification)
 
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
|
| '''Property''
| '''Description''
| '''Default Value(s)''
| '''Restrictions''
|
|
| '''File Name'''<br>''(FileName)'
The magnification factor to use for the saved
 
animation.
The name of the file to be written
 
|
|
1
|
|
|
| '''Input'''<br>''(Input)'
The input filter/source whose output dataset is to written to th
file


|-
|'''FileName''' (FileName)
|
|
 
The name of the file to save the animation
The selected object must be the result of the following: sources (includes readers), filters
into.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkTable
 
 
|
|
| '''Write All Time Steps'''<br>''(WriteAllTimeSteps)'
When WriteAllTimeSteps is turned ON, the writer is execute
once for each timestep available from the reader


|
|


Only the values 0 and 1 are accepted
|-
 
|'''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
==DataSetCSVWriter=
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.
 
 
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
|
|
| '''Property''
0
| '''Description''
| '''Default Value(s)''
| '''Restrictions''
|
|
| '''File Name'''<br>''(FileName)'
The name of the file to be written


|-
|'''PlaybackTimeWindow''' (PlaybackTimeWindow)
|
|
Time range to write
|
|
-1 1
|
|
| '''Input'''<br>''(Input)'
The input filter/source whose output dataset is to written to th
file


|-
|'''Compression''' (Compression)
|
|
 
Turns on(the default) or off compression for FFMEG
The selected object must be the result of the following: sources (includes readers), filters
(AVI on Linux and Mac) backend.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet
 


|
|
| '''Write All Time Steps'''<br>''(WriteAllTimeSteps)'
1
 
When WriteAllTimeSteps is turned ON, the writer is execute
once for each timestep available from the reader
 
|
|
 
Accepts boolean values (0 or 1).
Only the values 0 and 1 are accepted
|-
 
|'''StartFileCount''' (StartFileCount)
 
|
|
| '''Field Association'''<br>''(FieldAssociation)'
Select the attribute data to pass


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




==DataSetWriter=
|}


==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.


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


Writer to write any type of data object in a legacy vtk data file. <br
|-
Cannot be used for parallel writing.<br
|'''Input''' (Input)
 
{| class="PropertiesTable" border="1" cellpadding="5
|
|
| '''Property''
The input filter/source whose output dataset is to
| '''Description''
written to the file.
| '''Default Value(s)''
| '''Restrictions''
|
|
| '''File Name'''<br>''(FileName)'
The name of the file to be written


|
|
Accepts input of following types:
* vtkTable
|-
|'''FileName''' (FileName)
|
|
The name of the file to be written.
|
|
| '''Input'''<br>''(Input)'
The input filter/source whose output dataset is to written to th
file


|
|


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


|}


==EnSightWriter=
==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.


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


 
|-
Writer to write unstructured grid data as an EnSight file. Binary files <br
|'''Input''' (Input)
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
|
|
| '''Property''
The input filter/source whose output dataset is to
| '''Description''
written to the file.
| '''Default Value(s)''
| '''Restrictions''
|
|
| '''File Name'''<br>''(FileName)'
The name of the file to be written


|
|
Accepts input of following types:
* vtkDataSet
|-
|'''FileName''' (FileName)
|
|
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 tha
some writers (such as ExodusIIWriter) may not support writing ghos
levels


|
|


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
The input filter/source whose output dataset is to written to th
reader.
file
 
|
|
 
0
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
 
 
|
|
Accepts boolean values (0 or 1).


|}


==ExodusIIWriter=
==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.


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


 
|-
Writer to write Exodus II files. Refere to http://endo.sandia.gov/SEACAS/ <br
|'''Input''' (Input)
for more information about the Exodus II format.<br
 
{| class="PropertiesTable" border="1" cellpadding="5
|
|
| '''Property''
The input filter/source whose output dataset is to
| '''Description''
written to the file.
| '''Default Value(s)''
| '''Restrictions''
|
|
| '''File Name'''<br>''(FileName)'
The name of the file to be written


|
|
|
Accepts input of following types:
|
* vtkDataObject
| '''Ghost Level'''<br>''(GhostLevel)'


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


|
==EnSightWriter==


The value must be greater than or equal to 0
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.


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


|-
|'''Input''' (Input)
|
|
| '''Input'''<br>''(Input)'
The input filter/source whose output dataset is to
 
written to the file.
The input filter/source whose output dataset is to written to th
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)'
Accepts input of following types:
* vtkUnstructuredGrid


When WriteAllTimeSteps is turned ON, the writer is execute
|}
once for each timestep available from the reader


|
==ExodusIIWriter==


Only the values 0 and 1 are accepted
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.


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


|-
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
 
written to the file.
==MetaImageWriter=
 
 
 
 
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
|
|
| '''Property''
| '''Description''
| '''Default Value(s)''
| '''Restrictions''
|
| '''File Name'''<br>''(FileName)'
The name of the file to be written


|
|
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.
|
|
| '''Input'''<br>''(Input)'
0
 
The input filter/source whose output dataset is to written to th
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
 
 
|
|
Accepts boolean values (0 or 1).


|}


==PDataSetWriter=
==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.




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


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
|'''Input''' (Input)
first node and saves 1 file.<br
 
{| class="PropertiesTable" border="1" cellpadding="5
|
|
| '''Property''
The input filter/source whose output dataset is to
| '''Description''
written to the file.
| '''Default Value(s)''
| '''Restrictions''
|
|
| '''File Name'''<br>''(FileName)'
The name of the file to be written


|
|
Accepts input of following types:
* vtkImageData
|-
|'''FileName''' (FileName)
|
|
The name of the file to be written.
|
|
| '''Input'''<br>''(Input)'
The input filter/source whose output dataset is to written to th
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
==JSONImageWriter==


Write image data as a JSON file.


|
{| class="PropertiesTable" border="1" cellpadding="5"
| '''Write All Time Steps'''<br>''(WriteAllTimeSteps)'
|-
 
| '''Property'''
When WriteAllTimeSteps is turned ON, the writer is execute
| '''Description'''
once for each timestep available from the reader
| '''Default Value(s)'''
| '''Restrictions'''


|-
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
Only the values 0 and 1 are accepted
written to the file.
 
 
|
|
| '''File Type'''<br>''(FileType)'
The type for the data file (i.e. ascii or binary)


|
|
 
Accepts input of following types:
The value must be one of the following: Ascii (1), Binary (2)
* vtkImageData
 
|-
 
|'''FileName''' (FileName)
|
|
 
The name of the file to be written.
 
==PNGWriter=
 
 
 
 
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
|
|
| '''Property''
| '''Description''
| '''Default Value(s)''
| '''Restrictions''
|
| '''File Name'''<br>''(FileName)'
The name of the file to be written


|
|
|
|
| '''Input'''<br>''(Input)'
The input filter/source whose output dataset is to written to th
file


|-
|'''ArrayName''' (ArrayName)
|
|
 
The name of the field to export. If Empty all fields will be saved.
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 <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
|
|
| '''Property''
| '''Description''
| '''Default Value(s)''
| '''Restrictions''
|
| '''File Name'''<br>''(FileName)'
The name of the file to be written


|-
|'''Slice''' (Slice)
|
|
Write only one slice if slice &gt;= 0
|
|
-1
|
|
| '''Input'''<br>''(Input)'


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


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


==MetaImageWriter==


The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData
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"


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


|-
|'''Input''' (Input)
|
|
| '''File Type'''<br>''(FileType)'
The input filter/source whose output dataset is to
 
written to the file.
The type for the data file (i.e. ascii or binary)
 
|
|
The value must be one of the following: Ascii (1), Binary (2)


|
|
 
Accepts input of following types:
 
* vtkImageData
==PSTLWriter=
|-
 
|'''FileName''' (FileName)
 
 
 
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
|
|
| '''Property''
The name of the file to be written.
| '''Description''
| '''Default Value(s)''
| '''Restrictions''
|
|
| '''File Name'''<br>''(FileName)'
The name of the file to be written
|
|
|
| '''Input'''<br>''(Input)'
The input filter/source whose output dataset is to written to th
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'''<br>''(FileType)'
The type for the data file (i.e. ascii or binary)
|
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<br
for parallel writing as well as serial writing.<br
{| class="PropertiesTable" border="1" cellpadding="5
|
| '''Property''
| '''Description''
| '''Default Value(s)''
| '''Restrictions''
|
| '''File Name'''<br>''(FileName)'
The name of the file to be written
|
|
|
| '''Input'''<br>''(Input)'
The input filter/source whose output dataset is to written to th
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'''<br>''(WriteAllTimeSteps)'
When WriteAllTimeSteps is turned ON, the writer is execute
once for each timestep available from the reader
|
Only the values 0 and 1 are accepted
|
| '''Compressor Type'''<br>''(CompressorType)'
The compression algorithm used to compress binary data (appended mode only)
|
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, appende
binary
|
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 encodin
when writing binary data (only if appended mode is selected)
|
Only the values 0 and 1 are accepted
|
==XMLHyperOctreeWriter=
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
|
| '''Property''
| '''Description''
| '''Default Value(s)''
| '''Restrictions''
|
| '''File Name'''<br>''(FileName)'
The name of the file to be written
|
|
|
| '''Input'''<br>''(Input)'
The input filter/source whose output dataset is to written to th
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'''<br>''(WriteAllTimeSteps)'
When WriteAllTimeSteps is turned ON, the writer is execute
once for each timestep available from the reader
|
Only the values 0 and 1 are accepted


|
|
| '''Compressor Type'''<br>''(CompressorType)'


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


|
|}


The value must be one of the following: None (0), ZLib (1)
==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.


|
{| class="PropertiesTable" border="1" cellpadding="5"
| '''Data Mode'''<br>''(DataMode)'
|-
 
| '''Property'''
The mode uses for writing the file's data i.e. ascii, binary, appende
| '''Description'''
binary
| '''Default Value(s)'''
| '''Restrictions'''


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


|
|
 
Accepts input of following types:
Only the values 0 and 1 are accepted
* vtkDataObject
 
|-
 
|'''FileName''' (FileName)
|
 
 
==XMLImageDataWriter=
 
 
 
 
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
|
| '''Property''
| '''Description''
| '''Default Value(s)''
| '''Restrictions''
|
| '''File Name'''<br>''(FileName)'
 
The name of the file to be written
 
|
|
|
| '''Input'''<br>''(Input)'
 
The input filter/source whose output dataset is to written to th
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'''<br>''(WriteAllTimeSteps)'
 
When WriteAllTimeSteps is turned ON, the writer is execute
once for each timestep available from the reader
 
|
 
Only the values 0 and 1 are accepted
 
 
|
| '''Compressor Type'''<br>''(CompressorType)'
 
The compression algorithm used to compress binary data (appended mode only)
 
|
 
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, appende
binary
 
|
 
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 encodin
when writing binary data (only if appended mode is selected)
 
|
|
 
The name of the file to be written.
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<br
for parallel writing as well as serial writing.<br
{| class="PropertiesTable" border="1" cellpadding="5
|
|
| '''Property''
| '''Description''
| '''Default Value(s)''
| '''Restrictions''
|
| '''File Name'''<br>''(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
|
|
| '''Input'''<br>''(Input)'
Accepts boolean values (0 or 1).
 
The input filter/source whose output dataset is to written to th
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'''<br>''(WriteAllTimeSteps)'


When WriteAllTimeSteps is turned ON, the writer is execute
|}
once for each timestep available from the reader


|
==PNGWriter==


Only the values 0 and 1 are accepted
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.




|
{| class="PropertiesTable" border="1" cellpadding="5"
| '''Compressor Type'''<br>''(CompressorType)'
|-
 
| '''Property'''
The compression algorithm used to compress binary data (appended mode only)
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


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


|
|
 
Accepts input of following types:
The value must be one of the following: Ascii (0), Binary (1), Appended (2)
* vtkImageData
 
|-
 
|'''FileName''' (FileName)
|
|
| '''Encode Appended Data'''<br>''(EncodeAppendedData)'
The name of the file to be written.
 
When EncodeAppendedData is turned ON, the writer uses base64 encodin
when writing binary data (only if appended mode is selected)
 
|
|
Only the values 0 and 1 are accepted


|
|




==XMLPImageDataWriter=
|}


==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.


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


Writer to write image data in a xml-based vtk data file. Can be used<br
|-
for parallel writing.<br
|'''Input''' (Input)
 
{| class="PropertiesTable" border="1" cellpadding="5
|
|
| '''Property''
The input filter/source whose output dataset is to
| '''Description''
written to the file.
| '''Default Value(s)''
| '''Restrictions''
|
|
| '''File Name'''<br>''(FileName)'
The name of the file to be written


|
|
Accepts input of following types:
* vtkPolyData
|-
|'''FileName''' (FileName)
|
|
The name of the file to be written.
|
|
| '''Input'''<br>''(Input)'
The input filter/source whose output dataset is to written to th
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'''<br>''(WriteAllTimeSteps)'


When WriteAllTimeSteps is turned ON, the writer is execute
|}
once for each timestep available from the reader


|
==PSTLWriter==


Only the values 0 and 1 are accepted
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.


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


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


|
|
| '''Data Mode'''<br>''(DataMode)'
Accepts input of following types:
 
* vtkPolyData
The mode uses for writing the file's data i.e. ascii, binary, appende
|-
binary
|'''FileName''' (FileName)
 
|
|
 
The name of the file to be written.
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 encodin
when writing binary data (only if appended mode is selected)


|
|


Only the values 0 and 1 are accepted
|-
 
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
 
|
|
When WriteAllTimeSteps is turned ON, the writer is
executed once for each timestep available from the reader.


==XMLPPolyDataWriter=
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
|
|
| '''Property''
0
| '''Description''
| '''Default Value(s)''
| '''Restrictions''
|
|
| '''File Name'''<br>''(FileName)'
Accepts boolean values (0 or 1).


The name of the file to be written
|}
 
|
|
|
| '''Input'''<br>''(Input)'


The input filter/source whose output dataset is to written to th
==TIFFWriter==
file


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


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


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


|-
|'''Input''' (Input)
|
|
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)'
The input filter/source whose output dataset is to be
 
written to the file.
When WriteAllTimeSteps is turned ON, the writer is execute
once for each timestep available from the reader
 
|
|
Only the values 0 and 1 are accepted


|
|
| '''Compressor Type'''<br>''(CompressorType)'
Accepts input of following types:
 
* vtkImageData
The compression algorithm used to compress binary data (appended mode only)
|-
 
|'''FileName''' (FileName)
|
|
 
The name of the file to be written.
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, appende
binary


|
|


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


|}


|
==XMLDataSetWriterBase==
| '''Encode Appended Data'''<br>''(EncodeAppendedData)'


When EncodeAppendedData is turned ON, the writer uses base64 encodin
Base for all XML-based file-series
when writing binary data (only if appended mode is selected)
writers.


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


Only the values 0 and 1 are accepted


|}


|
==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.


==XMLPRectilinearGridWriter=


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




|}


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


{| class="PropertiesTable" border="1" cellpadding="5
Write unstructured grid in a xml-based vtk data file.
|
Writer to write unstructured grid in a xml-based vtk data file. Cannot be
| '''Property''
used for parallel writing.
| '''Description''
| '''Default Value(s)''
| '''Restrictions''
|
| '''File Name'''<br>''(FileName)'


The name of the file to be written
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


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


|
|
Accepts input of following types:
* vtkHyperOctree


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


==XMLImageDataWriter==


|
Write image data in a xml-based vtk data file.
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)'
Writer to write image data in a xml-based vtk data file. Cannot be used
for parallel writing.


When WriteAllTimeSteps is turned ON, the writer is execute
{| class="PropertiesTable" border="1" cellpadding="5"
once for each timestep available from the reader
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


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


|
|
Accepts input of following types:
* vtkImageData


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


==XMLMultiBlockDataWriter==


|
Write a multiblock in a xml-based vtk data file.
| '''Data Mode'''<br>''(DataMode)'
Writer to write a multiblock dataset in a xml-based vtk data file. Can be
used for parallel writing as well as serial writing.


The mode uses for writing the file's data i.e. ascii, binary, appende
{| class="PropertiesTable" border="1" cellpadding="5"
binary
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


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


|
|
Accepts input of following types:
* vtkMultiBlockDataSet


Only the values 0 and 1 are accepted
|}
 
 
|
 
 
==XMLPStructuredGridWriter=
 


==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.


Writer to write structured grid in a xml-based vtk data file. Can be used<br
{| class="PropertiesTable" border="1" cellpadding="5"
for parallel writing.<br
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


{| class="PropertiesTable" border="1" cellpadding="5
|-
|'''Input''' (Input)
|
|
| '''Property''
The input filter/source whose output dataset is to
| '''Description''
written to the file.
| '''Default Value(s)''
| '''Restrictions''
|
|
| '''File Name'''<br>''(FileName)'
The name of the file to be written


|
|
|
Accepts input of following types:
|
* vtkImageData
| '''Input'''<br>''(Input)'


The input filter/source whose output dataset is to written to th
|}
file


|
==XMLPPolyDataWriter==


The selected dataset must be one of the following types (or a subclass of one of them): vtkStructuredGrid
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.


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


|-
|'''Input''' (Input)
|
|
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)'
The input filter/source whose output dataset is to
 
written to the file.
When WriteAllTimeSteps is turned ON, the writer is execute
once for each timestep available from the reader
 
|
|
Only the values 0 and 1 are accepted


|
|
| '''Compressor Type'''<br>''(CompressorType)'
Accepts input of following types:
* vtkPolyData


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


|
==XMLPRectilinearGridWriter==


The value must be one of the following: None (0), ZLib (1)
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'''
| '''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, appende
binary
 
|
|
The value must be one of the following: Ascii (0), Binary (1), Appended (2)


|
|
| '''Encode Appended Data'''<br>''(EncodeAppendedData)'
Accepts input of following types:
* vtkRectilinearGrid


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


|
==XMLPStructuredGridWriter==


Only the values 0 and 1 are accepted
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.


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


|-
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
 
written to the file.
==XMLPUnstructuredGridWriter=
 
 
 
 
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
|
|
| '''Property''
| '''Description''
| '''Default Value(s)''
| '''Restrictions''
|
| '''File Name'''<br>''(FileName)'
The name of the file to be written


|
|
|
Accepts input of following types:
|
* vtkStructuredGrid
| '''Input'''<br>''(Input)'


The input filter/source whose output dataset is to written to th
|}
file


|
==XMLPUnstructuredGridWriter==


The selected dataset must be one of the following types (or a subclass of one of them): vtkUnstructuredGrid
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'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


|-
|'''Input''' (Input)
|
|
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)'
The input filter/source whose output dataset is to
 
written to the file.
When WriteAllTimeSteps is turned ON, the writer is execute
once for each timestep available from the reader
 
|
|
Only the values 0 and 1 are accepted


|
|
| '''Compressor Type'''<br>''(CompressorType)'
Accepts input of following types:
* vtkUnstructuredGrid


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


|
==XMLPVAnimationWriter==


The value must be one of the following: None (0), ZLib (1)
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.


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


|-
|'''Representations''' (Representations)
|
|
| '''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, appende
binary
 
|
|
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 encodin
when writing binary data (only if appended mode is selected)


|-
|'''FileName''' (FileName)
|
|
 
Name of the file to write.
Only the values 0 and 1 are accepted
 
 
|
|


==XMLPVDWriter=
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
|
| '''Property''
| '''Description''
| '''Default Value(s)''
| '''Restrictions''
|
|
| '''Compressor Type'''<br>''(CompressorType)'
The compression algorithm used to compress binary data (appended mode only)


|-
|'''WriteTime''' (WriteTime)
|
|
 
Write each time step in the animation
The value must be one of the following: None (0), ZLib (1)
 
 
|
|
| '''Data Mode'''<br>''(DataMode)'
0.0
 
The mode uses for writing the file's data i.e. ascii, binary, appende
binary
 
|
|


The value must be one of the following: Ascii (0), Binary (1), Appended (2)
|-
 
|'''ErrorCode''' (ErrorCode)
 
|
|
| '''Encode Appended Data'''<br>''(EncodeAppendedData)'
When EncodeAppendedData is turned ON, the writer uses base64 encodin
when writing binary data (only if appended mode is selected)


|
|
Only the values 0 and 1 are accepted


|
|
| '''File Name'''<br>''(FileName)'


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 tha
|}
some writers (such as ExodusIIWriter) may not support writing ghos
levels


|
==XMLPVDWriter==


The value must be greater than or equal to 0
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.


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


|-
|'''Input''' (Input)
|
|
| '''Input'''<br>''(Input)'
The input filter/source whose output dataset is to
 
written to the files.
The input filter/source whose output dataset is to written to th
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<br
for parallel writing.<br
{| class="PropertiesTable" border="1" cellpadding="5
|
|
| '''Property''
Accepts input of following types:
| '''Description''
* vtkDataSet
| '''Default Value(s)''
|-
| '''Restrictions''
|'''HeaderType''' (HeaderType)
|
|
| '''File Name'''<br>''(FileName)'
Set the binary data header word type. The default is
 
UInt32. Set to UInt64 when storing arrays requiring 64-bit indexing.
The name of the file to be written


|
|
64
|
|
The value(s) is an enumeration of the following:
* UInt32 (32)
* UInt64 (64)
|-
|'''DataMode''' (DataMode)
|
|
| '''Input'''<br>''(Input)'
The mode uses for writing the file's data i.e. ascii,
 
binary, appended binary.
The input filter/source whose output dataset is to written to th
file
 
|
|
 
2
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData
 
 
|
|
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)'
The value(s) is an enumeration of the following:
 
* Ascii (0)
When WriteAllTimeSteps is turned ON, the writer is execute
* Binary (1)
once for each timestep available from the reader
* Appended (2)
 
|-
|'''EncodeAppendedData''' (EncodeAppendedData)
|
|
 
When EncodeAppendedData is turned ON, the writer uses
Only the values 0 and 1 are accepted
base64 encoding when writing binary data (only if appended mode is
 
selected).
 
|
|
| '''Compressor Type'''<br>''(CompressorType)'
0
 
The compression algorithm used to compress binary data (appended mode only)
 
|
|
 
Accepts boolean values (0 or 1).
The value must be one of the following: None (0), ZLib (1)
|-
 
|'''CompressorType''' (CompressorType)
 
|
|
| '''Data Mode'''<br>''(DataMode)'
The compression algorithm used to compress binary data
 
(appended mode only).
The mode uses for writing the file's data i.e. ascii, binary, appende
binary
 
|
|
 
0
The value must be one of the following: Ascii (0), Binary (1), Appended (2)
 
 
|
|
| '''Encode Appended Data'''<br>''(EncodeAppendedData)'
The value(s) is an enumeration of the following:
* None (0)
* ZLib (1)


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


|
==XMLPolyDataWriter==


Only the values 0 and 1 are accepted
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.


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


|-
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
 
written to the file.
==XMLRectilinearGridWriter=
 
 
 
 
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
|
|
| '''Property''
| '''Description''
| '''Default Value(s)''
| '''Restrictions''
|
| '''File Name'''<br>''(FileName)'
The name of the file to be written
|
|
|
| '''Input'''<br>''(Input)'
The input filter/source whose output dataset is to written to th
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)'
When WriteAllTimeSteps is turned ON, the writer is execute
once for each timestep available from the reader
|
Only the values 0 and 1 are accepted
|
| '''Compressor Type'''<br>''(CompressorType)'
The compression algorithm used to compress binary data (appended mode only)
|
The value must be one of the following: None (0), ZLib (1)


|
|
| '''Data Mode'''<br>''(DataMode)'
Accepts input of following types:
* vtkPolyData


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


|
==XMLRectilinearGridWriter==


The value must be one of the following: Ascii (0), Binary (1), Appended (2)
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.


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


|-
|'''Input''' (Input)
|
|
| '''Encode Appended Data'''<br>''(EncodeAppendedData)'
The input filter/source whose output dataset is to
 
written to the file.
When EncodeAppendedData is turned ON, the writer uses base64 encodin
when writing binary data (only if appended mode is selected)
 
|
|
Only the values 0 and 1 are accepted


|
|
Accepts input of following types:
* vtkRectilinearGrid


|}


==XMLStructuredGridWriter=
==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.


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


Writer to write structured grid in a xml-based vtk data file. Cannot be used<br
|-
for parallel writing.<br
|'''Input''' (Input)
 
{| class="PropertiesTable" border="1" cellpadding="5
|
|
| '''Property''
The input filter/source whose output dataset is to
| '''Description''
written to the file.
| '''Default Value(s)''
| '''Restrictions''
|
|
| '''File Name'''<br>''(FileName)'
The name of the file to be written


|
|
|
Accepts input of following types:
|
* vtkStructuredGrid
| '''Input'''<br>''(Input)'


The input filter/source whose output dataset is to written to th
|}
file


|
==XMLUniformGridAMRWriter==


The selected dataset must be one of the following types (or a subclass of one of them): vtkStructuredGrid
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.


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


|-
|'''Input''' (Input)
|
|
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)'
The input filter/source whose output dataset is to
 
written to the file.
When WriteAllTimeSteps is turned ON, the writer is execute
once for each timestep available from the reader
 
|
 
Only the values 0 and 1 are accepted
 
 
|
| '''Compressor Type'''<br>''(CompressorType)'
 
The compression algorithm used to compress binary data (appended mode only)
 
|
|
The value must be one of the following: None (0), ZLib (1)


|
|
| '''Data Mode'''<br>''(DataMode)'
Accepts input of following types:
* vtkUniformGridAMR


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


|
==XMLUnstructuredGridWriter==


The value must be one of the following: Ascii (0), Binary (1), Appended (2)
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'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


|-
|'''Input''' (Input)
|
|
| '''Encode Appended Data'''<br>''(EncodeAppendedData)'
The input filter/source whose output dataset is to
 
written to the file.
When EncodeAppendedData is turned ON, the writer uses base64 encodin
when writing binary data (only if appended mode is selected)
 
|
|
Only the values 0 and 1 are accepted


|
|
Accepts input of following types:
* vtkUnstructuredGrid


|}


==XMLUnstructuredGridWriter=
==XdmfWriter==


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


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


 
|-
Writer to write unstructured grid in a xml-based vtk data file. Cannot be used<br
|'''Input''' (Input)
for parallel writing.<br
 
{| class="PropertiesTable" border="1" cellpadding="5
|
|
| '''Property''
The input filter/source whose output dataset is to
| '''Description''
written to the file.
| '''Default Value(s)''
| '''Restrictions''
|
|
| '''File Name'''<br>''(FileName)'
The name of the file to be written


|
|
Accepts input of following types:
* vtkDataSet
|-
|'''FileName''' (FileName)
|
|
The name of the file to be written.
|
|
| '''Input'''<br>''(Input)'
The input filter/source whose output dataset is to written to th
file


|
|


The selected dataset must be one of the following types (or a subclass of one of them): vtkUnstructuredGrid
|-
 
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
 
|
|
| '''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.
When WriteAllTimeSteps is turned ON, the writer is execute
once for each timestep available from the reader


|
|
 
0
Only the values 0 and 1 are accepted
 
 
|
|
| '''Compressor Type'''<br>''(CompressorType)'
Accepts boolean values (0 or 1).
 
|-
The compression algorithm used to compress binary data (appended mode only)
|'''MeshStaticOverTime''' (MeshStaticOverTime)
 
|
 
The value must be one of the following: None (0), ZLib (1)
 
 
|
|
| '''Data Mode'''<br>''(DataMode)'
When MeshStaticOverTime is turned ON, only the mesh
 
topology and geometry at the first time step will be written in the
The mode uses for writing the file's data i.e. ascii, binary, appende
heavy data file. All time steps will reference them in the Xdmf file.
binary


|
|
 
0
The value must be one of the following: Ascii (0), Binary (1), Appended (2)
 
 
|
|
| '''Encode Appended Data'''<br>''(EncodeAppendedData)'
Accepts boolean values (0 or 1).


When EncodeAppendedData is turned ON, the writer uses base64 encodin
|}
when writing binary data (only if appended mode is selected)
 
|
 
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)'
 
The input filter/source whose output dataset is to written to th
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).