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

From KitwarePublic
Jump to navigationJump to search
Line 6: Line 6:




 


Writer to write CSV files from table.<br>
Writer to write CSV files from table.<br>
Line 23: Line 23:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 31: Line 31:
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.
Line 38: Line 38:
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)''
Line 49: Line 49:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|}
|}


Line 56: Line 56:




 


Writer to write CSV files from any dataset. Set FieldAssociation to<br>
Writer to write CSV files from any dataset. Set FieldAssociation to<br>
Line 74: Line 74:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 82: Line 82:
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.
Line 89: Line 89:
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)''
Line 100: Line 100:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|-
|-
| '''Field Association'''<br>''(FieldAssociation)''
| '''Field Association'''<br>''(FieldAssociation)''
Line 110: Line 110:
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).


 
|}
|}


Line 117: Line 117:




 


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>
Line 133: Line 133:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 141: Line 141:
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.
Line 148: Line 148:
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)''
Line 159: Line 159:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|-
|-
| '''File Type'''<br>''(FileType)''
| '''File Type'''<br>''(FileType)''
Line 169: Line 169:
The value must be one of the following: Ascii (1), Binary (2).
The value must be one of the following: Ascii (1), Binary (2).


 
|}
|}


Line 176: Line 176:




 


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>
Line 193: Line 193:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Ghost Level'''<br>''(GhostLevel)''
| '''Ghost Level'''<br>''(GhostLevel)''
Line 206: Line 206:
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)''
Line 213: Line 213:
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.
Line 220: Line 220:
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.


 
|}
|}


Line 227: Line 227:




 


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>
Line 243: Line 243:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Ghost Level'''<br>''(GhostLevel)''
| '''Ghost Level'''<br>''(GhostLevel)''
Line 256: Line 256:
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)''
Line 263: Line 263:
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.
Line 270: Line 270:
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)''
Line 281: Line 281:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|}
|}


Line 288: Line 288:




 


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>
Line 306: Line 306:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 314: Line 314:
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.
Line 321: Line 321:
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.


 
|}
|}


Line 328: Line 328:




 


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>
Line 345: Line 345:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 353: Line 353:
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.
Line 360: Line 360:
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)''
Line 371: Line 371:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|-
|-
| '''File Type'''<br>''(FileType)''
| '''File Type'''<br>''(FileType)''
Line 381: Line 381:
The value must be one of the following: Ascii (1), Binary (2).
The value must be one of the following: Ascii (1), Binary (2).


 
|}
|}


Line 388: Line 388:




 


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>
Line 404: Line 404:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 412: Line 412:
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.
Line 419: Line 419:
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.


 
|}
|}


Line 426: Line 426:




 


Writer to write polygonal data in Stanford University PLY format. The <br>
Writer to write polygonal data in Stanford University PLY format. The <br>
Line 446: Line 446:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 454: Line 454:
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.
Line 461: Line 461:
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)''
Line 471: Line 471:
The value must be one of the following: Ascii (1), Binary (2).
The value must be one of the following: Ascii (1), Binary (2).


 
|}
|}


Line 478: Line 478:




 


STLWriter writes stereo lithography (.stl) files in either ASCII or<br>
STLWriter writes stereo lithography (.stl) files in either ASCII or<br>
Line 498: Line 498:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 506: Line 506:
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.
Line 513: Line 513:
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)''
Line 523: Line 523:
The value must be one of the following: Ascii (1), Binary (2).
The value must be one of the following: Ascii (1), Binary (2).


 
|}
|}


Line 530: Line 530:




 


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>
Line 546: Line 546:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 554: Line 554:
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)''
Line 569: Line 569:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|-
|-
| '''Compressor Type'''<br>''(CompressorType)''
| '''Compressor Type'''<br>''(CompressorType)''
Line 579: Line 579:
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)''
Line 590: Line 590:
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)''
Line 601: Line 601:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|}
|}


Line 608: Line 608:




 


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>
Line 624: Line 624:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 632: Line 632:
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)''
Line 647: Line 647:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|-
|-
| '''Compressor Type'''<br>''(CompressorType)''
| '''Compressor Type'''<br>''(CompressorType)''
Line 657: Line 657:
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)''
Line 668: Line 668:
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)''
Line 679: Line 679:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|}
|}


Line 686: Line 686:




 


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>
Line 702: Line 702:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 710: Line 710:
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)''
Line 725: Line 725:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|-
|-
| '''Compressor Type'''<br>''(CompressorType)''
| '''Compressor Type'''<br>''(CompressorType)''
Line 735: Line 735:
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)''
Line 746: Line 746:
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)''
Line 757: Line 757:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|}
|}


Line 764: Line 764:




 


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>
Line 780: Line 780:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 788: Line 788:
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)''
Line 803: Line 803:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|-
|-
| '''Compressor Type'''<br>''(CompressorType)''
| '''Compressor Type'''<br>''(CompressorType)''
Line 813: Line 813:
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)''
Line 824: Line 824:
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)''
Line 835: Line 835:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|}
|}


Line 842: Line 842:




 


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>
Line 858: Line 858:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 866: Line 866:
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)''
Line 881: Line 881:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|-
|-
| '''Compressor Type'''<br>''(CompressorType)''
| '''Compressor Type'''<br>''(CompressorType)''
Line 891: Line 891:
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)''
Line 902: Line 902:
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)''
Line 913: Line 913:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|}
|}


Line 920: Line 920:




 


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>
Line 936: Line 936:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 944: Line 944:
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)''
Line 959: Line 959:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|-
|-
| '''Compressor Type'''<br>''(CompressorType)''
| '''Compressor Type'''<br>''(CompressorType)''
Line 969: Line 969:
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)''
Line 980: Line 980:
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)''
Line 991: Line 991:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|}
|}


Line 998: Line 998:




 


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>
Line 1,014: Line 1,014:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 1,022: Line 1,022:
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)''
Line 1,037: Line 1,037:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|-
|-
| '''Compressor Type'''<br>''(CompressorType)''
| '''Compressor Type'''<br>''(CompressorType)''
Line 1,047: Line 1,047:
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)''
Line 1,058: Line 1,058:
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)''
Line 1,069: Line 1,069:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|}
|}


Line 1,076: Line 1,076:




 


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>
Line 1,092: Line 1,092:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 1,100: Line 1,100:
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)''
Line 1,115: Line 1,115:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|-
|-
| '''Compressor Type'''<br>''(CompressorType)''
| '''Compressor Type'''<br>''(CompressorType)''
Line 1,125: Line 1,125:
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)''
Line 1,136: Line 1,136:
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)''
Line 1,147: Line 1,147:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|}
|}


Line 1,154: Line 1,154:




 


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>
Line 1,170: Line 1,170:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 1,178: Line 1,178:
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)''
Line 1,193: Line 1,193:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|-
|-
| '''Compressor Type'''<br>''(CompressorType)''
| '''Compressor Type'''<br>''(CompressorType)''
Line 1,203: Line 1,203:
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)''
Line 1,214: Line 1,214:
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)''
Line 1,225: Line 1,225:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|}
|}


Line 1,232: Line 1,232:




 


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>
Line 1,253: Line 1,253:
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)''
Line 1,264: Line 1,264:
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)''
Line 1,275: Line 1,275:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


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


|  
|
|  
|
|-
|-
| '''Ghost Level'''<br>''(GhostLevel)''
| '''Ghost Level'''<br>''(GhostLevel)''
Line 1,294: Line 1,294:
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)''
Line 1,301: Line 1,301:
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.
Line 1,308: Line 1,308:
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.


 
|}
|}


Line 1,315: Line 1,315:




 


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>
Line 1,331: Line 1,331:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 1,339: Line 1,339:
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)''
Line 1,354: Line 1,354:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|-
|-
| '''Compressor Type'''<br>''(CompressorType)''
| '''Compressor Type'''<br>''(CompressorType)''
Line 1,364: Line 1,364:
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)''
Line 1,375: Line 1,375:
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)''
Line 1,386: Line 1,386:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|}
|}


Line 1,393: Line 1,393:




 


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>
Line 1,409: Line 1,409:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 1,417: Line 1,417:
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)''
Line 1,432: Line 1,432:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|-
|-
| '''Compressor Type'''<br>''(CompressorType)''
| '''Compressor Type'''<br>''(CompressorType)''
Line 1,442: Line 1,442:
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)''
Line 1,453: Line 1,453:
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)''
Line 1,464: Line 1,464:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|}
|}


Line 1,471: Line 1,471:




 


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>
Line 1,487: Line 1,487:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 1,495: Line 1,495:
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)''
Line 1,510: Line 1,510:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|-
|-
| '''Compressor Type'''<br>''(CompressorType)''
| '''Compressor Type'''<br>''(CompressorType)''
Line 1,520: Line 1,520:
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)''
Line 1,531: Line 1,531:
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)''
Line 1,542: Line 1,542:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|}
|}


Line 1,549: Line 1,549:




 


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>
Line 1,565: Line 1,565:
The name of the file to be written.
The name of the file to be written.


|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 1,573: Line 1,573:
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)''
Line 1,588: Line 1,588:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|-
|-
| '''Compressor Type'''<br>''(CompressorType)''
| '''Compressor Type'''<br>''(CompressorType)''
Line 1,598: Line 1,598:
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)''
Line 1,609: Line 1,609:
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)''
Line 1,620: Line 1,620:
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


 
|}
|}


Line 1,627: Line 1,627:




 


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>
Line 1,639: Line 1,639:
|-
|-
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|  
|
|  
|
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Input'''<br>''(Input)''
Line 1,648: Line 1,648:
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.
Line 1,655: Line 1,655:
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 15:36, 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.