removing return None statement

Author: ccluri

KCSD.py

@@ -41,10 +41,6 @@ def validate(self, ele_pos, pots):
             positions of electrodes
         pots : numpy array
             potentials measured by electrodes
-
-        Returns
-        -------
-        None
         """
         if ele_pos.shape[0] != pots.shape[0]:
             raise Exception("Number of measured potentials is not equal "
@@ -54,7 +50,6 @@ def validate(self, ele_pos, pots):
                             1+ele_pos.shape[1])
         if utils.check_for_duplicated_electrodes(ele_pos) is False:
             raise Exception("Error! Duplicated electrode!")
-        return
 
     def sanity(self, true_csd, pos_csd):
         """Useful for comparing TrueCSD with reconstructed CSD. Computes, the RMS error
@@ -97,10 +92,6 @@ def parameters(self, **kwargs):
         ----------
         **kwargs
             Same as those passed to initialize the Class
-
-        Returns
-        -------
-        None
         """
         self.src_type = kwargs.pop('src_type', 'gauss')
         self.sigma = kwargs.pop('sigma', 1.0)
@@ -124,7 +115,6 @@ def parameters(self, **kwargs):
             self.gdz = kwargs.pop('gdz', 0.01*(self.zmax - self.zmin))
         if kwargs:
             raise TypeError('Invalid keyword arguments:', kwargs.keys())
-        return
 
     def method(self):
         """Actual sequence of methods called for KCSD
@@ -134,32 +124,23 @@ def method(self):
         Parameters
         ----------
         None
-
-        Returns
-        -------
-        None
         """
         self.create_lookup()                                #Look up table 
         self.update_b_pot()                                 #update kernel
         self.update_b_src()                                 #update crskernel
         self.update_b_interp_pot()                          #update pot interp
-        return
 
     def create_lookup(self, dist_table_density=20):
         """Creates a table for easy potential estimation from CSD.
         Updates and Returns the potentials due to a 
         given basis source like a lookup
-        table whose shape=(dist_table_density,)--> set in KCSD2D_Helpers.py
+        table whose shape=(dist_table_density,)
 
         Parameters
         ----------
         dist_table_density : int
             number of distance values at which potentials are computed.
             Default 100
-
-        Returns
-        -------
-        None
         """
         xs = np.logspace(0., np.log10(self.dist_max+1.), dist_table_density)
         xs = xs - 1.0 #starting from 0
@@ -171,7 +152,6 @@ def create_lookup(self, dist_table_density=20):
                                                self.sigma, 
                                                self.basis)
         self.interpolate_pot_at = interpolate.interp1d(xs, dist_table, kind='cubic')
-        return
 
     def update_b_pot(self):
         """Updates the b_pot  - array is (#_basis_sources, #_electrodes)
@@ -184,15 +164,10 @@ def update_b_pot(self):
         Parameters
         ----------
         None
-
-        Returns
-        -------
-        None
         """
         self.b_pot = self.interpolate_pot_at(self.src_ele_dists)
         self.k_pot = np.dot(self.b_pot.T, self.b_pot) #K(x,x') Eq9,Jan2012
         self.k_pot /= self.n_src
-        return
 
     def update_b_src(self):
         """Updates the b_src in the shape of (#_est_pts, #_basis_sources)
@@ -204,15 +179,10 @@ def update_b_src(self):
         Parameters
         ----------
         None
-
-        Returns
-        -------
-        None
         """
         self.b_src = self.basis(self.src_estm_dists, self.R).T
         self.k_interp_cross = np.dot(self.b_src, self.b_pot) #K_t(x,y) Eq17
         self.k_interp_cross /= self.n_src
-        return
 
     def update_b_interp_pot(self):
         """Compute the matrix of potentials generated by every source
@@ -223,15 +193,10 @@ def update_b_interp_pot(self):
         Parameters
         ----------
         None
-
-        Returns
-        -------
-        None
         """
         self.b_interp_pot = self.interpolate_pot_at(self.src_estm_dists).T
         self.k_interp_pot = np.dot(self.b_interp_pot, self.b_pot)
         self.k_interp_pot /= self.n_src
-        return
 
     def values(self, estimate='CSD'):
         """Computes the values of the quantity of interest
@@ -284,35 +249,25 @@ def process_estimate(self, estimation):
         return estimation
 
     def update_R(self, R):
-        """Used in Cross validation
+        """Update the width of the basis fuction - Used in Cross validation
 
         Parameters
         ----------
         R : float
-
-        Returns
-        -------
-        None
         """
         self.R = R
         self.dist_max = max(np.max(self.src_ele_dists), 
                             np.max(self.src_estm_dists)) + self.R
         self.method()
-        return
 
     def update_lambda(self, lambd):
-        """Used in Cross validation
+        """Update the lambda parameter of regularization, Used in Cross validation
 
         Parameters
         ----------
         lambd : float
-
-        Returns
-        -------
-        None
         """
         self.lambd = lambd
-        return
 
     def cross_validate(self, lambdas=None, Rs=None): 
         """Method defines the cross validation.
@@ -441,10 +396,6 @@ def __init__(self, ele_pos, pots, **kwargs):
                 regularization parameter for ridge regression
                 Defaults to 0.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         LinAlgException
@@ -464,16 +415,11 @@ def estimate_at(self):
         Parameters
         ----------
         None
-
-        Returns
-        -------
-        None
         """
         nx = (self.xmax - self.xmin)/self.gdx
         self.estm_x = np.mgrid[self.xmin:self.xmax:np.complex(0,nx)]
         self.n_estm = self.estm_x.size
         self.ngx = self.estm_x.shape[0]
-        return
 
     def place_basis(self):
         """Places basis sources of the defined type.
@@ -489,10 +435,6 @@ def place_basis(self):
         Parameters
         ----------
         None
-
-        Returns
-        -------
-        None
         """
         source_type = self.src_type
         try:
@@ -506,18 +448,13 @@ def place_basis(self):
                                                         self.R_init )
         self.n_src = self.src_x.size
         self.nsx = self.src_x.shape
-        return
 
     def create_src_dist_tables(self):
         """Creates distance tables between sources, electrode and estm points
 
         Parameters
         ----------
         None
-
-        Returns
-        -------
-        None
         """
         src_loc = np.array((self.src_x.ravel()))
         src_loc = src_loc.reshape((len(src_loc), 1))
@@ -526,7 +463,6 @@ def create_src_dist_tables(self):
         self.src_ele_dists = distance.cdist(src_loc, self.ele_pos, 'euclidean')
         self.src_estm_dists = distance.cdist(src_loc, est_loc,  'euclidean')
         self.dist_max = max(np.max(self.src_ele_dists), np.max(self.src_estm_dists)) + self.R
-        return
 
     def forward_model(self, x, R, h, sigma, src_type):
         """FWD model functions
@@ -631,10 +567,6 @@ def __init__(self, ele_pos, pots, **kwargs):
                 regularization parameter for ridge regression
                 Defaults to 0.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         LinAlgError 
@@ -654,18 +586,13 @@ def estimate_at(self):
         Parameters
         ----------
         None
-
-        Returns
-        -------
-        None
         """
         nx = (self.xmax - self.xmin)/self.gdx
         ny = (self.ymax - self.ymin)/self.gdy
         self.estm_x, self.estm_y = np.mgrid[self.xmin:self.xmax:np.complex(0,nx), 
                                             self.ymin:self.ymax:np.complex(0,ny)]
         self.n_estm = self.estm_x.size
         self.ngx, self.ngy = self.estm_x.shape
-        return
 
     def place_basis(self):
         """Places basis sources of the defined type.
@@ -681,10 +608,6 @@ def place_basis(self):
         Parameters
         ----------
         None
-
-        Returns
-        -------
-        None
         """
         source_type = self.src_type
         try:
@@ -700,25 +623,19 @@ def place_basis(self):
                                                                     self.R_init ) 
         self.n_src = self.src_x.size
         self.nsx, self.nsy = self.src_x.shape
-        return        
 
     def create_src_dist_tables(self):
         """Creates distance tables between sources, electrode and estm points
 
         Parameters
         ----------
         None
-
-        Returns
-        -------
-        None
         """
         src_loc = np.array((self.src_x.ravel(), self.src_y.ravel()))
         est_loc = np.array((self.estm_x.ravel(), self.estm_y.ravel()))
         self.src_ele_dists = distance.cdist(src_loc.T, self.ele_pos, 'euclidean')
         self.src_estm_dists = distance.cdist(src_loc.T, est_loc.T,  'euclidean')
         self.dist_max = max(np.max(self.src_ele_dists), np.max(self.src_estm_dists)) + self.R
-        return
 
     def forward_model(self, x, R, h, sigma, src_type):
         """FWD model functions
@@ -833,9 +750,6 @@ def __init__(self, ele_pos, pots, **kwargs):
             MoI_iters : int
                 Number of interations in method of images.
                 Default is 20
-        Returns
-        -------
-        None
         """
         self.MoI_iters = kwargs.pop('MoI_iters', 20)
         self.sigma_S = kwargs.pop('sigma_S', 5.0)
@@ -957,10 +871,6 @@ def __init__(self, ele_pos, pots, **kwargs):
                 regularization parameter for ridge regression
                 Defaults to 0.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         LinAlgError 
@@ -980,10 +890,6 @@ def estimate_at(self):
         Parameters
         ----------
         None
-
-        Returns
-        -------
-        None
         """
         nx = (self.xmax - self.xmin)/self.gdx
         ny = (self.ymax - self.ymin)/self.gdy
@@ -993,7 +899,6 @@ def estimate_at(self):
                                                          self.zmin:self.zmax:np.complex(0,nz)]
         self.n_estm = self.estm_x.size
         self.ngx, self.ngy, self.ngz = self.estm_x.shape
-        return
 
     def place_basis(self):
         """Places basis sources of the defined type.
@@ -1009,10 +914,6 @@ def place_basis(self):
         Parameters
         ----------
         None
-
-        Returns
-        -------
-        None
         """
         source_type = self.src_type
         try:
@@ -1031,18 +932,13 @@ def place_basis(self):
 
         self.n_src = self.src_x.size
         self.nsx, self.nsy, self.nsz = self.src_x.shape
-        return        
 
     def create_src_dist_tables(self):
         """Creates distance tables between sources, electrode and estm points
 
         Parameters
         ----------
         None
-
-        Returns
-        -------
-        None
         """
         src_loc = np.array((self.src_x.ravel(), 
                             self.src_y.ravel(), 
@@ -1053,7 +949,6 @@ def create_src_dist_tables(self):
         self.src_ele_dists = distance.cdist(src_loc.T, self.ele_pos, 'euclidean')
         self.src_estm_dists = distance.cdist(src_loc.T, est_loc.T,  'euclidean')
         self.dist_max = max(np.max(self.src_ele_dists), np.max(self.src_estm_dists)) + self.R
-        return
 
     def forward_model(self, x, R, h, sigma, src_type):
         """FWD model functions