Extended IDL Help

This page was created by the IDL library routine mk_html_help. For more information on this routine, refer to the IDL Online Help Navigator or type:

     ? mk_html_help

at the IDL command line prompt.

Last modified: Tue Jan 18 02:08:37 2000.


List of Routines


Routine Descriptions

CREATE_CONTOUR_ST

[Next Routine] [List of Routines]
 NAME:
         create_contour_st
 PURPOSE:
         Creates a default structure for contour plotting in image_cont20
 CATEGORY:
         image display
 CALLING SEQUENCE:
         st=create_contour_st(images,[/silent][,lev1=lev1][,lev2=lev2],...)
 INPUTS:
         images  : images to be contoured. Can be a cube of several images
 OPTIONAL INPUTS:
         lev1    : first set of level values (for 1st image)
         lev2    : 2nd level of values (for 2nd image)
 KEYWORD PARAMETERS:
         silent  : if set the routine is silent
 OUTPUTS:
         st      : Overlay structure
 OPTIONAL OUTPUTS:
         None
 COMMON BLOCKS:
         None
 SIDE EFFECTS:
         None
 RESTRICTIONS:
         None
 PROCEDURE:
         Straigthforward.
         Uses create_struct
 EXAMPLE:
         images=fltarr(10,13,3)
         lev1=[1,2,3,4] & lev2=[0.1,0.6,0.7]
         levels=create_contour_st(images,lev1=lev1,lev2=lev2)
         help,levels,/str
         print,levels.set0.values
 MODIFICATION HISTORY:
         Created by J.Ph Bernard @ IAS on Jul 30 1997

(See MacintoshHD:IDL Libraries:JPBlib:Image_Display:create_contour_st.pro)


CREATE_OVERLAY_ST

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
          create_overlay_st
 PURPOSE:
          Create an empty overlay structure for image_cont20
 CATEGORY:
          Image Display
 CALLING SEQUENCE:
          st=create_overlay_st(N_values)
 INPUTS:
          N_values : Array containing the number of overlays in in set
 OPTIONAL INPUTS:
          None
 KEYWORD PARAMETERS:
          None
 OUTPUTS:
          st       : overlay structure
 OPTIONAL OUTPUTS:
          None
 COMMON BLOCKS:
          None
 SIDE EFFECTS:
          None
 RESTRICTIONS:
          None
 PROCEDURE:
          Uses create_struct 
 EXAMPLE:
          overlay=create_overlay_st([3,7])
          help,overlay,/str
          help,overlay.set0,/str
 MODIFICATION HISTORY:
          Created by J.-Ph. Bernard @ IAS on Wed Jul 30 1997
          Modified JPB Aug. 31 1998, to be compatible with jpb_plotsym.

(See MacintoshHD:IDL Libraries:JPBlib:Image_Display:create_overlay_st.pro)


DISP_SPECTRA

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       disp_spectra
 CALLING SEQUENCE:
       disp_spectra,input,header,imin,imax,jmin,jmax
 PURPOSE:
       display a set of spectra 
 INPUTS:
       input = cube (3D) in which data are taken.
       header = cube's header
       imin,imax = interval on first axis
	jmin,jmax = interval on second axis
 OPTIONAL INPUT:
 ACCEPTED KEY-WORDS:
 	histo	= if set, plot in histogram mode
	vrange	= gives the velocity range of plots
	trange	= gives the Temperature range of plots
	vmark	= location for vertical bars @ cste velocity
	tmark	= location for horizontal bars @ cste temp
	rebin1	= # of channels to rebin
	coord	= 'ad' or 'lb' or nthg:type of coordinates to print on each plot
    csize = character size for coordinates
 OUTPUTS:
       None
 PROCEDURE AND SUBROUTINE USED
       euler, nice_coord, sxpar,create_lb_fukui, create_coo2
 SIDE EFFECTS:
       ?
 MODIFICATION HISTORY:
       written Jean-Philippe Bernard 25-Oct-92
	modified JPB 06-Nov-1992 to plot real Temperature from cubes
	modified JPB 17-Feb-1993 to put Keywords HISTO, VRANGE, TRANGE
	                                        , VMARK, TMARK, REBIN, COORD
	modified JPB 26-Feb-1993 to remove undef values from min max search
	modified JPB 16-Mars-1993 to overplot coord at center of vrange.
	modified JPB Jan-94 to plot 2 arrays (V1.0)

(See MacintoshHD:IDL Libraries:JPBlib:Image_Display:disp_spectra.pro)


IMAGE_CONT20

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       image_cont20
 CALLING SEQUENCE:
       image_cont20, a, h
 PURPOSE:
     - Display an Astronomical image on screen (or print on paper).
     - Coordinates on the axis are computed from the fits header and are valid
	at the center of the image. They are decided automatically, unless
	!x.ticks or !y.ticks are non zero when calling the procedure, in
	which case the ticks positions, labels, ... must be provided explicitely
	by the user into !x.tickv, !x.tickname, ...

     - The position of the plot on a page (or screen) is determined from
	the !p.position parameter. The /square option allows to impose a
	similar linear scale (cm/pixel) on both axis.
     - A coordinate grid can be overlaid, given the coordinate arrays are
	provided (they can be computed from the header using create_coo). The
	coordinates values are those along the axis.
     - Levels in the image or another image with same size can be overlaid.
     - The position of Point Sources can be overlaid.
     - A bar giving the grey level intensity can also be drawn.
 INPUTS:
       a	= Image (2 dim) to be drawn.
       h	= image fits header
 OPTIONAL INPUT:
	None
 ACCEPTED KEY-WORDS:
	levels  = structure of levels to be plotted (use create_contour_st)
	print	= if set, output directed to printer
	postcript= if set, output directed to this postcript file
	invert	= to invert the image (usefull when printing on paper)
	square	= if set the paper output will be square (same deg/cm)
	title   = to write a main title
	nogrey  = to plot with no greyscale map (only contours)
	grid    = if set a grid of coordinates is drawn
    xgrid   = set of grid values to draw on x (deg) (if !x.ticks <> 0)
	ygrid   = set of grid values to draw on y (deg)	(if !y.ticks <> 0)
	deltaxy = spacing between labels (default [1,1],>0)
	rebin   = if set and GT 1, the images are rebined by *rebin
	silent  = to make the routine it silent
	coo1    = 2D array of x coordinates (in case /grid is set)
	coo2    = 2D array of y coordinates
	bar_pos = If set, a color bar is displayed at !p.position=bar_pos
	off_bar_pos = if set, the bar position is in offset compared to
		      the !p.position. Recommended with /print
    values_grid_coo1 = values to be drawn for the grid on coo1 (degrees)
    values_grid_coo2 = values to be drawn for the grid on coo2 (degrees)
 EXAMPLES
     ra=ten(16.,24,0)/24.*360. & dec=ten(-20.,0.,0.)
     file=locate_issa(ra,dec,band=4,closest=2)
     d=readfits(file(0),h)
	!p.position=[0.1,0.1,0.8,0.8]
	tit='Image_cont20 Example'
	create_coo2,h,coo1,coo2,/silent,/lbl
    lev=[100,500.,2000.]
    levels=create_contour_st(d,lev1=lev)
    levels.set0.color=[50,100,150]
    over=create_overlay_st([2,1])
    over.set0.coo1(0)=ra & over.set0.coo2(0)=dec
    over.set0.sym_type(0)='triangle' & over.set0.sym_angle(0)=45.
    over.set0.sym_size(0)=10. & over.set0.sym_color(0)=0.
    loadct,13
    image_cont20,d,h,imrange=[-50,200],off_bar_pos=[1.2,0.,1.3,1], $
       overlay=over, $
	  title=tit,/square,coo1=coo1,coo2=coo2,/grid,levels=levels,/silent
 OUTPUTS:
       None
 PROCEDURE AND SUBROUTINE USED
	IDL PROCEDURE used:
     sxpar
     mk_grid_val, my_bar20, rest_graph_var, save_graph_var, jpb_plotsym
 COMMONS:
    @proj_common.com
    @sysgraphvar.com
    @imcont8_common.com
 SIDE EFFECTS:
	use imrange to define the range to be plotted, not im>value screen display
	print=0,ps_color=1,postcript=set,pcl=0	-> color postcript file
	print=0,ps_color=0,postcript=set,pcl=1	-> PCL             file
	print=0,ps_color=0,postcript=set,pcl=1	-> B&W color post  file
	print=1,ps_color=1,postcript=und,pcl=0	-> color PS        print
	print=1,ps_color=0,postcript=set,pcl=1	-> color PCL       print
 MODIFICATION HISTORY:
    written 25-07-92 by Jean-Philippe Bernard, Nagoya University.
	modified JPB 03-03-93 to include key-words
	modified JPB 19-03-93 to fix a bug when plotting coordinates with SQUARE
	modified JPB 15-05-93 to adapt to IPAC Version 2.0.1
	modified JPB Fri Jan 27 95 to decode correct cor---proj strings
	modified JPB Tue Jul 25 95 to adapt to new IDL version
    modified JPB Wed Jul 30 97 to use contour and overplot structures
    modified JPB Tue Feb 16 99 to use values_grid_coo1 and values_grid_coo2

(See MacintoshHD:IDL Libraries:JPBlib:Image_Display:image_cont20.pro)


MY_BAR20

[Previous Routine] [Next Routine] [List of Routines]
NAME:
	my_bar20
NAME/ONE LINE DESCRIPTION OF ROUTINE:
     my_bar20 draws a color bar on the display.  

CALLING SEQUENCE:  
     my_bar20 [,MIN = Min] [,MAX = Max] [,TYPE = Type] $
         [,TITLE = Title] [,/REV] [bar_size=], [/print],
	  [[,bar_pos][,off_bar_pos=]]

ARGUMENTS: (I = input, O = output, [] = optional)
     Min    [I]   byt   Minimum color number in bar; default is 0
     Max    [I]   byt   Maximum color number in bar; default is 255
     Type   [I]   chr   Positioning indicator.
                         TYPE='XT': X bar and label at top (default).
                         TYPE='XB': X bar and label at bottom.
                         TYPE='YR': Y bar and label at right.
                         TYPE='YL': Y bar and label at left.
     Title  [I]   chr   Bar title.
     Rev    [I]   key   If specified, bar is reversed.

WARNINGS:
     Works only with devices that allow TV operations.
     Only values between 0 and 255 are allowed for Min and Max;
        Min must be less than Max if both are specified.

EXAMPLES:
     1.  Put a color bar from right to left at top of picture.
                BAR
     2.  Put a reversed color bar of width 20 pixels of colors 0 
            through 150 at top of picture.
                Bar,/rev, max = 150
     3.  Put a reversed color bar at bottom of picture with title
            'REVERSED'
                Bar, /rev, type = 'xb', title='REVERSED'
     4.  Put a color bar to left of picture 30 pixels wide with 
             title 'STRAIGHT'
                Bar, type = 'yl', title='STRAIGHT', thick=30
     5.  Put a color bar to right of picture showing only colors 
             50 through 200
                Bar, type = 'yr', min = 50, max = 200
#
COMMON BLOCKS:
     None

PROCEDURE (AND OTHER PROGRAMMING NOTES):
     Uses system variables to determine pixel size of window; scales
     size of title, if any, to correspond to thickness of bar.

PERTINENT ALGORITHMS, LIBRARY CALLS, ETC.:
     NONE

MODIFICATION HISTORY:
   R. Sterner. 12 NOV, 1987.
      Johns Hopkins University Applied Physics Laboratory.
   RES  27 Jan, 1988 --- upgraded to Y bar and allowed labels.
   Upgraded to Y bar; allowed labels; used keywords -- IDL Version II
           Alice R. Trenholme, General Sciences Corporation 
   Modified J.P.B. @ IPAC to add freedom to it
.TITLE
Routine BAR

(See MacintoshHD:IDL Libraries:JPBlib:Image_Display:my_bar20.pro)


MY_TICLABELS

[Previous Routine] [List of Routines]
 NAME:
	MY_TICLABELS
 PURPOSE:
	Used to display images with right ascension and declination
	axes.  This routine creates labels for already determined tic
	marks (every other tic mark)

 CALLING SEQUENCE:
	my_ticlabels, minval, numtics, incr, ticlabs, [ RA = ,DELTA = ]

 INPUTS:
	minval  - minimum value for labels (degrees)
	numtics - number of tic marks
	incr    - increment in minutes for labels

 OUTPUTS:
	ticlabs - array of charater string labels

 OPTIONAL INPUT KEYWORDS:
	RA - if this keyword is set then the grid axis is assumed to be
		a Right Ascension.   Otherwise a declination axis is assumed
	DELTA - Scalar specifying spacing of labels.   The default is 
		DELTA = 2 which means that a label is made or every other tic
		mark.  Set DELTA=1 to create a label for every tic mark.

 NOTES:
	The following note applies to users of IDL version 2.4.0 or before.
	This bug mentioned was fixed in Version 3.0.0

	If you are using the native Postscript fonts, you must first define
	your font with DEVICE,/TIMES,FONT_INDEX=3 where /TIMES is replaced with
	your font of choice.  The default is Helvetica and therefore does not
	require the above DEVICE command.  This patch is necessary if you are
	using IDL 2.4.0 or before, because the !X feature does not work
	properly using the PostScript Driver in this version.

 PROCEDURES USED:
	RADEC

 RESTRICTIONS:
	Invalid for wide field (> 2 degree) images since it assumes that a 
	fixed interval in Y (or X) corresponds to a fixed interval in Dec 
	(or RA)

 REVISON HISTORY:
	written by B. Pfarr, 4/15/87
	Added DELTA keywrd for compatibility with IMCONTOUR W. Landsman Nov 1991
	Added nicer hms and dms symbols when using native PS fonts Deutsch 11/92
	Added Patch for bug in IDL <2.4.0 as explained in NOTES E. Deutsch 11/92

(See MacintoshHD:IDL Libraries:JPBlib:Image_Display:my_ticlabels.pro)