Acoular 16.5 documentation

RectGrid3D

«  RectGrid   ::   grids   ::   microphones  »

RectGrid3D

class acoular.grids.RectGrid3D

Bases: acoular.grids.RectGrid

Provides a cartesian 3D grid for the beamforming results.

The grid has cubic or nearly cubic cells. It is defined by lower and upper x-, y- and z-limits.

z_min = Float(-1.0, desc="minimum z-value")

The lower z-limit that defines the grid, defaults to -1.

z_max = Float(1.0, desc="maximum z-value")

The upper z-limit that defines the grid, defaults to 1.

nzsteps = Property( desc="number of grid points alog x-axis")

Number of grid points along x-axis, readonly.

increment3D = CArray( dtype=float, shape=(3, ), desc="3D step sizes")

Respective increments in x,y, and z-direction (in m), defaults to increment for all three (whichever of the two increment parameters is set last replaces the other).

pos()

Calculates grid co-ordinates.

Returns:

array of floats of shape (3, size)

The grid point x, y, z-coordinates in one array.

index(x, y, z)

Queries the indices for a grid point near a certain co-ordinate.

This can be used to query results or co-ordinates at/near a certain co-ordinate.

Parameters:

x, y, z : float

The co-ordinates for which the indices is queried.

Returns:

3-tuple of integers

The indices that give the grid point nearest to the given x, y, z co-ordinates from an array with the same shape as the grid.

indices(x1, y1, z1, x2, y2, z2)

Queries the indices for a subdomain in the grid.

Allows box-shaped subdomains. This can be used to mask or to query results from a certain sector or subdomain.

Parameters:

x1, y1, z1, x2, y2, z2 : float

A box-shaped sector is assumed that is given by two corners (x1,y1,z1) and (x2,y2,z2).

Returns:

3-tuple of numpy slice objects

The indices that can be used to mask/select the grid subdomain from an array with the same shape as the grid.

«  RectGrid   ::   grids   ::   microphones  »