Overview   Directory   Index   Search   File   Source   Help   Etc 
   
Produced by IDL 7.1.1
User Documentation
 prev file | next file          view single page | view frames | update routines
SUMMARY: fields | routine          DETAILS: routine

./plotter
chantox.pro

Last modification date:
Wed Sep 28 13:27:09 2016

chantox

function chantox(chans, [type=integer], [dc=data container])

Convert the given channels numbers to the x values appropriate for the currently displayed data container and x-axis settings.

Returns
The converted channel numbers in the x-axis units currently displayed. If there is a problem (invalid arguments, no data found, etc.) then the returned value is the chans argument.
Examples
Get the x-axis value at channel 100 for the current plot 
       a=chantox(100)
Get the frequency at channel 100 for the current plot Note that the units of a depend on what the current x-axis is. If x-axis is frequency, the units (MHz, GHz, Hz) will be the same as that in the current display. If the x-axis is something else, then the units of a will be Hz. 
       a = chantox(100,type=1)
Get the velocity at channel 100 for a data container at buffer 7. 
       a = chantox(100,type=2,dc=!g.s[7])
Version
$Id$
Common blocks
gbtplot_common

Parameters
chans
in, required
array 		The channel numbers to convert.

Keywords
type
in, optional
integer 		The axis array type (0=channels, 1=frequency, 2=velocity). If not supplied, it will use the current x-axis type. When type is not the currently displayed x-axis type, the scaling is to standard SI units (m/s, Hz, and channels).
dc
in, optional
data container 		A data container to use. If not supplied, the most recently plotted (via show) data container is used.

Produced by IDLdoc 1.6 on Wed Sep 28 13:27:36 2016