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

From KitwarePublic
Jump to: navigation, search
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==AnimationSceneImageWriter==
 
  
 +
==AnimationSceneImageWriter==
  
Internal writer to used paraview uses when it disconnects the GUI.<br>
+
Internal writer to used paraview uses when it disconnects
 +
the GUI.
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 10: Line 11:
 
| '''Default Value(s)'''
 
| '''Default Value(s)'''
 
| '''Restrictions'''
 
| '''Restrictions'''
 +
 
|-
 
|-
| '''File Name'''<br>''(FileName)''
+
|'''Magnification''' (Magnification)
 
|
 
|
The name of the file to save the animation into.
+
The magnification factor to use for the saved
 
+
animation.
 
|
 
|
 +
1
 
|
 
|
 +
 
|-
 
|-
| '''Frame Rate'''<br>''(FrameRate)''
+
|'''FileName''' (FileName)
 +
|
 +
The name of the file to save the animation
 +
into.
 
|
 
|
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
 
 
|
 
|
 +
 
|-
 
|-
| '''Magnification'''<br>''(Magnification)''
+
|'''FrameRate''' (FrameRate)
 
|
 
|
The magnification factor to use for the saved animation.
+
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
| 1
+
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 value must be greater than or equal to 1.
 
  
  
 
|}
 
|}
 
  
 
==CSVWriter==
 
==CSVWriter==
  
 
+
Writer to write CSV filesWriter to write CSV
Writer to write CSV files from table. In parallel, it delivers the table to the root node and then saves the CSV. For composite datasets, it saves multiple csv files.<br>
+
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"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 49: Line 58:
 
| '''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:
 +
* vtkTable
 
|-
 
|-
| '''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): vtkTable.
 
 
  
 
|-
 
|-
| '''Write All Time Steps'''<br>''(WriteAllTimeSteps)''
+
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
 
|
 
|
When WriteAllTimeSteps is turned ON, the writer is executed
+
When WriteAllTimeSteps is turned ON, the writer is
once for each timestep available from the reader.
+
executed once for each time step available from the
 
+
reader.
| 0
+
 
|
 
|
Only the values 0 and 1 are accepted.
+
0
 
+
|
 +
Accepts boolean values (0 or 1).
  
 
|}
 
|}
 
  
 
==DataSetCSVWriter==
 
==DataSetCSVWriter==
  
 
+
Writer to write CSV filesWriter to write CSV
Writer to write CSV files from any dataset. Set FieldAssociation to choose whether cell data/point data needs to be saved. In parallel, it delivers the table to the root node and then saves the<br>
+
files from any dataset. Set FieldAssociation to choose whether cell
CSV. For composite datasets, it saves multiple csv files.<br>
+
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"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 95: Line 104:
 
| '''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:
 +
* vtkDataSet
 
|-
 
|-
| '''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): vtkDataSet.
 
 
  
 
|-
 
|-
| '''Write All Time Steps'''<br>''(WriteAllTimeSteps)''
+
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
 
|
 
|
When WriteAllTimeSteps is turned ON, the writer is executed
+
When WriteAllTimeSteps is turned ON, the writer is
once for each timestep available from the reader.
+
executed once for each timestep available from the
 
+
reader.
| 0
+
 
|
 
|
Only the values 0 and 1 are accepted.
+
0
 
+
 
+
|-
+
| '''Field Association'''<br>''(FieldAssociation)''
+
 
|
 
|
Select the attribute data to pass.
+
Accepts boolean values (0 or 1).
 
+
| 0
+
|
+
The value must be one of the following: Points (0), Cells (1), Field Data (2).
+
 
+
  
 
|}
 
|}
 
  
 
==DataSetWriter==
 
==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.<br>
+
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"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 150: Line 148:
 
| '''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 file.
+
The input filter/source whose output dataset is to
 
+
written to the file.
 
|
 
|
|
 
The selected object must be the result of the following: sources (includes readers), filters.
 
  
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataObject.
 
 
 
|-
 
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
 
 
|
 
|
When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.
+
Accepts input of following types:
 
+
* vtkDataObject
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
 
+
|-
+
| '''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).
+
 
+
  
 
|}
 
|}
 
  
 
==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 specify the endian-ness of the file when reading it into EnSight.<br>
+
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"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 204: Line 176:
 
| '''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.
+
The input filter/source whose output dataset is to
 
+
written to the file.
| 0
+
 
|
 
|
The value must be greater than or equal to 0.
 
  
 
|-
 
| '''Input'''<br>''(Input)''
 
 
|
 
|
The input filter/source whose output dataset is to written to the file.
+
Accepts input of following types:
 
+
* vtkUnstructuredGrid
|
+
|
+
The selected object must be the result of the following: sources (includes readers), filters.
+
 
+
 
+
The selected dataset must be one of the following types (or a subclass of one of them): vtkUnstructuredGrid.
+
 
+
  
 
|}
 
|}
 
  
 
==ExodusIIWriter==
 
==ExodusIIWriter==
  
 
+
Write Exodus II files.Writer to write Exodus
Writer to write Exodus II files. Refere to http://endo.sandia.gov/SEACAS/ for more information about the Exodus II format.<br>
+
II files. Refere to http://endo.sandia.gov/SEACAS/ for more information
 +
about the Exodus II format.
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 248: Line 202:
 
| '''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.
+
When WriteAllTimeSteps is turned ON, the writer is
 
+
executed once for each time step available from the
 +
reader.
 
|
 
|
 +
0
 
|
 
|
The selected object must be the result of the following: sources (includes readers), filters.
+
Accepts boolean values (0 or 1).
 
+
 
+
The selected dataset must be one of the following types (or a subclass of one of them): vtkCompositeDataSet, vtkDataSet.
+
 
+
 
+
|-
+
| '''Write All Time Steps'''<br>''(WriteAllTimeSteps)''
+
|
+
When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.
+
 
+
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
  
 
|}
 
|}
 
  
 
==MetaImageWriter==
 
==MetaImageWriter==
  
 
+
Write a binary UNC meta image data.Writer to
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"<br>
+
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"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 302: Line 240:
 
| '''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==
 
==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 1 file.<br>
+
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"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 336: Line 275:
 
| '''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): vtkDataObject.
 
 
  
 
|-
 
|-
| '''Write All Time Steps'''<br>''(WriteAllTimeSteps)''
+
|'''WriteAllTimeSteps''' (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
 
+
executed once for each timestep available from the
| 0
+
reader.
 
|
 
|
Only the values 0 and 1 are accepted.
+
0
 
+
 
+
|-
+
| '''File Type'''<br>''(FileType)''
+
 
|
 
|
The type for the data file (i.e. ascii or binary).
+
Accepts boolean values (0 or 1).
 
+
| 2
+
|
+
The value must be one of the following: Ascii (1), Binary (2).
+
 
+
  
 
|}
 
|}
 
  
 
==PNGWriter==
 
==PNGWriter==
  
 
+
Write image data as a PNG file.Writer to
Writer to write image data as a PNG file. It supports 1 to 4 component data of unsigned char or unsigned short.<br>
+
write image data as a PNG file. It supports 1 to 4 component data of
 +
unsigned char or unsigned short.
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 390: Line 319:
 
| '''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.
 
  
  
 
|}
 
|}
 
  
 
==PPLYWriter==
 
==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 <br>
+
Writer to write polygonal data in Stanford University PLY format. The
handle normals or vectors. It only handles RGB PointData and CellData. This version is used when running in parallel. It gathers data to first node and saves 1 file.<br>
+
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"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 425: Line 357:
 
| '''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:
 +
* vtkPolyData
 
|-
 
|-
| '''Input'''<br>''(Input)''
+
|'''FileName''' (FileName)
 
|
 
|
The input filter/source whose output dataset is to written to the file.
+
The name of the file to be written.
 
+
 
|
 
|
|
 
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).
 
  
  
 
|}
 
|}
 
  
 
==PSTLWriter==
 
==PSTLWriter==
  
 
+
Write stereo lithography files.STLWriter
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.<br>
+
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"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 469: Line 395:
 
| '''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:
 +
* vtkPolyData
 
|-
 
|-
| '''Input'''<br>''(Input)''
+
|'''FileName''' (FileName)
 
|
 
|
The input filter/source whose output dataset is to written to the file.
+
The name of the file to be written.
 
+
 
|
 
|
|
 
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).
 
  
  
 
|}
 
|}
 
  
 
==XMLDataSetWriterBase==
 
==XMLDataSetWriterBase==
  
 
+
Base for all XML-based file-series
Base for all XML-based file-series writers.<br>
+
writers.
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 513: Line 428:
 
| '''Default Value(s)'''
 
| '''Default Value(s)'''
 
| '''Restrictions'''
 
| '''Restrictions'''
|-
 
| '''File Name'''<br>''(FileName)''
 
|
 
The name of the file to be written.
 
 
|
 
|
 
|-
 
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
 
|
 
When WriteAllTimeSteps is turned ON, the writer is executed
 
once for each timestep available from the reader.
 
 
| 0
 
|
 
Only the values 0 and 1 are accepted.
 
 
 
|-
 
| '''Compressor Type'''<br>''(CompressorType)''
 
|
 
The compression algorithm used to compress binary data (appended mode only).
 
 
| 0
 
|
 
The value must be one of the following: None (0), ZLib (1).
 
 
 
|-
 
| '''Data Mode'''<br>''(DataMode)''
 
|
 
The mode uses for writing the file's data i.e. ascii, binary, appended
 
binary.
 
 
| 2
 
|
 
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
 
 
 
|-
 
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
 
|
 
When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).
 
 
| 0
 
|
 
Only the values 0 and 1 are accepted.
 
  
  
 
|}
 
|}
 
  
 
==XMLHierarchicalBoxDataWriter==
 
==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.
  
Writer to write a hierarchical box in a xml-based vtk data file. Can be used for parallel writing as well as serial writing.<br>
 
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 576: Line 446:
 
| '''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): vtkHierarchicalBoxDataSet.
 
 
 
|-
 
| '''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 reader.
 
 
| 0
 
|
 
Only the values 0 and 1 are accepted.
 
 
 
|-
 
| '''Compressor Type'''<br>''(CompressorType)''
 
|
 
The compression algorithm used to compress binary data (appended mode only).
 
 
| 0
 
|
 
The value must be one of the following: None (0), ZLib (1).
 
 
 
|-
 
| '''Data Mode'''<br>''(DataMode)''
 
|
 
The mode uses for writing the file's data i.e. ascii, binary, appended binary.
 
 
| 2
 
|
 
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
 
 
 
|-
 
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
 
|
 
When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).
 
 
| 0
 
|
 
Only the values 0 and 1 are accepted.
 
  
  
 
|}
 
|}
 
  
 
==XMLHyperOctreeWriter==
 
==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.<br>
+
Writer to write unstructured grid in a xml-based vtk data file. Cannot be
 +
used for parallel writing.
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 647: Line 462:
 
| '''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 file.
+
The input filter/source whose output dataset is to
 
+
written to the file.
 
|
 
|
|
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkHyperOctree.
 
  
 
|-
 
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
 
 
|
 
|
When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.
+
Accepts input of following types:
 
+
* vtkHyperOctree
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
 
+
|-
+
| '''Compressor Type'''<br>''(CompressorType)''
+
|
+
The compression algorithm used to compress binary data (appended mode only).
+
 
+
| 0
+
|
+
The value must be one of the following: None (0), ZLib (1).
+
 
+
 
+
|-
+
| '''Data Mode'''<br>''(DataMode)''
+
|
+
The mode uses for writing the file's data i.e. ascii, binary, appended binary.
+
 
+
| 2
+
|
+
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
+
 
+
 
+
|-
+
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
+
|
+
When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).
+
 
+
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
  
 
|}
 
|}
 
  
 
==XMLImageDataWriter==
 
==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.<br>
+
Writer to write image data in a xml-based vtk data file. Cannot be used
 +
for parallel writing.
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 718: Line 488:
 
| '''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 file.
+
The input filter/source whose output dataset is to
 
+
written to the file.
 
|
 
|
|
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData.
 
  
 
|-
 
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
 
 
|
 
|
When WriteAllTimeSteps is turned ON, the writer is executed once for each time step available from the reader.
+
Accepts input of following types:
 
+
* vtkImageData
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
 
+
|-
+
| '''Compressor Type'''<br>''(CompressorType)''
+
|
+
The compression algorithm used to compress binary data (appended mode only).
+
 
+
| 0
+
|
+
The value must be one of the following: None (0), ZLib (1).
+
 
+
 
+
|-
+
| '''Data Mode'''<br>''(DataMode)''
+
|
+
The mode uses for writing the file's data i.e. ascii, binary, appended binary.
+
 
+
| 2
+
|
+
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
+
 
+
 
+
|-
+
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
+
|
+
When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).
+
 
+
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
  
 
|}
 
|}
 
  
 
==XMLMultiBlockDataWriter==
 
==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.<br>
+
Writer to write a multiblock dataset in a xml-based vtk data file. Can be
 +
used for parallel writing as well as serial writing.
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 789: Line 514:
 
| '''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 file.
+
The input filter/source whose output dataset is to
 
+
written to the file.
 
|
 
|
|
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkMultiBlockDataSet.
 
  
 
|-
 
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
 
 
|
 
|
When WriteAllTimeSteps is turned ON, the writer is executed once for each time step available from the reader.
+
Accepts input of following types:
 
+
* vtkMultiBlockDataSet
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
 
+
|-
+
| '''Compressor Type'''<br>''(CompressorType)''
+
|
+
The compression algorithm used to compress binary data (appended mode only).
+
 
+
| 0
+
|
+
The value must be one of the following: None (0), ZLib (1).
+
 
+
 
+
|-
+
| '''Data Mode'''<br>''(DataMode)''
+
|
+
The mode uses for writing the file's data i.e. ascii, binary, appended binary.
+
 
+
| 2
+
|
+
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
+
 
+
 
+
|-
+
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
+
|
+
When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).
+
 
+
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
  
 
|}
 
|}
 
  
 
==XMLPImageDataWriter==
 
==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.<br>
+
Writer to write image data in a xml-based vtk data file. Can be used for
 +
parallel writing.
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 860: Line 540:
 
| '''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 file.
+
The input filter/source whose output dataset is to
 
+
written to the file.
 
|
 
|
|
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData.
 
  
 
|-
 
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
 
 
|
 
|
When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.
+
Accepts input of following types:
 
+
* vtkImageData
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
 
+
|-
+
| '''Compressor Type'''<br>''(CompressorType)''
+
|
+
The compression algorithm used to compress binary data (appended mode only).
+
 
+
| 0
+
|
+
The value must be one of the following: None (0), ZLib (1).
+
 
+
 
+
|-
+
| '''Data Mode'''<br>''(DataMode)''
+
|
+
The mode uses for writing the file's data i.e. ascii, binary, appended binary.
+
 
+
| 2
+
|
+
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
+
 
+
 
+
|-
+
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
+
|
+
When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).
+
 
+
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
  
 
|}
 
|}
 
  
 
==XMLPPolyDataWriter==
 
==XMLPPolyDataWriter==
  
 
+
Write polydata in a xml-based vtk data file.
Writer to write polydata in a xml-based vtk data file. Can be use for parallel writing.<br>
+
Writer to write polydata in a xml-based vtk data file. Can be used for
 +
parallel writing.
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 931: Line 566:
 
| '''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 file.
+
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.
+
Accepts input of following types:
 
+
* vtkPolyData
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
 
+
|-
+
| '''Compressor Type'''<br>''(CompressorType)''
+
|
+
The compression algorithm used to compress binary data (appended mode only).
+
 
+
| 0
+
|
+
The value must be one of the following: None (0), ZLib (1).
+
 
+
 
+
|-
+
| '''Data Mode'''<br>''(DataMode)''
+
|
+
The mode uses for writing the file's data i.e. ascii, binary, appended binary.
+
 
+
| 2
+
|
+
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
+
 
+
 
+
|-
+
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
+
|
+
When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).
+
 
+
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
  
 
|}
 
|}
 
  
 
==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.<br>
+
Writer to write rectilinear grid in a xml-based vtk data file. Can be
 +
used for parallel writing.
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,002: Line 592:
 
| '''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 file.
+
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.
+
Accepts input of following types:
 
+
* vtkRectilinearGrid
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
 
+
|-
+
| '''Compressor Type'''<br>''(CompressorType)''
+
|
+
The compression algorithm used to compress binary data (appended mode only).
+
 
+
| 0
+
|
+
The value must be one of the following: None (0), ZLib (1).
+
 
+
 
+
|-
+
| '''Data Mode'''<br>''(DataMode)''
+
|
+
The mode uses for writing the file's data i.e. ascii, binary, appended binary.
+
 
+
| 2
+
|
+
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
+
 
+
 
+
|-
+
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
+
|
+
When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).
+
 
+
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
  
 
|}
 
|}
 
  
 
==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.<br>
+
Writer to write structured grid in a xml-based vtk data file. Can be used
 +
for parallel writing.
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,073: Line 618:
 
| '''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.
 
  
 
|
 
|
|
+
Accepts input of following types:
The selected dataset must be one of the following types (or a subclass of one of them): vtkStructuredGrid.
+
* vtkStructuredGrid
  
 +
|}
  
|-
+
==XMLPUnstructuredGridWriter==
| '''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.
+
  
 +
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"
 
|-
 
|-
| '''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.
+
The input filter/source whose output dataset is to
 
+
written to the file.
| 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).
+
Accepts input of following types:
 
+
* vtkUnstructuredGrid
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
  
 
|}
 
|}
  
 +
==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 for parallel writing.<br>
+
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,144: Line 670:
 
| '''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)
 
|
 
|
The compression algorithm used to compress binary data (appended mode only).
+
Write each time step in the animation
 
+
| 0
+
 
|
 
|
The value must be one of the following: None (0), ZLib (1).
+
0.0
 
+
 
+
|-
+
| '''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)''
+
|'''ErrorCode''' (ErrorCode)
 
|
 
|
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.
 
  
 
|}
 
 
 
==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.<br>
 
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
|-
 
| '''Property'''
 
| '''Description'''
 
| '''Default Value(s)'''
 
| '''Restrictions'''
 
|-
 
| '''File Name'''<br>''(FileName)''
 
 
|
 
|
Name of the file to write.
 
  
|
 
|
 
|-
 
| '''Representations'''<br>''(Representations)''
 
|
 
The input filter/source whose output dataset is to written to the file.
 
  
|
 
|
 
 
|}
 
|}
 
  
 
==XMLPVDWriter==
 
==XMLPVDWriter==
  
 
+
Write ParaView data files (pvd).Writer to
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. <br>
+
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"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,243: Line 720:
 
| '''Default Value(s)'''
 
| '''Default Value(s)'''
 
| '''Restrictions'''
 
| '''Restrictions'''
|-
 
| '''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.
+
The input filter/source whose output dataset is to
 
+
written to the files.
| 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).
+
Accepts input of following types:
 
+
* vtkDataSet
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
 
+
 
|-
 
|-
| '''File Name'''<br>''(FileName)''
+
|'''DataMode''' (DataMode)
 
|
 
|
The name of the file to be written.
+
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)
 
|-
 
|-
| '''Ghost Level'''<br>''(GhostLevel)''
+
|'''EncodeAppendedData''' (EncodeAppendedData)
 
|
 
|
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.
+
When EncodeAppendedData is turned ON, the writer uses
 
+
base64 encoding when writing binary data (only if appended mode is
| 0
+
selected).
 
|
 
|
The value must be greater than or equal to 0.
+
0
 
+
|
 
+
Accepts boolean values (0 or 1).
 
|-
 
|-
| '''Input'''<br>''(Input)''
+
|'''CompressorType''' (CompressorType)
 
|
 
|
The input filter/source whose output dataset is to written to the files.
+
The compression algorithm used to compress binary data
 
+
(appended mode only).
 
|
 
|
 +
0
 
|
 
|
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.<br>
+
Writer to write poly data in a xml-based vtk data file. Cannot be used
 +
for parallel writing.
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,317: Line 779:
 
| '''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 file.
+
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.
+
Accepts input of following types:
 
+
* vtkPolyData
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
 
+
|-
+
| '''Compressor Type'''<br>''(CompressorType)''
+
|
+
The compression algorithm used to compress binary data (appended mode only).
+
 
+
| 0
+
|
+
The value must be one of the following: None (0), ZLib (1).
+
 
+
 
+
|-
+
| '''Data Mode'''<br>''(DataMode)''
+
|
+
The mode uses for writing the file's data i.e. ascii, binary, appended binary.
+
 
+
| 2
+
|
+
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
+
 
+
 
+
|-
+
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
+
|
+
When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).
+
 
+
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
  
 
|}
 
|}
 
  
 
==XMLRectilinearGridWriter==
 
==XMLRectilinearGridWriter==
  
 
+
Write rectilinear grid in a xml-based vtk data file.
Writer to write rectilinear grid in a xml-based vtk data file. Cannot be used for parallel writing.<br>
+
Writer to write rectilinear grid in a xml-based vtk data file. Cannot be
 +
used for parallel writing.
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,388: Line 805:
 
| '''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 file.
+
 
+
 
|
 
|
 +
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.
+
Accepts input of following types:
 
+
* vtkRectilinearGrid
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
 
+
|-
+
| '''Compressor Type'''<br>''(CompressorType)''
+
|
+
The compression algorithm used to compress binary data (appended mode only).
+
 
+
| 0
+
|
+
The value must be one of the following: None (0), ZLib (1).
+
 
+
 
+
|-
+
| '''Data Mode'''<br>''(DataMode)''
+
|
+
The mode uses for writing the file's data i.e. ascii, binary, appended binary.
+
 
+
| 2
+
|
+
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
+
 
+
 
+
|-
+
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
+
|
+
When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).
+
 
+
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
  
 
|}
 
|}
 
  
 
==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.<br>
+
Writer to write structured grid in a xml-based vtk data file. Cannot be
 +
used for parallel writing.
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,459: Line 831:
 
| '''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.
 
  
 
|
 
|
|
+
Accepts input of following types:
The selected dataset must be one of the following types (or a subclass of one of them): vtkStructuredGrid.
+
* vtkStructuredGrid
  
 +
|}
  
|-
+
==XMLUniformGridAMRWriter==
| '''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.
+
  
 +
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"
 
|-
 
|-
| '''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.
+
The input filter/source whose output dataset is to
 
+
written to the file.
| 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).
+
Accepts input of following types:
 
+
* vtkUniformGridAMR
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
  
 
|}
 
|}
 
  
 
==XMLUnstructuredGridWriter==
 
==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.<br>
+
Writer to write unstructured grid in a xml-based vtk data file. Cannot be
 +
used for parallel writing.
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,530: Line 884:
 
| '''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 file.
+
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)''
 
 
|
 
|
When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.
+
Accepts input of following types:
 
+
* vtkUnstructuredGrid
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
 
+
|-
+
| '''Compressor Type'''<br>''(CompressorType)''
+
|
+
The compression algorithm used to compress binary data (appended mode only).
+
 
+
| 0
+
|
+
The value must be one of the following: None (0), ZLib (1).
+
 
+
 
+
|-
+
| '''Data Mode'''<br>''(DataMode)''
+
|
+
The mode uses for writing the file's data i.e. ascii, binary, appended binary.
+
 
+
| 2
+
|
+
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
+
 
+
 
+
|-
+
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
+
|
+
When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected).
+
 
+
| 0
+
|
+
Only the values 0 and 1 are accepted.
+
 
+
  
 
|}
 
|}
 
  
 
==XdmfWriter==
 
==XdmfWriter==
  
 
+
Write data in Xdmf files.Writer to write
Writer to write data in eXtensible Data Model and Format *(XDMF) files.<br>
+
data in eXtensible Data Model and Format *(XDMF) files.
  
 
{| class="PropertiesTable" border="1" cellpadding="5"
 
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,601: Line 909:
 
| '''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:
 +
* vtkDataSet
 
|-
 
|-
| '''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): vtkDataSet.
 
  
  
 
|}
 
|}

Revision as of 14:55, 7 November 2012

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


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

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.

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.


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