Changeset 399 for trunk

Show
Ignore:
Timestamp:
06/15/09 20:59:29 (3 years ago)
Author:
pierre
Message:

Forgotten documentation

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/src/signals/pairs.py

    r398 r399  
    180180    def __init__(self, spk1, spk2, no_silent=False, no_auto=True, lenght=1.): 
    181181        PairsGenerator.__init__(self, spk1, spk2, no_silent) 
     182         
    182183        self.lenght  = lenght 
    183184        self.no_auto = no_auto 
    184185     
    185186    def get_pairs(self, nb_pairs, d_min, d_max): 
     187        """ 
     188        Function to obtain a certain number of cells from the generator 
     189         
     190        Inputs: 
     191            nb_pairs - int to specify the number of pairs desired 
     192            d_min    - the minimal distance between cells 
     193            d_max    - the maximal distance between cells 
     194             
     195        The length parameter of the DistantDependentPairs should be defined correctly. It is the extent of the grid. 
     196         
     197        Examples: 
     198            >> res = p.get_pairs(100, 0.3, 0.5) 
     199        """ 
    186200        cells1 = numpy.array(list(self.ids_1), int) 
    187201        cells2 = numpy.array(list(self.ids_2), int)