chan_id to channel_id

Author: h-mayorquin

neo/rawio/intanrawio.py

@@ -33,43 +33,24 @@
 
 class IntanRawIO(BaseRawIO):
     """
-    Class for reading rhd and rhs Intan data
-   
-    Parameters
-    ----------
-    filename: str, default: ''
-       name of the 'rhd' or 'rhs' data file
-
-    Notes
-    -----
-    * Intan reader can handle two file formats 'rhd' and 'rhs'. It will automatically
+    Intan reader can handle two file formats 'rhd' and 'rhs'. It will automatically
     check for the file extension and will gather the header information based on the
     extension. Additionally it functions with RHS v 1.0 and RHD 1.0, 1.1, 1.2, 1.3, 2.0,
     3.0, and 3.1 files.
-    
-    * Intan files contain amplifier channels labeled 'A', 'B' 'C' or 'D'
+    Intan files contain amplifier channels labeled 'A', 'B' 'C' or 'D'
     depending on the port in which they were recorded along with the following
     additional channels.
-    0: 'RHD2000' amplifier channel
     1: 'RHD2000 auxiliary input channel',
     2: 'RHD2000 supply voltage channel',
     3: 'USB board ADC input channel',
     4: 'USB board digital input channel',
     5: 'USB board digital output channel'
-
-    * Due to the structure of the digital input and output channels these can be accessed
+    Due to the structure of the digital input and output channels these can be accessed
     as one long vector, which must be post-processed.
-
-    Examples
-    --------
-    >>> import neo.rawio
-    >>> reader = neo.rawio.IntanRawIO(filename='data.rhd')
-    >>> reader.parse_header()
-    >>> raw_chunk = reader.get_analogsignal_chunk(block_index=0,
-                                                  seg_index=0
-                                                  stream_index=0)
-    >>> float_chunk = reader.rescale_signal_raw_to_float(raw_chunk, stream_index=0)
-    
+    Parameters
+    ----------
+    filename: str
+       name of the 'rhd' or 'rhs' data file
     """
 
     extensions = ["rhd", "rhs"]
@@ -105,7 +86,7 @@ def _parse_header(self):
         signal_channels = []
         for c, chan_info in enumerate(self._ordered_channels):
             name = chan_info["custom_channel_name"]
-            chan_id = chan_info["native_channel_name"]
+            channel_id = chan_info["native_channel_name"]
             if chan_info["signal_type"] == 20:
                 # exception for temperature
                 sig_dtype = "int16"
@@ -115,7 +96,7 @@ def _parse_header(self):
             signal_channels.append(
                 (
                     name,
-                    chan_id,
+                    channel_id,
                     chan_info["sampling_rate"],
                     sig_dtype,
                     chan_info["units"],
@@ -468,7 +449,10 @@ def read_rhd(filename):
 
         global_info = read_variable_header(f, rhd_global_header_base)
 
-        version = V(f"{global_info['major_version']}.{global_info['minor_version']}")
+        # This is a package.version object that allows lexicographic comparison
+        major_version = global_info["major_version"]
+        minor_version = global_info["minor_version"]
+        version = V(f"{major_version}.{minor_version}")
 
         # the header size depends on the version :-(
         header = list(rhd_global_header_part1)  # make a copy
@@ -552,7 +536,7 @@ def read_rhd(filename):
 
     # temperature is not an official channel in the header
     for i in range(global_info["num_temp_sensor_channels"]):
-        name = f"temperature_{i}"
+        name = "temperature_{}".format(i)
         chan_info = {"native_channel_name": name, "signal_type": 20}
         chan_info["sampling_rate"] = sr / BLOCK_SIZE
         chan_info["units"] = "Celsius"