Numerical python functions written for compatability with matlab(TM)
commands with the same names.  
 
  Matlab(TM) compatible functions:
 
    * cohere - Coherence (normalized cross spectral density)
 
    * conv     - convolution
    
    * corrcoef - The matrix of correlation coefficients
 
    * csd - Cross spectral density uing Welch's average periodogram
 
    * detrend -- Remove the mean or best fit line from an array
 
    * find - Return the indices where some condition is true
    
    * linspace -- Linear spaced array from min to max
 
    * hist -- Histogram
    
    * polyfit - least squares best polynomial fit of x to y
 
    * polyval - evaluate a vector for a vector of polynomial coeffs
 
    * prctile - find the percentiles of a sequence
    
    * prepca - Principal Component's Analysis
    
    * psd - Power spectral density uing Welch's average periodogram
 
    * rk4 - A 4th order runge kutta integrator for 1D or ND systems
 
    * vander - the Vandermonde matrix
 
    * trapz - trapeziodal integration
    
  Functions that don't exist in matlab(TM), but are useful anyway:
 
    * cohere_pairs - Coherence over all pairs.  This is not a matlab
      function, but we compute coherence a lot in my lab, and we
      compute it for alot of pairs.  This function is optimized to do
      this efficiently by caching the direct FFTs.
 
Credits:
 
  Unless otherwise noted, these functions were written by
  Author: John D. Hunter <jdhunter@ace.bsd.uchicago.edu>
 
  Some others are from the Numeric documentation, or imported from
  MLab or other Numeric packages

Modules
		matplotlib.numerix.linear_algebra math matplotlib.numerix operator random sys

Functions
		amap(fn, *args) amap(function, sequence[, sequence, ...]) -> array.   Works like map(), but it returns an array.  This is just a convenient shorthand for Numeric.array(map(...)) approx_real(x) approx_real(x) : returns x.real if |x.imag| < |x.real| * _eps_approx. This function is needed by sqrtm and allows further functions. arange(...) arange(start, stop=None, step=1, typecode=None)    Just like range() except it returns an array whose type can be specified by the keyword argument typecode. array(...) array(sequence, typecode=None, copy=1, savespace=0) will return a new array formed from the given (potentially nested) sequence with type given by typecode.  If no typecode is given, then the type will be determined as the minimum type required to hold the objects in sequence.  If copy is zero and sequence is already an array, a reference will be returned.  If savespace is nonzero, the new array will maintain its precision in operations. base_repr(number, base=2, padding=0) Return the representation of a number in any given base. binary_repr(number, max_length=1025) Return the binary representation of the input number as a string.   This is more efficient than using base_repr with base 2.   Increase the value of max_length for very large numbers. Note that on 32-bit machines, 2**1023 is the largest integer power of 2 which can be converted to a Python float. bivariate_normal(X, Y, sigmax=1.0, sigmay=1.0, mux=0.0, muy=0.0, sigmaxy=0.0) Bivariate gaussan distribution for equal shape X, Y   http://mathworld.wolfram.com/BivariateNormalDistribution.html center_matrix(M, dim=0) Return the matrix M with each row having zero mean and unit std   if dim=1, center columns rather than rows cohere(x, y, NFFT=256, Fs=2, detrend=<function detrend_none>, window=<function window_hanning>, noverlap=0) cohere the coherence between x and y.  Coherence is the normalized cross spectral density   Cxy = |Pxy|^2/(Pxx*Pyy)   The return value is (Cxy, f), where f are the frequencies of the coherence vector.  See the docs for psd and csd for information about the function arguments NFFT, detrend, windowm noverlap, as well as the methods used to compute Pxy, Pxx and Pyy.   Returns the tuple Cxy, freqs cohere_pairs(X, ij, NFFT=256, Fs=2, detrend=<function detrend_none>, window=<function window_hanning>, noverlap=0, preferSpeedOverMemory=True, progressCallback=<function donothing_callback>, returnPxx=False) Cxy, Phase, freqs = cohere_pairs( X, ij, ...)   Compute the coherence for all pairs in ij.  X is a numSamples,numCols Numeric array.  ij is a list of tuples (i,j). Each tuple is a pair of indexes into the columns of X for which you want to compute coherence.  For example, if X has 64 columns, and you want to compute all nonredundant pairs, define ij as     ij = []   for i in range(64):       for j in range(i+1,64):           ij.append( (i,j) )   The other function arguments, except for 'preferSpeedOverMemory' (see below), are explained in the help string of 'psd'.   Return value is a tuple (Cxy, Phase, freqs).     Cxy -- a dictionary of (i,j) tuples -> coherence vector for that     pair.  Ie, Cxy[(i,j) = cohere(X[:,i], X[:,j]).  Number of     dictionary keys is len(ij)      Phase -- a dictionary of phases of the cross spectral density at     each frequency for each pair.  keys are (i,j).     freqs -- a vector of frequencies, equal in length to either the     coherence or phase vectors for any i,j key.  Eg, to make a coherence     Bode plot:         subplot(211)       plot( freqs, Cxy[(12,19)])       subplot(212)       plot( freqs, Phase[(12,19)])    For a large number of pairs, cohere_pairs can be much more efficient than just calling cohere for each pair, because it caches most of the intensive computations.  If N is the number of pairs, this function is O(N) for most of the heavy lifting, whereas calling cohere for each pair is O(N^2).  However, because of the caching, it is also more memory intensive, making 2 additional complex arrays with approximately the same number of elements as X.   The parameter 'preferSpeedOverMemory', if false, limits the caching by only making one, rather than two, complex cache arrays. This is useful if memory becomes critical.  Even when preferSpeedOverMemory is false, cohere_pairs will still give significant performace gains over calling cohere for each pair, and will use subtantially less memory than if preferSpeedOverMemory is true.  In my tests with a 43000,64 array over all nonredundant pairs, preferSpeedOverMemory=1 delivered a 33% performace boost on a 1.7GHZ Athlon with 512MB RAM compared with preferSpeedOverMemory=0.  But both solutions were more than 10x faster than naievly crunching all possible pairs through cohere.   See test/cohere_pairs_test.py in the src tree for an example script that shows that this cohere_pairs and cohere give the same results for a given pair. conv(x, y, mode=2) convolve x with y corrcoef(*args) corrcoef(X) where X is a matrix returns a matrix of correlation coefficients for each numrows observations and numcols variables.   corrcoef(x,y) where x and y are vectors returns the matrix or correlation coefficients for x and y.   Numeric arrays can be real or complex   The correlation matrix is defined from the covariance matrix C as   r(i,j) = C[i,j] / sqrt(C[i,i]*C[j,j]) csd(x, y, NFFT=256, Fs=2, detrend=<function detrend_none>, window=<function window_hanning>, noverlap=0) The cross spectral density Pxy by Welches average periodogram method.  The vectors x and y are divided into NFFT length segments.  Each segment is detrended by function detrend and windowed by function window.  noverlap gives the length of the overlap between segments.  The product of the direct FFTs of x and y are averaged over each segment to compute Pxy, with a scaling to correct for power loss due to windowing.  Fs is the sampling frequency.   NFFT must be a power of 2   Returns the tuple Pxy, freqs       Refs:   Bendat & Piersol -- Random Data: Analysis and Measurement     Procedures, John Wiley & Sons (1986) detrend(x, key=None) detrend_linear(x) Return x minus best fit line; 'linear' detrending detrend_mean(x) Return x minus the mean(x) detrend_none(x) Return x: no detrending diagonal_matrix(diag) Return square diagonal matrix whose non-zero elements are given by the input array. dist(x, y) return the distance between two points dist_point_to_segment(p, s0, s1) get the distance of a point to a segment.   p, s0, s1 are xy sequences   This algorithm from http://softsurfer.com/Archive/algorithm_0102/algorithm_0102.htm#Distance%20to%20Ray%20or%20Segment donothing_callback(*args) entropy(y, bins) Return the entropy of the data in y   \sum p_i log2(p_i) where p_i is the probability of observing y in the ith bin of bins.  bins can be a number of bins or a range of bins; see hist   Compare S with analytic calculation for a Gaussian x = mu + sigma*randn(200000) Sanalytic = 0.5  * ( 1.0 + log(2*pi*sigma**2.0) ) exp_safe(x) Compute exponentials which safely underflow to zero.   Slow but convenient to use. Note that NumArray will introduce proper floating point exception handling with access to the underlying hardware. fftsurr(x) Compute an FFT phase randomized surrogate of x find(condition) Return the indices where condition is true fix(x) Rounds towards zero. x_rounded = fix(x) rounds the elements of x to the nearest integers towards zero. For negative numbers is equivalent to ceil and for positive to floor. frange(xini, xfin=None, delta=None, **kw) frange([start,] stop[, step, keywords]) -> array of floats   Return a Numeric array() containing a progression of floats. Similar to arange(), but defaults to a closed interval.   frange(x0, x1) returns [x0, x0+1, x0+2, ..., x1]; start defaults to 0, and the endpoint *is included*. This behavior is different from that of range() and arange(). This is deliberate, since frange will probably be more useful for generating lists of points for function evaluation, and endpoints are often desired in this use. The usual behavior of range() can be obtained by setting the keyword 'closed=0', in this case frange() basically becomes arange().   When step is given, it specifies the increment (or decrement). All arguments can be floating point numbers.   frange(x0,x1,d) returns [x0,x0+d,x0+2d,...,xfin] where xfin<=x1.   frange can also be called with the keyword 'npts'. This sets the number of points the list should contain (and overrides the value 'step' might have been given). arange() doesn't offer this option.   Examples: >>> frange(3) array([ 0.,  1.,  2.,  3.]) >>> frange(3,closed=0) array([ 0.,  1.,  2.]) >>> frange(1,6,2) array([1, 3, 5]) >>> frange(1,6.5,npts=5) array([ 1.   ,  2.375,  3.75 ,  5.125,  6.5  ]) fromfunction_kw(function, dimensions, **kwargs) Drop-in replacement for fromfunction() from Numerical Python.   Allows passing keyword arguments to the desired function.   Call it as (keywords are optional): fromfunction_kw(MyFunction, dimensions, keywords)   The function MyFunction() is responsible for handling the dictionary of keywords it will recieve. get_sparse_matrix(M, N, frac=0.10000000000000001) return a MxN sparse matrix with frac elements randomly filled get_xyz_where(Z, Cond) Z and Cond are MxN matrices.  Z are data and Cond is a boolean matrix where some condition is satisfied.  Return value is x,y,z where x and y are the indices into Z and z are the values of Z at those indices.  x,y,z are 1D arrays hist(y, bins=10, normed=0) Return the histogram of y with bins equally sized bins.  If bins is an array, use the bins.  Return value is (n,x) where n is the count for each bin in x   If normed is False, return the counts in the first element of the return tuple.  If normed is True, return the probability density n/(len(y)*dbin)   If y has rank>1, it will be raveled Credits: the Numeric 22 documentation identity(n, rank=2, typecode='l') identity(n,r) returns the identity matrix of shape (n,n,...,n) (rank r).   For ranks higher than 2, this object is simply a multi-index Kronecker delta:                     /  1  if i0=i1=...=iR, id[i0,i1,...,iR] = -|                     \  0  otherwise.   Optionally a typecode may be given (it defaults to 'l').   Since rank defaults to 2, this function behaves in the default case (when only n is given) like the Numeric identity function. ispower2(n) Returns the log base 2 of n if n is a power of 2, zero otherwise.   Note the potential ambiguity if n==1: 2**0==1, interpret accordingly. l1norm(a) Return the l1 norm of a, flattened out.   Implemented as a separate function (not a call to norm() for speed). l2norm(a) Return the l2 norm of a, flattened out.   Implemented as a separate function (not a call to norm() for speed). levypdf(x, gamma, alpha) Returm the levy pdf evaluated at x for params gamma, alpha linspace(xmin, xmax, N) log2(x, ln2=0.69314718055994529) Return the log(x) in base 2.   This is a _slow_ function but which is guaranteed to return the correct integer value if the input is an ineger exact power of 2. longest_contiguous_ones(x) return the indicies of the longest stretch of contiguous ones in x, assuming x is a vector of zeros and ones. longest_ones(x) return the indicies of the longest stretch of contiguous ones in x, assuming x is a vector of zeros and ones.   If there are two equally long stretches, pick the first mean(x, dim=None) mean_flat(a) Return the mean of all the elements of a, flattened out. meshgrid(x, y) For vectors x, y with lengths Nx=len(x) and Ny=len(y), return X, Y where X and Y are (Ny, Nx) shaped arrays with the elements of x and y repeated to fill the matrix   EG,     [X, Y] = meshgrid([1,2,3], [4,5,6,7])      X =      1   2   3      1   2   3      1   2   3      1   2   3        Y =      4   4   4      5   5   5      6   6   6      7   7   7 mfuncC(f, x) mfuncC(f, x) : matrix function with possibly complex eigenvalues. Note: Numeric defines (v,u) = eig(x) => x*u.T = u.T * Diag(v) This function is needed by sqrtm and allows further functions. norm(a, p=2) norm(a,p=2) -> l-p norm of a.flat   Return the l-p norm of a, considered as a flat array.  This is NOT a true matrix norm, since arrays of arbitrary rank are always flattened.   p can be a number or the string 'Infinity' to get the L-infinity norm. normpdf(x, *args) Return the normal pdf evaluated at x; args provides mu, sigma orth(A) Orthogonalization procedure by Matlab. The description is taken from its help:       Q = ORTH(A) is an orthonormal basis for the range of A.     That is, Q'*Q = I, the columns of Q span the same space as      the columns of A, and the number of columns of Q is the      rank of A. polyfit(x, y, N) Do a best fit polynomial of order N of y to x.  Return value is a vector of polynomial coefficients [pk ... p1 p0].  Eg, for N=2     p2*x0^2 +  p1*x0 + p0 = y1   p2*x1^2 +  p1*x1 + p0 = y1   p2*x2^2 +  p1*x2 + p0 = y2   .....   p2*xk^2 +  p1*xk + p0 = yk       Method: if X is a the Vandermonde Matrix computed from x (see http://mathworld.wolfram.com/VandermondeMatrix.html), then the polynomial least squares solution is given by the 'p' in     X*p = y   where X is a len(x) x N+1 matrix, p is a N+1 length vector, and y is a len(x) x 1 vector   This equation can be solved as     p = (XT*X)^-1 * XT * y   where XT is the transpose of X and -1 denotes the inverse.   For more info, see http://mathworld.wolfram.com/LeastSquaresFittingPolynomial.html, but note that the k's and n's in the superscripts and subscripts on that page.  The linear algebra is correct, however.   See also polyval polyval(p, x) y = polyval(p,x)   p is a vector of polynomial coeffients and y is the polynomial evaluated at x.   Example code to remove a polynomial (quadratic) trend from y:     p = polyfit(x, y, 2)   trend = polyval(p, x)   resid = y - trend   See also polyfit prctile(x, p=(0.0, 25.0, 50.0, 75.0, 100.0)) Return the percentiles of x.  p can either be a sequence of percentil values or a scalar.  If p is a sequence the i-th element of the return sequence is the p(i)-th percentile of x prepca(P, frac=0) Compute the principal components of P.  P is a numVars x numObservations numeric array.  frac is the minimum fraction of variance that a component must contain to be included   Return value are Pcomponents : a num components x num observations numeric array Trans       : the weights matrix, ie, Pcomponents = Trans*P fracVar     : the fraction of the variance accounted for by each               component returned psd(x, NFFT=256, Fs=2, detrend=<function detrend_none>, window=<function window_hanning>, noverlap=0) The power spectral density by Welches average periodogram method. The vector x is divided into NFFT length segments.  Each segment is detrended by function detrend and windowed by function window. noperlap gives the length of the overlap between segments.  The absolute(fft(segment))**2 of each segment are averaged to compute Pxx, with a scaling to correct for power loss due to windowing.  Fs is the sampling frequency.   -- NFFT must be a power of 2 -- detrend and window are functions, unlike in matlab where they are    vectors. -- if length x < NFFT, it will be zero padded to NFFT     Returns the tuple Pxx, freqs   Refs:   Bendat & Piersol -- Random Data: Analysis and Measurement     Procedures, John Wiley & Sons (1986) rank(x) Returns the rank of a matrix. The rank is understood here as the an estimation of the number of linearly independent rows or columns (depending on the size of the matrix). Note that numerix.mlab.rank() is not equivalent to Matlab's rank. This function is! rem(x, y) Remainder after division. rem(x,y) is equivalent to x - y.*fix(x./y) in case y is not zero. By convention, rem(x,0) returns None. We keep the convention by Matlab: "The input x and y must be real arrays of the same size, or real scalars." reshape(...) reshape(a, (d1, d2, ..., dn)).  Change the shape of a to be an n-dimensional array with dimensions given by d1...dn.  Note: the size specified for the new array must be exactly equal to the size of the  old one or an error will occur. rk4(derivs, y0, t) Integrate 1D or ND system of ODEs from initial state y0 at sample times t.  derivs returns the derivative of the system and has the signature    dy = derivs(yi, ti)   Example 1 :       ## 2D system     # Numeric solution     def derivs6(x,t):         d1 =  x[0] + 2*x[1]         d2 =  -3*x[0] + 4*x[1]         return (d1, d2)     dt = 0.0005     t = arange(0.0, 2.0, dt)     y0 = (1,2)     yout = rk4(derivs6, y0, t)   Example 2:       ## 1D system     alpha = 2     def derivs(x,t):         return -alpha*x + exp(-t)       y0 = 1     yout = rk4(derivs, y0, t) rms_flat(a) Return the root mean square of all the elements of a, flattened out. searchsorted = binarysearch(...) binarysearch(a,v) segments_intersect(s1, s2) Return True if s1 and s2 intersect. s1 and s2 are defines as   s1: (x1, y1), (x2, y2) s2: (x3, y3), (x4, y4) specgram(x, NFFT=256, Fs=2, detrend=<function detrend_none>, window=<function window_hanning>, noverlap=128) Compute a spectrogram of data in x.  Data are split into NFFT length segements and the PSD of each section is computed.  The windowing function window is applied to each segment, and the amount of overlap of each segment is specified with noverlap   See pdf for more info.   The returned times are the midpoints of the intervals over which the ffts are calculated sqrtm(x) Returns the square root of a square matrix. This means that s=sqrtm(x) implies s*s = x. Note that s and x are matrices. sum_flat(a) Return the sum of all the elements of a, flattened out.   It uses a.flat, and if a is not contiguous, a call to ravel(a) is made. take(...) take(a, indices, axis=0).  Selects the elements in indices from array a along the given axis. trapz(x, y) vander(x, N=None) X = vander(x,N=None)   The Vandermonde matrix of vector x.  The i-th column of X is the the i-th power of x.  N is the maximum power to compute; if N is None it defaults to len(x). window_hanning(x) return x times the hanning window of len(x) window_none(x) No window function; simply return x zeros(...) zeros((d1,...,dn),typecode='l',savespace=0) will return a new array of shape (d1,...,dn) and type typecode with all it's entries initialized to zero.  If savespace is nonzero the array will be a spacesaver array. zeros_like(a) Return an array of zeros of the shape and typecode of a.

Data
		Complex = 'D' Float = 'd' Int = 'l' absolute = <ufunc 'absolute'> arctan2 = <ufunc 'arctan2'> ceil = <ufunc 'ceil'> conjugate = <ufunc 'conjugate'> divide = <ufunc 'divide'> division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192) exp = <ufunc 'exp'> exp_safe_MAX = 1.7976931348623157e+308 exp_safe_MIN = -708.39641853226408 floor = <ufunc 'floor'> log = <ufunc 'log'> multiply = <ufunc 'multiply'> pi = 3.1415926535897931 power = <ufunc 'power'> readme = '\nMLab2.py, release 1\n\nCreated on February 2003 b...\nLook at: http://pdilib.sf.net for new releases.\n' verbose = <matplotlib.Verbose instance>