Stub documentation

docs/source/core.rst

@@ -0,0 +1 @@
+.. automodule:: zounds.core

docs/source/spectral.rst

@@ -0,0 +1 @@
+.. automodule:: zounds.spectral

zounds/__init__.py

@@ -22,7 +22,7 @@
     FrequencyAdaptiveTransform, ExplicitScale, ExplicitFrequencyDimension, \
     FrequencyAdaptive
 
-from loudness import log_modulus, inverse_log_modulus, decibel
+from loudness import log_modulus, inverse_log_modulus, decibel, mu_law, MuLaw
 
 from segment import MeasureOfTransience, MovingAveragePeakPicker, \
     ComplexDomain, TimeSliceFeature

zounds/core/__init__.py

@@ -1,2 +1,13 @@
+"""
+Core
+====
+
+Here is some text about core.
+
+.. autoclass:: ArrayWithUnits
+"""
+
 from dimensions import Dimension, IdentityDimension
 from axis import ArrayWithUnits
+
+__all__ = [Dimension, IdentityDimension, ArrayWithUnits]

zounds/core/axis.py

@@ -11,6 +11,10 @@ def __init__(self):
 
 
 class ArrayWithUnits(np.ndarray):
+    """
+    Here is documentation for ArrayWithUnits
+    """
+
     def __new__(cls, arr, dimensions):
         if arr.ndim != len(dimensions):
             raise ValueError(

zounds/loudness/__init__.py

@@ -1 +1 @@
-from loudness import log_modulus, inverse_log_modulus, decibel
+from loudness import log_modulus, inverse_log_modulus, decibel, mu_law, MuLaw

zounds/loudness/loudness.py

@@ -1,4 +1,5 @@
 import numpy as np
+from featureflow import Node
 
 
 def log_modulus(x):
@@ -11,3 +12,17 @@ def inverse_log_modulus(x):
 
 def decibel(x):
     return 20 * np.log10(x)
+
+
+def mu_law(x, mu=255):
+    s = np.sign(x)
+    return s * (np.log(1 + (mu * np.abs(x))) / np.log(1 + mu))
+
+
+class MuLaw(Node):
+    def __init__(self, mu=255, needs=None):
+        super(MuLaw, self).__init__(needs=needs)
+        self.mu = mu
+
+    def _process(self, data):
+        yield mu_law(data, mu=self.mu)

zounds/spectral/__init__.py

@@ -1,3 +1,17 @@
+"""
+Spectral
+========
+
+Welcome to the spectral stuff
+
+.. autoclass:: FrequencyBand
+.. autoclass:: FrequencyScale
+.. autoclass:: LinearScale
+.. autoclass:: GeometricScale
+.. autoclass:: FrequencyDimension
+.. autoclass:: ExplicitFrequencyDimension
+"""
+
 from sliding_window import \
     SlidingWindow, OggVorbisWindowingFunc, NDSlidingWindow, WindowingFunc, \
     HanningWindowingFunc