paraview.simple.__init__.VTKHDFWriter

paraview.simple.__init__.VTKHDFWriter(*input, **params)

The VTKHDF Writer writes files in VTKHDF format, using extension .vtkhdf, a format derived from HDF5. Currently, it supports writing Unstructured Grid and PolyData datasets, possibly transient, as well as composite types Partitioned Dataset Collection and Multiblock Dataset, without transient support.

Data Descriptors

ChunkSize

Chunk Size controls the size of HDF5 datasets chunks. Chunk size can impact multi-process reading performance and compression efficiency.

CompressionLevel

Compression level controls how much user wants to compress the written data. Using a higher level of compression will decrease file size but significantly slow down read and write operations.

FileName

The name of the file to be written.

Input

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

SplitByComposite

Write each composite leaf blocks in their own file. Each file can be opened independently and top level files points to lower level files. Only applies to vtkPartitionedDataSetCollection and vtkMultiBlockDataSet inputs.

SplitByPartitions

Write each individual partitions and composite leaf blocks in their own file. Each file can be opened independently and top level files points to lower level files. Turning this on implies turning UseExternalComposite on. Only applies to vtkPartitionedDataSet and its inheriting classes as well as composite data containing such data.

SplitByTimeSteps

Write each time step data in their own file, referenced by the main file to form a time-varying dataset.

WriteAllTimeSteps

When WriteAllTimeSteps is turned ON, the writer writes every available timestep to file. Otherwise, only the current timestep is written.

Data Descriptors inherited from Proxy

__dict__

dictionary for instance variables

__weakref__

list of weak references to the object

Methods

Initialize = aInitialize(self, connection=None, update=True) from paraview.servermanager._createInitialize.<locals>

Methods inherited from SourceProxy

FileNameChanged(self)

Called when the filename of a source proxy is changed.

GetCellDataInformation(self)

Returns the associated cell data information.

GetDataInformation(self, idx=None)

This method returns a DataInformation wrapper around a vtkPVDataInformation

GetFieldDataInformation(self)

Returns the associated cell data information.

GetInformation(self)

GetPointDataInformation(self)

Returns the associated point data information.

Rename(self, new_name)

Rename proxy in GUI

UpdatePipeline(self, time=None)

This method updates the server-side VTK pipeline and the associated data information. Make sure to update a source to validate the output meta-data.

UpdatePipelineInformation(self)

This method updates the meta-data of the server-side VTK pipeline and the associated information properties

__getitem__(self, idx)

Given a slice, int or string, returns the corresponding output port

Methods inherited from Proxy

GetProperty(self, name)

Given a property name, returns the property object.

GetPropertyValue(self, name)

Returns a scalar for properties with 1 elements, the property itself for vectors.

InitializeFromProxy(self, aProxy, update=True)

Constructor. Assigns proxy to self.SMProxy, updates the server object as well as register the proxy in _pyproxies dictionary.

ListProperties(self)

Returns a list of all property names on this proxy.

Set(self, **properties)

Update a set of properties using a keyword argument notation

SetPropertyWithName(self, pname, arg)

Generic method for setting the value of a property.

__del__(self)

Destructor. Cleans up all observers as well as remove the proxy from the _pyproxies dictionary

__enter__(self)

Activate proxy if possible

__eq__(self, other)

Returns true if the underlying SMProxies are the same.

__exit__(self, exc_type, exc_value, traceback)

Revert previously activated proxy

__getattr__(self, name)

With the exception of a few overloaded methods, returns the SMProxy method

__hash__(self)

Return hash(self).

__init__(self, **args)

Default constructor. It can be used to initialize properties by passing keyword arguments where the key is the name of the property. In addition registrationGroup and registrationName (optional) can be specified (as keyword arguments) to automatically register the proxy with the proxy manager.

__iter__(self)

Creates an iterator for the properties.

__ne__(self, other)

Returns false if the underlying SMProxies are the same.

__setattr__(self, name, value)

Implement setattr(self, name, value).

add_attribute(self, name, value)

For the full list of servermanager proxies, please refer to Available readers, sources, writers, filters and animation cues