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: Wed Mar 31 06:40:29 1999.
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.
WRUNMOVIE is then called for animation.
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 image.
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
PROCESS: Use MK_IMG to get images
Category : Image Processing/Display.
Prev. Hist. : Modified from COMBINE_MVI.PRO by Scott Paswaters.
Written : Nathan Rich, NRL, 1/12/99.
Modified : .
Version :
@(#)combine_img.pro 1.2 01/12/99 :NRL Solar Physics
(See /net/cronus/opt/local/idl_nrl_lib/lasco/inout/combine_img.pro)
NAME: DEF_LASCO_HDR
PURPOSE: Define a Header Structure for a LEB Science Image
CATEGORY: CCD
CALLING SEQUENCE: hdr=DEF_LASCO_HDR()
INPUTS: None
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: a structure array containing an initialized header
OPTIONAL OUTPUT PARAMETERS:
COMMON BLOCKS: 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:
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
@(#)def_lasco_hdr.pro 1.1 05/14/97 :NRL Solar Physics
(See /net/cronus/opt/local/idl_nrl_lib/lasco/inout/def_lasco_hdr.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
(See /net/cronus/opt/local/idl_nrl_lib/lasco/inout/fits_hdr_list.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
Version : Version 0.1, Feb. 12, 1996
@(#)lasco_fitshdr2struct.pro 1.8 11/28/98 :LASCO IDL LIBRARY
(See /net/cronus/opt/local/idl_nrl_lib/lasco/inout/lasco_fitshdr2struct.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
(See /net/cronus/opt/local/idl_nrl_lib/lasco/inout/lasco_image.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
@(#)lasco_readfits.pro 1.5 11/28/98 LASCO IDL LIBRARY
(See /net/cronus/opt/local/idl_nrl_lib/lasco/inout/lasco_readfits.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
(See /net/cronus/opt/local/idl_nrl_lib/lasco/inout/lz_disk_init.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
(See /net/cronus/opt/local/idl_nrl_lib/lasco/inout/lz_getlascodir.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
(See /net/cronus/opt/local/idl_nrl_lib/lasco/inout/lz_start_date.pro)
Project : SOHO - LASCO/EIT
Name : MK_IMG
Purpose : Process FITS files for display.
Explanation : This procedure reads an image and
normalizes to the exposure time.
(Not implemented: The on_off_diff keyword results in a movie
where each on line image is displayed with a nearby offband image
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, /DIFF)
Example: If you want to display BYTARR images 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 image array.
Keywords : The following keywords apply to all telescopes (C1,C2,C3,EIT)
/DISTORT : Apply distortion correction for C2 or C3
/NO_BYTSCL : Do not apply bytescaling
/LEE_FILT : Apply LEEFILT function to filter noise.
/TIMES : Set this keyword to display date and time in images.
/DIFF : Set this keyword to make a difference image. The
model is subtracted.
/NO_NORMAL : Don't normalize exposure times to that of the first image.
/NO_SORT : Don't sort by time in header.
UNSHARP : Set this keyword to make a movie of unsharp masked images.
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 image/reference frame
/MASK_OCC : applies a sun sized circle and removes the internal part of the image
/LG_MASK_OCC:applies a sun sized circle and removes the part of the field to 1.2Rsun
for C1 (especially good for the longer 100s exposures).
For C3 the pylon is masked
/LOG_SCL : Applies ALOG10() function to image before byte scaling
/SQRT_SCL : Applies SQRT() function to image before byte scaling
/FIXGAPS : Set to 1 to fill data gaps in image with color specified by FILL_COL
Set to 2 to fill data gaps in image with values from previous image
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 images to pixel size of the first image. Set this
keyword to perform additional scaling. Example: set to 0.5 for 2x2 rebinning.
COORDS : Set to 4 element array of image coordinates to use relative to 1024x1024 image.
Example: COORDS=[0,1023,128,895] for C2 Equatorial Field
BOX : Set to 4 element array of image coordinates to use for box normalization
relative to 1024x1024 image. Images are scaled relative to average counts
in box of first image. Example: BOX=[461,560,641,740]
REF_BOX : Set to avg counts specified in BOX otherwise first image is used
: The following keywords apply only to C1
/ON_OFF_DIFF: differences each on line image with an image taken at a continuum wavelength
/FLAT_FIELD : normalizes each image by a door closed image 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 any-year monthly model
USE_MODEL=2 for closest monthly model
: The following keywords apply only to EIT
/DEGRID : applies the degridding algorithm
Calls :
Side effects:
Category : Image Display.
See Also :
Prev. Hist. : None.
Written : 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 image names instead of filename.
SEP 24 Oct 96 - added /RATIO and /USE_MODEL options
RAH 13 Dec 96 - added check for daily median image 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 images
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 images are scaled (/bin^2) for level_05 images 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(image); change LG_MASK_OCC for c3 to use C3clearmask2.dat
NBR 17 Dec 98 - Change to MK_IMG
Version :
SCCS variables for IDL use
@(#)mk_img.pro 1.00 12/17/98 :NRL Solar Physics
(See /net/cronus/opt/local/idl_nrl_lib/lasco/inout/mk_img.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
(See /net/cronus/opt/local/idl_nrl_lib/lasco/inout/mk_mlo_struct.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.4 12/18/98 :LASCO IDL LIBRARY
(See /net/cronus/opt/local/idl_nrl_lib/lasco/inout/mlo_fitshdr2struct.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
(See /net/cronus/opt/local/idl_nrl_lib/lasco/inout/pickfiles2.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
(See /net/cronus/opt/local/idl_nrl_lib/lasco/inout/ql_getlascodir.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
(See /net/cronus/opt/local/idl_nrl_lib/lasco/inout/read_lasco_spectra.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
(See /net/cronus/opt/local/idl_nrl_lib/lasco/inout/read_limb_dark.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
(See /net/cronus/opt/local/idl_nrl_lib/lasco/inout/validlascodir.pro)