Update readme.md

artacs/kernel.py

@@ -51,7 +51,9 @@
 Object-oriented implementation
 ------------------------------
 
-There exists also an object-oriented implementation.
+There exists also an object-oriented implementation as follows::
+    
+    kernel = 
 
 
 """
@@ -280,7 +282,15 @@ def apply_kernel(indata:ndarray, fs:int, freq:int, kernel:ndarray):
 
 #%%
 class CombKernel():
+    '''Object-oriented comb kernel filter
     
+    Example to create and apply classical comb kernel::
+        
+        kernel = CombKernel(freq=20, fs=1000, width=1,
+                   left_mode='uniform', right_mode ='none')
+        
+        kernel.apply(artifacted_signal)
+    '''
     def __init__(self, freq:int, fs:int, width:int, 
                   left_mode:str='uniform', 
                   right_mode:str='uniform') -> None:
@@ -298,9 +308,12 @@ def _update_kernel(self):
                                      self._left_mode, 
                                      self._right_mode)      
 
-    def __call__(self, indata:np.array) -> ndarray:
+    def apply(self, indata:ndarray):
         return apply_kernel(indata=indata, freq=self._freq, fs=self._fs, 
                          kernel=self._kernel)
+
+    def __call__(self, indata:ndarray) -> ndarray:
+        return self.apply(indata)
 
     def __repr__(self):
         return (f'KernelFilter({self._freq}, {self._fs}, {self._width}, ' +

artacs/template.py

@@ -5,6 +5,7 @@
 
 @author: rgugg
 """
+from numpy import ndarray
 import numpy as np
 import artacs.tools as tools
 import logging
@@ -64,11 +65,11 @@ def prepare_data(self, indata):
         data, period, fs = self.inbound_resample(valid_data)
         seeds = self.calc_seeds(period)
         return data, period, fs, seeds        
-
-    def __call__(self, indata):
+                
+    def __call__(self, indata:ndarray) -> ndarray:
         return self.process(indata)
 
-    def process(self, indata):
+    def process(self, indata:ndarray):
         'process all channels of a dataset'
         if self.true_period is None:
             print('Invalid period length, skipping artifact removal')
@@ -93,7 +94,7 @@ def process(self, indata):
             print(']',end='\n')
         return np.squeeze(outdata)
 
-    def process_channel(self, indata):    
+    def process_channel(self, indata:ndarray) -> ndarray:    
         'process a single channels of data'
         if self.true_period is None:
             print('Invalid period length, skipping artifact removal')
@@ -117,7 +118,7 @@ def process_channel(self, indata):
 
         return outdata
 
-    def _process(self, data, period, fs, seed):
+    def _process(self, data:ndarray, period:int, fs:int, seed:int):
         converged = False
         iteration = 0
         fdata = data.copy()
@@ -133,4 +134,4 @@ def _process(self, data, period, fs, seed):
                 converged = True                    
             else:
                 fdata[put_where] -= template    
-        return put_where, fdata[put_where]
+        return put_where, fdata[put_where]