Renamed nb_elements to total_nb_rows

Author: MarcCote

nibabel/streamlines/array_sequence.py

@@ -102,8 +102,8 @@ def common_shape(self):
         return self._data.shape[1:]
 
     @property
-    def nb_elements(self):
-        """ Total number of elements in this array sequence. """
+    def total_nb_rows(self):
+        """ Total number of rows in this array sequence. """
         return np.sum(self._lengths)
 
     @property
@@ -112,7 +112,7 @@ def data(self):
         return self._data
 
     def _get_next_offset(self):
-        """ Offset in ``self._data`` at which to write next element """
+        """ Offset in ``self._data`` at which to write next rowelement """
         if len(self._offsets) == 0:
             return 0
         imax = np.argmax(self._offsets)

nibabel/streamlines/tests/test_array_sequence.py

@@ -116,8 +116,8 @@ def test_arraysequence_iter(self):
     def test_arraysequence_copy(self):
         orig = SEQ_DATA['seq']
         seq = orig.copy()
-        n_rows = seq.nb_elements
-        assert_equal(n_rows, orig.nb_elements)
+        n_rows = seq.total_nb_rows
+        assert_equal(n_rows, orig.total_nb_rows)
         assert_array_equal(seq._data, orig._data[:n_rows])
         assert_true(seq._data is not orig._data)
         assert_array_equal(seq._offsets, orig._offsets)

nibabel/streamlines/tests/test_tractogram.py

@@ -186,9 +186,9 @@ class TestPerArraySequenceDict(unittest.TestCase):
     def test_per_array_sequence_dict_creation(self):
         # Create a PerArraySequenceDict object using another
         # PerArraySequenceDict object.
-        nb_elements = DATA['tractogram'].streamlines.nb_elements
+        total_nb_rows = DATA['tractogram'].streamlines.total_nb_rows
         data_per_point = DATA['tractogram'].data_per_point
-        data_dict = PerArraySequenceDict(nb_elements, data_per_point)
+        data_dict = PerArraySequenceDict(total_nb_rows, data_per_point)
         assert_equal(data_dict.keys(), data_per_point.keys())
         for k in data_dict.keys():
             assert_arrays_equal(data_dict[k], data_per_point[k])
@@ -199,7 +199,7 @@ def test_per_array_sequence_dict_creation(self):
 
         # Create a PerArraySequenceDict object using an existing dict object.
         data_per_point = DATA['data_per_point']
-        data_dict = PerArraySequenceDict(nb_elements, data_per_point)
+        data_dict = PerArraySequenceDict(total_nb_rows, data_per_point)
         assert_equal(data_dict.keys(), data_per_point.keys())
         for k in data_dict.keys():
             assert_arrays_equal(data_dict[k], data_per_point[k])
@@ -209,7 +209,7 @@ def test_per_array_sequence_dict_creation(self):
 
         # Create a PerArraySequenceDict object using keyword arguments.
         data_per_point = DATA['data_per_point']
-        data_dict = PerArraySequenceDict(nb_elements, **data_per_point)
+        data_dict = PerArraySequenceDict(total_nb_rows, **data_per_point)
         assert_equal(data_dict.keys(), data_per_point.keys())
         for k in data_dict.keys():
             assert_arrays_equal(data_dict[k], data_per_point[k])
@@ -218,8 +218,8 @@ def test_per_array_sequence_dict_creation(self):
         assert_equal(len(data_dict), len(data_per_point)-1)
 
     def test_getitem(self):
-        nb_elements = DATA['tractogram'].streamlines.nb_elements
-        sdict = PerArraySequenceDict(nb_elements, DATA['data_per_point'])
+        total_nb_rows = DATA['tractogram'].streamlines.total_nb_rows
+        sdict = PerArraySequenceDict(total_nb_rows, DATA['data_per_point'])
 
         assert_raises(KeyError, sdict.__getitem__, 'invalid')
 

nibabel/streamlines/tractogram.py

@@ -82,16 +82,16 @@ class PerArrayDict(SliceableDataDict):
 
     Parameters
     ----------
-    nb_elements : None or int, optional
-        Number of elements per value in each key, value pair or None for not
+    n_rows : None or int, optional
+        Number of rows per value in each key, value pair or None for not
         specified.
     \*args :
     \*\*kwargs :
         Positional and keyword arguments, passed straight through the ``dict``
         constructor.
     """
-    def __init__(self, nb_elements=None, *args, **kwargs):
-        self.nb_elements = nb_elements
+    def __init__(self, n_rows=None, *args, **kwargs):
+        self.n_rows = n_rows
         super(PerArrayDict, self).__init__(*args, **kwargs)
 
     def __setitem__(self, key, value):
@@ -105,9 +105,9 @@ def __setitem__(self, key, value):
             raise ValueError("data_per_streamline must be a 2D array.")
 
         # We make sure there is the right amount of values
-        if self.nb_elements is not None and len(value) != self.nb_elements:
+        if self.n_rows is not None and len(value) != self.n_rows:
             msg = ("The number of values ({0}) should match n_elements "
-                   "({1}).").format(len(value), self.nb_elements)
+                   "({1}).").format(len(value), self.n_rows)
             raise ValueError(msg)
 
         self.store[key] = value
@@ -128,10 +128,10 @@ def __setitem__(self, key, value):
         value = ArraySequence(value)
 
         # We make sure there is the right amount of data.
-        if (self.nb_elements is not None and
-                value.nb_elements != self.nb_elements):
+        if (self.n_rows is not None and
+                value.total_nb_rows != self.n_rows):
             msg = ("The number of values ({0}) should match "
-                   "({1}).").format(value.nb_elements, self.nb_elements)
+                   "({1}).").format(value.total_nb_rows, self.n_rows)
             raise ValueError(msg)
 
         self.store[key] = value
@@ -299,7 +299,7 @@ def data_per_point(self):
     @data_per_point.setter
     def data_per_point(self, value):
         self._data_per_point = PerArraySequenceDict(
-            self.streamlines.nb_elements, {} if value is None else value)
+            self.streamlines.total_nb_rows, {} if value is None else value)
 
     @property
     def affine_to_rasmm(self):