You are here: NI Home > Support > Product Reference > Manuals > LabVIEW 8.2 Help

Generates a waveform that is the sum of integer cycle sine tones. Details  Example

	amplitude is the value that the sum of all the tones is scaled to and is the largest absolute value that the waveform contains. The default is –1. amplitude is useful when outputting the waveform to an analog output channel. If the maximum value that the hardware can output is 5 volts, set amplitude to 5. If amplitude 0, the scaling is not applied.
	reset signal, if TRUE, resets the phase to the phase control value and the time stamp to zero. The default is FALSE.
	start frequency is the lowest tone frequency generated. This value must be an integer multiple of Fs/#s. The default is 10.
	tone amplitudes is an array in which each element is a single tone amplitude. The size of this array determines how many tones are generated.
	seed, when > 0, causes reseeding of the noise sample generator. seed is ignored if phase relationship is set to Linear.
	delta f is the magnitude of the spacing between adjacent tone frequencies. delta f must be an integer multiple of Fs/#s. The default is 100. If start frequency is 100 Hz, delta f is ten, and the tone amplitudes array contains three elements, the tone frequencies generated are 100Hz, 110Hz, and 120Hz.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	sampling info contains sampling information. Fs is the sampling rate in samples per second. The default is 1000. #s is the number of samples in the waveform. The default is 1000.
	coerce frequencies? If coerce frequencies? is TRUE, the specified tone frequencies will be coerced to the nearest multiple of Fs/N.
	phase relationship is the distribution of the phases of the sine tones. The phase distribution affects the Peak/RMS ratio of the overall waveform. 0 Random—Each phase is chosen randomly between 0 and 360 degrees. 1 Linear—Gives the best Peak/RMS ratio, but might cause the signal to have periodic components within the period of the overall waveform.
	signal out is the generated waveform.
	crest factor is the ratio of the Peak voltage to the RMS voltage of signal out.
	actual tone frequencies are the tone frequencies generated after accounting for coercion, if coerce frequencies? is True, and the Nyquist criteria.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Basic Multitone with Amplitudes Details

The frequency domain representation of this waveform is a sequence of impulses at the specified tone frequencies and zero at all other frequencies. The number of tones is determined by the size of the tone amplitudes array. The sine tones are generated using the frequency, amplitude, and samples information. The phases of the tones are determined using the relationship specified in phase relationship. This raw array is then scaled so that the largest absolute value is equal to amplitude. Finally, the waveform is bundled. The X0 element of the waveform is always set equal to 0 and the delta X element is set equal to 1/Fs.

Example

Refer to the Multitone with Amplitudes VI in the labview\examples\measure\maxmpl.llb for an example of using the Basic Multitone with Amplitudes VI.