Base Classes

These provide base classes to simplify making new classes.

netCDF Points Reader Base

class pvgeohdf.base.netCDFPointsReaderBase(nOutputPorts=1, outputType='vtkPolyData', **kwargs)

Bases: pvgeohdf.base.netCDFReaderBase

netCDFPointsReaderBase: for netCDF files that will produce a point+attribute dataset.

RequestData(request, inInfo, outInfo)

Used by pipeline to get data for current timestep and populate the output data object. This assumes that self._get_raw_data() will return a dataset ready for PVGeo’s interface.points_to_poly_data().

net CDF Reader Base

class pvgeohdf.base.netCDFReaderBase(nOutputPorts=1, outputType='vtkPolyData', **kwargs)

Bases: PVGeo.base.ReaderBaseBase

RequestData(request, inInfo, outInfo)

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

RequestInformation(request, inInfo, outInfo)

This will handle setting the timesteps appropriately based on the number of file names when the pipeline needs to know the time information.

_get_file_contents(idx=None)

This opens a netCDF4 DataSet. This happens up front so the data read happens only once and ParaView will be able to make calls on the RequestData method to get the data for a specific timestep

_get_raw_data(idx=0)

Get the data as the called for data object. Return type depends on higher level API.

Parameters:idx (int) – the timestep index

_read_up_front()

OVERRIDE: This parses the loaded dataset.

_update_time_steps()

For internal use only: appropriately sets the timesteps.

extensions = 'nc netCDF netcdf'

get_file_name()

Super class has file names as a list but we will only handle a single netCDF file. This provides a conveinant way of making sure we only access that single file. A user could still access the list of file names using GetFileNames().

get_time_step_values()

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