paraview.simple.ImageReader(*input, **params)
The raw series

reader reads raw files. The output is a time sequence of uniform rectilinear (image/volume) dataset. The default file extension is .raw.

Data Descriptors


This property indicates the byte order of the binary file(s).


This property specifies the minimum and maximum index values of the data in each dimension (xmin, xmax, ymin, ymax, zmin, zmax).


The coordinate contained in this property specifies the position of the point with index (0,0,0).


The value of this property indicates the scalar type of the pixels/voxels in the file(s): short, int, float …


This property specifies the size of a voxel in each dimension.


This property indicates whether the file(s) in this dataset contain slices (2D) or volumes (3D).


This property determines whether the data originates in the lower left corner (on) or the upper left corner (off). Most scientific data is written with a right-handed axes that originates in the lower left corner. However, several 2D image file formats write the image from the upper left corner.


The list of files to be read by the reader. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step.


This property specifies the number of components the scalar value at each pixel or voxel has (e.g., RGB - 3 scalar components).


When set, the reader will read the set of files as an image stack, rather than a temporal file series.


This property contains a text string listing a name to assign to the point-centered data array read.


Available timestep values.

Data Descriptors inherited from Proxy


dictionary for instance variables (if defined)


list of weak references to the object (if defined)


Initialize = aInitialize(self, connection=None, update=True)

Methods inherited from SourceProxy


Called when the filename of a source proxy is changed.


Returns the associated cell data information.

GetDataInformation(self, idx=None)

This method returns a DataInformation wrapper around a vtkPVDataInformation


Returns the associated cell data information.


Returns the associated point data information.

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.


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.


Returns a list of all property names on this proxy.

SetPropertyWithName(self, pname, arg)

Generic method for setting the value of a property.


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

__eq__(self, other)

Returns true if the underlying SMProxies are the same.

__getattr__(self, name)

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


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.


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