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

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


==AnimationSceneImageWriter==


 
Internal writer to used paraview uses when it disconnects
==CSVWriter==
the GUI.
 
 
 
 
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"
Line 18: Line 11:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''Magnification''' (Magnification)
|
The magnification factor to use for the saved
animation.
|
1
|
|
The name of the file to be written.


|  
|  
|-
|-
| '''Input'''<br>''(Input)''
|'''FileName''' (FileName)
|
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.


|-
|'''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
|


The selected dataset must be one of the following types (or a subclass of one of them): vtkTable.
|-
|'''PlaybackTimeWindow''' (PlaybackTimeWindow)
|
Time range to write
|
-1 1
|


 
|-
|-
| '''Write All Time Steps'''<br>''(WriteAllTimeSteps)''
|'''Compression''' (Compression)
|
|
When WriteAllTimeSteps is turned ON, the writer is executed
Turns on(the default) or off compression for FFMEG
once for each timestep available from the reader.
(AVI on Linux and Mac) backend.


| 0
|
|
Only the values 0 and 1 are accepted.
1
|
Accepts boolean values (0 or 1).
|-
|'''StartFileCount''' (StartFileCount)
|


 
|
|}
0
|




==DataSetCSVWriter==
|}


==CSVWriter==


 
Writer to write CSV filesWriter to write CSV
 
files from table. In parallel, it delivers the table to the root node and
Writer to write CSV files from any dataset. Set FieldAssociation to<br>
then saves the CSV. For composite datasets, it saves multiple csv
choose whether cell data/point data needs to be saved.<br>
files.
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"
Line 69: Line 84:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''Input''' (Input)
|
|
The name of the file to be written.
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 the
file.


|  
|
|
The selected object must be the result of the following: sources (includes readers), filters.
Accepts input of following types:
 
* vtkTable
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
|-
| '''Write All Time Steps'''<br>''(WriteAllTimeSteps)''
|'''FileName''' (FileName)
|
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.


 
|-
|-
| '''Field Association'''<br>''(FieldAssociation)''
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
|
When WriteAllTimeSteps is turned ON, the writer is
executed once for each time step available from the
reader.
|
|
Select the attribute data to pass.
0
 
| 0
|
|
The value must be one of the following: Points (0), Cells (1), Field Data (2).
Accepts boolean values (0 or 1).


 
|}
|}


==DataSetCSVWriter==


==DataSetWriter==
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.
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"
Line 128: Line 130:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''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.
The name of the file to be written.
|
|


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


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


==DataSetWriter==


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataObject.
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"
|-
|-
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
| '''Property'''
|
| '''Description'''
When WriteAllTimeSteps is turned ON, the writer is executed
| '''Default Value(s)'''
once for each timestep available from the reader.
| '''Restrictions'''


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


| 2
|
|
The value must be one of the following: Ascii (1), Binary (2).
Accepts input of following types:
* vtkDataObject


 
|}
|}


==EnSightWriter==
==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
Writer to write unstructured grid data as an EnSight file. Binary files <br>
specify the endian-ness of the file when reading it into
written on one system may not be readable on other systems. Be sure to <br>
EnSight.
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"
Line 188: Line 202:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The name of the file to be written.


|  
|  
|-
|-
| '''Ghost Level'''<br>''(GhostLevel)''
|'''Input''' (Input)
|
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.
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 the
file.


|  
|
|
The selected object must be the result of the following: sources (includes readers), filters.
Accepts input of following types:
* vtkUnstructuredGrid


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


==ExodusIIWriter==
==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.
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"
Line 238: Line 228:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''Input''' (Input)
|
|
The name of the file to be written.
The input filter/source whose output dataset is to
 
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
|
|
The value must be greater than or equal to 0.
Accepts input of following types:
 
* vtkCompositeDataSet
 
* vtkDataSet
|-
|-
| '''Input'''<br>''(Input)''
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
|
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.
When WriteAllTimeSteps is turned ON, the writer is
 
executed once for each time step available from the
 
reader.
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
0
once for each timestep available from the reader.
 
| 0
|
|
Only the values 0 and 1 are accepted.
Accepts boolean values (0 or 1).


 
|}
|}


==JPEGWriter==


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


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


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


==PDataSetWriter==
Write image data as a JSON file.
 
 
 
 
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"
Line 340: Line 301:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''Input''' (Input)
|
The input filter/source whose output dataset is to
written to the file.
|
|
The name of the file to be written.


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


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


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataObject.
 
|-
|-
| '''Write All Time Steps'''<br>''(WriteAllTimeSteps)''
|'''ArrayName''' (ArrayName)
|
The name of the field to export. If Empty all fields will be saved.
|
|
When WriteAllTimeSteps is turned ON, the writer is executed
once for each timestep available from the reader.


| 0
|
|
Only the values 0 and 1 are accepted.


 
|-
|-
| '''File Type'''<br>''(FileType)''
|'''Slice''' (Slice)
|
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==


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


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


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


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


 
|}
|}


==PDataSetWriter==


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


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


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


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


 
|}
|}


==PNGWriter==


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


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


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


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


 
|}
|}


==PPLYWriter==


==XMLHierarchicalBoxDataWriter==
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
Writer to write a hierarchical box in a xml-based vtk data file. Can be used<br>
version is used when running in parallel. It gathers data to first node
for parallel writing as well as serial writing.<br>
and saves one file.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 541: Line 473:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The name of the file to be written.


|  
|  
|-
|-
| '''Input'''<br>''(Input)''
|'''Input''' (Input)
|
|
The input filter/source whose output dataset is to written to the
The input filter/source whose output dataset is to
file.
written to the file.
 
|  
|
|
The selected dataset must be one of the following types (or a subclass of one of them): vtkHierarchicalBoxDataSet.


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


==PSTLWriter==


==XMLHyperOctreeWriter==
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
Writer to write unstructured grid in a xml-based vtk data file. Cannot be used<br>
reader is used when running in parallel. It gathers all the geometry to
for parallel writing.<br>
first node and saves 1 file.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 619: Line 511:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''Input''' (Input)
|
|
The name of the file to be written.
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 the
file.


|  
|
|
The selected dataset must be one of the following types (or a subclass of one of them): vtkHyperOctree.
Accepts input of following types:
 
* vtkPolyData
 
|-
|-
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
|'''FileName''' (FileName)
|
|
When WriteAllTimeSteps is turned ON, the writer is executed
The name of the file to be written.
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)''
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
|
|
The mode uses for writing the file's data i.e. ascii, binary, appended
When WriteAllTimeSteps is turned ON, the writer is
binary.
executed once for each timestep available from the reader.


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


| 0
|
Only the values 0 and 1 are accepted.
 
|}
|}


==TIFFWriter==


==XMLImageDataWriter==
Write image data as a TIFF file.Writer to
 
write image data as a TIFF 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"
Line 697: Line 555:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''Input''' (Input)
|
|
The name of the file to be written.
The input filter/source whose output dataset is to be
 
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): vtkImageData.
Accepts input of following types:
 
* vtkImageData
 
|-
|-
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
|'''FileName''' (FileName)
|
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).


 
==XMLDataSetWriterBase==
|-
| '''Data Mode'''<br>''(DataMode)''
|
The mode uses for writing the file's data i.e. ascii, binary, appended
binary.


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


 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
| '''Property'''
|
| '''Description'''
When EncodeAppendedData is turned ON, the writer uses base64 encoding
| '''Default Value(s)'''
when writing binary data (only if appended mode is selected).
| '''Restrictions'''


| 0
|
Only the values 0 and 1 are accepted.


 
|}
|}


==XMLHierarchicalBoxDataWriter==


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


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"
Line 775: Line 606:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''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 the
file.


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


 
==XMLHyperOctreeWriter==
|-
| '''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
Write unstructured grid in a xml-based vtk data file.
|
Writer to write unstructured grid in a xml-based vtk data file. Cannot be
Only the values 0 and 1 are accepted.
used for parallel writing.


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


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


 
|}
|}


==XMLImageDataWriter==


==XMLPImageDataWriter==
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.
 
 
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"
Line 853: Line 648:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The name of the file to be written.


|  
|  
|-
|-
| '''Input'''<br>''(Input)''
|'''Input''' (Input)
|
|
The input filter/source whose output dataset is to written to the
The input filter/source whose output dataset is to
file.
written to the file.
 
|  
|
|
The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData.


 
|-
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
|
|
When WriteAllTimeSteps is turned ON, the writer is executed
Accepts input of following types:
once for each timestep available from the reader.
* vtkImageData


| 0
|}
|
Only the values 0 and 1 are accepted.


 
==XMLMultiBlockDataWriter==
|-
| '''Compressor Type'''<br>''(CompressorType)''
|
The compression algorithm used to compress binary data (appended mode only).


| 0
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
The value must be one of the following: None (0), ZLib (1).
used for parallel writing as well as serial writing.


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


| 2
|-
|'''Input''' (Input)
|
|
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
The input filter/source whose output dataset is to
 
written to the file.
 
|-
| '''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.
Accepts input of following types:
* vtkMultiBlockDataSet


 
|}
|}


==XMLPImageDataWriter==


==XMLPPolyDataWriter==
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 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"
Line 931: Line 700:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The name of the file to be written.


|  
|  
|-
|-
| '''Input'''<br>''(Input)''
|'''Input''' (Input)
|
|
The input filter/source whose output dataset is to written to the
The input filter/source whose output dataset is to
file.
written to the file.
 
|  
|
|
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.


 
|-
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
|
|
When WriteAllTimeSteps is turned ON, the writer is executed
Accepts input of following types:
once for each timestep available from the reader.
* vtkImageData


| 0
|}
|
Only the values 0 and 1 are accepted.


 
==XMLPPolyDataWriter==
|-
| '''Compressor Type'''<br>''(CompressorType)''
|
The compression algorithm used to compress binary data (appended mode only).


| 0
Write polydata in a xml-based vtk data file.
|
Writer to write polydata in a xml-based vtk data file. Can be used for
The value must be one of the following: None (0), ZLib (1).
parallel writing.


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


| 2
|-
|'''Input''' (Input)
|
|
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
The input filter/source whose output dataset is to
 
written to the file.
 
|-
| '''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.
Accepts input of following types:
* vtkPolyData


 
|}
|}


==XMLPRectilinearGridWriter==
==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.
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"
Line 1,009: Line 752:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''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 the
file.
|  
|
The selected dataset must be one of the following types (or a subclass of one of them): vtkRectilinearGrid.
 
|-
| '''Write all timesteps as file-series'''<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)''
|'''Input''' (Input)
|
The compression algorithm used to compress binary data (appended mode only).
 
| 0
|
|
The value must be one of the following: None (0), ZLib (1).
The input filter/source whose output dataset is to
 
written to the file.
 
|-
| '''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).
Accepts input of following types:
* vtkRectilinearGrid


 
|-
| '''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.
 
|}
|}


==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"
Line 1,087: Line 778:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The name of the file to be written.


|  
|  
|-
|-
| '''Input'''<br>''(Input)''
|'''Input''' (Input)
|
|
The input filter/source whose output dataset is to written to the
The input filter/source whose output dataset is to
file.
written to the file.
 
|  
|
|
The selected dataset must be one of the following types (or a subclass of one of them): vtkStructuredGrid.


 
|-
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
|
|
When WriteAllTimeSteps is turned ON, the writer is executed
Accepts input of following types:
once for each timestep available from the reader.
* vtkStructuredGrid


| 0
|}
|
Only the values 0 and 1 are accepted.


 
==XMLPUnstructuredGridWriter==
|-
| '''Compressor Type'''<br>''(CompressorType)''
|
The compression algorithm used to compress binary data (appended mode only).


| 0
Write unstructured grid in a xml-based vtk data file.
|
Writer to write unstructured grid in a xml-based vtk data file. Can be
The value must be one of the following: None (0), ZLib (1).
used for parallel writing.


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


| 2
|-
|'''Input''' (Input)
|
|
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
The input filter/source whose output dataset is to
 
written to the file.
 
|-
| '''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.
Accepts input of following types:
* vtkUnstructuredGrid


 
|}
|}


==XMLPVAnimationWriter==


==XMLPUnstructuredGridWriter==
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.
 
 
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"
Line 1,165: Line 830:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''Representations''' (Representations)
|
|
The name of the file to be written.
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 the
file.


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


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


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


 
|-
|-
| '''Data Mode'''<br>''(DataMode)''
|'''ErrorCode''' (ErrorCode)
|
|
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
Writer to write ParaView data files (pvd). It is used to save all pieces<br>
processes.
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"
Line 1,244: Line 880:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Compressor Type'''<br>''(CompressorType)''
|'''Input''' (Input)
|
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
|
|
The value must be one of the following: None (0), ZLib (1).
Accepts input of following types:
 
* vtkDataSet
 
|-
|-
| '''Data Mode'''<br>''(DataMode)''
|'''HeaderType''' (HeaderType)
|
|
The mode uses for writing the file's data i.e. ascii, binary, appended
Set the binary data header word type. The default is
binary.
UInt32. Set to UInt64 when storing arrays requiring 64-bit indexing.


| 2
|
|
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
64
 
|
 
The value(s) is an enumeration of the following:
* UInt32 (32)
* UInt64 (64)
|-
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
|'''DataMode''' (DataMode)
|
The mode uses for writing the file's data i.e. ascii,
binary, appended binary.
|
|
When EncodeAppendedData is turned ON, the writer uses base64 encoding
2
when writing binary data (only if appended mode is selected).
 
| 0
|
|
Only the values 0 and 1 are accepted.
The value(s) is an enumeration of the following:
 
* Ascii (0)
 
* Binary (1)
* Appended (2)
|-
|-
| '''File Name'''<br>''(FileName)''
|'''EncodeAppendedData''' (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).
|  
|-
| '''Ghost Level'''<br>''(GhostLevel)''
|
|
The number of ghost levels to include in the output file(s). Note that
0
some writers (such as ExodusIIWriter) may not support writing ghost
levels.
 
| 0
|
|
The value must be greater than or equal to 0.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Input'''<br>''(Input)''
|'''CompressorType''' (CompressorType)
|
The compression algorithm used to compress binary data
(appended mode only).
|
|
The input filter/source whose output dataset is to written to the
0
files.
 
|  
|
|
The selected object must be the result of the following: sources (includes readers), filters.
The value(s) is an enumeration of the following:
 
* 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"
Line 1,326: Line 951:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''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 the
file.
|  
|
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
|-
| '''Write all timesteps as file-series'''<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)''
|'''Input''' (Input)
|
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).
The input filter/source whose output dataset is to
 
written to the file.
 
|-
| '''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.
Accepts input of following types:
* vtkPolyData


 
|}
|}


==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"
Line 1,404: Line 977:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The name of the file to be written.


|  
|  
|-
|-
| '''Input'''<br>''(Input)''
|'''Input''' (Input)
|
|
The input filter/source whose output dataset is to written to the
The input filter/source whose output dataset is to
file.
written to the file.
 
|  
|
|
The selected dataset must be one of the following types (or a subclass of one of them): vtkRectilinearGrid.


 
|-
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
|
|
When WriteAllTimeSteps is turned ON, the writer is executed
Accepts input of following types:
once for each timestep available from the reader.
* vtkRectilinearGrid


| 0
|}
|
Only the values 0 and 1 are accepted.


 
==XMLStructuredGridWriter==
|-
| '''Compressor Type'''<br>''(CompressorType)''
|
The compression algorithm used to compress binary data (appended mode only).


| 0
Write structured grid in a xml-based vtk data file.
|
Writer to write structured grid in a xml-based vtk data file. Cannot be
The value must be one of the following: None (0), ZLib (1).
used for parallel writing.


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


| 2
|-
|'''Input''' (Input)
|
|
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
The input filter/source whose output dataset is to
 
written to the file.
 
|-
| '''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.
Accepts input of following types:
* vtkStructuredGrid


 
|}
|}


==XMLUniformGridAMRWriter==


==XMLStructuredGridWriter==
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.
 
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"
Line 1,482: Line 1,030:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The name of the file to be written.


|  
|  
|-
|-
| '''Input'''<br>''(Input)''
|'''Input''' (Input)
|
|
The input filter/source whose output dataset is to written to the
The input filter/source whose output dataset is to
file.
written to the file.
 
|  
|
|
The selected dataset must be one of the following types (or a subclass of one of them): vtkStructuredGrid.


 
|-
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
|
|
When WriteAllTimeSteps is turned ON, the writer is executed
Accepts input of following types:
once for each timestep available from the reader.
* vtkUniformGridAMR


| 0
|}
|
Only the values 0 and 1 are accepted.


 
==XMLUnstructuredGridWriter==
|-
| '''Compressor Type'''<br>''(CompressorType)''
|
The compression algorithm used to compress binary data (appended mode only).


| 0
Write unstructured grid in a xml-based vtk data file.
|
Writer to write unstructured grid in a xml-based vtk data file. Cannot be
The value must be one of the following: None (0), ZLib (1).
used for parallel writing.


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


| 2
|-
|'''Input''' (Input)
|
|
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
The input filter/source whose output dataset is to
 
written to the file.
 
|-
| '''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.
Accepts input of following types:
* vtkUnstructuredGrid


 
|}
|}


==XdmfWriter==


==XMLUnstructuredGridWriter==
Write data in Xdmf files.Writer to write
 
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"
Line 1,560: Line 1,081:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''Input''' (Input)
|
|
The name of the file to be written.
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 the
file.


|  
|
|
The selected dataset must be one of the following types (or a subclass of one of them): vtkUnstructuredGrid.
Accepts input of following types:
 
* vtkDataSet
 
|-
|-
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
|'''FileName''' (FileName)
|
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)''
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
|
The compression algorithm used to compress binary data (appended mode only).
 
| 0
|
|
The value must be one of the following: None (0), ZLib (1).
When WriteAllTimeSteps is turned ON, the writer is
executed once for each timestep available from the reader.


 
|-
| '''Data Mode'''<br>''(DataMode)''
|
|
The mode uses for writing the file's data i.e. ascii, binary, appended
0
binary.
 
| 2
|
|
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
|'''MeshStaticOverTime''' (MeshStaticOverTime)
|
|
When EncodeAppendedData is turned ON, the writer uses base64 encoding
When MeshStaticOverTime is turned ON, only the mesh
when writing binary data (only if appended mode is selected).
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
|
|
Only the values 0 and 1 are accepted.
0
 
 
|}
 
 
==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 the
Accepts boolean values (0 or 1).
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 18: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).