Module redvox.tests.common.test_cross_stats

cross correlation test module

"""
 cross correlation test module
"""

import unittest
import redvox.common.cross_stats as cs
import numpy as np

SIGNAL_LENGTH = 100   # number of elements in signal
SAMPLE_RATE = 80.0    # sample rate in hz


class CrossCorrelationTests(unittest.TestCase):
    def setUp(self) -> None:
        self.sig = np.ndarray((SIGNAL_LENGTH,), float)
        self.sig_ref = np.ndarray((SIGNAL_LENGTH,), float)
        self.double_sig_ref = np.ndarray((SIGNAL_LENGTH * 2,), float)
        self.sample_rate = SAMPLE_RATE
        sign = 1.0
        for index in range(SIGNAL_LENGTH):
            self.sig[index] = (index % 25) * sign
            self.sig_ref[index] = ((index + 10) % 25) * sign
            self.double_sig_ref[index] = ((index - 7) % 25) * sign
            self.double_sig_ref[index + SIGNAL_LENGTH] = ((index - 10) % 25) * sign
            sign *= -1.0
        self.half_sig_ref = self.sig_ref[13:63]

    def test_xcorr_all(self):
        # sig length == ref length
        xcorr_indexes, xcorr, xcorr_offset_index, xcorr_offset_samples = cs.xcorr_all(self.sig, self.sig_ref)
        self.assertEqual(len(xcorr), 100)
        self.assertEqual(len(xcorr_indexes), 100)
        self.assertEqual(xcorr_offset_index, 40)
        self.assertEqual(xcorr_offset_samples, -10)
        # sig length < ref length
        xcorr_indexes, xcorr, xcorr_offset_index, xcorr_offset_samples = cs.xcorr_all(self.sig, self.double_sig_ref)
        self.assertEqual(len(xcorr), 299)
        self.assertEqual(len(xcorr_indexes), 299)
        self.assertEqual(xcorr_offset_index, 139)
        self.assertEqual(xcorr_offset_samples, 60)
        # sig length > ref length
        xcorr_indexes, xcorr, xcorr_offset_index, xcorr_offset_samples = cs.xcorr_all(self.sig, self.half_sig_ref)
        self.assertEqual(len(xcorr), 149)
        self.assertEqual(len(xcorr_indexes), 149)
        self.assertEqual(xcorr_offset_index, 76)
        self.assertEqual(xcorr_offset_samples, -23)

    def test_xcorr_main(self):
        xcorr_normalized_max, xcorr_offset_samples, xcorr_offset_seconds = \
            cs.xcorr_main(self.sig, self.sig_ref, self.sample_rate)
        self.assertAlmostEqual(xcorr_normalized_max, 0.9855, 4)
        self.assertEqual(xcorr_offset_samples, -10)
        self.assertEqual(xcorr_offset_seconds, -0.125)

Classes

class CrossCorrelationTests (methodName='runTest')

A class whose instances are single test cases.

By default, the test code itself should be placed in a method named 'runTest'.

If the fixture may be used for many test cases, create as many test methods as are needed. When instantiating such a TestCase subclass, specify in the constructor arguments the name of the test method that the instance is to execute.

Test authors should subclass TestCase for their own tests. Construction and deconstruction of the test's environment ('fixture') can be implemented by overriding the 'setUp' and 'tearDown' methods respectively.

If it is necessary to override the init method, the base class init method must always be called. It is important that subclasses should not change the signature of their init method, since instances of the classes are instantiated automatically by parts of the framework in order to be run.

When subclassing TestCase, you can set these attributes: * failureException: determines which exception will be raised when the instance's assertion methods fail; test methods raising this exception will be deemed to have 'failed' rather than 'errored'. * longMessage: determines whether long messages (including repr of objects used in assert methods) will be printed on failure in addition to any explicit message passed. * maxDiff: sets the maximum length of a diff in failure messages by assert methods using difflib. It is looked up as an instance attribute so can be configured by individual tests if required.

Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.

Expand source code

class CrossCorrelationTests(unittest.TestCase):
    def setUp(self) -> None:
        self.sig = np.ndarray((SIGNAL_LENGTH,), float)
        self.sig_ref = np.ndarray((SIGNAL_LENGTH,), float)
        self.double_sig_ref = np.ndarray((SIGNAL_LENGTH * 2,), float)
        self.sample_rate = SAMPLE_RATE
        sign = 1.0
        for index in range(SIGNAL_LENGTH):
            self.sig[index] = (index % 25) * sign
            self.sig_ref[index] = ((index + 10) % 25) * sign
            self.double_sig_ref[index] = ((index - 7) % 25) * sign
            self.double_sig_ref[index + SIGNAL_LENGTH] = ((index - 10) % 25) * sign
            sign *= -1.0
        self.half_sig_ref = self.sig_ref[13:63]

    def test_xcorr_all(self):
        # sig length == ref length
        xcorr_indexes, xcorr, xcorr_offset_index, xcorr_offset_samples = cs.xcorr_all(self.sig, self.sig_ref)
        self.assertEqual(len(xcorr), 100)
        self.assertEqual(len(xcorr_indexes), 100)
        self.assertEqual(xcorr_offset_index, 40)
        self.assertEqual(xcorr_offset_samples, -10)
        # sig length < ref length
        xcorr_indexes, xcorr, xcorr_offset_index, xcorr_offset_samples = cs.xcorr_all(self.sig, self.double_sig_ref)
        self.assertEqual(len(xcorr), 299)
        self.assertEqual(len(xcorr_indexes), 299)
        self.assertEqual(xcorr_offset_index, 139)
        self.assertEqual(xcorr_offset_samples, 60)
        # sig length > ref length
        xcorr_indexes, xcorr, xcorr_offset_index, xcorr_offset_samples = cs.xcorr_all(self.sig, self.half_sig_ref)
        self.assertEqual(len(xcorr), 149)
        self.assertEqual(len(xcorr_indexes), 149)
        self.assertEqual(xcorr_offset_index, 76)
        self.assertEqual(xcorr_offset_samples, -23)

    def test_xcorr_main(self):
        xcorr_normalized_max, xcorr_offset_samples, xcorr_offset_seconds = \
            cs.xcorr_main(self.sig, self.sig_ref, self.sample_rate)
        self.assertAlmostEqual(xcorr_normalized_max, 0.9855, 4)
        self.assertEqual(xcorr_offset_samples, -10)
        self.assertEqual(xcorr_offset_seconds, -0.125)

Ancestors

• unittest.case.TestCase

Methods

def setUp(self) ‑> None

Hook method for setting up the test fixture before exercising it.

Expand source code

def setUp(self) -> None:
    self.sig = np.ndarray((SIGNAL_LENGTH,), float)
    self.sig_ref = np.ndarray((SIGNAL_LENGTH,), float)
    self.double_sig_ref = np.ndarray((SIGNAL_LENGTH * 2,), float)
    self.sample_rate = SAMPLE_RATE
    sign = 1.0
    for index in range(SIGNAL_LENGTH):
        self.sig[index] = (index % 25) * sign
        self.sig_ref[index] = ((index + 10) % 25) * sign
        self.double_sig_ref[index] = ((index - 7) % 25) * sign
        self.double_sig_ref[index + SIGNAL_LENGTH] = ((index - 10) % 25) * sign
        sign *= -1.0
    self.half_sig_ref = self.sig_ref[13:63]

def test_xcorr_all(self)

Expand source code

def test_xcorr_all(self):
    # sig length == ref length
    xcorr_indexes, xcorr, xcorr_offset_index, xcorr_offset_samples = cs.xcorr_all(self.sig, self.sig_ref)
    self.assertEqual(len(xcorr), 100)
    self.assertEqual(len(xcorr_indexes), 100)
    self.assertEqual(xcorr_offset_index, 40)
    self.assertEqual(xcorr_offset_samples, -10)
    # sig length < ref length
    xcorr_indexes, xcorr, xcorr_offset_index, xcorr_offset_samples = cs.xcorr_all(self.sig, self.double_sig_ref)
    self.assertEqual(len(xcorr), 299)
    self.assertEqual(len(xcorr_indexes), 299)
    self.assertEqual(xcorr_offset_index, 139)
    self.assertEqual(xcorr_offset_samples, 60)
    # sig length > ref length
    xcorr_indexes, xcorr, xcorr_offset_index, xcorr_offset_samples = cs.xcorr_all(self.sig, self.half_sig_ref)
    self.assertEqual(len(xcorr), 149)
    self.assertEqual(len(xcorr_indexes), 149)
    self.assertEqual(xcorr_offset_index, 76)
    self.assertEqual(xcorr_offset_samples, -23)

def test_xcorr_main(self)

Expand source code

def test_xcorr_main(self):
    xcorr_normalized_max, xcorr_offset_samples, xcorr_offset_seconds = \
        cs.xcorr_main(self.sig, self.sig_ref, self.sample_rate)
    self.assertAlmostEqual(xcorr_normalized_max, 0.9855, 4)
    self.assertEqual(xcorr_offset_samples, -10)
    self.assertEqual(xcorr_offset_seconds, -0.125)