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

From KitwarePublic
Jump to navigationJump to search
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 12:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|'''Magnification''' (Magnification)
|
The magnification factor to use for the saved animation.
|
1
|
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileName''' (FileName)
|
|
The name of the file to save the animation into.
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
Line 26: Line 43:
playback frame rate and not the animation generation frame rate.
playback frame rate and not the animation generation frame rate.


| 0
|
|-
| '''Magnification'''<br>''(Magnification)''
|
|
The magnification factor to use for the saved animation.
0
 
| 1
|
|
The value must be greater than or equal to 1.




|}
|}


==CSVWriter==
==CSVWriter==


Writer to write CSV files
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.


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


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


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


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


The name of the file to be written.


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
once for each timestep available from the reader.


| 0
When WriteAllTimeSteps is turned ON, the writer is executed
once for each time step available from the reader.
 
|
|
Only the values 0 and 1 are accepted.
0
 
|
Accepts boolean values (0 or 1).


|}
|}


==DataSetCSVWriter==
==DataSetCSVWriter==


Writer to write CSV files
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
CSV. For composite datasets, it saves multiple csv files.


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


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


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


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


The name of the file to be written.


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 executed  
once for each timestep available from the reader.
once for each timestep available from the reader.


| 0
|
Only the values 0 and 1 are accepted.
|-
| '''Field Association'''<br>''(FieldAssociation)''
|
|
Select the attribute data to pass.
0
 
| 0
|
|
The value must be one of the following: Points (0), Cells (1), Field Data (2).
Accepts boolean values (0 or 1).
 


|}
|}


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


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


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


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


|}
|}


==EnSightWriter==
==EnSightWriter==


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


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


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


|
|
|-
|-
| '''Ghost Level'''<br>''(GhostLevel)''
|'''Input''' (Input)
|
The number of ghost levels to include in the output file(s). Note that
some writers (such as ExodusIIWriter) may not support writing ghost
levels.
 
| 0
|
|
The value must be greater than or equal to 0.


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


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


|}
|}


==ExodusIIWriter==
==ExodusIIWriter==


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


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


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


|
|
|-
|-
| '''Ghost Level'''<br>''(GhostLevel)''
|'''Input''' (Input)
|
|
The number of ghost levels to include in the output file(s). Note that
some writers (such as ExodusIIWriter) may not support writing ghost
levels.
| 0
|
The value must be greater than or equal to 0.


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


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


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


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


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


|}
|}


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


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 268:
| '''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.


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


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


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


The name of the file to be written.


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
 
When WriteAllTimeSteps is turned ON, the writer is executed  
once for each timestep available from the reader.
once for each timestep available from the reader.


| 0
|
Only the values 0 and 1 are accepted.
|-
| '''File Type'''<br>''(FileType)''
|
|
The type for the data file (i.e. ascii or binary).
0
 
| 2
|
|
The value must be one of the following: Ascii (1), Binary (2).
Accepts boolean values (0 or 1).
 


|}
|}


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


Writer to write image data as a PNG file. It supports 1 to 4 component<br>
data of unsigned char or unsigned short.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 421: Line 358:
| '''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.


|
|
|
|
Accepts input of following types:
* vtkImageData
|-
|-
| '''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): 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
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.


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


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


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


|
|
|
Accepts input of following types:
* vtkPolyData
|-
|'''FileName''' (FileName)
|
|
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.


The name of the file to be written.


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


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 444:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''Input''' (Input)
|
|
The name of the file to be written.


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


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


The name of the file to be written.


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


Base for all XML-based file-series writers.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 556: Line 482:
| '''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==


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


Writer to write a hierarchical box in a xml-based vtk data file. Can be used<br>
for parallel writing as well as serial writing.<br>


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


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


|
|
|
The selected dataset must be one of the following types (or a subclass of one of them): vtkHierarchicalBoxDataSet.
|-
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
|
When WriteAllTimeSteps is turned ON, the writer is executed
once for each timestep available from the reader.
| 0
|
Only the values 0 and 1 are accepted.
|-
| '''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.
Accepts input of following types:
 
* vtkHierarchicalBoxDataSet


|}
|}


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


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 528:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''Input''' (Input)
|
|
The name of the file to be written.


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


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 557:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''Input''' (Input)
|
|
The name of the file to be written.


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


|}
|}


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


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 586:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''Input''' (Input)
|
|
The name of the file to be written.


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


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


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


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


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


|-
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
|
|
When WriteAllTimeSteps is turned ON, the writer is executed
Accepts input of following types:
once for each timestep available from the reader.
* vtkImageData
 
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''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 used
for parallel writing.


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


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


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


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


|}
|}


==XMLPRectilinearGridWriter==
==XMLPRectilinearGridWriter==


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


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


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


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


|
|
|
The selected dataset must be one of the following types (or a subclass of one of them): vtkRectilinearGrid.
|-
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
|
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).
Accepts input of following types:
 
* vtkRectilinearGrid
 
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
|
When EncodeAppendedData is turned ON, the writer uses base64 encoding
when writing binary data (only if appended mode is selected).
 
| 0
|
Only the values 0 and 1 are accepted.
 


|}
|}


==XMLPStructuredGridWriter==
==XMLPStructuredGridWriter==


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


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


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


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


|
|
|
|
The selected dataset must be one of the following types (or a subclass of one of them): vtkStructuredGrid.
Accepts input of following types:
* 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
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
Only the values 0 and 1 are accepted.
for parallel writing.




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


|-
|-
| '''Data Mode'''<br>''(DataMode)''
|'''Input''' (Input)
|
The mode uses for writing the file's data i.e. ascii, binary, appended
binary.
 
| 2
|
|
The value must be one of the following: Ascii (0), Binary (1), Appended (2).


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


|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
|
|
When EncodeAppendedData is turned ON, the writer uses base64 encoding
when writing binary data (only if appended mode is selected).


| 0
|
|
Only the values 0 and 1 are accepted.
Accepts input of following types:
 
* 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 761:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''Representations''' (Representations)
|
|
The name of the file to be written.


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


| 0
Name of the file to write.
 
|
|
Only the values 0 and 1 are accepted.


|


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


|-
|-
| '''Data Mode'''<br>''(DataMode)''
|'''ErrorCode''' (ErrorCode)
|
The mode uses for writing the file's data i.e. ascii, binary, appended
binary.
 
| 2
|
|
The value must be one of the following: Ascii (0), Binary (1), Appended (2).


|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
|
|
When EncodeAppendedData is turned ON, the writer uses base64 encoding
when writing binary data (only if appended mode is selected).


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




|}
|}


==XMLPVDWriter==


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


Internal writer proxy used when saving animation geometry to save all<br>
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 816:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''Input''' (Input)
|
|
Name of the file to write.


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


|
|
|
|
Accepts input of following types:
* vtkDataSet
|-
|-
| '''Start'''<br>''(Start)''
|'''DataMode''' (DataMode)
| Used to begin writing of the animation
|
|
|
|}


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


==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).
2
 
| 0
|
|
The value must be one of the following: None (0), ZLib (1).
The value(s) is an enumeration of the following:
 
* Ascii (0)
 
* Binary (1)
* Appended (2)
|-
|-
| '''Data Mode'''<br>''(DataMode)''
|'''EncodeAppendedData''' (EncodeAppendedData)
|
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 EncodeAppendedData is turned ON, the writer uses base64 encoding
when writing binary data (only if appended mode is selected).
when writing binary data (only if appended mode is selected).
| 0
|
Only the values 0 and 1 are accepted.
|-
| '''File Name'''<br>''(FileName)''
|
The name of the file to be written.


|
|
0
|
|
Accepts boolean values (0 or 1).
|-
|-
| '''Ghost Level'''<br>''(GhostLevel)''
|'''CompressorType''' (CompressorType)
|
|
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 compression algorithm used to compress binary data (appended mode only).
|
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
files.


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


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


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


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


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


|}
|}


==XMLRectilinearGridWriter==
==XMLRectilinearGridWriter==


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


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


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


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


|
|
|
The selected dataset must be one of the following types (or a subclass of one of them): vtkRectilinearGrid.
|-
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
|
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).
Accepts input of following types:
 
* vtkRectilinearGrid
 
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
|
When EncodeAppendedData is turned ON, the writer uses base64 encoding
when writing binary data (only if appended mode is selected).
 
| 0
|
Only the values 0 and 1 are accepted.
 


|}
|}


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


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


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


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


|
|
|
The selected dataset must be one of the following types (or a subclass of one of them): vtkStructuredGrid.
|-
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)''
|
When WriteAllTimeSteps is turned ON, the writer is executed
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.
Accepts input of following types:
 
* vtkStructuredGrid


|}
|}


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


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 969:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''Input''' (Input)
|
|
The name of the file to be written.


|
|
|-
| '''Input'''<br>''(Input)''
|
The input filter/source whose output dataset is to written to the
The input filter/source whose output dataset is to written to the
file.
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.
| 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).
Accepts input of following types:
 
* vtkUnstructuredGrid
 
|-
| '''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 data in eXtensible Data Model and Format *(XDMF) files.


Writer to write data in eXtensible Data Model and Format *(XDMF) files.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,730: Line 997:
| '''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.


|
|
|
|
Accepts input of following types:
* vtkDataSet
|-
|-
| '''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): vtkDataSet.




|}
|}

Revision as of 21:49, 2 February 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 files 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.


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

Write a hierarchical box dataset in a xml-based vtk data file. Writer to write a hierarchical box 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:

  • vtkHierarchicalBoxDataSet

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

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.