Merge pull request #43 from aajayi-21/construct_component

function construct_component_matrix

Author: sbillinge

diffpy/snmf/subroutines.py

@@ -74,16 +74,43 @@ def construct_stretching_matrix(components, number_of_components, number_of_sign
     if (len(components)) == 0:
         raise ValueError(f"Number of components = {number_of_components}. Number_of_components must be >= 1.")
     number_of_components = len(components)
-    
+
     if number_of_signals <= 0:
         raise ValueError(f"Number of signals = {number_of_signals}. Number_of_signals must be >= 1.")
-        
+
     stretching_factor_matrix = np.zeros((number_of_components, number_of_signals))
     for i, component in enumerate(components):
         stretching_factor_matrix[i] = component.stretching_factors
     return stretching_factor_matrix
 
 
+def construct_component_matrix(components):
+    """Constructs the component matrix
+
+    Parameters
+    ----------
+    components: tuple of ComponentSignal objects
+      The tuple containing the component signals in ComponentSignal objects.
+
+    Returns
+    -------
+    2d array
+      The matrix containing the component signal values. Has dimensions `signal_length` x `number_of_components`.
+
+    """
+    signal_length = len(components[0].iq)
+    number_of_components = len(components)
+    if signal_length == 0:
+        raise ValueError(f"Signal length = {signal_length}. Signal length must be >= 1")
+    if number_of_components == 0:
+        raise ValueError(f"Number of components = {number_of_components}. Number_of_components must be >= 1")
+
+    component_matrix = np.zeros((number_of_components, signal_length))
+    for i, component in enumerate(components):
+        component_matrix[i] = component.iq
+    return component_matrix
+
+
 def initialize_arrays(number_of_components, number_of_moments, signal_length):
     """Generates the initial guesses for the weight, stretching, and component matrices
 

diffpy/snmf/tests/test_subroutines.py

@@ -2,7 +2,7 @@
 import numpy as np
 from diffpy.snmf.containers import ComponentSignal
 from diffpy.snmf.subroutines import objective_function, get_stretched_component, reconstruct_data, get_residual_matrix, \
-    update_weights_matrix, initialize_arrays, lift_data, initialize_components, construct_stretching_matrix
+    update_weights_matrix, initialize_arrays, lift_data, initialize_components, construct_stretching_matrix, construct_component_matrix
 
 to = [
     ([[[1, 2], [3, 4]], [[5, 6], [7, 8]], 1e11, [[1, 2], [3, 4]], [[1, 2], [3, 4]], 1], 2.574e14),
@@ -186,3 +186,23 @@ def test_construct_stretching_matrix(tcso):
     for component in tcso[0]:
         np.testing.assert_allclose(actual[component.id,:], component.stretching_factors)
         #assert actual[component.id, :] == component.stretching_factors
+
+tccm = [
+        ([ComponentSignal([0,.25,.5,.75,1],20,0)]),
+        ([ComponentSignal([0,.25,.5,.75,1],0,0)]),
+        ([ComponentSignal([0,.25,.5,.75,1],20,0),ComponentSignal([0,.25,.5,.75,1],20,1),ComponentSignal([0,.25,.5,.75,1],20,2)]),
+        ([ComponentSignal([0, .25, .5, .75, 1], 20, 0), ComponentSignal([0, .25, .5, .75, 1], 20, 1),
+          ComponentSignal([0, .25, .5, .75, 1], 20, 2)]),
+        ([ComponentSignal([0, .25, .5, .75, 1], 20, 0), ComponentSignal([0, .25, .5, 2.75, 1], 20, 1),
+          ComponentSignal([0, .25, .5, .75, 1], 20, 2)]),
+        ([ComponentSignal([.25], 20, 0), ComponentSignal([.25], 20, 1), ComponentSignal([.25], 20, 2)]),
+        ([ComponentSignal([0, .25, .5, .75, 1], 20, 0), ComponentSignal([0, .25, .5, .75, 1], 20, 1)]),
+        # ([ComponentSignal([[0, .25, .5, .75, 1],[0, .25, .5, .75, 1]], 20, 0), ComponentSignal([[0, .25, .5, .75, 1],[0, .25, .5, .75, 1]], 20, 1)]), # iq is multidimensional. Expected to fail
+        # (ComponentSignal([], 20, 0)), # Expected to fail
+        # ([]), #Expected to fail
+        ]
+@pytest.mark.parametrize('tccm',tccm)
+def test_construct_component_matrix(tccm):
+    actual = construct_component_matrix(tccm)
+    for component in tccm:
+        np.testing.assert_allclose(actual[component.id], component.iq)