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

From KitwarePublic
Jump to navigationJump to search
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==AnimationSceneImageWriter==
==AnimationSceneImageWriter==


 
Internal writer to used paraview uses when it disconnects
Internal writer to used paraview uses when it disconnects the GUI.<br>
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 magnification factor to use for the saved
animation.
|
1
|
|
The name of the file to save the animation into.


|-
|'''FileName''' (FileName)
|
|
The name of the file to save the animation
into.
|
|
|
|-
|-
| '''Frame Rate'''<br>''(FrameRate)''
|'''FrameRate''' (FrameRate)
|
|
Get/Set the frame rate to use for saving the 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
This frame rate is the frame rate that gets saved in the movie file
file generated, if applicable. If does not affect the FrameRate
generated, if applicable. If does not affect the FrameRate set on the
set on the animation scene at all. In other words, this is the
animation scene at all. In other words, this is the playback frame rate
playback frame rate and not the animation generation frame rate.
and not the animation generation frame rate.
|
0
|


| 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).
|-
|-
| '''Magnification'''<br>''(Magnification)''
|'''StartFileCount''' (StartFileCount)
|
|
The magnification factor to use for the saved animation.


| 1
|
|
The value must be greater than or equal to 1.
0
|




|}
|}


==CSVWriter==
==CSVWriter==


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 54: Line 84:
| '''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
|-
|'''FileName''' (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 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
|
0
|
|
Only the values 0 and 1 are accepted.
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<br>
files from any dataset. Set FieldAssociation to choose whether cell
choose whether cell data/point data needs to be saved.<br>
data/point data needs to be saved. In parallel, it delivers the table to
In parallel, it delivers the table to the root node and then saves the<br>
the root node and then saves the CSV. For composite datasets, it saves
CSV. For composite datasets, it saves multiple csv files.<br>
multiple csv files.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 103: 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.
|
|
The name of the file to be written.


|
|
Accepts input of following types:
* vtkDataSet
|-
|'''FileName''' (FileName)
|
|
|-
The name of the file to be written.
| '''Input'''<br>''(Input)''
|
|
The input filter/source whose output dataset is to written to 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. <br>
Writer to write any type of data object in a legacy vtk data file. Cannot
Cannot be used for parallel writing.<br>
be used for parallel writing.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 160: Line 174:
| '''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 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)''
|'''Input''' (Input)
|
|
When WriteAllTimeSteps is turned ON, the writer is executed
The input filter/source whose output dataset is to
once for each timestep available from the reader.
written to the file.
 
| 0
|
|
Only the values 0 and 1 are accepted.


|-
| '''File Type'''<br>''(FileType)''
|
|
The type for the data file (i.e. ascii or binary).
Accepts input of following types:
 
* vtkDataObject
| 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 <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 <br>
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>
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 218: 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
The input filter/source whose output dataset is to
some writers (such as ExodusIIWriter) may not support writing ghost
written to the file.
levels.
 
| 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
Accepts input of following types:
file.
* 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/ <br>
II files. Refere to http://endo.sandia.gov/SEACAS/ for more information
for more information about the Exodus II format.<br>
about the Exodus II format.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 266: 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
| '''Ghost Level'''<br>''(GhostLevel)''
written to the file.
|
|
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.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
0
 
 
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
Accepts boolean values (0 or 1).
once for each timestep available from the reader.
 
| 0
|
Only the values 0 and 1 are accepted.
 


|}
|}


==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 327: 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
|-
|'''FileName''' (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 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 364: 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
|-
|'''FileName''' (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 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)
|
|
The type for the data file (i.e. ascii or binary).
Write only one slice if slice &gt;= 0
 
|
| 2
-1
|
|
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
Writer to write image data as a PNG file. It supports 1 to 4 component<br>
headers are expected to have extension: ".mha" or ".mhd"
data of unsigned char or unsigned short.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 421: 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
|-
|'''FileName''' (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 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
Writer to write polygonal data in Stanford University PLY format. The <br>
and saves one file.
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 461: 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
|-
|'''FileName''' (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 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)
|
|
The type for the data file (i.e. ascii or binary).
When WriteAllTimeSteps is turned ON, the writer is
 
executed once for each timestep available from the
| 2
reader.
|
0
|
|
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 511: 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==


==XMLDataSetWriterBase==
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
Base for all XML-based file-series writers.<br>
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 556: Line 473:
| '''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)''
|'''Input''' (Input)
|
|
When WriteAllTimeSteps is turned ON, the writer is executed
The input filter/source whose output dataset is to
once for each timestep available from the reader.
written to the file.
 
| 0
|
|
Only the values 0 and 1 are accepted.


|-
| '''Compressor Type'''<br>''(CompressorType)''
|
|
The compression algorithm used to compress binary data (appended mode only).
Accepts input of following types:
 
* vtkPolyData
| 0
|
The value must be one of the following: None (0), ZLib (1).
 
 
|-
|-
| '''Data Mode'''<br>''(DataMode)''
|'''FileName''' (FileName)
|
|
The mode uses for writing the file's data i.e. ascii, binary, appended
The name of the file to be written.
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==


==XMLHierarchicalBoxDataWriter==
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
Writer to write a hierarchical box in a xml-based vtk data file. Can be used<br>
than 3 vertices are present, only the first 3 vertices are written. Use
for parallel writing as well as serial writing.<br>
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 621: 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.


|
|
|
Accepts input of following types:
The selected dataset must be one of the following types (or a subclass of one of them): vtkHierarchicalBoxDataSet.
* 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
binary.
 
| 2
|
|
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
When WriteAllTimeSteps is turned ON, the writer is
executed once for each timestep available from the reader.


|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
|
|
When EncodeAppendedData is turned ON, the writer uses base64 encoding
0
when writing binary data (only if appended mode is selected).
 
| 0
|
|
Only the values 0 and 1 are accepted.
Accepts boolean values (0 or 1).
 


|}
|}


==TIFFWriter==


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


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


|
|
|
Accepts input of following types:
The selected dataset must be one of the following types (or a subclass of one of them): vtkHyperOctree.
* vtkImageData
 
 
|-
|-
| '''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).


|}


|-
==XMLDataSetWriterBase==
| '''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).


Base for all XML-based file-series
writers.


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


==XMLImageDataWriter==
(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 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 773: 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): vtkImageData.


|}


|-
==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
|
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. Cannot 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
The input filter/source whose output dataset is to
binary.
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).


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


|}
|}


==XMLImageDataWriter==


==XMLMultiBlockDataWriter==
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 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 849: Line 648:
| '''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): vtkMultiBlockDataSet.
* vtkImageData


|}


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


{| 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
The input filter/source whose output dataset is to
binary.
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).


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


|}
|}


==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<br>
Writer to write image data in a xml-based vtk data file. Can be used for
for parallel writing.<br>
parallel writing.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 925: 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)''
|
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.
| 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
The input filter/source whose output dataset is to
binary.
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
Accepts input of following types:
when writing binary data (only if appended mode is selected).
* vtkImageData
 
| 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 used<br>
Writer to write polydata in a xml-based vtk data file. Can be used for
for parallel writing.<br>
parallel writing.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,001: Line 726:
| '''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)''
|'''Input''' (Input)
|
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.
The input filter/source whose output dataset is to
 
written to the file.
 
|-
| '''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).
Accepts input of following types:
 
* vtkPolyData
 
|-
| '''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<br>
Writer to write rectilinear grid in a xml-based vtk data file. Can be
for parallel writing.<br>
used for parallel writing.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,077: 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)''
|
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
The input filter/source whose output dataset is to
binary.
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
Accepts input of following types:
when writing binary data (only if appended mode is selected).
* vtkRectilinearGrid
 
| 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<br>
Writer to write structured grid in a xml-based vtk data file. Can be used
for parallel writing.<br>
for parallel writing.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,153: Line 778:
| '''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
| '''Input'''<br>''(Input)''
written to the file.
|
|
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
The input filter/source whose output dataset is to
binary.
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).


| 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,229: 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)
|
|
The compression algorithm used to compress binary data (appended mode only).
Write each time step in the animation
 
|
| 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==


==XMLPVAnimationWriter==
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
Internal writer proxy used when saving animation geometry to save all<br>
processes.
parts of the current source to the file with pieces spread across the<br>
server processes.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,306: Line 880:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
Name of the file to write.


|
|
|-
|-
| '''Finish'''<br>''(Finish)''
|'''Input''' (Input)
| Finish writing animation
|
|
The input filter/source whose output dataset is to
written to the files.
|
|
|-
| '''Representations'''<br>''(Representations)''
|
The input filter/source whose output dataset is to written to the
file.


|
|
|
Accepts input of following types:
* vtkDataSet
|-
|-
| '''Start'''<br>''(Start)''
|'''HeaderType''' (HeaderType)
| Used to begin writing of the animation
|
|
|
Set the binary data header word type. The default is
|}
UInt32. Set to UInt64 when storing arrays requiring 64-bit indexing.
 
 
==XMLPVDWriter==
 
 
Writer to write ParaView data files (pvd). It is used to save all pieces<br>
of a source/filter to a file with pieces spread across the server<br>
processes. <br>


{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Compressor Type'''<br>''(CompressorType)''
|
|
The compression algorithm used to compress binary data (appended mode only).
64
 
| 0
|
|
The value must be one of the following: None (0), ZLib (1).
The value(s) is an enumeration of the following:
 
* UInt32 (32)
 
* UInt64 (64)
|-
|-
| '''Data Mode'''<br>''(DataMode)''
|'''DataMode''' (DataMode)
|
|
The mode uses for writing the file's data i.e. ascii, binary, appended
The mode uses for writing the file's data i.e. ascii,
binary.
binary, appended binary.
 
| 2
|
|
The value must be one of the following: Ascii (0), Binary (1), Appended (2).
2
 
 
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
|
|
When EncodeAppendedData is turned ON, the writer uses base64 encoding
The value(s) is an enumeration of the following:
when writing binary data (only if appended mode is selected).
* Ascii (0)
 
* Binary (1)
| 0
* Appended (2)
|
Only the values 0 and 1 are accepted.
 
 
|-
|-
| '''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).
|
|
|-
0
| '''Ghost Level'''<br>''(GhostLevel)''
|
|
The number of ghost levels to include in the output file(s). Note that
Accepts boolean values (0 or 1).
some writers (such as ExodusIIWriter) may not support writing ghost
levels.
 
| 0
|
The value must be greater than or equal to 0.
 
 
|-
|-
| '''Input'''<br>''(Input)''
|'''CompressorType''' (CompressorType)
|
|
The input filter/source whose output dataset is to written to the
The compression algorithm used to compress binary data
files.
(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<br>
Writer to write poly data in a xml-based vtk data file. Cannot be used
for parallel writing.<br>
for parallel writing.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,427: 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)''
|'''Input''' (Input)
|
|
The compression algorithm used to compress binary data (appended mode only).
The input filter/source whose output dataset is to
 
written to the file.
| 0
|
|
The value must be one of the following: None (0), ZLib (1).


|-
| '''Data Mode'''<br>''(DataMode)''
|
|
The mode uses for writing the file's data i.e. ascii, binary, appended
Accepts input of following types:
binary.
* vtkPolyData
 
| 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<br>
Writer to write rectilinear grid in a xml-based vtk data file. Cannot be
for parallel writing.<br>
used for parallel writing.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,503: Line 977:
| '''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
| '''Input'''<br>''(Input)''
written to the file.
|
|
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): vtkRectilinearGrid.
* vtkRectilinearGrid


|}


|-
==XMLStructuredGridWriter==
| '''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 structured grid in a xml-based vtk data file.
Writer to write structured grid in a xml-based vtk data file. Cannot be
used for parallel writing.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''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
The input filter/source whose output dataset is to
binary.
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).
| 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
Writer to write structured grid in a xml-based vtk data file. Cannot be used<br>
serial writing.
for parallel writing.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,579: Line 1,030:
| '''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.
* vtkUniformGridAMR


|}


|-
==XMLUnstructuredGridWriter==
| '''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. Cannot 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
The input filter/source whose output dataset is to
binary.
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
Accepts input of following types:
when writing binary data (only if appended mode is selected).
* vtkUnstructuredGrid
 
| 0
|
Only the values 0 and 1 are accepted.
 


|}
|}


==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,655: Line 1,081:
| '''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
Accepts input of following types:
once for each timestep available from the reader.
* vtkDataSet
 
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
|-
| '''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)''
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
|
|
When EncodeAppendedData is turned ON, the writer uses base64 encoding
When WriteAllTimeSteps is turned ON, the writer is
when writing binary data (only if appended mode is selected).
executed once for each timestep available from the reader.
 
| 0
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==XdmfWriter==
 
 
Writer to write data in eXtensible Data Model and Format *(XDMF) files.<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The name of the file to be written.


|
|
0
|
|
Accepts boolean values (0 or 1).
|-
|-
| '''Input'''<br>''(Input)''
|'''MeshStaticOverTime''' (MeshStaticOverTime)
|
|
The input filter/source whose output dataset is to written to the
When MeshStaticOverTime is turned ON, only the mesh
file.
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
|
|
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): vtkDataSet.
 


|}
|}

Latest revision as of 13:07, 26 January 2016

AnimationSceneImageWriter

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

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

The magnification factor to use for the saved animation.

1

FileName (FileName)

The name of the file to save the animation into.

FrameRate (FrameRate)

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

0

PlaybackTimeWindow (PlaybackTimeWindow)

Time range to write

-1 1

Compression (Compression)

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

1

Accepts boolean values (0 or 1).

StartFileCount (StartFileCount)

0


CSVWriter

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

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

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

Accepts input of following types:

  • vtkTable
FileName (FileName)

The name of the file to be written.

WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

DataSetCSVWriter

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

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

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

Accepts input of following types:

  • vtkDataSet
FileName (FileName)

The name of the file to be written.

WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

DataSetWriter

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

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

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

Accepts input of following types:

  • vtkDataObject

EnSightWriter

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

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

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

Accepts input of following types:

  • vtkUnstructuredGrid

ExodusIIWriter

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

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

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

Accepts input of following types:

  • vtkCompositeDataSet
  • vtkDataSet
WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

JPEGWriter

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


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

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

Accepts input of following types:

  • vtkImageData
FileName (FileName)

The name of the file to be written.


JSONImageWriter

Write image data as a JSON file.

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

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

Accepts input of following types:

  • vtkImageData
FileName (FileName)

The name of the file to be written.

ArrayName (ArrayName)

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

Slice (Slice)

Write only one slice if slice >= 0

-1


MetaImageWriter

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

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

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

Accepts input of following types:

  • vtkImageData
FileName (FileName)

The name of the file to be written.


PDataSetWriter

Writer that writes polydata as legacy vtk files. Writer to write any type of data object in a legacy vtk data file. This version is used when running in parallel. It gathers data to first node and saves one file.

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

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

Accepts input of following types:

  • vtkDataObject
FileName (FileName)

The name of the file to be written.

WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

PNGWriter

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


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

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

Accepts input of following types:

  • vtkImageData
FileName (FileName)

The name of the file to be written.


PPLYWriter

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

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

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

Accepts input of following types:

  • vtkPolyData
FileName (FileName)

The name of the file to be written.


PSTLWriter

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

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

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

Accepts input of following types:

  • vtkPolyData
FileName (FileName)

The name of the file to be written.

WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

TIFFWriter

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


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

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

Accepts input of following types:

  • vtkImageData
FileName (FileName)

The name of the file to be written.


XMLDataSetWriterBase

Base for all XML-based file-series writers.

Property Description Default Value(s) Restrictions


XMLHierarchicalBoxDataWriter

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


Property Description Default Value(s) Restrictions


XMLHyperOctreeWriter

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

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

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

Accepts input of following types:

  • vtkHyperOctree

XMLImageDataWriter

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

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

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

Accepts input of following types:

  • vtkImageData

XMLMultiBlockDataWriter

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

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

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

Accepts input of following types:

  • vtkMultiBlockDataSet

XMLPImageDataWriter

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

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

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

Accepts input of following types:

  • vtkImageData

XMLPPolyDataWriter

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

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

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

Accepts input of following types:

  • vtkPolyData

XMLPRectilinearGridWriter

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

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

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

Accepts input of following types:

  • vtkRectilinearGrid

XMLPStructuredGridWriter

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

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

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

Accepts input of following types:

  • vtkStructuredGrid

XMLPUnstructuredGridWriter

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

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

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

Accepts input of following types:

  • vtkUnstructuredGrid

XMLPVAnimationWriter

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

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

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

FileName (FileName)

Name of the file to write.

WriteTime (WriteTime)

Write each time step in the animation

0.0

ErrorCode (ErrorCode)


XMLPVDWriter

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

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

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

Accepts input of following types:

  • vtkDataSet
HeaderType (HeaderType)

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

64

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

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

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

2

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

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

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

0

Accepts boolean values (0 or 1).

CompressorType (CompressorType)

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

0

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

  • None (0)
  • ZLib (1)

XMLPolyDataWriter

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

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

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

Accepts input of following types:

  • vtkPolyData

XMLRectilinearGridWriter

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

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

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

Accepts input of following types:

  • vtkRectilinearGrid

XMLStructuredGridWriter

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

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

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

Accepts input of following types:

  • vtkStructuredGrid

XMLUniformGridAMRWriter

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

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

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

Accepts input of following types:

  • vtkUniformGridAMR

XMLUnstructuredGridWriter

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

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

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

Accepts input of following types:

  • vtkUnstructuredGrid

XdmfWriter

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

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

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

Accepts input of following types:

  • vtkDataSet
FileName (FileName)

The name of the file to be written.

WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

MeshStaticOverTime (MeshStaticOverTime)

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

0

Accepts boolean values (0 or 1).