./toolbox
freqtochan.pro

Last modification date:

Wed Sep 28 13:27:11 2016

freqtochan

function freqtochan(data, freqs, [frame=string], [true_frame=variable])

Convert frequency (Hz) to channel number using the supplied data container. The frequency may be expressed in another reference frame from that given in the data.

Returns

channel number.

Uses

data_valid frame_velocity

Version

$Id$

Parameters
data in, required spectrum	The spectrum data container to use to get the necessary header information.
freqs in, required	The frequencies to convert (Hz), may be an array of values.

Keywords
frame in, optional string	The rest frame that the frequencies are in. Known rest frames are listed in frame_velocity. Defaults to the frame given in the data container.
true_frame out, optional variable	The actual rest frame used in converting the frequencies. The only way this will not equal the frame argument is if that argument was invalid. In that case, this keyword will be the same as the frame in data.frequency_type.