acoular 24.5__py3-none-any.whl → 24.10__py3-none-any.whl

acoular/environments.py

@@ -43,9 +43,9 @@ from numpy import (
     vstack,
     zeros_like,
 )
-from numpy.linalg.linalg import norm
 from scipy.integrate import ode
 from scipy.interpolate import LinearNDInterpolator
+from scipy.linalg import norm
 from scipy.spatial import ConvexHull
 from traits.api import CArray, Dict, Float, HasPrivateTraits, Int, Property, Trait, cached_property
 
@@ -85,7 +85,7 @@ def dist_mat(gpos, mpos):
     return rm
 
 
-def cartToCyl(x, Q=None):
+def cartToCyl(x, Q=None):  # noqa: N802, N803
     """Returns the cylindrical coordinate representation of a input position
     which was before transformed into a modified cartesian coordinate, which
     has flow into positive z direction.
@@ -111,7 +111,7 @@ def cartToCyl(x, Q=None):
     return array([arctan2(x[1], x[0]), sqrt(x[0] ** 2 + x[1] ** 2), x[2]])
 
 
-def cylToCart(x, Q=None):
+def cylToCart(x, Q=None):  # noqa: N802, N803
     """Returns the cartesian coordinate representation of a input position
     which was before transformed into a cylindrical coordinate, which
     has flow into positive z direction.
@@ -283,8 +283,9 @@ class FlowField(HasPrivateTraits):
 
 
 class SlotJet(FlowField):
-    """Provides an analytical approximation of the flow field of a slot jet,
-    see :ref:`Albertson et al., 1950<Albertson1950>`.
+    """Provides an analytical approximation of the flow field of a slot jet.
+
+    See :cite:`Albertson1950` for details.
     """
 
     #: Exit velocity at jet origin, i.e. the nozzle. Defaults to 0.
@@ -303,9 +304,12 @@ class SlotJet(FlowField):
     #: Width of the slot, defaults to 0.2 .
     B = Float(0.2, desc='nozzle diameter')
 
+    #: Nondimensional length of zone of flow establishment (jet core length), defaults to 5.2
+    l = Float(5.2, desc='flow establishment length')  # noqa: E741
+
     # internal identifier
     digest = Property(
-        depends_on=['v0', 'origin', 'flow', 'plane', 'B'],
+        depends_on=['v0', 'origin', 'flow', 'plane', 'B', 'l'],
     )
 
     @cached_property
@@ -330,7 +334,6 @@ class SlotJet(FlowField):
             given location.
 
         """
-        # TODO: better to make sure that self.flow and self.plane are indeed unit vectors before
         # normalize
         flow = self.flow / norm(self.flow)
         plane = self.plane / norm(self.plane)
@@ -342,7 +345,7 @@ class SlotJet(FlowField):
         # local co-ordinate system
         x = dot(flow, xx1)
         y = dot(yy, xx1)
-        x1 = 0.109 * x
+        x1 = 0.5668 / self.l * x  # C1 in Albertson1950
         h1 = abs(y) + sqrt(pi) * 0.5 * x1 - 0.5 * self.B
         if h1 < 0.0:
             # core jet
@@ -362,8 +365,9 @@ class SlotJet(FlowField):
 
 
 class OpenJet(FlowField):
-    """Provides an analytical approximation of the flow field of an open jet,
-    see :ref:`Albertson et al., 1950<Albertson1950>`.
+    """Provides an analytical approximation of the flow field of an open jet.
+
+    See :cite:`Albertson1950` for details.
 
     Notes
     -----
@@ -382,9 +386,12 @@ class OpenJet(FlowField):
     #: Diameter of the nozzle, defaults to 0.2 .
     D = Float(0.2, desc='nozzle diameter')
 
+    #: Nondimensional length of zone of flow establishment (jet core length), defaults to 6.2
+    l = Float(6.2, desc='flow establishment length')  # noqa: E741
+
     # internal identifier
     digest = Property(
-        depends_on=['v0', 'origin', 'D'],
+        depends_on=['v0', 'origin', 'D', 'l'],
     )
 
     @cached_property
@@ -411,7 +418,7 @@ class OpenJet(FlowField):
         """
         x, y, z = xx - self.origin
         r = sqrt(y * y + z * z)
-        x1 = 0.081 * x
+        x1 = 0.5022 / self.l * x  # C2 in Albertson1950
         h1 = r + x1 - 0.5 * self.D
         U = self.v0 * exp(-h1 * h1 / (2 * x1 * x1))
         if h1 < 0.0:
@@ -497,7 +504,7 @@ class RotatingFlow(FlowField):
         return v, dv
 
 
-def spiral_sphere(N, Om=None, b=None):  # change to 4*pi
+def spiral_sphere(N, Om=None, b=None):  # noqa: N803 # change to 4*pi
     """Internal helper function for the raycasting that returns an array of
     unit vectors (N, 3) giving equally distributed directions on a part of
     sphere given by the center direction b and the solid angle Om.
@@ -589,8 +596,6 @@ class GeneralFlowEnvironment(Environment):
         gt = empty((gpos.shape[-1], mpos.shape[-1]))
         for micnum, x0 in enumerate(mpos.T):
             key = x0.tobytes()  # make array hashable
-            # TODO: the interpolator also depends the roi, so idict keys should also depend on roi
-            # OR the idict should be cleaned if roi changes
             try:
                 li = self.idict[key]  # fetch stored interpolator
             except KeyError:

acoular/fastFuncs.py

@@ -8,9 +8,9 @@ computational costs. All functionalities are optimized via NUMBA.
 import numba as nb
 import numpy as np
 
-cachedOption = True  # if True: saves the numba func as compiled func in sub directory
-parallelOption = 'parallel'  # if numba.guvectorize is used: 'CPU' for single threading; 'parallel' for multithreading; 'cuda' for calculating on GPU
-fastOption = True  # fastmath options
+CACHED_OPTION = True  # if True: saves the numba func as compiled func in sub directory
+PARALLEL_OPTION = 'parallel'  # if numba.guvectorize is used: 'CPU' for single threading; 'parallel' for multithreading; 'cuda' for calculating on GPU
+FAST_OPTION = True  # fastmath options
 
 
 # Formerly known as 'faverage'
@@ -19,9 +19,9 @@ fastOption = True  # fastmath options
         nb.complex128[:, :, ::1](nb.complex128[:, :, ::1], nb.complex128[:, ::1]),
         nb.complex64[:, :, ::1](nb.complex64[:, :, ::1], nb.complex64[:, ::1]),
     ],
-    cache=cachedOption,
+    cache=CACHED_OPTION,
     parallel=True,
-    fastmath=fastOption,
+    fastmath=FAST_OPTION,
 )
 def calcCSM(csm, SpecAllMics):
     """Adds a given spectrum to the Cross-Spectral-Matrix (CSM).
@@ -216,7 +216,7 @@ def beamformerFreq(steerVecType, boolRemovedDiagOfCSM, normFactor, inputTupleSte
             nb.float64[::1],
         ),
     ],
-    cache=cachedOption,
+    cache=CACHED_OPTION,
     parallel=True,
     error_model='numpy',
 )
@@ -306,7 +306,7 @@ def _freqBeamformer_FullCSM(
             nb.float64[::1],
         ),
     ],
-    cache=cachedOption,
+    cache=CACHED_OPTION,
     parallel=True,
     error_model='numpy',
 )
@@ -389,9 +389,9 @@ def _freqBeamformer_EigValues(
     [(nb.complex128[:, :], nb.complex128[:], nb.float64[:], nb.float64[:], nb.float64[:])],
     '(m,m),(m),()->(),()',
     nopython=True,
-    target=parallelOption,
-    cache=cachedOption,
-    fastmath=fastOption,
+    target=PARALLEL_OPTION,
+    cache=CACHED_OPTION,
+    fastmath=FAST_OPTION,
 )
 def _freqBeamformer_SpecificSteerVec_FullCSM(csm, steerVec, signalLossNormalization, result, normalizeSteer):
     # see bottom of information header of 'beamformerFreq' for information on which steps are taken, in order to gain speed improvements.
@@ -419,9 +419,9 @@ def _freqBeamformer_SpecificSteerVec_FullCSM(csm, steerVec, signalLossNormalizat
     [(nb.complex128[:, :], nb.complex128[:], nb.float64[:], nb.float64[:], nb.float64[:])],
     '(m,m),(m),()->(),()',
     nopython=True,
-    target=parallelOption,
-    cache=cachedOption,
-    fastmath=fastOption,
+    target=PARALLEL_OPTION,
+    cache=CACHED_OPTION,
+    fastmath=FAST_OPTION,
 )
 def _freqBeamformer_SpecificSteerVec_CsmRemovedDiag(csm, steerVec, signalLossNormalization, result, normalizeSteer):
     # see bottom of information header of 'beamformerFreq' for information on which steps are taken, in order to gain speed improvements.
@@ -446,9 +446,9 @@ def _freqBeamformer_SpecificSteerVec_CsmRemovedDiag(csm, steerVec, signalLossNor
     [(nb.float64[:], nb.complex128[:, :], nb.complex128[:], nb.float64[:], nb.float64[:], nb.float64[:])],
     '(e),(m,e),(m),()->(),()',
     nopython=True,
-    target=parallelOption,
-    cache=cachedOption,
-    fastmath=fastOption,
+    target=PARALLEL_OPTION,
+    cache=CACHED_OPTION,
+    fastmath=FAST_OPTION,
 )
 def _freqBeamformer_EigValProb_SpecificSteerVec_FullCSM(
     eigVal,
@@ -482,9 +482,9 @@ def _freqBeamformer_EigValProb_SpecificSteerVec_FullCSM(
     [(nb.float64[:], nb.complex128[:, :], nb.complex128[:], nb.float64[:], nb.float64[:], nb.float64[:])],
     '(e),(m,e),(m),()->(),()',
     nopython=True,
-    target=parallelOption,
-    cache=cachedOption,
-    fastmath=fastOption,
+    target=PARALLEL_OPTION,
+    cache=CACHED_OPTION,
+    fastmath=FAST_OPTION,
 )
 def _freqBeamformer_EigValProb_SpecificSteerVec_CsmRemovedDiag(
     eigVal,
@@ -599,12 +599,12 @@ def calcPointSpreadFunction(steerVecType, distGridToArrayCenter, distGridToAllMi
     ],
     '(),(m),(s),(s,m),()->(s)',
     nopython=True,
-    target=parallelOption,
-    cache=cachedOption,
-    fastmath=fastOption,
+    target=PARALLEL_OPTION,
+    cache=CACHED_OPTION,
+    fastmath=FAST_OPTION,
 )
 def _psf_Formulation1AkaClassic(
-    distGridToArrayCenter,
+    distGridToArrayCenter,  # noqa ARG001
     distGridToAllMics,
     distSourcesToArrayCenter,
     distSourcesToAllMics,
@@ -632,9 +632,9 @@ def _psf_Formulation1AkaClassic(
     ],
     '(),(m),(s),(s,m),()->(s)',
     nopython=True,
-    target=parallelOption,
-    cache=cachedOption,
-    fastmath=fastOption,
+    target=PARALLEL_OPTION,
+    cache=CACHED_OPTION,
+    fastmath=FAST_OPTION,
 )
 def _psf_Formulation2AkaInverse(
     distGridToArrayCenter,
@@ -669,9 +669,9 @@ def _psf_Formulation2AkaInverse(
     ],
     '(),(m),(s),(s,m),()->(s)',
     nopython=True,
-    target=parallelOption,
-    cache=cachedOption,
-    fastmath=fastOption,
+    target=PARALLEL_OPTION,
+    cache=CACHED_OPTION,
+    fastmath=FAST_OPTION,
 )
 def _psf_Formulation3AkaTrueLevel(
     distGridToArrayCenter,
@@ -708,12 +708,12 @@ def _psf_Formulation3AkaTrueLevel(
     ],
     '(),(m),(s),(s,m),()->(s)',
     nopython=True,
-    target=parallelOption,
-    cache=cachedOption,
-    fastmath=fastOption,
+    target=PARALLEL_OPTION,
+    cache=CACHED_OPTION,
+    fastmath=FAST_OPTION,
 )
 def _psf_Formulation4AkaTrueLocation(
-    distGridToArrayCenter,
+    distGridToArrayCenter,  # noqa ARG001
     distGridToAllMics,
     distSourcesToArrayCenter,
     distSourcesToAllMics,
@@ -743,7 +743,7 @@ def _psf_Formulation4AkaTrueLocation(
 # CURRENTLY NOT NEEDED, AS CUSTOM PSF WILL BE CALCULATED IN fbeamform.SteeringVector WITH THE USE OF Trait transfer
 # @nb.guvectorize([(nb.float64[:], nb.float64[:], nb.float64[:], nb.float64[:,:], nb.float64[:], nb.float64[:]),
 #                 (nb.float64[:], nb.float64[:], nb.float64[:], nb.float64[:,:], nb.float64[:], nb.float32[:])],
-#                 '(),(m),(s),(s,m),()->(s)', nopython=True, target=parallelOption, cache=cachedOption)
+#                 '(),(m),(s),(s,m),()->(s)', nopython=True, target=PARALLEL_OPTION, cache=CACHED_OPTION)
 # def _psf_SpecificSteerVec(steerVec, steerVecSources, result):
 #    nMics = len(steerVec)
 #    for cntSources in range(steerVecSources.shape[0]):
@@ -765,9 +765,9 @@ def _psf_Formulation4AkaTrueLocation(
     ],
     '(g,g),(g),(),()->(g)',
     nopython=True,
-    target=parallelOption,
-    cache=cachedOption,
-    fastmath=fastOption,
+    target=PARALLEL_OPTION,
+    cache=CACHED_OPTION,
+    fastmath=FAST_OPTION,
 )
 def damasSolverGaussSeidel(A, dirtyMap, nIterations, relax, damasSolution):
     """Solves the DAMAS inverse problem via modified gauss seidel.
@@ -847,9 +847,9 @@ def calcTransfer(distGridToArrayCenter, distGridToAllMics, waveNumber):
     [(nb.float64[:], nb.float64[:], nb.float64[:], nb.complex128[:])],
     '(),(m),()->(m)',
     nopython=True,
-    target=parallelOption,
-    cache=cachedOption,
-    fastmath=fastOption,
+    target=PARALLEL_OPTION,
+    cache=CACHED_OPTION,
+    fastmath=FAST_OPTION,
 )
 def _transferCoreFunc(distGridToArrayCenter, distGridToAllMics, waveNumber, result):
     nMics = distGridToAllMics.shape[0]