4. gridData.core — Core functionality for storing n-D grids

The core module contains classes and functions that are independent of the grid data format. In particular this module contains the Grid class that acts as a universal constructor for specific formats:

g = Grid(**kwargs)           # construct
g.export(filename, format)   # export to the desired format

Some formats can also be read:

g = Grid()                   # make an empty Grid
g.load(filename)             # populate with data from filename

4.1. Classes and functions

class gridData.core.Grid(grid=None, edges=None, origin=None, delta=None, metadata={}, interpolation_spline_order=3)[source]

Class to manage a multidimensional grid object.

The export(format=’dx’) method always exports a 3D object, the rest should work for an array of any dimension.

The grid (Grid.grid) can be manipulated as a standard numpy array.

The attribute Grid.metadata holds a user-defined dictionary that can be used to annotate the data. It is saved with save().


Returns the coordinates of the centers of all grid cells as an iterator.


Check if other can be used in an arithmetic operation.

  1. other is a scalar
  2. other is a grid defined on the same edges
Raises:TypeError if not compatible.
export(filename, file_format=None)[source]

export density to file using the given format.

The format can also be deduced from the suffix of the filename though the format keyword takes precedence.

The default format for export() is ‘dx’. Use ‘dx’ for visualization.

Implemented formats:

pickle (use :meth:Grid.load` to restore); :meth:`Grid.save` is simpler than ``export(format='python').

B-spline function over the data grid(x,y,z).

interpolated([x1,x2,...],[y1,y2,...],[z1,z2,...]) -> F[x1,y1,z1],F[x2,y2,z2],...

The interpolation order is set in Grid.interpolation_spline_order.

The interpolated function is computed once and is cached for better performance. Whenever interpolation_spline_order is modified, Grid.interpolated() is recomputed.

The value for unknown data is set in Grid.interpolation_cval (TODO: also recompute when interpolation_cval value is changed.)

Example usage for resampling::
>>> XX,YY,ZZ = numpy.mgrid[40:75:0.5, 96:150:0.5, 20:50:0.5]
>>> FF = interpolated(XX,YY,ZZ)
load(filename, file_format=None)[source]

Load saved (pickled or dx) grid and edges from <filename>.pickle

Grid.load(<filename>.pickle) Grid.load(<filename>.dx)

The load() method calls the class’s constructor method and completely resets all values, based on the loaded data.


Resample data to a new grid with edges edges.

resample(edges) –> Grid


resample(otherGrid) –> Grid

The order of the interpolation is set by Grid.interpolation_spline_order.


Resample to a new regular grid with factor*oldN cells along each dimension.


Save a grid object to <filename>.pickle


Internally, this calls Grid.export(filename,format=”python”). A grid can be regenerated from the saved data with

g = Grid(filename=<filename>)

Return a mesh grid for N dimensions.

The input are N arrays, each of which contains the values along one axis of the coordinate system. The arrays do not have to have the same number of entries. The function returns arrays that can be fed into numpy functions so that they produce values for all points spanned by the axes arrs.

Original from http://stackoverflow.com/questions/1827489/numpy-meshgrid-in-3d and fixed.