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

From KitwarePublic
Jump to navigationJump to search
Line 1: Line 1:
[[ParaViewUsersGuide]]
[[ParaViewUsersGuide]]






==CSVWriter==
==CSVWriter==






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


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


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


|-
|-
| '''Write All Time Steps'''<br>''(WriteAllTimeSteps)''
| '''Write All Time Steps'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|}
|}




==DataSetCSVWriter==
==DataSetCSVWriter==






Writer to write CSV files from any dataset. Set FieldAssociation to<br>
Writer to write CSV files from any dataset. Set FieldAssociation to<br>
choose whether cell data/point data needs to be saved.<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>
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>
CSV. For composite datasets, it saves multiple csv files.<br>


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


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


|-
|-
| '''Write All Time Steps'''<br>''(WriteAllTimeSteps)''
| '''Write All Time Steps'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|-
|-
| '''Field Association'''<br>''(FieldAssociation)''
| '''Field Association'''<br>''(FieldAssociation)''
|
|
Select the attribute data to pass.
Select the attribute data to pass.


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


|}
|}




==DataSetWriter==
==DataSetWriter==






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. <br>
Cannot be used for parallel writing.<br>
Cannot be used for parallel writing.<br>


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


| �
| �
| �
| �
|-
|-
| '''Input'''<br>''(Input)''
| '''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 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.
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)''
| '''Write all timesteps as file-series'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|-
|-
| '''File Type'''<br>''(FileType)''
| '''File Type'''<br>''(FileType)''
|
|
The type for the data file (i.e. ascii or binary).
The type for the data file (i.e. ascii or binary).


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


|}
|}




==EnSightWriter==
==EnSightWriter==






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


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


| �
| �
| �
| �
|-
|-
| '''Ghost Level'''<br>''(GhostLevel)''
| '''Ghost Level'''<br>''(GhostLevel)''
|
|
The number of ghost levels to include in the output file(s). Note that
The number of ghost levels to include in the output file(s). Note that
some writers (such as ExodusIIWriter) may not support writing ghost
some writers (such as ExodusIIWriter) may not support writing ghost
levels.
levels.


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


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


|}
|}




==ExodusIIWriter==
==ExodusIIWriter==






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


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


| �
| �
| �
| �
|-
|-
| '''Ghost Level'''<br>''(GhostLevel)''
| '''Ghost Level'''<br>''(GhostLevel)''
|
|
The number of ghost levels to include in the output file(s). Note that
The number of ghost levels to include in the output file(s). Note that
some writers (such as ExodusIIWriter) may not support writing ghost
some writers (such as ExodusIIWriter) may not support writing ghost
levels.
levels.


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


|-
|-
| '''Input'''<br>''(Input)''
| '''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 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.
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)''
| '''Write All Time Steps'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|}
|}




==MetaImageWriter==
==MetaImageWriter==






Writer to write a binary UNC meta image data. This is a fairly simple <br>
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>
yet powerful format consisting of a text header and a binary data <br>
section. <br>
section. <br>
MetaImage headers are expected to have extension: ".mha" or ".mhd"<br>
MetaImage headers are expected to have extension: ".mha" or ".mhd"<br>


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


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


|}
|}




==PDataSetWriter==
==PDataSetWriter==






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. <br>
This version is used when running in parallel. It gathers data to<br>
This version is used when running in parallel. It gathers data to<br>
first node and saves 1 file.<br>
first node and saves 1 file.<br>


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


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


|-
|-
| '''Write All Time Steps'''<br>''(WriteAllTimeSteps)''
| '''Write All Time Steps'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|-
|-
| '''File Type'''<br>''(FileType)''
| '''File Type'''<br>''(FileType)''
|
|
The type for the data file (i.e. ascii or binary).
The type for the data file (i.e. ascii or binary).


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


|}
|}




==PNGWriter==
==PNGWriter==






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


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


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


|}
|}




==PPLYWriter==
==PPLYWriter==






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


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


| �
| �
| �
| �
|-
|-
| '''Input'''<br>''(Input)''
| '''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 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 selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.


|-
|-
| '''File Type'''<br>''(FileType)''
| '''File Type'''<br>''(FileType)''
|
|
The type for the data file (i.e. ascii or binary).
The type for the data file (i.e. ascii or binary).


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


|}
|}




==PSTLWriter==
==PSTLWriter==






STLWriter writes stereo lithography (.stl) files in either ASCII or<br>
STLWriter writes stereo lithography (.stl) files in either ASCII or<br>
binary form. Stereo lithography files only contain triangles. If<br>
binary form. Stereo lithography files only contain triangles. If<br>
polygons with more than 3 vertices are present, only the first 3<br>
polygons with more than 3 vertices are present, only the first 3<br>
vertices are written.  Use TriangleFilter to convert polygons to<br>
vertices are written.  Use TriangleFilter to convert polygons to<br>
triangles. This version of the reader is used when running in<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>
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"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|
|
The name of the file to be written.
The name of the file to be written.


| �
| �
| �
| �
|-
|-
| '''Input'''<br>''(Input)''
| '''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 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 selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.


|-
|-
| '''File Type'''<br>''(FileType)''
| '''File Type'''<br>''(FileType)''
|
|
The type for the data file (i.e. ascii or binary).
The type for the data file (i.e. ascii or binary).


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


|}
|}




==XMLHierarchicalBoxDataWriter==
==XMLHierarchicalBoxDataWriter==






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


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


| �
| �
| �
| �
|-
|-
| '''Input'''<br>''(Input)''
| '''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.
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)''
| '''Write all timesteps as file-series'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


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


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


|-
|-
| '''Data Mode'''<br>''(DataMode)''
| '''Data Mode'''<br>''(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, appended
binary.
binary.


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


|-
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
| '''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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|}
|}




==XMLHyperOctreeWriter==
==XMLHyperOctreeWriter==






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


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


| �
| �
| �
| �
|-
|-
| '''Input'''<br>''(Input)''
| '''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.
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)''
| '''Write all timesteps as file-series'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


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


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


|-
|-
| '''Data Mode'''<br>''(DataMode)''
| '''Data Mode'''<br>''(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, appended
binary.
binary.


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


|-
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
| '''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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|}
|}




==XMLImageDataWriter==
==XMLImageDataWriter==






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


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


| �
| �
| �
| �
|-
|-
| '''Input'''<br>''(Input)''
| '''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.
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)''
| '''Write all timesteps as file-series'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


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


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


|-
|-
| '''Data Mode'''<br>''(DataMode)''
| '''Data Mode'''<br>''(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, appended
binary.
binary.


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


|-
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
| '''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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|}
|}




==XMLMultiBlockDataWriter==
==XMLMultiBlockDataWriter==






Writer to write a multiblock dataset in a xml-based vtk data file. Can be used<br>
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>
for parallel writing as well as serial writing.<br>


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


| �
| �
| �
| �
|-
|-
| '''Input'''<br>''(Input)''
| '''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.
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)''
| '''Write all timesteps as file-series'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


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


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


|-
|-
| '''Data Mode'''<br>''(DataMode)''
| '''Data Mode'''<br>''(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, appended
binary.
binary.


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


|-
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
| '''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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|}
|}




==XMLPImageDataWriter==
==XMLPImageDataWriter==






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<br>
for parallel writing.<br>
for parallel writing.<br>


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


| �
| �
| �
| �
|-
|-
| '''Input'''<br>''(Input)''
| '''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.
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)''
| '''Write all timesteps as file-series'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


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


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


|-
|-
| '''Data Mode'''<br>''(DataMode)''
| '''Data Mode'''<br>''(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, appended
binary.
binary.


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


|-
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
| '''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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|}
|}




==XMLPPolyDataWriter==
==XMLPPolyDataWriter==






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<br>
for parallel writing.<br>
for parallel writing.<br>


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


| �
| �
| �
| �
|-
|-
| '''Input'''<br>''(Input)''
| '''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.
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)''
| '''Write all timesteps as file-series'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


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


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


|-
|-
| '''Data Mode'''<br>''(DataMode)''
| '''Data Mode'''<br>''(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, appended
binary.
binary.


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


|-
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
| '''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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|}
|}




==XMLPRectilinearGridWriter==
==XMLPRectilinearGridWriter==






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 used<br>
for parallel writing.<br>
for parallel writing.<br>


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


| �
| �
| �
| �
|-
|-
| '''Input'''<br>''(Input)''
| '''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.
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)''
| '''Write all timesteps as file-series'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


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


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


|-
|-
| '''Data Mode'''<br>''(DataMode)''
| '''Data Mode'''<br>''(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, appended
binary.
binary.


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


|-
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
| '''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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|}
|}




==XMLPStructuredGridWriter==
==XMLPStructuredGridWriter==






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<br>
for parallel writing.<br>
for parallel writing.<br>


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


| �
| �
| �
| �
|-
|-
| '''Input'''<br>''(Input)''
| '''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.
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)''
| '''Write all timesteps as file-series'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


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


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


|-
|-
| '''Data Mode'''<br>''(DataMode)''
| '''Data Mode'''<br>''(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, appended
binary.
binary.


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


|-
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
| '''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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|}
|}




==XMLPUnstructuredGridWriter==
==XMLPUnstructuredGridWriter==






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


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


| �
| �
| �
| �
|-
|-
| '''Input'''<br>''(Input)''
| '''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.
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)''
| '''Write all timesteps as file-series'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


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


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


|-
|-
| '''Data Mode'''<br>''(DataMode)''
| '''Data Mode'''<br>''(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, appended
binary.
binary.


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


|-
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
| '''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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|}
|}




==XMLPVDWriter==
==XMLPVDWriter==






Writer to write ParaView data files (pvd). It is used to save all pieces<br>
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>
of a source/filter to a file with pieces spread across the server<br>
processes. <br>
processes. <br>


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


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


|-
|-
| '''Data Mode'''<br>''(DataMode)''
| '''Data Mode'''<br>''(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, appended
binary.
binary.


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


|-
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
| '''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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|-
|-
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|
|
The name of the file to be written.
The name of the file to be written.


| �
| �
| �
| �
|-
|-
| '''Ghost Level'''<br>''(GhostLevel)''
| '''Ghost Level'''<br>''(GhostLevel)''
|
|
The number of ghost levels to include in the output file(s). Note that
The number of ghost levels to include in the output file(s). Note that
some writers (such as ExodusIIWriter) may not support writing ghost
some writers (such as ExodusIIWriter) may not support writing ghost
levels.
levels.


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


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


| �
| �
|
|
The selected object must be the result of the following: sources (includes readers), filters.
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.
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.


|}
|}




==XMLPolyDataWriter==
==XMLPolyDataWriter==






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<br>
for parallel writing.<br>
for parallel writing.<br>


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


| �
| �
| �
| �
|-
|-
| '''Input'''<br>''(Input)''
| '''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.
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)''
| '''Write all timesteps as file-series'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


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


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


|-
|-
| '''Data Mode'''<br>''(DataMode)''
| '''Data Mode'''<br>''(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, appended
binary.
binary.


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


|-
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
| '''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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|}
|}




==XMLRectilinearGridWriter==
==XMLRectilinearGridWriter==






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 used<br>
for parallel writing.<br>
for parallel writing.<br>


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


| �
| �
| �
| �
|-
|-
| '''Input'''<br>''(Input)''
| '''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.
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)''
| '''Write all timesteps as file-series'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


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


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


|-
|-
| '''Data Mode'''<br>''(DataMode)''
| '''Data Mode'''<br>''(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, appended
binary.
binary.


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


|-
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
| '''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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|}
|}




==XMLStructuredGridWriter==
==XMLStructuredGridWriter==






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


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


| �
| �
| �
| �
|-
|-
| '''Input'''<br>''(Input)''
| '''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.
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)''
| '''Write all timesteps as file-series'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


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


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


|-
|-
| '''Data Mode'''<br>''(DataMode)''
| '''Data Mode'''<br>''(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, appended
binary.
binary.


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


|-
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
| '''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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|}
|}




==XMLUnstructuredGridWriter==
==XMLUnstructuredGridWriter==






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


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


| �
| �
| �
| �
|-
|-
| '''Input'''<br>''(Input)''
| '''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.
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)''
| '''Write all timesteps as file-series'''<br>''(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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


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


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


|-
|-
| '''Data Mode'''<br>''(DataMode)''
| '''Data Mode'''<br>''(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, appended
binary.
binary.


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


|-
|-
| '''Encode Appended Data'''<br>''(EncodeAppendedData)''
| '''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
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|}
|}




==XdmfWriter==
==XdmfWriter==






Writer to write data in eXtensible Data Model and Format *(XDMF) files.<br>
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"
|-
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
| �
| �
| �
| �
| �
| �
|-
|-
| '''Input'''<br>''(Input)''
| '''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 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.
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.


|}
|}

Revision as of 10:39, 12 October 2010

ParaViewUsersGuide



CSVWriter


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
File Name
(FileName)

The name of the file to be written.


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



DataSetCSVWriter


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
File Name
(FileName)

The name of the file to be written.


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


Field Association
(FieldAssociation)

Select the attribute data to pass.


0

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



DataSetWriter


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
File Name
(FileName)

The name of the file to be written.


Input
(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
(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
(FileType)

The type for the data file (i.e. ascii or binary).


2

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



EnSightWriter


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
File Name
(FileName)

The name of the file to be written.


Ghost Level
(GhostLevel)

The number of ghost levels to include in the output file(s). Note that

some writers (such as ExodusIIWriter) may not support writing ghost

levels.


0

The value must be greater than or equal to 0.


Input
(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): vtkUnstructuredGrid.



ExodusIIWriter


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
File Name
(FileName)

The name of the file to be written.


Ghost Level
(GhostLevel)

The number of ghost levels to include in the output file(s). Note that

some writers (such as ExodusIIWriter) may not support writing ghost

levels.


0

The value must be greater than or equal to 0.


Input
(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): vtkCompositeDataSet, vtkDataSet.


Write All Time Steps
(WriteAllTimeSteps)

When WriteAllTimeSteps is turned ON, the writer is executed

once for each timestep available from the reader.


0

Only the values 0 and 1 are accepted.



MetaImageWriter


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
File Name
(FileName)

The name of the file to be written.


Input
(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


Writer to write any type of data object in a legacy vtk data file.

This version is used when running in parallel. It gathers data to

first node and saves 1 file.


Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.


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



PNGWriter


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
File Name
(FileName)

The name of the file to be written.


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



PPLYWriter


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


Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.


Input
(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
(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


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
File Name
(FileName)

The name of the file to be written.


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



XMLHierarchicalBoxDataWriter


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
File Name
(FileName)

The name of the file to be written.


Input
(Input)

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

file.


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


Write all timesteps as file-series
(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
(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
(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
(EncodeAppendedData)

When EncodeAppendedData is turned ON, the writer uses base64 encoding

when writing binary data (only if appended mode is selected).


0

Only the values 0 and 1 are accepted.



XMLHyperOctreeWriter


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

for parallel writing.


Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.


Input
(Input)

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

file.


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


Write all timesteps as file-series
(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
(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
(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
(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


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

for parallel writing.


Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.


Input
(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
(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
(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
(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
(EncodeAppendedData)

When EncodeAppendedData is turned ON, the writer uses base64 encoding

when writing binary data (only if appended mode is selected).


0

Only the values 0 and 1 are accepted.



XMLMultiBlockDataWriter


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
File Name
(FileName)

The name of the file to be written.


Input
(Input)

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

file.


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


Write all timesteps as file-series
(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
(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
(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
(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


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

for parallel writing.


Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.


Input
(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
(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
(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
(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
(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


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

for parallel writing.


Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.


Input
(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
(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
(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
(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
(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


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

for parallel writing.


Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.


Input
(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
(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
(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
(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
(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


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

for parallel writing.


Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.


Input
(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): vtkStructuredGrid.


Write all timesteps as file-series
(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
(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
(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
(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.



XMLPUnstructuredGridWriter


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

for parallel writing.


Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.


Input
(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
(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
(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
(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
(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


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
Compressor Type
(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
(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
(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.


File Name
(FileName)

The name of the file to be written.


Ghost Level
(GhostLevel)

The number of ghost levels to include in the output file(s). Note that

some writers (such as ExodusIIWriter) may not support writing ghost

levels.


0

The value must be greater than or equal to 0.


Input
(Input)

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

files.


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


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



XMLPolyDataWriter


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

for parallel writing.


Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.


Input
(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
(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
(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
(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
(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


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

for parallel writing.


Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.


Input
(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
(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
(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
(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
(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


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

for parallel writing.


Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.


Input
(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): vtkStructuredGrid.


Write all timesteps as file-series
(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
(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
(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
(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.



XMLUnstructuredGridWriter


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

for parallel writing.


Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the file to be written.


Input
(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
(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
(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
(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
(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


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


Property Description Default Value(s) Restrictions
File Name
(FileName)
Input
(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.