From 1251f70aa3442736ce6fd9c4fb7fbce412af5a52 Mon Sep 17 00:00:00 2001 From: Sunil Shetye Date: Wed, 25 Jul 2018 17:11:09 +0530 Subject: code changes by Kartik Hegde during FOSSEE Fellowship 2018 --- help/en_US/ac2poly.xml | 2 +- help/en_US/armcov.xml | 41 +++++++++++- help/en_US/buffer.xml | 10 +-- help/en_US/cconv.xml | 51 ++++++++++++++- help/en_US/cummax.xml | 34 ++++++---- help/en_US/decimate.xml | 58 ++++++++++++++++- help/en_US/filtfilt.xml | 7 +- help/en_US/filtic.xml | 15 +++-- help/en_US/firtype.xml | 42 +++++++++++- help/en_US/fwhmjlt.xml | 35 +++++++++- help/en_US/fwht.xml | 2 +- help/en_US/helperHarmonicDistortion.xml | 81 ++++++++++++++++++++++++ help/en_US/helperHarmonicDistortionAmplifier.xml | 23 ------- help/en_US/icceps.xml | 39 ++++++++++++ help/en_US/impz.xml | 51 ++++++++++++++- help/en_US/impzlength.xml | 42 ++++++++---- help/en_US/interp.xml | 64 ------------------- help/en_US/intfilt.xml | 58 ++++++++++++++++- help/en_US/is2rc.xml | 34 ++++++---- help/en_US/isallpass.xml | 72 ++++++++++++++++++++- help/en_US/oct_interp.xml | 64 +++++++++++++++++++ 21 files changed, 677 insertions(+), 148 deletions(-) create mode 100644 help/en_US/helperHarmonicDistortion.xml delete mode 100644 help/en_US/helperHarmonicDistortionAmplifier.xml delete mode 100644 help/en_US/interp.xml create mode 100644 help/en_US/oct_interp.xml (limited to 'help/en_US') diff --git a/help/en_US/ac2poly.xml b/help/en_US/ac2poly.xml index e90759d..33cbd96 100644 --- a/help/en_US/ac2poly.xml +++ b/help/en_US/ac2poly.xml @@ -57,6 +57,6 @@ Parthe Pandit Bibliography - Kay, Steven M. Modern Spectral Estimation. Englewood Cliffs, NJ: Prentice-Hall, 1988. + kartik Kay, Steven M. Modern Spectral Estimation. Englewood Cliffs, NJ: Prentice-Hall, 1988. diff --git a/help/en_US/armcov.xml b/help/en_US/armcov.xml index 62e33b7..79ed57c 100644 --- a/help/en_US/armcov.xml +++ b/help/en_US/armcov.xml @@ -17,7 +17,46 @@ armcov - + This function uses the modified covariance method to fit a pth-order autoregressive (AR) model to the input signal x + + Calling Sequence + + a=armcov(x,p) + [a,e] = armcov(x,p) + + + + + Parameters + + x: + input signal + p: + order + a: + output of an AR system driven by white noise + e: + variance estimate + + + + + Description + +This function uses the modified covariance method to fit a pth-order autoregressive (AR) model to the input signal x. + + + + + Examples + + + diff --git a/help/en_US/buffer.xml b/help/en_US/buffer.xml index 24b5214..9a8db7b 100644 --- a/help/en_US/buffer.xml +++ b/help/en_US/buffer.xml @@ -56,11 +56,11 @@ This function buffers the given data into a matrix of signal frames Examples diff --git a/help/en_US/cconv.xml b/help/en_US/cconv.xml index 5c9a665..3cb0ea8 100644 --- a/help/en_US/cconv.xml +++ b/help/en_US/cconv.xml @@ -17,7 +17,56 @@ cconv - [nargout,nargin]=argn(); + circularly convolves vectors a and b. n is the length of the resulting vector. + + Calling Sequence + + o = cconv(a,b) + o = cconv(a,b,n) + + + + + Parameters + + a: + a real or complex vector. + b: + a real or complex vector. + n: + length of circular convolution + o: + convolution sequence + + + + + Description + +This function buffers the given data into a matrix of signal frames + + + + + Examples + + + + + diff --git a/help/en_US/cummax.xml b/help/en_US/cummax.xml index 76c863a..e385ac0 100644 --- a/help/en_US/cummax.xml +++ b/help/en_US/cummax.xml @@ -25,32 +25,42 @@ Calling Sequence M = cummax(A) - returns the cumulative maximum of the arguments of A. The dimension - of M is same as the dimension of A. If A is a 2D matrix, the operation - is performed along the columns. For a hypermatrix, the operation is - performed along the first non-zero dimension M = cummax(A,dim) - The operation is performed along the dimension specified by dim M = cummax(_,direction) - direction specifies as the direction of operation - Parameters + + A: + positive integer valueFor complex elements, cummax compares the magnitude of elements. If the magnitude are same, phase angles are compared. + dim: + Dimension to operate alongIf no dimension is specified, then the default value is the first array dimension whose value is greater than 1 + direction: + Direction of cumulationIf the direction is forward, cummax works from 1 to end of the active dimension. Otherwise, it works in the opposite sense + + + Description + +The function returns the cumulative maximum elements of the input vector/array. + + + + + Examples @@ -62,9 +72,5 @@ Expected output: [8 8 1 1 1 1 1 1 1 1] - - See also - - - + diff --git a/help/en_US/decimate.xml b/help/en_US/decimate.xml index bc0efe7..30440dd 100644 --- a/help/en_US/decimate.xml +++ b/help/en_US/decimate.xml @@ -17,7 +17,63 @@ decimate - rhs = argn(2) + Decimation — decrease sample rate by integer factor + + Calling Sequence + + y = decimate(x,q) + y = decimate(x,q,n) + y = decimate (…, "fir") + + + + + Parameters + + x: + input sequence + q: + reduction factor + n: + filter order + ftype: + filter type: iir or fir + + + + + Description + +y = decimate(x,q) reduces the sample rate of x, the input signal, by a factor of q. +By default, an order n Chebyshev type I filter is used. If n is not specified, the default is 8. +If the optional argument "fir" is given, an order n FIR filter is used, with a default order of 30 if n is not given. +Note that q must be an integer for this rate change method. + + + + + Examples + + + + + + + Authors + + Ayush Baid + + + + diff --git a/help/en_US/filtfilt.xml b/help/en_US/filtfilt.xml index baf8dfe..e8d9c99 100644 --- a/help/en_US/filtfilt.xml +++ b/help/en_US/filtfilt.xml @@ -17,7 +17,7 @@ filtfilt - + Zero phase digital filtering @@ -51,8 +51,9 @@ In theory, it forwards and reverse filters the signal and corrects phase distort Examples diff --git a/help/en_US/filtic.xml b/help/en_US/filtic.xml index ec5e08e..f27f53e 100644 --- a/help/en_US/filtic.xml +++ b/help/en_US/filtic.xml @@ -17,7 +17,7 @@ filtic - + This function finds the initial conditions for the delays in the transposed direct-form II filter implementation @@ -54,12 +54,13 @@ The vectors b and a represent the numerator and denominator coefficients of the Examples diff --git a/help/en_US/firtype.xml b/help/en_US/firtype.xml index 8050565..c4bc7e5 100644 --- a/help/en_US/firtype.xml +++ b/help/en_US/firtype.xml @@ -17,7 +17,47 @@ firtype - if (type(b)~=1) then + This function identifies Type of linear phase FIR filter + + + Calling Sequence + + t=firtype(b) + + + + + Parameters + + t: + type of an FIR filter + b: + Filter coefficients + + + + + + Description + +"t = firtype(b)" determines the type, t, of an FIR filter with coefficients b. "t" can be 1, 2, 3, or 4. +The filter must be real and have linear phase. + + + + + + Examples + + + + + diff --git a/help/en_US/fwhmjlt.xml b/help/en_US/fwhmjlt.xml index 4663d1a..c093385 100644 --- a/help/en_US/fwhmjlt.xml +++ b/help/en_US/fwhmjlt.xml @@ -17,7 +17,40 @@ fwhmjlt - rhs = argn(2) + This function Computes peak full-width at half maximum + + Calling Sequence + + f = fwhm (y) + f = fwhm (x, y) + f = fwhm (…, "zero") + f = fwhm (…, "min") + f = fwhm (…, "alevel", level) + f = fwhm (…, "rlevel", level) + + + + + + + Description + +Compute peak full-width at half maximum (FWHM) or at another level of peak maximum for vector or matrix data y, optionally sampled as y(x). If y is a matrix, return FWHM for each column as a row vector.The default option "zero" computes fwhm at half maximum, i.e. 0.5*max(y). The option "min" computes fwhm at the middle curve, i.e. 0.5*(min(y)+max(y)). The option "rlevel" computes full-width at the given relative level of peak profileThe option "alevel" computes full-width at the given absolute level of y. + + + + + Examples + + + + diff --git a/help/en_US/fwht.xml b/help/en_US/fwht.xml index 4140453..4e0d8a6 100644 --- a/help/en_US/fwht.xml +++ b/help/en_US/fwht.xml @@ -17,7 +17,7 @@ fwht - Compute the Walsh-Hadamard transform of x using the Fast Walsh-Hadamard Transform (FWHT) algorithm + Compute the Walsh-Hadamard transform of x using the Fast Walsh-Hadamard Transform (FWHT) algorithm.. diff --git a/help/en_US/helperHarmonicDistortion.xml b/help/en_US/helperHarmonicDistortion.xml new file mode 100644 index 0000000..b49a559 --- /dev/null +++ b/help/en_US/helperHarmonicDistortion.xml @@ -0,0 +1,81 @@ + + + + + + + + helperHarmonicDistortion + helperHarmonicDistortionADC Helper function for HarmonicDistortionExample.m + + + + + Calling Sequence + + outputVoltage=helperHarmonicDistortion(inputVoltage) + + + + + Parameters + + inputVmax: + Maximum operating voltage times the sinusoidal signal. + + + + + + Description + +Analizing the harmonic distortion of a weakly non-linear system in the presence of noise.... + + + + + Examples + + + VmaxPk = 2; + Fi = 2000; + Fs = 44.1e3; + Tstop = 50e-3; + t = 0:1/Fs:Tstop; + inputVmax = VmaxPk*sin(2*%pi*Fi*t); + outputVmax = helperHarmonicDistortion(inputVmax); + plot(t, outputVmax) + replot([0,-2.5,0.005,2.5]) + xlabel('Time') + ylabel('Output Voltage') + title('Amplifier output') + + + + + + diff --git a/help/en_US/helperHarmonicDistortionAmplifier.xml b/help/en_US/helperHarmonicDistortionAmplifier.xml deleted file mode 100644 index c58cc51..0000000 --- a/help/en_US/helperHarmonicDistortionAmplifier.xml +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - - - helperHarmonicDistortionAmplifier - helperHarmonicDistortionADC Helper function for HarmonicDistortionExample.m - - - diff --git a/help/en_US/icceps.xml b/help/en_US/icceps.xml index bd10adc..0cae986 100644 --- a/help/en_US/icceps.xml +++ b/help/en_US/icceps.xml @@ -20,4 +20,43 @@ ICCEPS computes the inverse cepstrum of a real-valued input. This spectrum + + Calling Sequence + + inv_ceps = icceps(xhat,remv_samp) + + + + + Parameters + + remv_samp: + Number of samples of delay to be removed + xhat: + real valued input + inv_ceps: + Inverse cepstrum output + + + + + Description + +inv_ceps = icceps(xhat,remv_samp) returns the inverse complex cepstrum of the real data sequence "xhat", removing "remv_samp" samples of delay. If "xhat" was obtained with cceps(x), then the amount of delay that was added to x was the element of round(unwrap(angle(fft(x)))/pi) corresponding to π radians. + + + + + + Examples + + + diff --git a/help/en_US/impz.xml b/help/en_US/impz.xml index 3cde46f..197c5c8 100644 --- a/help/en_US/impz.xml +++ b/help/en_US/impz.xml @@ -17,7 +17,8 @@ impz - + It gives Impulse response of digital filter + @@ -31,4 +32,52 @@ [x_r, t_r] = impz(b, a, n, fs) + + + + Parameters + + x_r: + impz chooses the number of samples and returns the response in the column vector, x_r. + t_r: + impz returns the sample times in the column vector, t_r + b: + numerator coefficients of the filter + a: + denominator coefficients of the filter + n: + samples of the impulse response t(by default ,n = length(t) and is computed automatically. + fs: + sampling frequency + + + + + Description + +[x_r,t_r] = impz(b,a) returns the impulse response of the filter with numerator coefficients, b, and denominator coefficients, a. impz chooses the number of samples and returns the response in the column vector, x_r, and the sample times in the column vector, t_r. t_r = [0:n-1]' and n = length(t) is computed automatically. + + + + + Example 1 + + + + + Example 2 + + + diff --git a/help/en_US/impzlength.xml b/help/en_US/impzlength.xml index 1b5adc8..6ed57fc 100644 --- a/help/en_US/impzlength.xml +++ b/help/en_US/impzlength.xml @@ -24,7 +24,31 @@ Calling Sequence - len = impzlength(b, a, tol) + len=impzlength(b,a) + len=impzlength(sos) + len=impzlength(b,a,tol) + + + + + + Parameters + + b: + Numerator coefficients. real|complex - vector|scalar + a: + Denominator coefficients. real|complex - vector|scalar + sos: + Second order estimates. real|complex - matrix (K-by-6) + tol: + Tolerance for estimating the effective length of an IIR filter impulse response. scalar + + + + + Description + +len = impzlength(b, a, tol) returns the impulse response length for the causal discrete-time filter with the transfer function coefficients for numerator and denominator in a and b respectively. For stable IIR filters, len is the effective length @@ -39,23 +63,18 @@ specifies a tolerance for estimating the effective impulse response length in case of an IIR filter. By default, tol is 5e-5. Increasing tol leads to shorter len and vice-versa - - - - - - Parameters - - + Examples @@ -63,7 +82,8 @@ len = impzlength(b,a); See also - | digitalFilter | impz | zp2sos + + diff --git a/help/en_US/interp.xml b/help/en_US/interp.xml deleted file mode 100644 index ec22cbc..0000000 --- a/help/en_US/interp.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - interp - function y = interp(x, q, n, Wc) - - - - - Calling Sequence - - y = interp(x, q) - y = interp(x, q, n) - y = interp(x, q, n, Wc) - - - - - Parameters - - x: - scalar or vector of complex or real numbers - q: - positive integer value, or logical - n: - positive integer, default value 4 - Wc: - non decreasing vector or scalar, starting from 0 uptill 1, default value 0.5 - - - - - Description - -This is an Octave function. -This function upsamples the signal x by a factor of q, using an order 2*q*n+1 FIR filter. -The second argument q must be an integer. The default values of the third and fourth arguments (n, Wc) are 4 and 0.5 respectively. - - - - - Examples - - - diff --git a/help/en_US/intfilt.xml b/help/en_US/intfilt.xml index a674813..29c93f6 100644 --- a/help/en_US/intfilt.xml +++ b/help/en_US/intfilt.xml @@ -17,7 +17,63 @@ intfilt - + The "intfilt" function estimate Interpolated FIR Filter Design + + Calling Sequence + + h=intfilt(R,L,freqmult) + [h a]=intfilt(R,L,freqmult) + + + + + + Parameters + + R: + Samples. It should be numeric + L: + bandlimited interpolation samples. It must be nonzero. + freqmult: + bandlimitedness of ALPHA times the Nyquist frequency. It can be numeric or character ('B' or 'L', B is length (N+1)*L-1 for N odd and (N+1)*L for N even) + + + + + + Description + +"h=intfilt(R,L,freqmult)" designs a linear phase FIR filter. This function does ideal bandlimited interpolation using the nearest 2*L nonzero samples, when used on a sequence inserted with l-1 consecutive zeros between every l samples. It assumes an original bandlimitedness of "freqmult" times the Nyquist frequency. + + + + + Example 1 + + + + + Example 2 + + + + + Authors + + Jitendra Singh + + + diff --git a/help/en_US/is2rc.xml b/help/en_US/is2rc.xml index 8f1bd14..0da550b 100644 --- a/help/en_US/is2rc.xml +++ b/help/en_US/is2rc.xml @@ -25,7 +25,7 @@ Calling Sequence K = is2rc(isin) - + @@ -42,19 +42,25 @@ Description -This function returns a vector of reflection coefficients from a vector of inverse sine parameters -output array has k(i) = sin(pi/2*isin(i)) - - -Example -k = [0.3090 0.9801 0.0031 0.0082 -0.0082]; -isin = rc2is(k) //Gives inverse sine parameters -k_dash = is2rc(isin) +This function returns a vector of reflection coefficients from a vector of inverse sine parameters.output array has k(i) = sin(pi/2*isin(i)) + + + Example 1 + + + See also @@ -62,8 +68,14 @@ k_dash = is2rc(isin) rc2poly rc2ac rc2lar - Author - Pandit + + + + + + Authors + + Parthe Pandit diff --git a/help/en_US/isallpass.xml b/help/en_US/isallpass.xml index b519d07..4dbf9ab 100644 --- a/help/en_US/isallpass.xml +++ b/help/en_US/isallpass.xml @@ -17,7 +17,77 @@ isallpass - [nargout,nargin]=argn(); + Determines whether the filter is allpass or not + + Calling Sequence + + flag = isallpass(b,a) + flag = isallpass(sos) + flag = isallpass(...,tol) + + + + + + Parameters + + b: + vector containing zero coefficients of the transfer function + a: + vector containing pole coefficients of the transfer functtion + sos: + Second order estimates. real|complex - matrix (K-by-6) + tol: + tolerance is used to determine when two numbers are close enough to be considered equal. scalar + + + + + Description + +flag = isallpass(b,a) returns a logical output that is either 1 or 0 depending on output parameter "flag" by the filter specified by numerator coefficients, b, and denominator coefficients, a, is an allpass filter or not. If the filter is not an allpass filter, flag is equal to false.flag = isallpass(sos) returns true if the filter specified by second order sections matrix ie sos, is an allpass filter. sos is a K-by-6 matrix, where the number of sections, K, must be greater than or equal to 2. Each row of sos corresponds to the coefficients of a second order (biquad) filter. The ith row of the sos matrix corresponds to [bi(1) bi(2) bi(3) ai(1) ai(2) ai(3)]. + + + + + Example 1 + + + + + Example 2 + + + + + Example 3 + + + + + Authors + + Parthasarathi Panda + + + diff --git a/help/en_US/oct_interp.xml b/help/en_US/oct_interp.xml new file mode 100644 index 0000000..48146ea --- /dev/null +++ b/help/en_US/oct_interp.xml @@ -0,0 +1,64 @@ + + + + + + + + oct_interp + function y = interp(x, q, n, Wc) + + + + + Calling Sequence + + y = interp(x, q) + y = interp(x, q, n) + y = interp(x, q, n, Wc) + + + + + Parameters + + x: + scalar or vector of complex or real numbers + q: + positive integer value, or logical + n: + positive integer, default value 4 + Wc: + non decreasing vector or scalar, starting from 0 uptill 1, default value 0.5 + + + + + Description + +This is an Octave function. +This function upsamples the signal x by a factor of q, using an order 2*q*n+1 FIR filter. +The second argument q must be an integer. The default values of the third and fourth arguments (n, Wc) are 4 and 0.5 respectively. + + + + + Examples + + + -- cgit