Acoular 21.05 documentation

Grid

«  grids   ::   grids   ::   RectGrid  »

Grid

class acoular.grids.Grid

Bases: traits.has_traits.HasPrivateTraits

Virtual base class for grid geometries.

Defines the common interface for all grid classes and provides facilities to query grid properties and related data. This class may be used as a base for specialized grid implementaions. It should not be used directly as it contains no real functionality.

size = Property(desc="overall number of grid points")

Overall number of grid points. Readonly; is set automatically when other grid defining properties are set

shape = Property(desc="grid shape as tuple")

Shape of grid. Readonly, gives the shape as tuple, useful for cartesian grids

gpos = Property(desc="x, y, z positions of grid points")

Grid positions as (3, size) array of floats, without invalid microphones; readonly.

pos()

Calculates grid co-ordinates. Deprecated; use gpos attribute instead.

Returns
array of floats of shape (3, size)

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

subdomain(sector)

Queries the indices for a subdomain in the grid.

Allows arbitrary subdomains of type Sector

Parameters
sectorSector

Sector describing the subdomain.

Returns
2-tuple of arrays of integers or 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.

«  grids   ::   grids   ::   RectGrid  »