Acoular 23.6 documentation

Sector

«  MergeGrid   ::   grids   ::   RectSector  »

Sector

class acoular.grids.Sector

Bases: traits.has_traits.HasPrivateTraits

Base class for sector types.

Defines the common interface for all sector classes. This class may be used as a base for diverse sector implementaions. If used directly, it implements a sector encompassing the whole grid.

include_border = Bool(True, …

Boolean flag, if ‘True’ (default), grid points lying on the sector border are included.

abs_tol = Float(1e-12, …

Absolute tolerance for sector border

default_nearest = Bool(True, …

Boolean flag, if ‘True’ (default), the nearest grid point is returned if none is inside the sector.

contains(pos)

Queries whether the coordinates in a given array lie within the defined sector. For this sector type, any position is valid.

Parameters
posarray of floats

Array with the shape 3x[number of gridpoints] containing the grid positions

Returns
array of bools with as many entries as columns in pos

Array indicating which of the given positions lie within the given sector

«  MergeGrid   ::   grids   ::   RectSector  »