Base Classes

Algorithm Base

class PVGeo.base.AlgorithmBase(nInputPorts=1, inputType='vtkDataSet', nOutputPorts=1, outputType='vtkTable', **kwargs)

Bases: vtk.util.vtkAlgorithm.VTKPythonAlgorithmBase

This is a base class to add convienace methods to the VTKPythonAlgorithmBase for all algorithms implemented in PVGeo. We implement our algorithms in this manner to harness all of the backend support that the VTKPythonAlgorithmBase class provides for integrating custom algorithms on a VTK pipeline. All of the pipeline methods for setting inputs, getting outputs, making requests are handled by the super classes. For more information on what functionality is available, check out the VTK Docs for the vtkAlgorithm and then check out the following blog posts:

• vtkPythonAlgorithm is great

• A VTK pipeline primer (part 1), (part 2), and (part 3)

• ParaView Python Docs

GetOutput(port=0)

A conveience method to get the output data object of this PVGeo algorithm.

apply()

Update the algorithm and get the output data object

error_occurred()

A conveience method for handling errors on the VTK pipeline

Returns

true if an error has ovvured since last checked

Return type

bool

get_error_message()

A conveience method to print the error message.

get_output(port=0)

Alias for self.GetOutput()

update()

Alias for self.Update()

Filter Base

class PVGeo.base.FilterBase(nInputPorts=1, inputType='vtkDataSet', nOutputPorts=1, outputType='vtkPolyData', **kwargs)

Bases: PVGeo.base.AlgorithmBase

A base class for implementing filters which holds several convienace methods

apply(input_data_object)

Run this algorithm on the given input dataset

Filter Preserve Type Base

class PVGeo.base.FilterPreserveTypeBase(nInputPorts=1, **kwargs)

Bases: PVGeo.base.FilterBase

A Base class for implementing filters that preserve the data type of their arbitrary input.

RequestDataObject(request, inInfo, outInfo)

There is no need to overwrite this. This method lets the pipeline know that the algorithm will dynamically decide the output data type based in the input data type.

Interfaced Base Reader

class PVGeo.base.InterfacedBaseReader(**kwargs)

Bases: PVGeo.base.ReaderBase

A general base reader for all interfacing with librarues that already have file I/O methods and VTK data object interfaces. This provides a routine for using an external library to handle all I/O and produce the VTK data objects.

RequestData(request, inInfo, outInfo)

Do not override. Used by pipeline to get data for current timestep and populate the output data object.

RequestDataObject(request, inInfo, outInfo)

Do not override. This method lets the us dynamically decide the output data type based in the read meshes. Note: they all have to be the same VTK type.

RequestInformation(request, inInfo, outInfo)

Do not override. Used by pipeline to set extents and time info.

_get_object_at_index(idx=None)

Internal helper to get the data object at the specified index

static _get_vtk_object(obj)

OVERRIDE: Given an object in the interfaced library’s type, return a converted VTK data object.

static _read_file(filename)

OVERRIDE: Reads from the the libraries format and returns an object in the given library’s format.

_read_up_front()

Do not override. A predifiened routine for reading the files up front.

Reader Base: Time Varying

class PVGeo.base.ReaderBase(nOutputPorts=1, outputType='vtkTable', **kwargs)

Bases: PVGeo.base.ReaderBaseBase

A base class for inherrited functionality common to all reader algorithms that need to handle a time series.

RequestInformation(request, inInfo, outInfo)

This is a conveience method that should be overwritten when needed. This will handle setting the timesteps appropriately based on the number of file names when the pipeline needs to know the time information.

_update_time_steps()

For internal use only: appropriately sets the timesteps.

get_time_step_values()

Use this in ParaView decorator to register timesteps on the pipeline.

set_time_delta(dt)

An advanced property to set the time step in seconds.

Reader Base Base

class PVGeo.base.ReaderBaseBase(nOutputPorts=1, outputType='vtkTable', **kwargs)

Bases: PVGeo.base.AlgorithmBase

A base class for inherrited functionality common to all reader algorithms

AddFileName(filename)

Use to set the file names for the reader. Handles singlt string or list of strings.

Parameters

filename (str) – The absolute file name with path to read.

Modified(read_again=True)

Call modified if the files needs to be read again again

_get_file_contents(idx=None)

_get_raw_data(idx=0)

_read_up_front()

add_file_name(filename)

Use to set the file names for the reader. Handles singlt string or list of strings.

Parameters

filename (str) – The absolute file name with path to read.

apply(filename)

Given a file name (or list of file names), perfrom the read

clear_file_names()

Use to clear file names of the reader.

Note

This does not set the reader to need to read again as there are no files to read.

get_file_names(idx=None)

Returns the list of file names or given and index returns a specified timestep’s filename.

modified(read_again=True)

need_to_read(flag=None)

Ask self if the reader needs to read the files again.

Parameters

flag (bool) – Set the read status

Returns

the status of the reader.

Return type

bool

Two File Reader Base

class PVGeo.base.TwoFileReaderBase(nOutputPorts=1, outputType='vtkUnstructuredGrid', **kwargs)

Bases: PVGeo.base.AlgorithmBase

A base clase for readers that need to handle two input files. One meta-data file and a series of data files.

Modified(read_again_mesh=True, read_again_models=True)

Call modified if the files needs to be read again again

Parameters

• read_again_mesh (bool) – set the status of the reader for mesh files.

• read_again_models (bool) – set the status of the reader for model files.

RequestInformation(request, inInfo, outInfo)

Used by pipeline to handle setting up time variance

_TwoFileReaderBase__update_time_steps()

For internal use only

add_model_file_name(filename)

Use to set the file names for the reader. Handles single string or list of strings.

Parameters

filename (str or list(str)) – the file name(s) to use for the model data.

apply()

Perfrom the read with parameters/file names set during init or by setters

clear_mesh()

Use to clear mesh file name

clear_models()

Use to clear data file names

get_mesh_filename()

Get the mesh filename

get_model_filenames(idx=None)

Returns the list of file names or given and index returns a specified timestep’s filename.

get_time_step_values()

Use this in ParaView decorator to register timesteps

static has_models(model_files)

A convienance method to see if a list contatins models filenames.

modified(read_again_mesh=True, read_again_models=True)

need_to_readMesh(flag=None)

Ask self if the reader needs to read the mesh file again.

Parameters

flag (bool) – set the status of the reader for mesh files.

need_to_readModels(flag=None)

Ask self if the reader needs to read the model files again.

Parameters

flag (bool) – set the status of the reader for model files.

set_mesh_filename(filename)

Set the mesh file name.

set_time_delta(dt)

An advanced property for the time step in seconds.

this_has_models()

Ask self if the reader has model filenames set.

Writer Base

class PVGeo.base.WriterBase(nInputPorts=1, inputType='vtkPolyData', **kwargs)

Bases: PVGeo.base.AlgorithmBase

FillInputPortInformation(port, info)

Allows us to save composite datasets as well.

Note

I only care about vtkMultiBlockDataSet

RequestData(request, inInfo, outInfo)

Subclasses must implement a perform_write_out method that takes an input data object and a filename. This method will automatically handle composite data sets.

SetFileName(filename)

Specify the filename for the output. Writer can only handle a single output data object/time step.

Write(input_data_object=None)

Perfrom the write out.

apply(input_data_object)

Run this writer algorithm on the given input data object

get_block_filename(idx)

Get filename for component of a multi block dataset

get_file_name()

Get the set filename.

get_format()

Get the ASCII format used for floats

perform_write_out(input_data_object, filename, object_name)

This method must be implemented. This is automatically called by RequestData for single inputs or composite inputs.

set_block_filenames(n)

Gets a list of filenames based on user input filename and creates a numbered list of filenames for the reader to save out. Assumes the filename has an extension set already.

set_file_name(filename)

Specify the filename for the output. Writer can only handle a single output data object/time step.

set_format(fmt)

Use to set the ASCII format for the writer default is '%.9e'

use_composite()

True if input dataset is a composite dataset

write(input_data_object=None)