ParaView/Users Guide/List of writers: Difference between revisions
No edit summary |
No edit summary |
||
Line 3: | Line 3: | ||
==CSVWriter | ==CSVWriter= | ||
{| class="PropertiesTable" border="1" cellpadding="5 | Writer to write CSV files from table.<br | ||
| | In parallel, it delivers the table to the root node and then saves the<br | ||
| '''Property | CSV. For composite datasets, it saves multiple csv files.<br | ||
| '''Description | |||
| '''Default Value(s) | {| class="PropertiesTable" border="1" cellpadding="5 | ||
| '''Restrictions | | | ||
| '''Property'' | |||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | | | ||
The name of the file to be written | | '''File Name'''<br>''(FileName)' | ||
The name of the file to be written | |||
| | | | ||
The input filter/source whose output dataset is to written to | | | ||
file | | | ||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
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 | |||
| | | | ||
When WriteAllTimeSteps is turned ON, the writer is | | '''Write All Time Steps'''<br>''(WriteAllTimeSteps)' | ||
once for each timestep available from the reader | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | |||
==DataSetCSVWriter= | |||
{| class="PropertiesTable" border="1" cellpadding="5 | |||
Writer to write CSV files from any dataset. Set FieldAssociation to<br | |||
choose whether cell data/point data needs to be saved.<br | |||
In parallel, it delivers the table to the root node and then saves the<br | |||
CSV. For composite datasets, it saves multiple csv files.<br | |||
{| class="PropertiesTable" border="1" cellpadding="5 | |||
| | | | ||
| '''Property'' | |||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | |||
| '''File Name'''<br>''(FileName)' | |||
The name of the file to be written | |||
| | | | ||
| | | | ||
| | | | ||
The input filter/source whose output dataset is to written to | | '''Input'''<br>''(Input)' | ||
file | |||
The input filter/source whose output dataset is to written to th | |||
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 | |||
| | | | ||
When WriteAllTimeSteps is turned ON, the writer is | | '''Write All Time Steps'''<br>''(WriteAllTimeSteps)' | ||
once for each timestep available from the reader | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | |||
| '''Field Association'''<br>''(FieldAssociation)' | |||
| | |||
| '''Field Association'''<br>''(FieldAssociation)' | |||
Select the attribute data to pass | |||
| | | | ||
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. <br | Writer to write any type of data object in a legacy vtk data file. <br | ||
Cannot be used for parallel writing.<br | Cannot be used for parallel writing.<br | ||
{| class="PropertiesTable" border="1" cellpadding="5 | {| class="PropertiesTable" border="1" cellpadding="5 | ||
| | | | ||
| '''Property | | '''Property'' | ||
| '''Description | | '''Description'' | ||
| '''Default Value(s) | | '''Default Value(s)'' | ||
| '''Restrictions | | '''Restrictions'' | ||
| | | | ||
The name of the file to be written | | '''File Name'''<br>''(FileName)' | ||
The name of the file to be written | |||
| | | | ||
The input filter/source whose output dataset is to written to | | | ||
file | | | ||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
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 | |||
| | | | ||
When WriteAllTimeSteps is turned ON, the writer is | | '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)' | ||
once for each timestep available from the reader | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
The type for the data file (i.e. ascii or binary) | | '''File Type'''<br>''(FileType)' | ||
The type for the data file (i.e. ascii or binary) | |||
| | | | ||
The value must be one of the following: Ascii (1), Binary (2) | |||
| | |||
==EnSightWriter= | |||
{| class="PropertiesTable" border="1" cellpadding="5 | |||
| | |||
| '''Property | Writer to write unstructured grid data as an EnSight file. Binary files <br | ||
| '''Description | written on one system may not be readable on other systems. Be sure to <br | ||
| '''Default Value(s) | specify the endian-ness of the file when reading it into EnSight.<br | ||
| '''Restrictions | |||
{| class="PropertiesTable" border="1" cellpadding="5 | |||
| | |||
| '''Property'' | |||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | | | ||
The name of the file to be written | | '''File Name'''<br>''(FileName)' | ||
The name of the file to be written | |||
| | | | ||
The number of ghost levels to include in the output file(s). Note | | | ||
some writers (such as ExodusIIWriter) may not support writing | | | ||
levels | | '''Ghost Level'''<br>''(GhostLevel)' | ||
The number of ghost levels to include in the output file(s). Note tha | |||
some writers (such as ExodusIIWriter) may not support writing ghos | |||
levels | |||
| | | | ||
The value must be greater than or equal to 0 | |||
| | | | ||
The input filter/source whose output dataset is to written to | | '''Input'''<br>''(Input)' | ||
file | |||
The input filter/source whose output dataset is to written to th | |||
file | |||
| | | | ||
The selected object must be the result of the following: sources (includes readers), filters | |||
The selected object must be the result of the following: sources (includes readers), filters | |||
The selected dataset must be one of the following types (or a subclass of one of them): vtkUnstructuredGrid | |||
| | |||
==ExodusIIWriter= | |||
Writer to write Exodus II files. Refere to http://endo.sandia.gov/SEACAS/ <br | Writer to write Exodus II files. Refere to http://endo.sandia.gov/SEACAS/ <br | ||
for more information about the Exodus II format.<br | for more information about the Exodus II format.<br | ||
{| class="PropertiesTable" border="1" cellpadding="5 | {| class="PropertiesTable" border="1" cellpadding="5 | ||
| | | | ||
| '''Property | | '''Property'' | ||
| '''Description | | '''Description'' | ||
| '''Default Value(s) | | '''Default Value(s)'' | ||
| '''Restrictions | | '''Restrictions'' | ||
| | | | ||
The name of the file to be written | | '''File Name'''<br>''(FileName)' | ||
The name of the file to be written | |||
| | | | ||
The number of ghost levels to include in the output file(s). Note | | | ||
some writers (such as ExodusIIWriter) may not support writing | | | ||
levels | | '''Ghost Level'''<br>''(GhostLevel)' | ||
The number of ghost levels to include in the output file(s). Note tha | |||
some writers (such as ExodusIIWriter) may not support writing ghos | |||
levels | |||
| | | | ||
The value must be greater than or equal to 0 | |||
| | | | ||
The input filter/source whose output dataset is to written to | | '''Input'''<br>''(Input)' | ||
file | |||
The input filter/source whose output dataset is to written to th | |||
file | |||
| | | | ||
The selected object must be the result of the following: sources (includes readers), filters | |||
The selected object must be the result of the following: sources (includes readers), filters | |||
The selected dataset must be one of the following types (or a subclass of one of them): vtkCompositeDataSet, vtkDataSet | The selected dataset must be one of the following types (or a subclass of one of them): vtkCompositeDataSet, vtkDataSet | ||
| | | | ||
When WriteAllTimeSteps is turned ON, the writer is | | '''Write All Time Steps'''<br>''(WriteAllTimeSteps)' | ||
once for each timestep available from the reader | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | |||
==MetaImageWriter= | |||
{| class="PropertiesTable" border="1" cellpadding="5 | |||
| | |||
| '''Property | Writer to write a binary UNC meta image data. This is a fairly simple <br | ||
| '''Description | yet powerful format consisting of a text header and a binary data <br | ||
| '''Default Value(s) | section. <br | ||
| '''Restrictions | MetaImage headers are expected to have extension: ".mha" or ".mhd"<br | ||
{| class="PropertiesTable" border="1" cellpadding="5 | |||
| | |||
| '''Property'' | |||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | | | ||
The name of the file to be written | | '''File Name'''<br>''(FileName)' | ||
The name of the file to be written | |||
| | | | ||
The input filter/source whose output dataset is to written to | | | ||
file | | | ||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
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= | | | ||
==PDataSetWriter= | |||
Writer to write any type of data object in a legacy vtk data file. <br | Writer to write any type of data object in a legacy vtk data file. <br | ||
This version is used when running in parallel. It gathers data to<br | This version is used when running in parallel. It gathers data to<br | ||
first node and saves 1 file.<br | first node and saves 1 file.<br | ||
{| class="PropertiesTable" border="1" cellpadding="5 | {| class="PropertiesTable" border="1" cellpadding="5 | ||
| | | | ||
The name of the file to be written | | '''Property'' | ||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | |||
| '''File Name'''<br>''(FileName)' | |||
The name of the file to be written | |||
| | | | ||
The input filter/source whose output dataset is to written to | | | ||
file | | | ||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
file | |||
| | | | ||
The selected object must be the result of the following: sources (includes readers), filters | |||
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataObject | |||
| | |||
| '''Write All Time Steps'''<br>''(WriteAllTimeSteps)' | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
| '''File Type'''<br>''(FileType)' | |||
The type for the data file (i.e. ascii or binary) | |||
| | | | ||
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<br | Writer to write image data as a PNG file. It supports 1 to 4 component<br | ||
data of unsigned char or unsigned short.<br | data of unsigned char or unsigned short.<br | ||
{| class="PropertiesTable" border="1" cellpadding="5 | {| class="PropertiesTable" border="1" cellpadding="5 | ||
| | | | ||
| '''Property'' | |||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | |||
| '''File Name'''<br>''(FileName)' | |||
The name of the file to be written | |||
| | | | ||
| | | | ||
| | | | ||
The input filter/source whose output dataset is to written to | | '''Input'''<br>''(Input)' | ||
file | |||
The input filter/source whose output dataset is to written to th | |||
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= | |||
{| class="PropertiesTable" border="1" cellpadding="5 | |||
Writer to write polygonal data in Stanford University PLY format. The <br | |||
data can be written in either binary (little or big endian) or ASCII <br | |||
representation. As for PointData and CellData, vtkPLYWriter cannot <br | |||
handle normals or vectors. It only handles RGB PointData and CellData. <br | |||
This version is used when running in parallel. It gathers data to<br | |||
first node and saves 1 file.<br | |||
{| class="PropertiesTable" border="1" cellpadding="5 | |||
| | | | ||
The name of the file to be written | | '''Property'' | ||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | |||
| '''File Name'''<br>''(FileName)' | |||
The name of the file to be written | |||
| | | | ||
The input filter/source whose output dataset is to written to | | | ||
file | | | ||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
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 | |||
| | | | ||
The type for the data file (i.e. ascii or binary) | | '''File Type'''<br>''(FileType)' | ||
The type for the data file (i.e. ascii or binary) | |||
| | |||
The value must be one of the following: Ascii (1), Binary (2) | |||
| | | | ||
==PSTLWriter= | |||
STLWriter writes stereo lithography (.stl) files in either ASCII or<br | STLWriter writes stereo lithography (.stl) files in either ASCII or<br | ||
binary form. Stereo lithography files only contain triangles. If<br | binary form. Stereo lithography files only contain triangles. If<br | ||
polygons with more than 3 vertices are present, only the first 3<br | polygons with more than 3 vertices are present, only the first 3<br | ||
vertices are written. Use TriangleFilter to convert polygons to<br | vertices are written. Use TriangleFilter to convert polygons to<br | ||
triangles. This version of the reader is used when running in<br | triangles. This version of the reader is used when running in<br | ||
parallel. It gathers all the geometry to first node and saves 1 file.<br | parallel. It gathers all the geometry to first node and saves 1 file.<br | ||
{| class="PropertiesTable" border="1" cellpadding="5 | {| class="PropertiesTable" border="1" cellpadding="5 | ||
| | | | ||
| '''Property | | '''Property'' | ||
| '''Description | | '''Description'' | ||
| '''Default Value(s) | | '''Default Value(s)'' | ||
| '''Restrictions | | '''Restrictions'' | ||
| | | | ||
The name of the file to be written | | '''File Name'''<br>''(FileName)' | ||
The name of the file to be written | |||
| | | | ||
The input filter/source whose output dataset is to written to | | | ||
file | | | ||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
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 | |||
| | | | ||
The type for the data file (i.e. ascii or binary) | | '''File Type'''<br>''(FileType)' | ||
The type for the data file (i.e. ascii or binary) | |||
| | | | ||
The value must be one of the following: Ascii (1), Binary (2) | |||
| | |||
| | |||
==XMLHierarchicalBoxDataWriter | ==XMLHierarchicalBoxDataWriter= | ||
{| class="PropertiesTable" border="1" cellpadding="5 | Writer to write a hierarchical box in a xml-based vtk data file. Can be used<br | ||
for parallel writing as well as serial writing.<br | |||
{| class="PropertiesTable" border="1" cellpadding="5 | |||
| | | | ||
The name of the file to be written | | '''Property'' | ||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | |||
| '''File Name'''<br>''(FileName)' | |||
The name of the file to be written | |||
| | | | ||
The input filter/source whose output dataset is to written to the | | | ||
| | |||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
file | |||
| | |||
The selected dataset must be one of the following types (or a subclass of one of them): vtkHierarchicalBoxDataSet | |||
| | | | ||
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)' | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
| '''Compressor Type'''<br>''(CompressorType)' | |||
The compression algorithm used to compress binary data (appended mode only) | |||
| | | | ||
The value must be one of the following: None (0), ZLib (1) | |||
| | | | ||
The | | '''Data Mode'''<br>''(DataMode)' | ||
The mode uses for writing the file's data i.e. ascii, binary, appende | |||
binary | |||
| | | | ||
The value must be one of the following: Ascii (0), Binary (1), Appended (2) | |||
| | | | ||
| '''Encode Appended Data'''<br>''(EncodeAppendedData)' | |||
When EncodeAppendedData is turned ON, the writer uses base64 encodin | |||
when writing binary data (only if appended mode is selected) | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
==XMLHyperOctreeWriter= | |||
Writer to write unstructured grid in a xml-based vtk data file. Cannot be used<br | Writer to write unstructured grid in a xml-based vtk data file. Cannot be used<br | ||
for parallel writing.<br | for parallel writing.<br | ||
{| class="PropertiesTable" border="1" cellpadding="5 | {| class="PropertiesTable" border="1" cellpadding="5 | ||
| | | | ||
| '''Property'' | |||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | |||
| '''File Name'''<br>''(FileName)' | |||
The name of the file to be written | |||
| | | | ||
| | | | ||
| | | | ||
The input filter/source whose output dataset is to written to | | '''Input'''<br>''(Input)' | ||
file | |||
The input filter/source whose output dataset is to written to th | |||
file | |||
| | | | ||
The selected dataset must be one of the following types (or a subclass of one of them): vtkHyperOctree | |||
| | | | ||
When WriteAllTimeSteps is turned ON, the writer is | | '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)' | ||
once for each timestep available from the reader | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
The compression algorithm used to compress binary data (appended mode only) | | '''Compressor Type'''<br>''(CompressorType)' | ||
The compression algorithm used to compress binary data (appended mode only) | |||
| | | | ||
The value must be one of the following: None (0), ZLib (1) | |||
| | | | ||
The mode uses for writing the file's data i.e. ascii, binary, | | '''Data Mode'''<br>''(DataMode)' | ||
binary | |||
The mode uses for writing the file's data i.e. ascii, binary, appende | |||
binary | |||
| | | | ||
The value must be one of the following: Ascii (0), Binary (1), Appended (2) | |||
| | | | ||
When EncodeAppendedData is turned ON, the writer uses base64 | | '''Encode Appended Data'''<br>''(EncodeAppendedData)' | ||
when writing binary data (only if appended mode is selected) | |||
When EncodeAppendedData is turned ON, the writer uses base64 encodin | |||
when writing binary data (only if appended mode is selected) | |||
| | |||
Only the values 0 and 1 are accepted | |||
| | | | ||
==XMLImageDataWriter= | |||
Writer to write image data in a xml-based vtk data file. Cannot be used<br | Writer to write image data in a xml-based vtk data file. Cannot be used<br | ||
for parallel writing.<br | for parallel writing.<br | ||
{| class="PropertiesTable" border="1" cellpadding="5 | {| class="PropertiesTable" border="1" cellpadding="5 | ||
| | | | ||
| '''Property | | '''Property'' | ||
| '''Description | | '''Description'' | ||
| '''Default Value(s) | | '''Default Value(s)'' | ||
| '''Restrictions | | '''Restrictions'' | ||
| | | | ||
The name of the file to be written | | '''File Name'''<br>''(FileName)' | ||
The name of the file to be written | |||
| | | | ||
The input filter/source whose output dataset is to written to | | | ||
file | | | ||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
file | |||
| | | | ||
The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData | |||
| | | | ||
When WriteAllTimeSteps is turned ON, the writer is | | '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)' | ||
once for each timestep available from the reader | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
The compression algorithm used to compress binary data (appended mode only) | | '''Compressor Type'''<br>''(CompressorType)' | ||
The compression algorithm used to compress binary data (appended mode only) | |||
| | | | ||
The value must be one of the following: None (0), ZLib (1) | |||
| | | | ||
The mode uses for writing the file's data i.e. ascii, binary, | | '''Data Mode'''<br>''(DataMode)' | ||
binary | |||
The mode uses for writing the file's data i.e. ascii, binary, appende | |||
binary | |||
| | | | ||
The value must be one of the following: Ascii (0), Binary (1), Appended (2) | |||
| | | | ||
When EncodeAppendedData is turned ON, the writer uses base64 | | '''Encode Appended Data'''<br>''(EncodeAppendedData)' | ||
when writing binary data (only if appended mode is selected) | |||
When EncodeAppendedData is turned ON, the writer uses base64 encodin | |||
when writing binary data (only if appended mode is selected) | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | |||
==XMLMultiBlockDataWriter= | |||
{| class="PropertiesTable" border="1" cellpadding="5 | |||
| | Writer to write a multiblock dataset in a xml-based vtk data file. Can be used<br | ||
| '''Property | for parallel writing as well as serial writing.<br | ||
| '''Description | |||
| '''Default Value(s) | {| class="PropertiesTable" border="1" cellpadding="5 | ||
| '''Restrictions | | | ||
| '''Property'' | |||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | | | ||
The name of the file to be written | | '''File Name'''<br>''(FileName)' | ||
The name of the file to be written | |||
| | | | ||
The input filter/source whose output dataset is to written to | | | ||
file | | | ||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
file | |||
| | | | ||
The selected dataset must be one of the following types (or a subclass of one of them): vtkMultiBlockDataSet | |||
| | |||
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)' | |||
| | |||
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)' | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
| '''Compressor Type'''<br>''(CompressorType)' | |||
The compression algorithm used to compress binary data (appended mode only) | |||
| | | | ||
The value must be one of the following: None (0), ZLib (1) | |||
| | | | ||
The | | '''Data Mode'''<br>''(DataMode)' | ||
The mode uses for writing the file's data i.e. ascii, binary, appende | |||
binary | |||
| | | | ||
The value must be one of the following: Ascii (0), Binary (1), Appended (2) | |||
| | | | ||
| '''Encode Appended Data'''<br>''(EncodeAppendedData)' | |||
When EncodeAppendedData is turned ON, the writer uses base64 encodin | |||
when writing binary data (only if appended mode is selected) | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
==XMLPImageDataWriter= | |||
Writer to write image data in a xml-based vtk data file. Can be used<br | |||
for parallel writing.<br | |||
{| class="PropertiesTable" border="1" cellpadding="5 | |||
| | |||
| '''Property'' | |||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | |||
| '''File Name'''<br>''(FileName)' | |||
The name of the file to be written | |||
| | | | ||
The | | | ||
| | |||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
file | |||
| | | | ||
The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData | |||
| | | | ||
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)' | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
| '''Compressor Type'''<br>''(CompressorType)' | |||
The compression algorithm used to compress binary data (appended mode only) | |||
| | | | ||
The value must be one of the following: None (0), ZLib (1) | |||
| | | | ||
The | | '''Data Mode'''<br>''(DataMode)' | ||
The mode uses for writing the file's data i.e. ascii, binary, appende | |||
binary | |||
| | | | ||
The value must be one of the following: Ascii (0), Binary (1), Appended (2) | |||
| | | | ||
| '''Encode Appended Data'''<br>''(EncodeAppendedData)' | |||
When EncodeAppendedData is turned ON, the writer uses base64 encodin | |||
when writing binary data (only if appended mode is selected) | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
==XMLPPolyDataWriter= | |||
Writer to write polydata in a xml-based vtk data file. Can be used<br | Writer to write polydata in a xml-based vtk data file. Can be used<br | ||
for parallel writing.<br | for parallel writing.<br | ||
{| class="PropertiesTable" border="1" cellpadding="5 | {| class="PropertiesTable" border="1" cellpadding="5 | ||
| | | | ||
The name of the file to be written | | '''Property'' | ||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | |||
| '''File Name'''<br>''(FileName)' | |||
The name of the file to be written | |||
| | | | ||
The input filter/source whose output dataset is to written to the | | | ||
| | |||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
file | |||
| | |||
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData | |||
| | | | ||
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)' | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
| '''Compressor Type'''<br>''(CompressorType)' | |||
The compression algorithm used to compress binary data (appended mode only) | |||
| | | | ||
The value must be one of the following: None (0), ZLib (1) | |||
| | | | ||
The | | '''Data Mode'''<br>''(DataMode)' | ||
The mode uses for writing the file's data i.e. ascii, binary, appende | |||
binary | |||
| | | | ||
The value must be one of the following: Ascii (0), Binary (1), Appended (2) | |||
| | | | ||
| '''Encode Appended Data'''<br>''(EncodeAppendedData)' | |||
When EncodeAppendedData is turned ON, the writer uses base64 encodin | |||
when writing binary data (only if appended mode is selected) | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
==XMLPRectilinearGridWriter= | |||
Writer to write rectilinear grid in a xml-based vtk data file. Can be used<br | Writer to write rectilinear grid in a xml-based vtk data file. Can be used<br | ||
for parallel writing.<br | for parallel writing.<br | ||
{| class="PropertiesTable" border="1" cellpadding="5 | {| class="PropertiesTable" border="1" cellpadding="5 | ||
| | | | ||
The name of the file to be written | | '''Property'' | ||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | |||
| '''File Name'''<br>''(FileName)' | |||
The name of the file to be written | |||
| | | | ||
The input filter/source whose output dataset is to written to | | | ||
file | | | ||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
file | |||
| | | | ||
The selected dataset must be one of the following types (or a subclass of one of them): vtkRectilinearGrid | |||
| | | | ||
When WriteAllTimeSteps is turned ON, the writer is | | '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)' | ||
once for each timestep available from the reader | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
The compression algorithm used to compress binary data (appended mode only) | | '''Compressor Type'''<br>''(CompressorType)' | ||
The compression algorithm used to compress binary data (appended mode only) | |||
| | |||
The value must be one of the following: None (0), ZLib (1) | |||
| | | | ||
The | | '''Data Mode'''<br>''(DataMode)' | ||
The mode uses for writing the file's data i.e. ascii, binary, appende | |||
binary | |||
| | | | ||
The value must be one of the following: Ascii (0), Binary (1), Appended (2) | |||
| | | | ||
| '''Encode Appended Data'''<br>''(EncodeAppendedData)' | |||
When EncodeAppendedData is turned ON, the writer uses base64 encodin | |||
when writing binary data (only if appended mode is selected) | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
==XMLPStructuredGridWriter= | |||
Writer to write structured grid in a xml-based vtk data file. Can be used<br | Writer to write structured grid in a xml-based vtk data file. Can be used<br | ||
for parallel writing.<br | for parallel writing.<br | ||
{| class="PropertiesTable" border="1" cellpadding="5 | {| class="PropertiesTable" border="1" cellpadding="5 | ||
| | | | ||
The name of the file to be written | | '''Property'' | ||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | |||
| '''File Name'''<br>''(FileName)' | |||
The name of the file to be written | |||
| | | | ||
The input filter/source whose output dataset is to written to | | | ||
file | | | ||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
file | |||
| | | | ||
The selected dataset must be one of the following types (or a subclass of one of them): vtkStructuredGrid | |||
| | | | ||
When WriteAllTimeSteps is turned ON, the writer is | | '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)' | ||
once for each timestep available from the reader | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
The compression algorithm used to compress binary data (appended mode only) | | '''Compressor Type'''<br>''(CompressorType)' | ||
The compression algorithm used to compress binary data (appended mode only) | |||
| | | | ||
The value must be one of the following: None (0), ZLib (1) | |||
| | | | ||
The mode uses for writing the file's data i.e. ascii, binary, | | '''Data Mode'''<br>''(DataMode)' | ||
binary | |||
The mode uses for writing the file's data i.e. ascii, binary, appende | |||
binary | |||
| | | | ||
The value must be one of the following: Ascii (0), Binary (1), Appended (2) | |||
| | | | ||
When EncodeAppendedData is turned ON, the writer uses base64 | | '''Encode Appended Data'''<br>''(EncodeAppendedData)' | ||
when writing binary data (only if appended mode is selected) | |||
When EncodeAppendedData is turned ON, the writer uses base64 encodin | |||
when writing binary data (only if appended mode is selected) | |||
| | |||
Only the values 0 and 1 are accepted | |||
| | | | ||
==XMLPUnstructuredGridWriter= | |||
Writer to write unstructured grid in a xml-based vtk data file. Can be used<br | |||
for parallel writing.<br | |||
{| class="PropertiesTable" border="1" cellpadding="5 | |||
| | |||
| '''Property'' | |||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | |||
| '''File Name'''<br>''(FileName)' | |||
The name of the file to be written | |||
| | | | ||
The | | | ||
| | |||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
file | |||
| | | | ||
The selected dataset must be one of the following types (or a subclass of one of them): vtkUnstructuredGrid | |||
| | | | ||
| '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)' | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
| '''Compressor Type'''<br>''(CompressorType)' | |||
The compression algorithm used to compress binary data (appended mode only) | |||
| | | | ||
The value must be one of the following: None (0), ZLib (1) | |||
| | | | ||
The | | '''Data Mode'''<br>''(DataMode)' | ||
The mode uses for writing the file's data i.e. ascii, binary, appende | |||
binary | |||
| | | | ||
The value must be one of the following: Ascii (0), Binary (1), Appended (2) | |||
| | | | ||
| '''Encode Appended Data'''<br>''(EncodeAppendedData)' | |||
When EncodeAppendedData is turned ON, the writer uses base64 encodin | |||
when writing binary data (only if appended mode is selected) | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
==XMLPVDWriter= | |||
Writer to write ParaView data files (pvd). It is used to save all pieces<br | Writer to write ParaView data files (pvd). It is used to save all pieces<br | ||
of a source/filter to a file with pieces spread across the server<br | of a source/filter to a file with pieces spread across the server<br | ||
processes. <br | processes. <br | ||
{| class="PropertiesTable" border="1" cellpadding="5 | {| class="PropertiesTable" border="1" cellpadding="5 | ||
| | | | ||
The compression algorithm used to compress binary data (appended mode only) | | '''Property'' | ||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | |||
| '''Compressor Type'''<br>''(CompressorType)' | |||
The compression algorithm used to compress binary data (appended mode only) | |||
| | | | ||
The value must be one of the following: None (0), ZLib (1) | |||
| | | | ||
The mode uses for writing the file's data i.e. ascii, binary, | | '''Data Mode'''<br>''(DataMode)' | ||
binary | |||
The mode uses for writing the file's data i.e. ascii, binary, appende | |||
binary | |||
| | | | ||
The value must be one of the following: Ascii (0), Binary (1), Appended (2) | |||
| | | | ||
When EncodeAppendedData is turned ON, the writer uses base64 | | '''Encode Appended Data'''<br>''(EncodeAppendedData)' | ||
when writing binary data (only if appended mode is selected) | |||
When EncodeAppendedData is turned ON, the writer uses base64 encodin | |||
when writing binary data (only if appended mode is selected) | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
The name of the file to be written | | '''File Name'''<br>''(FileName)' | ||
The name of the file to be written | |||
| | | | ||
The number of ghost levels to include in the output file(s). Note | | | ||
some writers (such as ExodusIIWriter) may not support writing | | | ||
levels | | '''Ghost Level'''<br>''(GhostLevel)' | ||
The number of ghost levels to include in the output file(s). Note tha | |||
some writers (such as ExodusIIWriter) may not support writing ghos | |||
levels | |||
| | | | ||
The value must be greater than or equal to 0 | |||
| | | | ||
The input filter/source whose output dataset is to written to | | '''Input'''<br>''(Input)' | ||
files | |||
The input filter/source whose output dataset is to written to th | |||
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= | |||
{| class="PropertiesTable" border="1" cellpadding="5 | |||
Writer to write poly data in a xml-based vtk data file. Cannot be used<br | |||
for parallel writing.<br | |||
{| class="PropertiesTable" border="1" cellpadding="5 | |||
| | | | ||
The name of the file to be written | | '''Property'' | ||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | |||
| '''File Name'''<br>''(FileName)' | |||
The name of the file to be written | |||
| | | | ||
The input filter/source whose output dataset is to written to | | | ||
file | | | ||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
file | |||
| | | | ||
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData | |||
| | | | ||
When WriteAllTimeSteps is turned ON, the writer is | | '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)' | ||
once for each timestep available from the reader | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | |||
Only the values 0 and 1 are accepted | |||
| | | | ||
| '''Compressor Type'''<br>''(CompressorType)' | |||
The compression algorithm used to compress binary data (appended mode only) | |||
| | | | ||
The value must be one of the following: None (0), ZLib (1) | |||
| | | | ||
The | | '''Data Mode'''<br>''(DataMode)' | ||
The mode uses for writing the file's data i.e. ascii, binary, appende | |||
binary | |||
| | | | ||
The value must be one of the following: Ascii (0), Binary (1), Appended (2) | |||
| | | | ||
| '''Encode Appended Data'''<br>''(EncodeAppendedData)' | |||
When EncodeAppendedData is turned ON, the writer uses base64 encodin | |||
when writing binary data (only if appended mode is selected) | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
==XMLRectilinearGridWriter= | |||
Writer to write rectilinear grid in a xml-based vtk data file. Cannot be used<br | Writer to write rectilinear grid in a xml-based vtk data file. Cannot be used<br | ||
for parallel writing.<br | for parallel writing.<br | ||
{| class="PropertiesTable" border="1" cellpadding="5 | {| class="PropertiesTable" border="1" cellpadding="5 | ||
| | | | ||
| '''Property | | '''Property'' | ||
| '''Description | | '''Description'' | ||
| '''Default Value(s) | | '''Default Value(s)'' | ||
| '''Restrictions | | '''Restrictions'' | ||
| | | | ||
The name of the file to be written | | '''File Name'''<br>''(FileName)' | ||
The name of the file to be written | |||
| | | | ||
The input filter/source whose output dataset is to written to | | | ||
file | | | ||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
file | |||
| | | | ||
The selected dataset must be one of the following types (or a subclass of one of them): vtkRectilinearGrid | |||
| | | | ||
When WriteAllTimeSteps is turned ON, the writer is | | '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)' | ||
once for each timestep available from the reader | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
The compression algorithm used to compress binary data (appended mode only) | | '''Compressor Type'''<br>''(CompressorType)' | ||
The compression algorithm used to compress binary data (appended mode only) | |||
| | | | ||
The value must be one of the following: None (0), ZLib (1) | |||
| | | | ||
The mode uses for writing the file's data i.e. ascii, binary, | | '''Data Mode'''<br>''(DataMode)' | ||
binary | |||
The mode uses for writing the file's data i.e. ascii, binary, appende | |||
binary | |||
| | | | ||
The value must be one of the following: Ascii (0), Binary (1), Appended (2) | |||
| | | | ||
When EncodeAppendedData is turned ON, the writer uses base64 | | '''Encode Appended Data'''<br>''(EncodeAppendedData)' | ||
when writing binary data (only if appended mode is selected) | |||
When EncodeAppendedData is turned ON, the writer uses base64 encodin | |||
when writing binary data (only if appended mode is selected) | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | |||
==XMLStructuredGridWriter= | |||
{| class="PropertiesTable" border="1" cellpadding="5 | |||
| | |||
| '''Property | Writer to write structured grid in a xml-based vtk data file. Cannot be used<br | ||
| '''Description | for parallel writing.<br | ||
| '''Default Value(s) | |||
| '''Restrictions | {| class="PropertiesTable" border="1" cellpadding="5 | ||
| | |||
| '''Property'' | |||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | | | ||
The name of the file to be written | | '''File Name'''<br>''(FileName)' | ||
The name of the file to be written | |||
| | | | ||
The input filter/source whose output dataset is to written to | | | ||
file | | | ||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
file | |||
| | | | ||
The selected dataset must be one of the following types (or a subclass of one of them): vtkStructuredGrid | |||
| | | | ||
When WriteAllTimeSteps is turned ON, the writer is | | '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)' | ||
once for each timestep available from the reader | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
The compression algorithm used to compress binary data (appended mode only) | | '''Compressor Type'''<br>''(CompressorType)' | ||
The compression algorithm used to compress binary data (appended mode only) | |||
| | | | ||
The value must be one of the following: None (0), ZLib (1) | |||
| | | | ||
The mode uses for writing the file's data i.e. ascii, binary, | | '''Data Mode'''<br>''(DataMode)' | ||
binary | |||
The mode uses for writing the file's data i.e. ascii, binary, appende | |||
binary | |||
| | | | ||
The value must be one of the following: Ascii (0), Binary (1), Appended (2) | |||
| | | | ||
When EncodeAppendedData is turned ON, the writer uses base64 | | '''Encode Appended Data'''<br>''(EncodeAppendedData)' | ||
when writing binary data (only if appended mode is selected) | |||
When EncodeAppendedData is turned ON, the writer uses base64 encodin | |||
when writing binary data (only if appended mode is selected) | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | |||
==XMLUnstructuredGridWriter= | |||
{| class="PropertiesTable" border="1" cellpadding="5 | |||
| | |||
| '''Property | Writer to write unstructured grid in a xml-based vtk data file. Cannot be used<br | ||
| '''Description | for parallel writing.<br | ||
| '''Default Value(s) | |||
| '''Restrictions | {| class="PropertiesTable" border="1" cellpadding="5 | ||
| | |||
| '''Property'' | |||
| '''Description'' | |||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | | | ||
The name of the file to be written | | '''File Name'''<br>''(FileName)' | ||
The name of the file to be written | |||
| | | | ||
The input filter/source whose output dataset is to written to | | | ||
file | | | ||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
file | |||
| | | | ||
The selected dataset must be one of the following types (or a subclass of one of them): vtkUnstructuredGrid | |||
| | | | ||
When WriteAllTimeSteps is turned ON, the writer is | | '''Write all timesteps as file-series'''<br>''(WriteAllTimeSteps)' | ||
once for each timestep available from the reader | |||
When WriteAllTimeSteps is turned ON, the writer is execute | |||
once for each timestep available from the reader | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
The compression algorithm used to compress binary data (appended mode only) | | '''Compressor Type'''<br>''(CompressorType)' | ||
The compression algorithm used to compress binary data (appended mode only) | |||
| | | | ||
The value must be one of the following: None (0), ZLib (1) | |||
| | |||
| '''Data Mode'''<br>''(DataMode)'' | |||
| | |||
| '''Data Mode'''<br>''(DataMode)' | |||
The mode uses for writing the file's data i.e. ascii, binary, appende | |||
binary | |||
| | | | ||
The value must be one of the following: Ascii (0), Binary (1), Appended (2) | |||
| | | | ||
| '''Encode Appended Data'''<br>''(EncodeAppendedData)' | |||
When EncodeAppendedData is turned ON, the writer uses base64 encodin | |||
when writing binary data (only if appended mode is selected) | |||
| | | | ||
Only the values 0 and 1 are accepted | |||
| | | | ||
==XdmfWriter= | |||
Writer to write data in eXtensible Data Model and Format *(XDMF) files.<br | Writer to write data in eXtensible Data Model and Format *(XDMF) files.<br | ||
{| class="PropertiesTable" border="1" cellpadding="5 | {| class="PropertiesTable" border="1" cellpadding="5 | ||
| | | | ||
The input filter/source whose output dataset is to written to | | '''Property'' | ||
file | | '''Description'' | ||
| '''Default Value(s)'' | |||
| '''Restrictions'' | |||
| | |||
| '''File Name'''<br>''(FileName)' | |||
| | |||
| | |||
| | |||
| | |||
| '''Input'''<br>''(Input)' | |||
The input filter/source whose output dataset is to written to th | |||
file | |||
| | | | ||
The selected object must be the result of the following: sources (includes readers), filters | |||
The selected object must be the result of the following: sources (includes readers), filters | |||
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet | The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet | ||
| | | |
Revision as of 15:51, 12 October 2010
=CSVWriter
Writer to write CSV files from table.<br In parallel, it delivers the table to the root node and then saves the<br CSV. For composite datasets, it saves multiple csv files.<br
'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 th file |
The selected object must be the result of the following: sources (includes readers), filters
|
Write All Time Steps (WriteAllTimeSteps)' When WriteAllTimeSteps is turned ON, the writer is execute once for each timestep available from the reader |
Only the values 0 and 1 are accepted
|
=DataSetCSVWriterWriter to write CSV files from any dataset. Set FieldAssociation to<br choose whether cell data/point data needs to be saved.<br In parallel, it delivers the table to the root node and then saves the<br CSV. For composite datasets, it saves multiple csv files.<br
|