Headers for LASCO IDL Library: INOUT

This page was created by IDL lasco_mk_html_help.pro on Wed Aug 17 12:21:55 2005.


List of Routines


Routine Descriptions

ADD_MISSING_BLOCKS

[List of Routines] (See ./add_missing_blocks.pro)

 NAME:
	ADD_MISSING_BLOCKS

 PURPOSE:
	Masks blocks in the input image which are identified in the MISSLIST
	keyword.

 CATEGORY:
	LASCO Level 1 post-processing

 CALLING SEQUENCE:

	Result = add_missing_blocks(image, header)

 INPUTS:
	image	LASCO image with filled-in missing blocks (if any)
	header	LASCO header structure

 KEYWORD PARAMETERS:

 OUTPUTS:
	image with missing blocks masked

 COMMON BLOCKS:

 SIDE EFFECTS:

 RESTRICTIONS:

 PROCEDURE:
	Obtain coordinates of missing blocks from MISSLIST keyword; create
	a mask of the blocks; warp the mask; multiply image by the mask

 MODIFICATION HISTORY:
 	Written by:	Nathan Rich,  8/29/02.

	@(#)add_missing_blocks.pro	1.1 10/01/02 LASCO IDL LIBRARY


COMBINE_IMG

[List of Routines] (See ./combine_img.pro)

 Project     : SOHO - LASCO/EIT

 Name        : COMBINE_IMG

 Purpose     : Insert frames from one FITS image into another to create combined image.

 Explanation : This procedure combines images from different telescopes by inserting
		frames from img1 inside img2.  The imgf1 frame is then CONGRID'd to the pixel size
		of imgf2 (the outer field) and inserted into the imgf2 frame.
		If imgf1 or imgf2 are not names of FITS files, headers must be input using the H1 
		and H2 keywords, or you will be prompted for coordinates of center and arcsec/pixel
		of each image.

 Use         : result = COMBINE_IMG( imgf1, imgf2, CUTOFF=cutoff, /PROMPT)

      Example: IDL> result = COMBINE_IMG( 'c2.fts', 'c3.fts', CUTOFF=5.5)

 Inputs      : img1 : Filename of FITS file for inner field.
               img2 : Filename of FITS file for outer field.

 Outputs     : None.

 Keywords    : /PROMPT	: Set this keyword to be prompted for centers and scale factors.
		      	  Otherwise they are read from FITS files.
               CUTOFF=cutoff : Set this keyword to the boundary desired between the inner and
				outer fields (Units of Rsun).  Defaults are:
				IF EIT is inner image : cutoff is 1.3
				IF C1  is inner image : cutoff is 2.2
				IF C2  is inner image : cutoff is 5.5
		/SPLIT_COLORS: Set this keyword to split color table in
		              output img between those in the input images.
               /INNER :  Setting this keyword will CONGRID the outer field image (img2) to the 
                        pixel size of the inner field image (img1). It uses the portion of the
                        original image that corresponds to the new
                        field of view for speed.
               FOV    : Set this keyword to the desired size (in pixels)
               	  of the final image. FOV can either 1- or 2-element array.
		FACTOR :  Number to multiply the inner image by. Default is 1.02
		DR:	  amount of radius to interpolate between images. Default is no interpolation.
			  Suggested value for C2-C3: 0.5
		/PROCESS:  Use MK_IMG to get images
		H1, H2:	  Headers for imgf1,imgf2 if not FITS filenames
		/NO_BYTSCL:Do not output result scaled to 256 values
		ZOOM:	  Magnify inner image by this amount relative to outer. Default is 1.
		/POLEMATCH:  Match intensity at poles
		/AUTOFACTOR: Better than POLEMATCH.
		CEN2:	  Structure, center of image 2
		/SQRT_SCL: apply SQRT function to img1
		ADDFAC:	  Factor to add to img1. Default is 0.
		/TEST:	  Stop before exitting to allow interactive changing of parameters.
		/EXTRAP	 Extrapolate EIT image to 2 R


 Category    : Image Processing/Display.

 Prev. Hist. : Modified from COMBINE_MVI.PRO by Scott Paswaters.

 Written     : Nathan Rich, NRL, 1/12/99. 

 Modified    : .
	Jun 1999  NBR	Make output integer arrays.
	Aug 1999  NBR	Add EXTRAP_EIT
	Sep 1999  NBR 	Interactively set color tables of input images
	Jan 2000  NBR  	Add EXTRAP keyword making EXTRAP_EIT optional
	 4mar01, nbr - Allow input to be two filenames for each (for fixgaps=2)

 Version     :

 11/02/01 @(#)combine_img.pro	1.1 :NRL Solar Physics


DEF_LASCO_HDR

[List of Routines] (See ./def_lasco_hdr.pro)

 NAME:				DEF_LASCO_HDR
 PURPOSE:			Define a Header Structure for a Level 0.5 or Level 1 LASCO Image
 CATEGORY:			CCD
 CALLING SEQUENCE:		hdr=DEF_LASCO_HDR(empty_variable)
 INPUTS:			None
 OPTIONAL INPUT PARAMETERS:	None
 KEYWORD PARAMETERS:		None

 OUTPUTS:		a structure array containing an initialized header
  lasco_hdr_tags	Returns strarr of tags in structure

 OPTIONAL OUTPUT PARAMETERS:
 COMMON BLOCKS (deleted):	LASCO_HEADER_COMMON,header,nt,tags
				header = the header structure
				nt = number of elements in the header
				tags = string array of names of header items
 SIDE EFFECTS:
 RESTRICTIONS:			DATE_OBS does not conform to SSW 
 PROCEDURE:
 MODIFICATION HISTORY:		SEP 1/07/95  Adapted from define_ccd_hdr.pro
                               SEP 1/20/95  If a FITS header is passed in the LASCO
				   header structure is filled with its contents.
                               SEP 3/17/95  Added CAMP_ID
	NBR  8/08/00	Update for current Level 0.5 and Level 1 LASCO hdr structure
	NBR  9/17/02	Add keywords for level 1; remove common block; change EXP_CMD to EXPCMD

 @(#)def_lasco_hdr.pro	1.3 10/02/02 :NRL Solar Physics


FITS_HDR_LIST

[List of Routines] (See ./fits_hdr_list.pro)

 NAME:
	FITS_HDR_LIST

 PURPOSE:
	This routine prints a list of all of the timing parameters returned in 
	the header.

 CATEGORY:
	DATA_ANAL

 CALLING SEQUENCE:
	FITS_HDR_LIST,Fnames

 INPUTS:
	Fnames:	String array containing the file names to be printed.

 OUTPUTS:
	This procedure generates a listing of the FITS headers.

 RESTRICTIONS:
	Looks in the directory pointed to by the environment variable:
	$IMAGES

 PROCEDURE:

 MODIFICATION HISTORY:
 	Written by:	R.A. Howard, 17 Feb 1996

	@(#)fits_hdr_list.pro	1.1 10/04/96 LASCO IDL LIBRARY


GET_CACHE

[List of Routines] (See ./get_cache.pro)

 Project     : SOHO - LASCO
                   
 Name        : GET_CACHE
               
 Purpose     : Implements caching of files in /tmp/idlpidxx. This speeds up processes which read 
		many files from the jukebox by cutting down on CD mounts.
               
 Use         : IDL> filename = GET_CACHE(j, list_of_filenames, pid)
    
 Inputs      : j	INT	A subscript of flist
		flist	STRARR	A list of filenames
               
 Outputs     : filename	STR	filename in /tmp corresponding to flist[j]
		idlpid		STR	output of getidlpid.pro
		optid		STR	Optional additional identifier if more than one list
					is being used.
                             
 Keywords    :  /ALL		Retrieve all files in list

 Explanation : Checks to see if file i in flist is in /tmp. If not, copies flist[j:j+25] 
		(or end of flist) to /tmp, and returns '/tmp/filename.fts' as the filename, 
		which then is used as input to readfits or whatever.
               
 Calls       : BREAK_FILE, SPAWN

 Category    : Data_Handling, I_O
               
 Prev. Hist. : None.

 Written     : Nathan Rich, NRL/Interferometrics, 2002/01/07.
               
 Modified    : 
	02.05.23, nbr - Use IDLPID to create subdir in /tmp; add IDL_SESSION common block
	02.05.31, nbr - Add optid


	10/02/02, @(#)get_cache.pro	1.4 LASCO IDL LIBRARY


GET_DAILY_LIST

[List of Routines] (See ./get_daily_list.pro)

unction get_daily_list, cam, dte, QL=ql, FILTER=filter

 Purpose: Returns list of files for given tel fitting standard parameters

 Input: 
  dte:	'970502'
  cam:	'c2' or 'c3' or 'eit_195' or 'eit_284' or 'eit_171' or 'eit_304'

 KEYWORDS:
  QL:		Use quicklook and save in $MVIS/daily/; 
		otherwise use LZ and save in $MVIS/daily/yyyy_mm/
  FILTER:	Set = to unusual filter: so far, 'orange'

 Written by N. Rich, NRL, 2002/11/20
 @(#)get_daily_list.pro	1.1 11/22/02 : NRL LASCO Library


LASCO_FITSHDR2STRUCT

[List of Routines] (See ./lasco_fitshdr2struct.pro)

 Project     : SOHO - LASCO
                   
 Name        : LASCO_FITSHDR2STRUCT
               
 Purpose     : Read a LASCO FITS file to obtain an image and header array.
               
 Explanation : This routine calls the IDL Astronomy Library routine READFITS
		to read the LASCO FITS file.  It then fills in a LASCO header
		structure with the header information.
               
 Use         : IDL> lasco_hdr = LASCO_FITSHDR2STRUCT(fits_hdr)
    
 Inputs      : fits_hdr	FITS header, STRARR
               
 Outputs     : lasco_hdr   	LASCO header structure.
               
 Calls       : FXPAR, GETTOK

 Category    : Data_Handling, I_O
               
 Prev. Hist. : None.

 Written     : Scott Paswaters, NRL, Feb. 1996.
               
 Modified    : 02/22/96  S. Paswaters 	Modified for DATE-OBS,TIME-OBS change
					to FITS header.
               08/30/96  S. Paswaters 	Perform STRTRIM(val,2) on type STR tags
					  ex: changes 'C1    ' to 'C1'
               10/23/96  S. Paswaters 	added default structure to work with differing fits hdrs
               11/10/97  S. Paswaters 	include multiple comment or history fields
	11/30/01, N. Rich - Add Windows SSW compatibility for GSV
	 8/28/02, N. Rich - Use SSW recommendation for DATE_OBS (includes time) for Level 1 images
	 9/19/02, N. Rich - Change test for Level 1
	 4/14/03, N. Rich - Reverse SSW DATE_OBS change (because getbkgimg crashed)


 Version     : 


 10/02/02, 04/14/03 @(#)lasco_fitshdr2struct.pro	1.11 :LASCO IDL LIBRARY


LASCO_IMAGE

[List of Routines] (See ./lasco_image.pro)

 Project     : SOHO - LASCO
                   
 Name        : LASCO_IMAGE
               
 Purpose     : Read a LASCO FITS file to obtain an image and header array.
               
 Explanation : This routine calls the IDL Astronomy Library routine READFITS
		to read the LASCO FITS file.  It then fills in a LASCO header
		structure with the header information.
               
 Use         : IDL> image = LASCO_IMAGE('filename' [,header])
    
 Inputs      : filename	Name of the LASCO FITS file.
               
 Outputs     : image		The image array.
               
 Opt. Outputs: header		The image header can be returned either as a
				LASCO header structure or a STRARR (FITS header).
               
 Keywords    : FITS_HDR	The header is normally returned as a LASCO header
				structure.  Set this keyword to return the header
				as a STRARR (FITS header).

 Calls       : READFITS, DEF_LASCO_HDR

 Category    : Data_Handling, I_O
               
 Prev. Hist. : None.

 Written     : Scott Paswaters, NRL, January 1995.
               
 Modified    : 

 Version     : Version 0.1, January 18, 1994

	@(#)lasco_image.pro	1.1 10/04/96 LASCO IDL LIBRARY


LASCO_READFITS

[List of Routines] (See ./lasco_readfits.pro)

 Project     : SOHO - LASCO
                   
 Name        : LASCO_READFITS
               
 Purpose     : Read a LASCO FITS file to obtain an image and header array.
               
 Explanation : This routine calls the IDL Astronomy Library routine READFITS
		to read the LASCO FITS file.  It then fills in a LASCO header
		structure with the header information.
               
 Use         : IDL> image = LASCO_READFITS('filename' [,header])
    
 Inputs      : filename	Name of the LASCO FITS file.
               
 Outputs     : image		The image array.
               
 Opt. Outputs: header		The image header can be returned either as a
				LASCO header structure or a STRARR (FITS header).
               
 Keywords    : FITS_HDR	The header is normally returned as a LASCO header
				structure.  Set this keyword to return the header
				as a STRARR (FITS header).

               NO_IMG  	Set this keyword if you only want the header returned.

               REFCOORD  	Set this keyword to define CRPIX if needed.
               SILENT  	Set this keyword to turn off printing of remarks
		CACHE		Set equal to list of fits files; if set, then will copy 
				at most 25 files to /tmp and uses these copies 

 Calls       : READFITS, HEADFITS

 Category    : Data_Handling, I_O
               
 Prev. Hist. : None.

 Written     : Scott Paswaters, NRL, Feb. 1996.
               
 Modified    : 

 Version     : 
		1996/09/27  SEP 	Added REFCOORD
		RAH, 5/23/97, added error handling for call to READFITS
		RAH, 8/28/98, added handling of MLO/MK3 images
		NBR, 12/1999, retry READFITS if it fails
		NBR, 01/2000, Repeat READFITS max 5 times or until it succeeds
		NBR, 02/2000, Add 2nd catch function and GOTO function for null image; 
				IF incr GT 5, return -1
		NBR, 05/2000, Also repeat for null hdr
		RAH, 7/28/00, added handling of MLO/MK4 images
		NBR, 09/06/00, Check for .gz FITS if unable to find file
	NBR, 12/04/00, Fix error condition
		DW,  12/04/00, Add SILENT Keyword
		NBR, 01/17/01, Add help statements
	NBR, 02/12/01, Convert all headers to structure, regardless if LASCO or MK 
	NBR, 11/30/01 - Replace TRIM with STRTRIM
	NBR, 01/03/02 - Add CACHE keyword
	NBR, 01/07/02 - Edit SILENT usage


	01/10/02, @(#)lasco_readfits.pro	1.13 LASCO IDL LIBRARY


LASCO_READFITS_MK4

[List of Routines] (See ./lasco_readfits_mk4.pro)

 Project     : SOHO - LASCO
                   
 Name        : LASCO_READFITS
               
 Purpose     : Read a LASCO FITS file to obtain an image and header array.
               
 Explanation : This routine calls the IDL Astronomy Library routine READFITS
		to read the LASCO FITS file.  It then fills in a LASCO header
		structure with the header information.
               
 Use         : IDL> image = LASCO_READFITS('filename' [,header])
    
 Inputs      : filename	Name of the LASCO FITS file.
               
 Outputs     : image		The image array.
               
 Opt. Outputs: header		The image header can be returned either as a
				LASCO header structure or a STRARR (FITS header).
               
 Keywords    : FITS_HDR	The header is normally returned as a LASCO header
				structure.  Set this keyword to return the header
				as a STRARR (FITS header).

               NO_IMG  	Set this keyword if you only want the header returned.

               REFCOORD  	Set this keyword to define CRPIX if needed.

 Calls       : READFITS, HEADFITS

 Category    : Data_Handling, I_O
               
 Prev. Hist. : None.

 Written     : Scott Paswaters, NRL, Feb. 1996.
               
 Modified    : 

 Version     : Version 0.1, Feb. 12, 1996
		1996/09/27  SEP 	Added REFCOORD
		RAH, 5/23/97, added error handling for call to READFITS
		RAH, 8/28/98, added handling of MLO/MK3 images
		NBR, 12/1999, retry READFITS if it fails
		NBR, 01/2000, Repeat READFITS max 5 times or until it succeeds
		NBR, 02/2000, Add 2nd catch function and GOTO function for null image; 
				IF incr GT 5, return -1
		NBR, 05/2000, Also repeat for null hdr

	11/02/01 @(#)lasco_readfits_mk4.pro	1.1 LASCO IDL LIBRARY
		RAH, 7/28/00, added handling of MLO/MK4 images


LZ_DISK_INIT3

[List of Routines] (See ./lz_disk_init3.pro)

 NAME:
	LZ_DISK_INIT3

 PURPOSE:
	This procedure does some level-0 disk initial tasks:
    	copy definitive attitude files from cd to $NRL_LIB/lasco/data/attitude
    	copy definitive orbit files from cd to $NRL_LIB/lasco/data/orbit
    	read data files and get start dates

 CATEGORY:
	UTIL

 CALLING SEQUENCE:
	LZ_DISK_INIT3

 INPUTS:
	None

 OUTPUTS:
	None

 SIDE EFFECTS:
	Creates various disk files

 RESTRICTIONS:
	None

 MODIFICATION HISTORY:
 	Written by:	RAHoward, NRL, May 1996
	961216 by N. Rich	commented out miss_pckts, start_dates lines
	970423 by N. Rich	prompt for multiple disks for each release
       970618 by N. Rich	avoid long list of chmod: WARNING messages by
				changing cp and chmod commands for or and at
	970627 by N. Rich	Include print statements for copied files
	990416 by N. Rich	Print multiple volume numbers
	991216 by N. Rich	Change hkdir to solardata
	000803 by Jake		Added /SH to spawn commands
	000808 the Jake		Changed lzcds to .lzcds
	001011 the Jake		Copying d01 files to $TMFILES Directory now.
	011030 the Jake		Changed name to lz_disk_init3 for clarification
	020314	Jake            attitude and orbit files not available in download
				ISTP is no longer supplying CDs
				lines copying this data have been REM'd
	021009 Jake		trying to fix carriage return kept at the end of volno
	030729	Jake	added NOCOPY keyword to not copy data files
	03.10.08, nbr	screwed up sccs, so started archive over
	03.10.09, nbr 	Use CD numbers instead of "volume" numbers


 10/10/03 @(#)lz_disk_init3.pro	1.10 : LASCO IDL LIBRARY


LZ_DISK_INIT[1]

[List of Routines] (See ./lz_disk_init.pro)

 NAME:
	LZ_DISK_INIT

 PURPOSE:
	This procedure does some level-0 disk initial tasks:
    	copy definitive attitude files from cd to $NRL_LIB/lasco/data/attitude
    	copy definitive orbit files from cd to $NRL_LIB/lasco/data/orbit
    	read data files and get start dates

 CATEGORY:
	UTIL

 CALLING SEQUENCE:
	LZ_DISK_INIT

 INPUTS:
	None

 OUTPUTS:
	None

 SIDE EFFECTS:
	Creates various disk files

 RESTRICTIONS:
	None

 MODIFICATION HISTORY:
 	Written by:	RAHoward, NRL, May 1996


	@(#)lz_disk_init.pro	1.2 05/14/97 LASCO IDL LIBRARY


LZ_DISK_INIT[2]

[List of Routines] (See ./lz_disk_init2.pro)

 NAME:
	LZ_DISK_INIT

 PURPOSE:
	This procedure does some level-0 disk initial tasks:
    	copy definitive attitude files from cd to $NRL_LIB/lasco/data/attitude
    	copy definitive orbit files from cd to $NRL_LIB/lasco/data/orbit
    	read data files and get start dates

 CATEGORY:
	UTIL

 CALLING SEQUENCE:
	LZ_DISK_INIT

 INPUTS:
	None

 OUTPUTS:
	None

 SIDE EFFECTS:
	Creates various disk files

 RESTRICTIONS:
	None

 MODIFICATION HISTORY:
 	Written by:	RAHoward, NRL, May 1996
	961216 by N. Rich	commented out miss_pckts, start_dates lines
	970423 by N. Rich	prompt for multiple disks for each release
       970618 by N. Rich	avoid long list of chmod: WARNING messages by
				changing cp and chmod commands for or and at
	970627 by N. Rich	Include print statements for copied files
	990416 by N. Rich	Print multiple volume numbers
	991216 by N. Rich	Change hkdir to solardata

	@(#)lz_disk_init.pro	1.2 11/27/96 LASCO IDL LIBRARY


LZ_GETLASCODIR

[List of Routines] (See ./lz_getlascodir.pro)

NAME: LZ_GETLASCODIR

PURPOSE:
       Tells user which directory contains a given days worth of level zero
	LASCO data for a particular camera.

CALLING SEQUENCE:
	dir=lz_getlascodir(1,6,1996,'C1')
     or
	dir=lz_getlascodir(1,6,96,'c1')

INPUTS:
	month:	an integer betwen 1 (January) and 12 (December)
	day:	day of the month
	year:	either the last two digits of the year (e.g. 96) or all 4 digits
	camera:	a two-character string describing which camera is desired.
		Acceptable choices for camera are: "c1","c2","c3", or "c4"
		camera is case-insensitive

KEYWORDS: 
	SILENT: Supress output of all error messages except lower-level IDL
		and system messages. 

OUTPUTS:
      A string specifiying the directory in which desired images can be found.

AUTHOR: Scott Hawley, NRL, June 27, 1996

MODIFIED: SHH 7/12/96  Generates directory names for cplex2
	9/23/96 by N. Rich	modified printed output
	961007 by N. Rich	fixed findfile call
	970827 by N. Rich	use LZ_IMG for directory
       990126 Ed Esfandiari    Fixed code for Y2K problem.
 
 SCCS variables for IDL use
 
 @(#)lz_getlascodir.pro	1.7 08/27/97 :NRL Solar Physics


LZ_START_DATE3

[List of Routines] (See ./lz_start_date3.pro)

 NAME:
	LZ_START_DATE3

 PURPOSE:
   	Lists the level-0 cdrom start dates

 CATEGORY:
	UTIL

 CALLING SEQUENCE:
	LZ_START_DATE3,Volno

 INPUTS:
	Volno:	The CD_ROM volume number

 OPTIONAL INPUTS:
	None

 KEYWORD PARAMETERS:
	None

 OUTPUTS:
	None

 OPTIONAL OUTPUTS:
	None

 COMMON BLOCKS:
	None

 SIDE EFFECTS:
	Writes a file of the start dates

 RESTRICTIONS:
	None

 PROCEDURE:

 EXAMPLE:

 MODIFICATION HISTORY:
 	Written by:	RA Howard, 15 Mar 1996
	N. Rich, 10/21/96, prompts for multiple disks for each release;
			   prints info for each volume of 1 release on the
			   same page
	000803 Jake		Added /SH to spawn commands
	000808 the Jake		Changed lzcds to .lzcds
	020318	Jake		Changed to grep for CD-NUMBER now that making disks here
				modified strtrim line
	03.10.09, nbr - Use volno input; create new file each time


 @(#)lz_start_date3.pro	1.1 10/10/03 : LASCO IDL LIBRARY


LZ_START_DATE[1]

[List of Routines] (See ./lz_start_date.pro)

 NAME:
	LZ_START_DATE

 PURPOSE:
   	Lists the level-0 cdrom start dates

 CATEGORY:
	UTIL

 CALLING SEQUENCE:
	LZ_START_DATE,Volno

 INPUTS:
	Volno:	The CD_ROM volume number

 OPTIONAL INPUTS:
	None
	
 KEYWORD PARAMETERS:
	None

 OUTPUTS:
	None

 OPTIONAL OUTPUTS:
	None

 COMMON BLOCKS:
	None

 SIDE EFFECTS:
	Writes a file of the start dates

 RESTRICTIONS:
	None

 PROCEDURE:

 EXAMPLE:

 MODIFICATION HISTORY:
 	Written by:	RA Howard, 15 Mar 1996


	@(#)lz_start_date.pro	1.3 05/14/97 LASCO IDL LIBRARY


LZ_START_DATE[2]

[List of Routines] (See ./lz_start_date2.pro)

 NAME:
	LZ_START_DATE

 PURPOSE:
   	Lists the level-0 cdrom start dates

 CATEGORY:
	UTIL

 CALLING SEQUENCE:
	LZ_START_DATE,Volno

 INPUTS:
	Volno:	The CD_ROM volume number

 OPTIONAL INPUTS:
	None
	
 KEYWORD PARAMETERS:
	None

 OUTPUTS:
	None

 OPTIONAL OUTPUTS:
	None

 COMMON BLOCKS:
	None

 SIDE EFFECTS:
	Writes a file of the start dates

 RESTRICTIONS:
	None

 PROCEDURE:

 EXAMPLE:

 MODIFICATION HISTORY:
 	Written by:	RA Howard, 15 Mar 1996
	N. Rich, 10/21/96, prompts for multiple disks for each release;
			   prints info for each volume of 1 release on the
			   same page


	@(#)lz_start_date.pro	1.1 10/05/96 LASCO IDL LIBRARY


MAKE_GIFS

[List of Routines] (See ./make_gifs.pro)

 Project     : SOHO - LASCO/EIT
                   
 Name        : MAKE_GIFS
               
 Purpose     : Write GIF images from list.
               
 Use         : IDL> MAKE_GIFS, list

 Inputs      :	list	STRARR	List of FITS files

 Keywords    : SAVEDIR STRING	Directory where images are to be saved. Default is '.'.
		NOLABEL		When set, omits time and logo on images (c3 only)
		PICT	Save as PICT files
		VIDEO	Save as 640x480 video size
		TIFF	Save as TIFF files
		PAN	Rebin image (ex: Pan=0.5)
		BW	Use B&W color table
		NOLOGO	Omit logo only (c3 only)

 Calls       : For EIT you need to have $SSW/soho/eit in your IDL_PATH

 Side effects: None.
               
 Category    : Image Display.  Animation.
               
 Written     : Nathan Rich, Jan 2000.  From rtmvi.pro
               
 Changes     :
	5/9/2000, NBR, Add PICT option
	10/27/00, NBR, Auto create pictprefx
	 3/12/01, nbr, Add TIFF option
	 5/ 2/01, nbr, Add /sh to spawn; save picts in SAVEDIR
	 5/22/01, nbr, Add BW keyword, NOLABEL for C3
	 4/ 8/02, nbr, Implement eit_prep
	 9/20/02, nbr, Change output filename for TIFF and GIF; add NOLOGO and NOLABEL for C2


 10/01/02 @(#)make_gifs.pro	1.4 :LASCO IDL LIBRARY


MK_IMG

[List of Routines] (See ./mk_img.pro)

 Project     : SOHO - LASCO/EIT
                   
 Name        : MK_IMG
               
 Purpose     : Process FITS files for display.
               
 Explanation : This procedure  reads an imaje and 
		normalizes to the exposure time.
		(Not implemented: The on_off_diff keyword results in a movie
               where each on line imaje is displayed with a nearby offband imaje
               subtracted.)
               
 Use         : result = MK_IMG( filename, bmin, bmax, /TIMES, /DIFF, /NO_NORMAL, $
                        UNSHARP=unsharp, PAN=pan, COORDS=coords, BOX=box, $
                        /RATIO, /USE_MODEL,/FLAT_FIELD,/ON_OFF_DIFF,/MASK_OCC,/LG_MASK_OCC,
                        /RADIAL, /DEGRID, /FIXGAPS, /LOG_SCL, /SQRT_SCL, $
			 FILL_COL=fill_col, SAVE=save)

      Example: IDL> result = MK_IMG( '32002333.fts', -100, 100, shdr, /DIFF)

      Example: If you want to display BYTARR imajes straight from the FITS files without
		any scaling use:
               IDL> result = MK_IMG( filename, 0, 255, /NO_NORMAL)
    
 Inputs      : filename : string containing the filename
               bmin, bmax : Minimum and maximum DN for BYTSCL.
               
 Outputs     : processed imaje array.
		shdr	STRARR	FITS header as a string array
               
 Keywords    : The following keywords apply to all telescopes (C1,C2,C3,EIT)

	
	POINTFILT  : Implements point_filter on raw image; set equal to [boxsize, sensitivity, iterations]
			default is [5,7,3]
	SUNC	   ; Returns sun center structure {xcen, ycen}
	BKG	   ; Set equal to background image to use instead of GETBKGIMG; should 
		 	be normalized to exptime and correctly sized
	/INIT1	   ; Set to reset COMMON block; MK_IMG always returns zero for this value
	/EXPFAC    ; set equal to variable which contains exp correction factor 
		 	(-1 if not found)
	/ROLL      : Apply roll correction if GT 2 deg.; returns value of roll angle 
	/LIST	   : for use with PROCESS_LIST procedure
	/LOGO	   ; Add LASCO logo to bottom right corner
	/OUTMASK   : apply outer mask only
	/INMASK    : apply occulter mask only
	/NO_DISPLAY: do not display image as it is processed
	/NX	   : Desired final size of image; superseded by PAN
	/CREM	   : Set this keyword if doing CR removal; filename in or will prompt
	/HIDE_PYLON: Replace (byte) values below setting with median
	/DBIAS	   : Add this to bias before subtracting
	/NORM	   : Apply linear normalization function based on imaje median (5/99)
	/DO_BYTSCL : Apply bytescaling (default is not to)
	/LEE_FILT  : Apply LEEFILT function to filter noise.
       /TIMES     : Set this keyword to display date and time in imajes.
	/DIFF      : Set this keyword to make a difference imaje.  The 
			     model is subtracted.
	/NO_NORMAL : Don't normalize exposure times to that of the first imaje.
	/NO_SORT   : Don't sort by time in header.
       UNSHARP    : Set this keyword to make a movie of unsharp masked imajes.
                    The value of the keyword if any is set to the size of the
                    unsharp mask, default=25
                    Example:  A value of 9 would form a 9x9 unsharp mask
	/RATIO     : If using diff or running_diff display data as ratio of 
			imaje/reference frame
       /MASK_OCC  : applies a sun sized circle and removes the internal part of the 
			image and masks outer image
	/LOG_SCL   : Applies ALOG10() function to imaje before byte scaling
	/SQRT_SCL  : Applies SQRT() function to imaje before byte scaling
	/FIXGAPS   : Set to 1 to fill data gaps in imaje with color specified by 
			FILL_COL
		     Set to 2 to fill data gaps in imaje with values from previous 
			imaje
	FILL_COL   : Set this keyword to the color index to use for data gaps and 
			occ masks.
	SAVE       : For use in batch mode.  Set this keyword to the name of the 
			.mvi file to save as.  Routine will save movie and then exit.
	PAN        : Default is to resize imajes to pixel size of the first imaje.  
			Set this keyword to perform additional scaling.  
			Example: set to 0.5 for 2x2 rebinning.
	COORDS     : Set to 4 element array of imaje coordinates to use relative to 
			1024x1024 imaje.
		 	Example: COORDS=[0,1023,128,895] for C2 Equatorial Field
	BOX        : Set to 4 element array of imaje coordinates to use for box 
			normalization relative to 1024x1024 imaje. Images are scaled 
			relative to average counts in box of first imaje. 
			Example: BOX=[461,560,641,740]
	REF_BOX    : Set to avg counts specified in BOX otherwise first imaje is used

      : The following keywords apply only to C1

       /ON_OFF_DIFF: differences each on line imaje with an imaje taken at a continuum 
			wavelength
       /FLAT_FIELD : normalizes each imaje by a door closed imaje to remove the solar 
			spectrum
       /RADIAL	    : applies a radial filter

      : The following keywords apply only to C2 and C3

	/USE_MODEL : If using diff or running_diff use background corona model
                 as base frame.  USE_MODEL=1 for closest any_year monthly model
                                 USE_MODEL=2 for closest monthly model (1 year)
                                 USE_MODEL=3 for for overall yearly model
	/DISTORT   : Apply distortion correction for C2 or C3

       : The following keywords apply only to EIT

       /DEGRID	   : applies the degridding algorithm

 Calls       : 

 Side effects: 
               
 Category    : Image Display.
               
 See Also    : 
               
               
 Prev. Hist. : None.

 Written     : Nathan Rich, NRL/Interferferometrics, 17 Dec 1998
	Based on MKMOVIE.PRO by Scott Paswaters, NRL, Jan 1996.
               
 Modified    : SEP 29 May 96 - Place frames into multiple pixmaps instead of 1 large
				pixmap because of limitations on window size in IDL.
               SEP  9 Jul 96 - Read in img headers as structures and pass to wrunmovie
               SEP 18 Oct 96 - Add option to pass in STRARR of imaje names instead of filename.
               SEP 24 Oct 96 - added /RATIO and /USE_MODEL options
               RAH 13 Dec 96 - added check for daily median imaje which doesn't have bias
               CMK 16 Feb 97 - added all C1 related features and changed the procedure name to mkc1movie2
           RAH/SEP 14 Mar 97 - integrated mkc1movie2 features into mkmovie
               SEP 21 Mar 97 - corrected bias subtraction for LEB summed imajes
               SEP 01 Oct 97 - added /SUM keyword to OFFSET_BIAS call
               SEP 22 Oct 97 - fixed divide by zero error for /RATIO option
               SEP 31 Oct 97 - Binned imajes are scaled (/bin^2) for level_05 imajes only
               SEP 13 Nov 97 - Added /FLAT_FIELD for EIT, added /NEW flag to EIT_DEGRIDN
               RAH 02 Feb 98 - Now normalizes to calculated exposure time (if data exists).
		NBR 06 Nov 98 - Change default fillcol to median(imaje); change LG_MASK_OCC for c3 to use C3clearmask2.dat
		NBR 17 Dec 98 - Change to MK_IMG; add LEE_FILT, NO_BYTSCL, DISTORT keywords
		NBR 04 Dec 99 - Add default bmin and bmax
		nbr 13 Apr 99 - ALlow replace gaps with prev imaje
		nbr 17 May 99 - Add FNAME keyword
		nbr    Jul 99 - use first of two filename strings in 'fullname' to remove CRs; Move Leefilt before BYTSCL; Make MASK_OCC work for non-byte results; change HIDE_PYLON
		nbr    Aug 99 - Add NX keyword
		nbr    Sep 99 - Add NO_DISPLAY keyword, add OUTER keyword; Use updated EIT_DEGRID, EIT_FLAT
		nbr    Mar 00 - Automatically correct for different bias value in bkg model for c3 (default); use INMASK and outmask keywords; add LIST keyword; add 1 to imaje for ALOG10 to prevent negative output
	nbr  May 00 - Change USE_MODEL numbering; add shdr output; change NO_BYTSCL to DO_BYTSCL
	nbr  Oct 00 - Add NO_PROFILE, INIT1 keywords; use one value for maskfill when doing a list; 
			add EIT_NORM_RESPONSE and make DEGRID and FLATFIELD automatic for EIT
	nbr  Nov 00 - Change mask radius for C2 LG_MASK_OCC; add CIRC_WIDTH keyword; 
	nbr, 21Nov00 - Accept image array as input for fullname
	nbr,  4Apr01 - Always use any_year=0 for images after 2000/12/03
	nbr, 11Apr01 - Change r_occ_out for C2
	nbr,  1Jun01 - Move REMOVE_CR and RUNNING_DIFF to before ratio/difference
	nbr,  8Jun01 - Use EIT_PREP; move READFITS to middle; add PROFILE keyword and use wset
			for profile
	nbr, 17Jul01 - Use separate mask for pylon and c3mask; change how dbias is computed for C3
	nbr, 18Jul01 - Increase upper limit for HIDE_PYLON
	nbr, 20Nov01 - Add BKG keyword; do not match pylon if BKG is set
	nbr, 13Dec01 - Fix lower left corner mask problem
	nbr, 13Mar02 - Implement ROLL keyword
	nbr,  1Apr02 - DON'T divide EIT images by exptime
	nbr,  8Apr02 - Modify [hv]size, f[hv]size
	nbr,  7Aug02 - Add images common block
	nbr, 18Sep02 - Add POINTFILT keyword; add some VERBOSE comments
	nbr,  3Sep03 - Add COMMON get_im for logging with carrmapmaker2.pro
	nbr, 15Jan04 - Add header values, fix roll, add FILL_COL

 Version     : 

 06/28/05 @(#)mk_img.pro	1.7 :NRL Solar Physics


MK_MLO_STRUCT

[List of Routines] (See ./mk_mlo_struct.pro)

 NAME:
	MK_MLO_STRUCT

 PURPOSE:
 	This procedure generates a structure type for the HAO-MLO fits files.

 CATEGORY:
	LASCO DATA ANALYSIS

 CALLING SEQUENCE:
	MK_MLO_STRUCT

 INPUTS:
	None

 OUTPUTS:
	The procedure generates a file with the desired structure.

 SIDE EFFECTS:
	Writes a file to $NRL_LIB/lasco/inout

 EXAMPLE:
	To generate a sample header, you must have a new copy of IDL, or at least one
	that hasn't had the MLO structure defined.

	MK_MLO_STRUCT

 MODIFICATION HISTORY:
 	Written by:	RAHoward, NRL, Oct, 1998


MK_ONE_DEB_GIF

[List of Routines] (See ./mk_one_deb_gif.pro)

 NAME:
	MK_ONE_DEB_GIF

 PURPOSE:
	This function makes one gif image of debris data.

 CATEGORY:
	LASCO INOUT

 CALLING SEQUENCE:
	MK_ONE_DEB_GIF,Fname

 INPUTS:
	Fname	STRING	  FITS filename                               

 OUTPUTS:
	Writes the gif file onto the debris directory.

 COMMON BLOCKS:
	BLOCK1:	Describe any common blocks here. If there are no COMMON
		blocks, just delete this entry.

 RESTRICTIONS:

 PROCEDURE:

 EXAMPLE:

 MODIFICATION HISTORY:
 	Written by:	Nathan Rich, NRL
	12/7/00, nbr - Change input description

	@(#)mk_one_deb_gif.pro	1.1 11/02/01 LASCO IDL LIBRARY


MLO_FITSHDR2STRUCT

[List of Routines] (See ./mlo_fitshdr2struct.pro)

 Project     : SOHO - LASCO
                   
 Name        : MLO_FITSHDR2STRUCT
               
 Purpose     : Converts a FITS header into a structure similar to the LASCO structure
               
 Use         : IDL> mlo_hdr = MLO_FITSHDR2STRUCT(fits_hdr)
    
 Inputs      : fits_hdr	FITS header, STRARR
               
 Outputs     : mlo_hdr   	MLO header structure.
               
 Calls       : FXPAR, GETTOK

 Category    : Data_Handling, I_O
               
 Prev. Hist. : None.

 Written     : Russ Howard, NRL, Aug. 1998. (adapted from LASCO_FITSHDR2STRUCT)
               
 Modified    : 

 Version     : Version 1.0, Aug. 22, 1998

 
 @(#)mlo_fitshdr2struct.pro	1.5 11/05/01 :LASCO IDL LIBRARY



PICKFILES2

[List of Routines] (See ./pickfiles2.pro)

 Project     : SOHO - LASCO/EIT
                   
 Name        : PICKFILES2
               
 Purpose     : Widget tool to allow user to pick multiple files.
               
 Use         : files = PICKFILES2(FILES=files, FILTER=filter, PATH=path)
    
 Inputs      : None.
               
 Outputs     : STRARR containing names of files selected, or '' (empty string)
		if none selected.
               
 Keywords    : 
       FILES:  A string array containing file choices to diplay.

       PATH:   The initial path to select files from.  If this keyword is
               not set, the current directory is used.

       FILTER: A string value for filtering the files in the file list.  This
               keyword is used to reduce the number of files to choose from.
               Example filter values might be "*.fits" or "*.pro".


 Common      : PICKFILES2_COMMON
               
 Restrictions: None.
               
 Side effects: None.
               
 Category    : Widgets.
               
 Prev. Hist. : None.

 Written     : Scott Paswaters, NRL, Feb. 1996.
               
 Modified    : 

 Version     : 

	@(#)pickfiles2.pro	1.1 10/05/96 LASCO IDL LIBRARY


QL_GETLASCODIR

[List of Routines] (See ./ql_getlascodir.pro)

NAME: QL_GETLASCODIR

PURPOSE:
       Tells user which directory contains a given days worth of Quick Look
	LASCO data for a particular
       camera.

CALLING SEQUENCE:
	dir=ql_getlascodir(1,6,1996,'C1')
     or
	dir=ql_getlascodir(1,6,96,'c1')

INPUTS:
	month:	an integer betwen 1 (January) and 12 (December)
	day:	day of the month
	year:	either the last two digits of the year (e.g. 96) or all 4 digits
	camera:	a two-character string describing which camera is desired.
		Acceptable choices for camera are: "c1","c2","c3", or "c4"
		camera is case-insensitive

KEYWORDS:  
	SILENT:	Suppress output of all error messages except lower-level
		IDL or system messages.

OUTPUTS:
      A string specifiying the directory in which desired images can be found.

AUTHOR: Scott Hawley, NRL, June 27, 1996

MODIFIED:	Nathan Rich	960923	shortened to look at cplex1 
	                                instead of jukebox
               Ed Esfandiari   990126  Fixed code for Y2K problem.
 
 SCCS variables for IDL use
 
 @(#)ql_getlascodir.pro	1.5 05/14/97 :NRL Solar Physics


READ_LASCO_SPECTRA

[List of Routines] (See ./read_lasco_spectra.pro)

 NAME:
	READ_LASCO_SPECTRA

 PURPOSE:
	This procedure reads the LASCO filter spectral data

 CATEGORY
	CALIBRATION

 CALLING SEQUENCE:
	READ_LASCO_SPECTRA,Fname,Wl,Int,Np

 INPUTS:
	Fname:	String containing the file name

 Outputs:
	Wl:	Array containing the wavelengths
	Int:	Array containing the intensities
	Np:	Number of points in the array

 OPTIONAL OUTPUTS:
	Title:	Title of file

 MODIFICATION HISTORY:
	Written by R.A. Howard, NRL

 @(#)read_lasco_spectra.pro	1.1 07/31/97 :NRL Solar Physics


READ_LIMB_DARK

[List of Routines] (See ./read_limb_dark.pro)

 NAME:
	READ_LIMB_DARK

 PURPOSE:
	This procedure reads the LASCO filter spectral data

 CATEGORY
	CALIBRATION

 CALLING SEQUENCE:
	READ_LIMB_DARK,Wavel,Limbdark

 INPUTS:
	None

 Outputs:
	Wavel:		An array of wavelengths in nm
	Limbdark:	An array of limb darkening parameters

 MODIFICATION HISTORY:
	Written by R.A. Howard, NRL, Nov 29, 1998

 @(#)read_limb_dark.pro	1.1 11/28/98 :LASCO IDL LIBRARY



VALIDLASCODIR

[List of Routines] (See ./validlascodir.pro)

NAME:
	VALIDLASCODIR

PURPOSE:
	This procedure (called by others) determines if the directory is
	valid

CALLING SEQUENCE:
	Result = VALIDLASCODIR (Sd,Camera,Silent)

INPUTS:
	Sd:	A string giving the date directory (YYMMDD)
	Camera:	A two-character string describing which camera is
		desired.  Acceptable choices for camera are: "c1",
		"c2","c3", or "c4".  Camera is case-insensitive.
	SILENT:	Supress output of all error messages except lower-
		level IDL and system messages.

OUTPUTS:
	This function returns a string specifiying the directory in
	which desired images can be found.

RESTRICTIONS:
	You must have the LASCO/EIT image file system mounted on
	the machine your are running IDL from.

EXAMPLE:
	dir=validlascodir('960531','C1',silent)

AUTHOR: Scott Hawley, NRL, June 27, 1996
	7/12/96	SHH, Generates directory names for cplex2
	9/22/96	RAH, NRL Addapted from LZ_GETLASCODIR


	@(#)validlascodir.pro	1.2 10/17/96 LASCO IDL LIBRARY


This page was created by IDL lasco_mk_html_help.pro on Wed Aug 17 12:21:55 2005.