paraview.simple.CSVReader

paraview.simple.CSVReader(*input, **params)

The CSV

reader reads a Delimited Text values file into a 1D rectilinear grid. If the file was saved using the CSVWriter, then the rectilinear grid’s points and point data can be restored as well as the cell data. Otherwise all the data in the CSV file is treated as cell data. The default file extension is .csv as well as .txt. This can read file series as well.

Data Descriptors

AddTabFieldDelimiter

This property indicates whether to add the tab character as a field delimiter to the list of other delimiter characters. This is needed since in the GUI the user can’t enter a tab character.

DetectNumericColumns

When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray.

FieldDelimiterCharacters

This property lists the characters that may be used to separate fields. For example, a value of “,” indicates a comma-separated value file. A value of “.:;” indicates that columns may be separated by a period, colon or semicolon. The order of the characters in the text string does not matter.

FileName

The list of files to be read by the reader. Each file is expected to be a csv file. 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.

HaveHeaders

If the value of this property is 1, treat the first line of the file as headers.

MergeConsecutiveDelimiters

Whether to merge successive delimiters. Use this if (for example) your fields are separated by spaces but you don’t know exactly how many.

TimestepValues

Available timestep values.

UseStringDelimiter

This property indicates whether to use the string delimiter.

Data Descriptors inherited from Proxy

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

Methods

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

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.

GetPointDataInformation(self)

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.

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.

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

__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

__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