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

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


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 16: Line 15:
|'''Magnification''' (Magnification)
|'''Magnification''' (Magnification)
|
|
 
The magnification factor to use for the saved
The magnification factor to use for the saved animation.
animation.
 
|
|
1
1
Line 25: Line 23:
|-
|-
|'''FileName''' (FileName)
|'''FileName''' (FileName)
|
The name of the file to save the animation
into.
|
|


The name of the file to save the animation into.
|


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


|-
|'''PlaybackTimeWindow''' (PlaybackTimeWindow)
|
Time range to write
|
-1 1
|
|


|-
|-
|'''FrameRate''' (FrameRate)
|'''Compression''' (Compression)
|
|
Turns on(the default) or off compression for FFMEG
(AVI on Linux and Mac) backend.


Get/Set the frame rate to use for saving the animation.
|
This frame rate is the frame rate that gets saved in the movie
1
file generated, if applicable. If does not affect the FrameRate
|
set on the animation scene at all. In other words, this is the
Accepts boolean values (0 or 1).
playback frame rate and not the animation generation frame rate.
|-
|'''StartFileCount''' (StartFileCount)
|


|
|
Line 52: Line 73:
==CSVWriter==
==CSVWriter==


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 68: Line 88:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 80: Line 98:
|'''FileName''' (FileName)
|'''FileName''' (FileName)
|
|
The name of the file to be written.
The name of the file to be written.
|
|


Line 90: Line 106:
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
|
|
 
When WriteAllTimeSteps is turned ON, the writer is
When WriteAllTimeSteps is turned ON, the writer is executed  
executed once for each time step available from the
once for each time step available from the reader.
reader.
 
|
|
0
0
Line 103: Line 118:
==DataSetCSVWriter==
==DataSetCSVWriter==


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 120: Line 134:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 132: Line 144:
|'''FileName''' (FileName)
|'''FileName''' (FileName)
|
|
The name of the file to be written.
The name of the file to be written.
|
|


Line 142: Line 152:
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
|
|
 
When WriteAllTimeSteps is turned ON, the writer is
When WriteAllTimeSteps is turned ON, the writer is executed  
executed once for each timestep available from the
once for each timestep available from the reader.
reader.
 
|
|
0
0
Line 156: Line 165:


Write any type of data object in a legacy vtk data file.
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.  
Writer to write any type of data object in a legacy vtk data file. Cannot
Cannot be used for parallel writing.
be used for parallel writing.
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 170: Line 178:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 185: Line 191:


Write unstructured grid data as an EnSight file.
Write unstructured grid data as an EnSight file.
Writer to write unstructured grid data as an EnSight file. Binary files  
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  
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.
specify the endian-ness of the file when reading it into
 
EnSight.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 200: Line 206:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 214: Line 218:
==ExodusIIWriter==
==ExodusIIWriter==


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 229: Line 232:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 242: Line 243:
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
|
|
 
When WriteAllTimeSteps is turned ON, the writer is
When WriteAllTimeSteps is turned ON, the writer is executed  
executed once for each time step available from the
once for each time step available from the reader.
reader.
 
|
|
0
0
Line 253: Line 253:
|}
|}


==MetaImageWriter==
==JPEGWriter==


Write a binary UNC meta image data.
Write image data as a JPEG file.
Writer to write a binary UNC meta image data. This is a fairly simple
Writer to write image data as a JPEG file. It supports 1 to 3 component
yet powerful format consisting of a text header and a binary data  
data of unsigned char or unsigned short.
section.
This Writer can also generate a stack of images when the FileName is in
MetaImage headers are expected to have extension: ".mha" or ".mhd"
the form of /path/file_%03d.jpg and that the input data is a 3D image
data.




Line 271: Line 272:
|-
|-
|'''Input''' (Input)
|'''Input''' (Input)
|
The input filter/source whose output dataset is to
written to the file.
|
|


The input filter/source whose output dataset is to written to the
|
file.
Accepts input of following types:
* vtkImageData
|-
|'''FileName''' (FileName)
|
The name of the file to be written.
|
 
|
 
 
|}
 
==JSONImageWriter==
 
Write image data as a JSON file.
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


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


Line 284: Line 315:
|'''FileName''' (FileName)
|'''FileName''' (FileName)
|
|
The name of the file to be written.
|
|
|-
|'''ArrayName''' (ArrayName)
|
The name of the field to export. If Empty all fields will be saved.
|
|
|-
|'''Slice''' (Slice)
|
Write only one slice if slice >= 0
|
-1
|
|}
==MetaImageWriter==
Write a binary UNC meta image data.Writer to
write a binary UNC meta image data. This is a fairly simple yet powerful
format consisting of a text header and a binary data section. MetaImage
headers are expected to have extension: ".mha" or ".mhd"


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


Line 297: Line 377:


Writer that writes polydata as legacy vtk files.
Writer that writes polydata as legacy vtk files.
Writer to 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. This
This version is used when running in parallel. It gathers data to
version is used when running in parallel. It gathers data to first node
first node and saves one file.
and saves one file.
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 312: Line 391:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 324: Line 401:
|'''FileName''' (FileName)
|'''FileName''' (FileName)
|
|
The name of the file to be written.
The name of the file to be written.
|
|


Line 334: Line 409:
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
|
|
 
When WriteAllTimeSteps is turned ON, the writer is
When WriteAllTimeSteps is turned ON, the writer is executed  
executed once for each timestep available from the
once for each timestep available from the reader.
reader.
 
|
|
0
0
Line 347: Line 421:
==PNGWriter==
==PNGWriter==


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




Line 362: Line 439:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 374: Line 449:
|'''FileName''' (FileName)
|'''FileName''' (FileName)
|
|
The name of the file to be written.
The name of the file to be written.
|
|


Line 387: Line 460:


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 405: Line 477:
|'''Input''' (Input)
|'''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.
|
|


The input filter/source whose output dataset is to written to the
|}
file.
 
==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.
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


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


Line 417: Line 525:
|'''FileName''' (FileName)
|'''FileName''' (FileName)
|
|
The name of the file to be written.
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).


|}
|}


==PSTLWriter==
==TIFFWriter==


Write stereo lithography files.
Write image data as a TIFF file.Writer to
STLWriter writes stereo lithography (.stl) files in either ASCII or
write image data as a TIFF file.
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.




Line 448: Line 559:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to be
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkPolyData
* vtkImageData
|-
|-
|'''FileName''' (FileName)
|'''FileName''' (FileName)
|
|
The name of the file to be written.
The name of the file to be written.
|
|


Line 472: Line 579:
==XMLDataSetWriterBase==
==XMLDataSetWriterBase==


 
Base for all XML-based file-series
Base for all XML-based file-series writers.
writers.
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 488: Line 594:
==XMLHierarchicalBoxDataWriter==
==XMLHierarchicalBoxDataWriter==


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




Line 500: Line 607:
| '''Restrictions'''
| '''Restrictions'''


|-
|'''Input''' (Input)
|
The input filter/source whose output dataset is to written to the
file.
|
|
Accepts input of following types:
* vtkHierarchicalBoxDataSet


|}
|}
Line 518: Line 613:


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 532: Line 626:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 549: Line 641:
Writer to write image data in a xml-based vtk data file. Cannot be used
Writer to write image data in a xml-based vtk data file. Cannot be used
for parallel writing.
for parallel writing.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 561: Line 652:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 576: Line 665:


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 590: Line 678:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 605: Line 691:


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 619: Line 704:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 634: Line 717:


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 648: Line 730:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 663: Line 743:


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 677: Line 756:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 706: Line 782:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 721: Line 795:


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 735: Line 808:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 749: Line 820:
==XMLPVAnimationWriter==
==XMLPVAnimationWriter==


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 765: Line 834:
|'''Representations''' (Representations)
|'''Representations''' (Representations)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 776: Line 843:
|'''FileName''' (FileName)
|'''FileName''' (FileName)
|
|
Name of the file to write.
Name of the file to write.
|
|


Line 804: Line 869:
==XMLPVDWriter==
==XMLPVDWriter==


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 820: Line 884:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the files.
files.
 
|
|


Line 829: Line 891:
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkDataSet
|-
|'''HeaderType''' (HeaderType)
|
Set the binary data header word type. The default is
UInt32. Set to UInt64 when storing arrays requiring 64-bit indexing.
|
64
|
The value(s) is an enumeration of the following:
* UInt32 (32)
* UInt64 (64)
|-
|-
|'''DataMode''' (DataMode)
|'''DataMode''' (DataMode)
|
|
 
The mode uses for writing the file's data i.e. ascii,
The mode uses for writing the file's data i.e. ascii, binary, appended
binary, appended binary.
binary.
 
|
|
2
2
Line 846: Line 918:
|'''EncodeAppendedData''' (EncodeAppendedData)
|'''EncodeAppendedData''' (EncodeAppendedData)
|
|
 
When EncodeAppendedData is turned ON, the writer uses
When EncodeAppendedData is turned ON, the writer uses base64 encoding
base64 encoding when writing binary data (only if appended mode is
when writing binary data (only if appended mode is selected).
selected).
 
|
|
0
0
Line 857: Line 928:
|'''CompressorType''' (CompressorType)
|'''CompressorType''' (CompressorType)
|
|
 
The compression algorithm used to compress binary data
The compression algorithm used to compress binary data (appended mode only).
(appended mode only).
 
|
|
0
0
Line 874: Line 944:
Writer to write poly data in a xml-based vtk data file. Cannot be used
Writer to write poly data in a xml-based vtk data file. Cannot be used
for parallel writing.
for parallel writing.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 886: Line 955:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 901: Line 968:


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 915: Line 981:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 930: Line 994:


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 943: Line 1,006:
|-
|-
|'''Input''' (Input)
|'''Input''' (Input)
|
The input filter/source whose output dataset is to
written to the file.
|
|


The input filter/source whose output dataset is to written to the
|
file.
Accepts input of following types:
* vtkStructuredGrid
 
|}


==XMLUniformGridAMRWriter==
Write a amr dataset in a xml-based vtk data file.
Writer to write an AMR data-set (overlapping/non-overlapping)
in a xml-based vtk data file. Can be used for parallel writing as well as
serial writing.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''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:
Accepts input of following types:
* vtkStructuredGrid
* vtkUniformGridAMR


|}
|}
Line 959: Line 1,047:


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 973: Line 1,060:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 987: Line 1,072:
==XdmfWriter==
==XdmfWriter==


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,001: Line 1,085:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input filter/source whose output dataset is to
The input filter/source whose output dataset is to written to the
written to the file.
file.
 
|
|


Line 1,013: Line 1,095:
|'''FileName''' (FileName)
|'''FileName''' (FileName)
|
|
The name of the file to be written.
The name of the file to be written.
|


|
|


|-
|'''WriteAllTimeSteps''' (WriteAllTimeSteps)
|
|
When WriteAllTimeSteps is turned ON, the writer is
executed once for each timestep available from the reader.


|
0
|
Accepts boolean values (0 or 1).
|-
|'''MeshStaticOverTime''' (MeshStaticOverTime)
|
When MeshStaticOverTime is turned ON, only the mesh
topology and geometry at the first time step will be written in the
heavy data file. All time steps will reference them in the Xdmf file.
|
0
|
Accepts boolean values (0 or 1).


|}
|}

Latest revision as of 18:07, 26 January 2016

AnimationSceneImageWriter

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

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

The magnification factor to use for the saved animation.

1

FileName (FileName)

The name of the file to save the animation into.

FrameRate (FrameRate)

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

0

PlaybackTimeWindow (PlaybackTimeWindow)

Time range to write

-1 1

Compression (Compression)

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

1

Accepts boolean values (0 or 1).

StartFileCount (StartFileCount)

0


CSVWriter

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

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

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

Accepts input of following types:

  • vtkTable
FileName (FileName)

The name of the file to be written.

WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

DataSetCSVWriter

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

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

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

Accepts input of following types:

  • vtkDataSet
FileName (FileName)

The name of the file to be written.

WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

DataSetWriter

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

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

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

Accepts input of following types:

  • vtkDataObject

EnSightWriter

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

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

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

Accepts input of following types:

  • vtkUnstructuredGrid

ExodusIIWriter

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

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

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

Accepts input of following types:

  • vtkCompositeDataSet
  • vtkDataSet
WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

JPEGWriter

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


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

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

Accepts input of following types:

  • vtkImageData
FileName (FileName)

The name of the file to be written.


JSONImageWriter

Write image data as a JSON file.

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

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

Accepts input of following types:

  • vtkImageData
FileName (FileName)

The name of the file to be written.

ArrayName (ArrayName)

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

Slice (Slice)

Write only one slice if slice >= 0

-1


MetaImageWriter

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

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

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

Accepts input of following types:

  • vtkImageData
FileName (FileName)

The name of the file to be written.


PDataSetWriter

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

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

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

Accepts input of following types:

  • vtkDataObject
FileName (FileName)

The name of the file to be written.

WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

PNGWriter

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


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

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

Accepts input of following types:

  • vtkImageData
FileName (FileName)

The name of the file to be written.


PPLYWriter

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

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

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

Accepts input of following types:

  • vtkPolyData
FileName (FileName)

The name of the file to be written.


PSTLWriter

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

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

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

Accepts input of following types:

  • vtkPolyData
FileName (FileName)

The name of the file to be written.

WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

TIFFWriter

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


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

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

Accepts input of following types:

  • vtkImageData
FileName (FileName)

The name of the file to be written.


XMLDataSetWriterBase

Base for all XML-based file-series writers.

Property Description Default Value(s) Restrictions


XMLHierarchicalBoxDataWriter

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


Property Description Default Value(s) Restrictions


XMLHyperOctreeWriter

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

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

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

Accepts input of following types:

  • vtkHyperOctree

XMLImageDataWriter

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

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

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

Accepts input of following types:

  • vtkImageData

XMLMultiBlockDataWriter

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

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

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

Accepts input of following types:

  • vtkMultiBlockDataSet

XMLPImageDataWriter

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

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

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

Accepts input of following types:

  • vtkImageData

XMLPPolyDataWriter

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

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

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

Accepts input of following types:

  • vtkPolyData

XMLPRectilinearGridWriter

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

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

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

Accepts input of following types:

  • vtkRectilinearGrid

XMLPStructuredGridWriter

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

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

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

Accepts input of following types:

  • vtkStructuredGrid

XMLPUnstructuredGridWriter

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

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

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

Accepts input of following types:

  • vtkUnstructuredGrid

XMLPVAnimationWriter

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

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

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

FileName (FileName)

Name of the file to write.

WriteTime (WriteTime)

Write each time step in the animation

0.0

ErrorCode (ErrorCode)


XMLPVDWriter

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

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

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

Accepts input of following types:

  • vtkDataSet
HeaderType (HeaderType)

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

64

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

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

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

2

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

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

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

0

Accepts boolean values (0 or 1).

CompressorType (CompressorType)

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

0

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

  • None (0)
  • ZLib (1)

XMLPolyDataWriter

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

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

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

Accepts input of following types:

  • vtkPolyData

XMLRectilinearGridWriter

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

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

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

Accepts input of following types:

  • vtkRectilinearGrid

XMLStructuredGridWriter

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

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

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

Accepts input of following types:

  • vtkStructuredGrid

XMLUniformGridAMRWriter

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

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

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

Accepts input of following types:

  • vtkUniformGridAMR

XMLUnstructuredGridWriter

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

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

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

Accepts input of following types:

  • vtkUnstructuredGrid

XdmfWriter

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

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

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

Accepts input of following types:

  • vtkDataSet
FileName (FileName)

The name of the file to be written.

WriteAllTimeSteps (WriteAllTimeSteps)

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

0

Accepts boolean values (0 or 1).

MeshStaticOverTime (MeshStaticOverTime)

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

0

Accepts boolean values (0 or 1).