Programmer Guide/Command Reference/EVAL/hcomb - Revision history

Christian at 18:21, 21 April 2011

2011-04-21T18:21:01Z

← Older revision		Revision as of 20:21, 21 April 2011
Line 10:		Line 10:
	:;<var>oflag</var>:selects the format and content of the result (see '''Result'''); the values '''0''' and '''1''' are supported		:;<var>oflag</var>:selects the format and content of the result (see '''Result'''); the values '''0''' and '''1''' are supported
	:;<var>a</var>:a vector containing an amplitude spectrum (linear, with constant df); in the description below ''n'' is the length of ''a''.		:;<var>a</var>:a vector containing an amplitude spectrum (linear, with constant df); in the description below ''n'' is the length of ''a''.
	:;<var>imin, imax</var>:index range for test tone (''ft'') detection; 0 <= ''imin'' < ''imax'' < ''n''		:;<var>imin, imax</var>:index range for test tone (''ft'') detection; 0 ≤ ''imin'' < ''imax'' < ''n''
	:;<var>ot</var>:test tone order (''f0'' = ''ft'' / ''ot''); 0 < ''ot''		:;<var>ot</var>:test tone order (''f0'' = ''ft'' / ''ot''); 0 < ''ot''
	:;<var>ok, oo</var>:order factor and offset for the components of the comp ''fc''[i];		:;<var>ok, oo</var>:order factor and offset for the components of the comp ''fc''[i];
	::<code>''fc''[i] = ''f0'' * (''oo'' + ''ok''*i); with: i=1,2,...</code>		::<code>''fc''[i] = ''f0'' * (''oo'' + ''ok''*i); with: i=1,2,...</code>
	:;<var>nget</var>:the number of points (+/-) to detect the peak of a harmonic component ''fc''[i]; 3 <= ''nget''		:;<var>nget</var>:the number of points (+/-) to detect the peak of a harmonic component ''fc''[i]; 3 ≤ ''nget''
	:;<var>rrms</var>:defines the energy ratio threshold for harmonic components; 0 <= ''rrms'' < 1		:;<var>rrms</var>:defines the energy ratio threshold for harmonic components; 0 ≤ ''rrms'' < 1
	:;<var>nrms</var>:defines the bandwidth (+/- ''nrms'' points) used to compute the energy ratio; 2 <= ''nrms''		:;<var>nrms</var>:defines the bandwidth (+/- ''nrms'' points) used to compute the energy ratio; 2 ≤ ''nrms''
	:::(<code>component-rms / testband-rms >= ''rrms''</code>)		:::(<code>component-rms / testband-rms ≥ ''rrms''</code>)
	:;<var>nset</var>:defines the comb bandwidth (+/- ''nset'' points); if ''nset'' equals 0, a variable comb bandwidth is used to remove the detected components; this argument is only used if ''oflag'' equals '''1'''		:;<var>nset</var>:defines the comb bandwidth (+/- ''nset'' points); if ''nset'' equals 0, a variable comb bandwidth is used to remove the detected components; this argument is only used if ''oflag'' equals '''1'''
	;Description:		;Description:

193.171.195.48 at 09:47, 21 April 2011

2011-04-21T09:47:26Z

← Older revision		Revision as of 11:47, 21 April 2011
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	This function implements a methods to detect harmonics in a spectrum and to create a harmonic comb filter.		This function implements a methods to detect harmonics in a spectrum and to create a harmonic comb filter.

	;Usage:<code>hcomb(<var>mflag</var>, <var>oflag</var>, <var>a</var>, <var>imin</var>, <var>imax</var>, <var>ot</var>, <var>ok</var>, <var>oo</var>, <var>nget</var>, <var>rrms</var>, <var>nrms</var>, <var>nset</var>)</code>		;Usage:<code>hcomb(<var>mflag</var>, <var>oflag</var>, <var>a</var>, <var>imin</var>, <var>imax</var>, <var>ot</var>, <var>ok</var>, <var>oo</var>, <var>nget</var>, <var>rrms</var>, <var>nrms</var>, <var>nset</var>)</code>
	:;<var>mflag</var>:selects the method used to detect the test tone ''ft''		:;<var>mflag</var>:selects the method used to detect the test tone ''ft''

Toni at 12:32, 20 April 2011

2011-04-20T12:32:09Z

← Older revision		Revision as of 14:32, 20 April 2011
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	This function implements a methods to detect harmonics in a spectrum and to create a harmonic comb filter~~. It was especially implemented for the [[Programmer_Guide/BScript#MulAc\|script application '''MulAc''']]~~.		This function implements a methods to detect harmonics in a spectrum and to create a harmonic comb filter.

	;Usage:<code>hcomb(<var>mflag</var>, <var>oflag</var>, <var>a</var>, <var>imin</var>, <var>imax</var>, <var>ot</var>, <var>ok</var>, <var>oo</var>, <var>nget</var>, <var>rrms</var>, <var>nrms</var>, <var>nset</var>)</code>		;Usage:<code>hcomb(<var>mflag</var>, <var>oflag</var>, <var>a</var>, <var>imin</var>, <var>imax</var>, <var>ot</var>, <var>ok</var>, <var>oo</var>, <var>nget</var>, <var>rrms</var>, <var>nrms</var>, <var>nset</var>)</code>

Toni at 11:25, 20 April 2011

2011-04-20T11:25:27Z

← Older revision		Revision as of 13:25, 20 April 2011
Line 10:		Line 10:
	\|}		\|}
	:;<var>oflag</var>:selects the format and content of the result (see '''Result'''); the values '''0''' and '''1''' are supported		:;<var>oflag</var>:selects the format and content of the result (see '''Result'''); the values '''0''' and '''1''' are supported
	:;<var>a</var>:a vector containing amplitude spectrum (linear, with constant df); in the description below ''n'' is the length of ''a''.		:;<var>a</var>:a vector containing an amplitude spectrum (linear, with constant df); in the description below ''n'' is the length of ''a''.
	:;<var>imin, imax</var>:index range for test tone (''ft'') detection; 0 <= ''imin'' < ''imax'' < ''n''		:;<var>imin, imax</var>:index range for test tone (''ft'') detection; 0 <= ''imin'' < ''imax'' < ''n''
	:;<var>ot</var>:test tone order (''f0'' = ''ft'' / ''ot''); 0 < ''ot''		:;<var>ot</var>:test tone order (''f0'' = ''ft'' / ''ot''); 0 < ''ot''

Toni at 11:24, 20 April 2011

2011-04-20T11:24:36Z

← Older revision		Revision as of 13:24, 20 April 2011
Line 38:		Line 38:
	\|}		\|}
	:*''oflag''=1: The result ''r'' is a vector with ''n'' elements containing the amplitude spectrum of the comb filter. Inside each detected band the amplitudes are set to '''1''', outside the amplitudes are set to '''0'''.		:*''oflag''=1: The result ''r'' is a vector with ''n'' elements containing the amplitude spectrum of the comb filter. Inside each detected band the amplitudes are set to '''1''', outside the amplitudes are set to '''0'''.
			:Note: All frequencies computed and returned by this function are relative frequencies, computed for a frequency resolution ''df''=1.
	;See also: [[../optmm\|optmm]], [[../cvphase\|cvphase]], [[Programmer_Guide/BScript#MulAc\|script application '''MulAc''']]		;See also: [[../optmm\|optmm]], [[../cvphase\|cvphase]], [[Programmer_Guide/BScript#MulAc\|script application '''MulAc''']]

	[[../#Functions\|<function list>]]		[[../#Functions\|<function list>]]

Toni at 11:22, 20 April 2011

2011-04-20T11:22:47Z

← Older revision		Revision as of 13:22, 20 April 2011
Line 37:		Line 37:
	\|''r''[i,2] \|\| order of component i (i=1..M)		\|''r''[i,2] \|\| order of component i (i=1..M)
	\|}		\|}
	:*''oflag''=1		:*''oflag''=1: The result ''r'' is a vector with ''n'' elements containing the amplitude spectrum of the comb filter. Inside each detected band the amplitudes are set to '''1''', outside the amplitudes are set to '''0'''.
	;See also: [[../optmm\|optmm]], [[../cvphase\|cvphase]], [[Programmer_Guide/BScript#MulAc\|script application '''MulAc''']]		;See also: [[../optmm\|optmm]], [[../cvphase\|cvphase]], [[Programmer_Guide/BScript#MulAc\|script application '''MulAc''']]

	[[../#Functions\|<function list>]]		[[../#Functions\|<function list>]]

Toni at 11:19, 20 April 2011

2011-04-20T11:19:55Z

← Older revision		Revision as of 13:19, 20 April 2011
Line 26:		Line 26:
	;Result:		;Result:
	:*''oflag''=0: The result ''r'' is a (M+1)x3 matrix, with M is the number of detected harmonics		:*''oflag''=0: The result ''r'' is a (M+1)x3 matrix, with M is the number of detected harmonics
	::{class ="einrahmen"		::{\|class ="einrahmen"
	\|''r''[0,0] \|\| fundamental frequency ''f0'' (weighted average of component frequencies)		\|''r''[0,0] \|\| fundamental frequency ''f0'' (weighted average of component frequencies)
	\|-		\|-

Toni at 11:19, 20 April 2011

2011-04-20T11:19:38Z

← Older revision		Revision as of 13:19, 20 April 2011
Line 21:		Line 21:
	:;<var>nset</var>:defines the comb bandwidth (+/- ''nset'' points); if ''nset'' equals 0, a variable comb bandwidth is used to remove the detected components; this argument is only used if ''oflag'' equals '''1'''		:;<var>nset</var>:defines the comb bandwidth (+/- ''nset'' points); if ''nset'' equals 0, a variable comb bandwidth is used to remove the detected components; this argument is only used if ''oflag'' equals '''1'''
	;Description:		;Description:
	#The function extracts the frequency ~~of the test tone~~ ''ft'' from the selected test frequency band (arguments: ''mflag'', ''imin'', ''imax'' and ''rr'').		#The function extracts the frequency ''ft'' of the test tone from the selected test frequency band (arguments: ''mflag'', ''imin'', ''imax'' and ''rr'').
	#The argument ''ot'' is used to compute the fundamental frequency ''f0'' of the harmonic comb.		#The argument ''ot'' is used to compute the fundamental frequency ''f0'' of the harmonic comb.
	#For each frequency band of the harmonic comb is tested if there is a ~~harmonic~~ spectral component or not. The frequency, amplitude and order of the detected harmonic components is saved.		#For each frequency band of the harmonic comb is tested if there is a spectral component (peak) or not. The frequency, amplitude and order of the detected harmonic components are saved.
	;Result:		;Result:
	:*''oflag''=0: The result is a (M+1)x3 matrix, with M is the number of detected harmonics		:*''oflag''=0: The result ''r'' is a (M+1)x3 matrix, with M is the number of detected harmonics
			::{class ="einrahmen"
			\|''r''[0,0] \|\| fundamental frequency ''f0'' (weighted average of component frequencies)
			\|-
			\|''r''[0,1], ''r[0,2] \|\| always '''0'''
			\|-
			\|''r''[i,0] \|\| frequency of component i (i=1..M)
			\|-
			\|''r''[i,1] \|\| amplitude of component i (i=1..M)
			\|-
			\|''r''[i,2] \|\| order of component i (i=1..M)
			\|}
	:*''oflag''=1		:*''oflag''=1
	;See also: [[../optmm\|optmm]], [[../cvphase\|cvphase]], [[Programmer_Guide/BScript#MulAc\|script application '''MulAc''']]		;See also: [[../optmm\|optmm]], [[../cvphase\|cvphase]], [[Programmer_Guide/BScript#MulAc\|script application '''MulAc''']]

	[[../#Functions\|<function list>]]		[[../#Functions\|<function list>]]

Toni at 11:13, 20 April 2011

2011-04-20T11:13:59Z

@@ Line 20: / Line 20: @@
 :::(<code>component-rms / testband-rms >= ''rrms''</code>)
 :;<var>nset</var>:defines the comb bandwidth (+/- ''nset'' points); if ''nset'' equals 0, a variable comb bandwidth is used to remove the detected components; this argument is only used if ''oflag'' equals '''1'''
-:;
+;Description:
+#The function extracts the frequency of the test tone ''ft'' from the selected test frequency band (arguments: ''mflag'', ''imin'', ''imax'' and ''rr'').
+#The argument ''ot'' is used to compute the fundamental frequency ''f0'' of the harmonic comb.
+#For each frequency band of the harmonic comb is tested if there is a harmonic spectral component or not. The frequency, amplitude and order of the detected harmonic components is saved.
-test tone order (''f0'' = ''ft'' / ''ot''); 0 < ''ot''
+;Result:
+:*''oflag''=0: The result is a (M+1)x3 matrix, with M is the number of detected harmonics
+:*''oflag''=1
+;See also: [[../optmm|optmm]], [[../cvphase|cvphase]], [[Programmer_Guide/BScript#MulAc|script application '''MulAc''']]
 [[../#Functions|<function list>]]

Toni at 11:01, 20 April 2011

2011-04-20T11:01:16Z

← Older revision		Revision as of 13:01, 20 April 2011
Line 11:		Line 11:
	:;<var>oflag</var>:selects the format and content of the result (see '''Result'''); the values '''0''' and '''1''' are supported		:;<var>oflag</var>:selects the format and content of the result (see '''Result'''); the values '''0''' and '''1''' are supported
	:;<var>a</var>:a vector containing amplitude spectrum (linear, with constant df); in the description below ''n'' is the length of ''a''.		:;<var>a</var>:a vector containing amplitude spectrum (linear, with constant df); in the description below ''n'' is the length of ''a''.
	:;<var>imin, imax</var>index range for test tone (''ft'') detection; 0 <= ''imin'' < ''imax'' < ''n''		:;<var>imin, imax</var>:index range for test tone (''ft'') detection; 0 <= ''imin'' < ''imax'' < ''n''
	:;<var>ot</var>:test tone order (''f0'' = ''ft'' / ''ot''); 0 < ''ot''		:;<var>ot</var>:test tone order (''f0'' = ''ft'' / ''ot''); 0 < ''ot''
	:;<var>ok, oo</var>:order factor and offset for the components of the comp ''fc''[i];		:;<var>ok, oo</var>:order factor and offset for the components of the comp ''fc''[i];