Programmer Guide/Command Reference/EVAL - Revision history

Jw: /* Functions */

2015-03-02T13:12:20Z

Functions

← Older revision		Revision as of 15:12, 2 March 2015
Line 345:		Line 345:
	==Functions==		==Functions==
	<!-- A.N.: Bei ändern/hinzufügen der Dokumentation einer EVAL Funktion bitte hier richtiges Datum setzen -->		<!-- A.N.: Bei ändern/hinzufügen der Dokumentation einer EVAL Funktion bitte hier richtiges Datum setzen -->
	latest update: ~~April 21~~, ~~2011~~ (A.N.)		latest update: March 2, 2015 (J.W.)
			<!-- J.W.: added f0sp documentation (direct from cpp source file) -->
	<!-- A.N.:		<!-- A.N.:
	Die Beschreibung der EVAL Funktionen entspricht dem aktuellen Stand.		Die Beschreibung der EVAL Funktionen entspricht dem aktuellen Stand.

Christian: /* Script examples */

2014-04-25T14:23:23Z

Script examples

← Older revision		Revision as of 16:23, 25 April 2014
Line 587:		Line 587:
	// pick out the smallest/largest value from vec1, vec2 and a number of numbers		// pick out the smallest/largest value from vec1, vec2 and a number of numbers
	#min := eval [[Programmer_Guide/Command_Reference/EVAL/min\|min]]($#v1, $#v2, 100, 20)		#min := eval [[Programmer_Guide/Command_Reference/EVAL/min\|min]]($#v1, $#v2, 100, 20)
	#max := eval [[[[Programmer_Guide/Command_Reference/EVAL/max\|max]]($#v1,$#v2, 100, 20)		#max := eval [[Programmer_Guide/Command_Reference/EVAL/max\|max]]($#v1,$#v2, 100, 20)

	// merge vectors and numbers		// merge vectors and numbers

Christian: /* Script examples */

2014-04-25T14:23:00Z

Script examples

← Older revision		Revision as of 16:23, 25 April 2014
Line 538:		Line 538:

	// using "? :" to select a function argument		// using "? :" to select a function argument
	#c1 := eval sin( $#a > $#b ? $#a : $#b )		#c1 := eval [[Programmer_Guide/Command_Reference/EVAL/sin\|sin]]( $#a > $#b ? $#a : $#b )
	#c2 := eval sin( $#a < $#b ? $#a : $#b )		#c2 := eval [[Programmer_Guide/Command_Reference/EVAL/sin\|sin]]( $#a < $#b ? $#a : $#b )

	// initialize vectors		// initialize vectors
	#v1 := eval [[Programmer_Guide/Command_Reference/EVAL/fill\|fill]]( 10, 0.1, 0.2 ) // ten elements		#v1 := eval [[Programmer_Guide/Command_Reference/EVAL/fill\|fill]]( 10, 0.1, 0.2 ) // ten elements
	#v2 := eval [[Programmer_Guide/Command_Reference/EVAL/fill\|fill]]( 10, 0.2, 0.1 ) // also ten elements		#v2 := eval [[Programmer_Guide/Command_Reference/EVAL/fill\|fill]]( 10, 0.2, 0.1 ) // also ten elements
	#v3 := eval fill( 5, 0.2, 0.1 ) // only five elements		#v3 := eval [[Programmer_Guide/Command_Reference/EVAL/fill\|fill]]( 5, 0.2, 0.1 ) // only five elements

	// ten elements each of which is larger than the corresponding element in #v1		// ten elements each of which is larger than the corresponding element in #v1
Line 564:		Line 564:
	#c1 := eval $#v1 == $#v3		#c1 := eval $#v1 == $#v3
	#c2 := eval $#v1 != $#v3		#c2 := eval $#v1 != $#v3

	// illegal comparisons due to different size		// illegal comparisons due to different size
	#c3 := eval $#v1 < $#v3 // illegal!		#c3 := eval $#v1 < $#v3 // illegal!
Line 572:		Line 573:

	// limit all values to be >= -1 and <= 2		// limit all values to be >= -1 and <= 2
	$#v2 := eval limit( $#v1, -2, 2 )		$#v2 := eval [[Programmer_Guide/Command_Reference/EVAL/limit\|limit]]( $#v1, -2, 2 )
	// set lowest bound only		// set lowest bound only
	$#v2 := eval limitLow( $#v1, -2 )		$#v2 := eval [[Programmer_Guide/Command_Reference/EVAL/limit\|limitLow]]( $#v1, -2 )
	// set highest bound only		// set highest bound only
	$#v2 := eval limitHigh( $#v1, 2 )		$#v2 := eval [[Programmer_Guide/Command_Reference/EVAL/limit\|limitHigh]]( $#v1, 2 )

	// this works with a number (as opposed to vectors and matrices), too		// this works with a number (as opposed to vectors and matrices), too
	#c1 := 123.5		#c1 := 123.5
	#c2 := eval limit($#c1,0,100)		#c2 := eval [[Programmer_Guide/Command_Reference/EVAL/limit\|limit]]($#c1,0,100)
	#c2 := eval ~~limitlow~~( $#c1, 100 )		#c2 := eval [[Programmer_Guide/Command_Reference/EVAL/limit\|limitLow]]( $#c1, 100 )
	#c2 := eval ~~limithigh~~( $#c1, 100 )		#c2 := eval [[Programmer_Guide/Command_Reference/EVAL/limit\|limitHigh]]( $#c1, 100 )

	// pick out the smallest/largest value from vec1, vec2 and a number of numbers		// pick out the smallest/largest value from vec1, vec2 and a number of numbers
	#min := eval min($#v1, $#v2, 100, 20)		#min := eval [[Programmer_Guide/Command_Reference/EVAL/min\|min]]($#v1, $#v2, 100, 20)
	#max := eval max($#v1,$#v2, 100, 20)		#max := eval [[[[Programmer_Guide/Command_Reference/EVAL/max\|max]]($#v1,$#v2, 100, 20)

	// merge vectors and numbers		// merge vectors and numbers
	$#v3 := eval vv($#v1, $#c1, $#v2, $#c2)		$#v3 := eval [[Programmer_Guide/Command_Reference/EVAL/vv\|vv]]($#v1, $#c1, $#v2, $#c2)

	In the directory '''scripts\examples''' of the {{STX}} installation, you can find a lot of script files using <code>EVAL</code> for differnt purposes (dsp_examples.sts, eval_example.sts, expression_checks.sts, matrix_algebra_examples.sts, parameter_table_example.sts, plot_sample.sts, polygon_examples.sts, ...)		In the directory '''scripts\examples''' of the {{STX}} installation, you can find a lot of script files using <code>EVAL</code> for differnt purposes (dsp_examples.sts, eval_example.sts, expression_checks.sts, matrix_algebra_examples.sts, parameter_table_example.sts, plot_sample.sts, polygon_examples.sts, ...)

Christian: /* Using GDX files */

2014-04-25T14:20:12Z

Using GDX files

← Older revision		Revision as of 16:20, 25 April 2014
Line 464:		Line 464:
	// Result: the path of the GDX file containing the spectrogram		// Result: the path of the GDX file containing the spectrogram
	//---		//---
	#path := [[Programmer_Guide/Command_Reference/UNIQUE\|unique^]] '$@work' gdx 1 8 // get unique output file name		#path := [[Programmer_Guide/Command_Reference/UNIQUE\|unique]] '$@work' gdx 1 8 // get unique output file name
	#lfft := eval [[Programmer_Guide/Command_Reference/EVAL/fft\|fft]]($#len) // compute transformation length		#lfft := eval [[Programmer_Guide/Command_Reference/EVAL/fft\|fft]]($#len) // compute transformation length
	#nfrm := int $#wave[!length] / $#hop // compute number of frames		#nfrm := int $#wave[!length] / $#hop // compute number of frames

Christian: /* Using GDX files */

2014-04-25T14:20:01Z

Using GDX files

← Older revision		Revision as of 16:20, 25 April 2014
Line 456:		Line 456:

	===Using GDX files===		===Using GDX files===
	[[Programmer_Guide/Shell_Items/File\|GDX file items]] are special binary files which can be used directly in a numerical expression and which can also be connected to an input of a [[Programmer_Guide/Shell_Items/Graph\|graph item]]. One matrix can be stored ~~in a~~ GDX file.		[[Programmer_Guide/Shell_Items/File\|GDX file items]] are special binary files which can be used directly in a numerical expression and which can also be connected to an input of a [[Programmer_Guide/Shell_Items/Graph\|graph item]]. One matrix can be stored per GDX file.

	[macro computeSpectrogram #wave #len=1024 #hop=256]		[macro computeSpectrogram #wave #len=1024 #hop=256]
	// Compute a spectrogram and store it in a GDX file		// Compute a spectrogram and store it in a GDX file

Christian: /* Using GDX files */

2014-04-25T14:19:33Z

Using GDX files

← Older revision		Revision as of 16:19, 25 April 2014
Line 463:		Line 463:
	// Result: the path of the GDX file containing the spectrogram		// Result: the path of the GDX file containing the spectrogram
	//---		//---
	#path := unique '$@work' gdx 1 8 // get unique output file name		#path := [[Programmer_Guide/Command_Reference/UNIQUE\|unique^]] '$@work' gdx 1 8 // get unique output file name
	#lfft := eval [[Programmer_Guide/Command_Reference/EVAL/fft\|fft]]($#len) // compute transformation length		#lfft := eval [[Programmer_Guide/Command_Reference/EVAL/fft\|fft]]($#len) // compute transformation length
	#nfrm := int $#wave[!length] / $#hop // compute number of frames		#nfrm := int $#wave[!length] / $#hop // compute number of frames
	#file := new file * '$#path' 4 $#nfrm $(int $#lfft/2+1) // create GDX file		#file := [[Programmer_Guide/Shell_Items/File/NEW_FILE\|new file]] * '$#path' 4 $#nfrm $(int $#lfft/2+1) // create GDX file
	// compute and save one log. amplitude spectrum / frame		// compute and save one log. amplitude spectrum / frame
	for #i := 0 to $#i < $#nfrm step #i := int $#i+1		for #i := 0 to $#i < $#nfrm step #i := int $#i+1
Line 472:		Line 472:
	$#file[!data,$#i] := eval [[Programmer_Guide/Command_Reference/EVAL/fft\|fft]]($#wave[!signal,1,$#pos,$#len] ?* whanning($#len) , $#lfft, 4)		$#file[!data,$#i] := eval [[Programmer_Guide/Command_Reference/EVAL/fft\|fft]]($#wave[!signal,1,$#pos,$#len] ?* whanning($#len) , $#lfft, 4)
	end		end
	delete $#file // close the file		delete /Var #file // close the file
	exit 1 set '$#path'		exit 1 set '$#path'

Line 480:		Line 480:
	// Result: the average log. powerspectrum (a temp. numeric table item)		// Result: the average log. powerspectrum (a temp. numeric table item)
	//---		//---
	#file := new file * '$#path' // open GDX file		#file := [[Programmer_Guide/Shell_Items/File/NEW_FILE\|new file]] * '$#path' // open GDX file
	// compute average spectrum		// compute average spectrum
	#avr := eval [[Programmer_Guide/Command_Reference/EVAL/fill\|fill]]($#file[!nrow],0,0)		#avr := eval [[Programmer_Guide/Command_Reference/EVAL/fill\|fill]]($#file[!nrow],0,0)

Christian: /* Using GDX files */

2014-04-25T14:17:53Z

Using GDX files

← Older revision		Revision as of 16:17, 25 April 2014
Line 457:		Line 457:
	===Using GDX files===		===Using GDX files===
	[[Programmer_Guide/Shell_Items/File\|GDX file items]] are special binary files which can be used directly in a numerical expression and which can also be connected to an input of a [[Programmer_Guide/Shell_Items/Graph\|graph item]]. One matrix can be stored in a GDX file.		[[Programmer_Guide/Shell_Items/File\|GDX file items]] are special binary files which can be used directly in a numerical expression and which can also be connected to an input of a [[Programmer_Guide/Shell_Items/Graph\|graph item]]. One matrix can be stored in a GDX file.
	~~<pre>~~		[macro computeSpectrogram #wave #len=1024 #hop=256]
	[macro computeSpectrogram #wave #len=1024 #hop=256]		// Compute a spectrogram and store it in a GDX file
	// Compute a spectrogram and store it in a GDX file		// Args: #wave a mono wave item
	// Args: #wave a mono wave item		// #len, #hop the analysis window length and the hopsize in samples
	// #len, #hop the analysis window length and the hopsize in samples		// Result: the path of the GDX file containing the spectrogram
	// Result: the path of the GDX file containing the spectrogram		//---
	//---		#path := unique '$@work' gdx 1 8 // get unique output file name
	#path := unique '$@work' gdx 1 8 // get unique output file name		#lfft := eval [[Programmer_Guide/Command_Reference/EVAL/fft\|fft]]($#len) // compute transformation length
	#lfft := eval [[Programmer_Guide/Command_Reference/EVAL/fft\|fft]]($#len) // compute transformation length		#nfrm := int $#wave[!length] / $#hop // compute number of frames
	#nfrm := int $#wave[!length] / $#hop // compute number of frames		#file := new file * '$#path' 4 $#nfrm $(int $#lfft/2+1) // create GDX file
	#file := new file * '$#path' 4 $#nfrm $(int $#lfft/2+1) // create GDX file		// compute and save one log. amplitude spectrum / frame
	// compute and save one log. amplitude spectrum / frame		for #i := 0 to $#i < $#nfrm step #i := int $#i+1
	for #i := 0 to $#i < $#nfrm step #i := int $#i+1		#pos := int $#i * $#hop - $#len/2
	#pos := int $#i * $#hop - $#len/2		$#file[!data,$#i] := eval [[Programmer_Guide/Command_Reference/EVAL/fft\|fft]]($#wave[!signal,1,$#pos,$#len] ?* whanning($#len) , $#lfft, 4)
	$#file[!data,$#i] := eval [[Programmer_Guide/Command_Reference/EVAL/fft\|fft]]($#wave[!signal,1,$#pos,$#len] ?* whanning($#len) , $#lfft, 4)		end
	end		delete $#file // close the file
	delete $#file // close the file		exit 1 set '$#path'
	exit 1 set '$#path'
	~~</pre>~~		[macro computeAvrPowerspectrum #path]
	~~<pre>~~		// Compute the average powerspectrum of a spectrogram stored in a GDX file
	[macro computeAvrPowerspectrum #path]		// Args: #path the path of the GDX file containing the spectrogram
	// Compute the average powerspectrum of a spectrogram stored in a GDX file		// Result: the average log. powerspectrum (a temp. numeric table item)
	// Args: #path the path of the GDX file containing the spectrogram		//---
	// Result: the average log. powerspectrum (a temp. numeric table item)		#file := new file * '$#path' // open GDX file
	//---		// compute average spectrum
	#file := new file * '$#path' // open GDX file		#avr := eval [[Programmer_Guide/Command_Reference/EVAL/fill\|fill]]($#file[!nrow],0,0)
	// compute average spectrum		for #i := 0 to $#i < $#file[!ncol] step #i := int $#i+1
	#avr := eval [[Programmer_Guide/Command_Reference/EVAL/fill\|fill]]($#file[!nrow],0,0)		$#avr := eval $#avr + [[Programmer_Guide/Command_Reference/EVAL/log2lin\|log2lin]]($#file[!data,$#i,1], 1, 10) / $#file[!ncol]
	for #i := 0 to $#i < $#file[!ncol] step #i := int $#i+1		end
	$#avr := eval $#avr + [[Programmer_Guide/Command_Reference/EVAL/log2lin\|log2lin]]($#file[!data,$#i,1], 1, 10) / $#file[!ncol]		delete /Var #file // close the file
	end		exit 1 eval [[Programmer_Guide/Command_Reference/EVAL/lin2log\|lin2log]]($#avr, 1, 20)
	delete /Var #file // close the file
	exit 1 eval [[Programmer_Guide/Command_Reference/EVAL/lin2log\|lin2log]]($#avr, 1, 20)
	~~</pre>~~

	=== Script examples ===		=== Script examples ===

Christian: /* Using GDX files */

2014-04-25T14:17:12Z

Using GDX files

← Older revision		Revision as of 16:17, 25 April 2014
Line 465:		Line 465:
	//---		//---
	#path := unique '$@work' gdx 1 8 // get unique output file name		#path := unique '$@work' gdx 1 8 // get unique output file name
	#lfft := eval fft($#len) // compute transformation length		#lfft := eval [[Programmer_Guide/Command_Reference/EVAL/fft\|fft]]($#len) // compute transformation length
	#nfrm := int $#wave[!length] / $#hop // compute number of frames		#nfrm := int $#wave[!length] / $#hop // compute number of frames
	#file := new file * '$#path' 4 $#nfrm $(int $#lfft/2+1) // create GDX file		#file := new file * '$#path' 4 $#nfrm $(int $#lfft/2+1) // create GDX file
Line 471:		Line 471:
	for #i := 0 to $#i < $#nfrm step #i := int $#i+1		for #i := 0 to $#i < $#nfrm step #i := int $#i+1
	#pos := int $#i * $#hop - $#len/2		#pos := int $#i * $#hop - $#len/2
	$#file[!data,$#i] := eval fft($#wave[!signal,1,$#pos,$#len] ?* whanning($#len) , $#lfft, 4)		$#file[!data,$#i] := eval [[Programmer_Guide/Command_Reference/EVAL/fft\|fft]]($#wave[!signal,1,$#pos,$#len] ?* whanning($#len) , $#lfft, 4)
	end		end
	delete $#file // close the file		delete $#file // close the file
Line 486:		Line 486:
	#avr := eval [[Programmer_Guide/Command_Reference/EVAL/fill\|fill]]($#file[!nrow],0,0)		#avr := eval [[Programmer_Guide/Command_Reference/EVAL/fill\|fill]]($#file[!nrow],0,0)
	for #i := 0 to $#i < $#file[!ncol] step #i := int $#i+1		for #i := 0 to $#i < $#file[!ncol] step #i := int $#i+1
	$#avr := eval $#avr + log2lin($#file[!data,$#i,1], 1, 10) / $#file[!ncol]		$#avr := eval $#avr + [[Programmer_Guide/Command_Reference/EVAL/log2lin\|log2lin]]($#file[!data,$#i,1], 1, 10) / $#file[!ncol]
	end		end
	delete $#file // close the file		delete /Var #file // close the file
	exit 1 eval lin2log($#avr, 1, 20)		exit 1 eval [[Programmer_Guide/Command_Reference/EVAL/lin2log\|lin2log]]($#avr, 1, 20)
	</pre>		</pre>

Christian: /* Storing a signal in a wave item */

2014-04-25T14:15:35Z

Storing a signal in a wave item

← Older revision		Revision as of 16:15, 25 April 2014
Line 437:		Line 437:
	// the number of samples stored in x equals the length of the assigned vectors		// the number of samples stored in x equals the length of the assigned vectors
	$#x[!signal,1,0] := eval [[Programmer_Guide/Command_Reference/EVAL/fill\|fill]]($#x[!length],0,2pi440/$#x[!srate])/2		$#x[!signal,1,0] := eval [[Programmer_Guide/Command_Reference/EVAL/fill\|fill]]($#x[!length],0,2pi440/$#x[!srate])/2
	$#x[!signal,2,0] := eval rand(0,$#x[!length],1) / 4		$#x[!signal,2,0] := eval [[Programmer_Guide/Command_Reference/EVAL/rand\|rand]](0,$#x[!length],1) / 4

	// its also possible to assign a matrix to a wave item		// its also possible to assign a matrix to a wave item

Christian: /* Assigning to an entry of a matrix, or a vector */

2014-04-25T14:15:08Z

Assigning to an entry of a matrix, or a vector

← Older revision		Revision as of 16:15, 25 April 2014
Line 423:		Line 423:
	// the id of the returned item is assigned to the cell		// the id of the returned item is assigned to the cell
	$#x[0,b] := eval [[Programmer_Guide/Command_Reference/EVAL/fill\|fill]](10,1,1) // error: a string can not be assigned to a numeric field!		$#x[0,b] := eval [[Programmer_Guide/Command_Reference/EVAL/fill\|fill]](10,1,1) // error: a string can not be assigned to a numeric field!
	$#x[0,b] := eval sum($#x[0,b]) // okay: the sum is assigned to the cell		$#x[0,b] := eval [[Programmer_Guide/Command_Reference/EVAL/sum\|sum]]($#x[0,b]) // okay: the sum is assigned to the cell

	=== Storing a signal in a wave item ===		=== Storing a signal in a wave item ===