update readme for new rdsamp input value and move convert_dtype function

cx1111 · cx1111 · commit e44e87cc6898 · 2017-08-15T10:09:25.000-04:00
diff --git a/README.rst b/README.rst
@@ -159,6 +159,7 @@ Input Arguments:
 -  ``m2s`` (default=True): Flag used only for multi-segment records. Specifies whether to convert the returned wfdb.MultiRecord object into a wfdb.Record object (True) or not (False).
 -  ``smoothframes`` (default=True): Flag used when reading records with signals having multiple samples per frame. Specifies whether to smooth the samples in signals with more than one sample per frame and return an mxn uniform numpy array as the d_signals or p_signals field (True), or to return a list of 1d numpy arrays containing every expanded sample as the e_d_signals or e_p_signals field (False).
 -  ``ignoreskew`` (default=False): Flag used when reading records with at least one skewed signal. Specifies whether to apply the skew to align the signals in the output variable (False), or to ignore the skew field and load in all values contained in the dat files unaligned (True).
+-  ``returnres`` (default=64): The numpy array dtype of the returned signals. Options are: 64, 32, 16, and 8, where the value represents the numpy int or float dtype. Note that the value cannot be 8 when physical is True since there is no float8 format.
 
 Output Arguments:
 
diff --git a/setup.py b/setup.py
@@ -20,7 +20,7 @@
     # Versions should comply with PEP440. For a discussion on single-sourcing
     # the version across setup.py and the project code, see
     # https://packaging.python.org/en/latest/single_source_version.html
-    version='1.2.0',
+    version='1.2.1',
 
     description='The WFDB Python Toolbox',
     long_description=long_description,
diff --git a/wfdb/readwrite/_signals.py b/wfdb/readwrite/_signals.py
@@ -377,6 +377,37 @@ def calculate_adcparams(self):
         
         return (gains, baselines)
 
+
+    def convert_dtype(self, physical, returnres, smoothframes):
+        if physical is True:
+            returndtype = 'float'+str(returnres)
+            if smoothframes is True:
+                currentdtype = self.p_signals.dtype
+                if currentdtype != returndtype:
+                    self.p_signals = self.p_signals.astype(returndtype, copy=False)
+            else:
+                for ch in range(self.nsig):
+                    if self.e_p_signals[ch].dtype != returndtype:
+                        self.e_p_signals[ch] = self.e_p_signals[ch].astype(returndtype, copy=False)
+        else:
+            returndtype = 'int'+str(returnres)
+            if smoothframes is True:
+                currentdtype = self.d_signals.dtype
+                if currentdtype != returndtype:
+                    # Do not allow changing integer dtype to lower value due to over/underflow
+                    if int(str(currentdtype)[3:])>int(str(returndtype)[3:]):
+                        raise Exception('Cannot convert digital samples to lower dtype. Risk of overflow/underflow.')
+                    self.d_signals = self.d_signals.astype(returndtype, copy=False)
+            else:
+                for ch in range(self.nsig):
+                    currentdtype = self.e_d_signals[ch].dtype
+                    if currentdtype != returndtype:
+                        # Do not allow changing integer dtype to lower value due to over/underflow
+                        if int(str(currentdtype)[3:])>int(str(returndtype)[3:]):
+                            raise Exception('Cannot convert digital samples to lower dtype. Risk of overflow/underflow.')
+                        self.e_d_signals[ch] = self.e_d_signals[ch].astype(returndtype, copy=False)
+        return
+
     def calc_checksum(self, expanded=False):
         """
         Calculate the checksum(s) of the d_signals (expanded=False)
diff --git a/wfdb/readwrite/records.py b/wfdb/readwrite/records.py
@@ -773,8 +773,10 @@ def rdsamp(recordname, sampfrom=0, sampto=None, channels = None, physical = True
       Specifies whether to apply the skew to align the signals in the output variable (False), or
       to ignore the skew field and load in all values contained in the dat files unaligned (True).
     - returnres (default=64): The numpy array dtype of the returned signals. Options are: 64, 32,
-       16, or 8, where the value represents the numpy int or float dtype. Note that the value
-       cannot be 8 when physical=True since there is no float8 format.
+       16, and 8, where the value represents the numpy int or float dtype. Note that the value
+       cannot be 8 when physical is True since there is no float8 format.
+    
+    Output argument:
     - record: The wfdb Record or MultiRecord object representing the contents of the record read.
 
     Note: If a signal range or channel selection is specified when calling this function, the
@@ -895,33 +897,7 @@ def rdsamp(recordname, sampfrom=0, sampto=None, channels = None, physical = True
 
     # Perform dtype conversion if necessary
     if type(record) == Record and record.nsig>0:
-        if physical is True:
-            returndtype = 'float'+str(returnres)
-            if smoothframes is True:
-                currentdtype = record.p_signals.dtype
-                if currentdtype != returndtype:
-                    record.p_signals = record.p_signals.astype(returndtype, copy=False)
-            else:
-                for ch in range(record.nsig):
-                    if record.e_p_signals[ch].dtype != returndtype:
-                        record.e_p_signals[ch] = record.e_p_signals[ch].astype(returndtype, copy=False)
-        else:
-            returndtype = 'int'+str(returnres)
-            if smoothframes is True:
-                currentdtype = record.d_signals.dtype
-                if currentdtype != returndtype:
-                    # Do not allow changing integer dtype to lower value due to over/underflow
-                    if int(str(currentdtype)[3:])>int(str(returndtype)[3:]):
-                        raise Exception('Cannot convert digital samples to lower dtype. Overflow/Underflow likely.')
-                    record.d_signals = record.d_signals.astype(returndtype, copy=False)
-            else:
-                for ch in range(record.nsig):
-                    currentdtype = record.e_d_signals[ch].dtype
-                    if currentdtype != returndtype:
-                        # Do not allow changing integer dtype to lower value due to over/underflow
-                        if int(str(currentdtype)[3:])>int(str(returndtype)[3:]):
-                            raise Exception('Cannot convert digital samples to lower dtype. Overflow/Underflow likely.')
-                        record.e_d_signals[ch] = record.e_d_signals[ch].astype(returndtype, copy=False)
+        record.convert_dtype(physical, returnres, smoothframes)
 
     return record
 
