This page was created by IDL
lasco_mk_html_help.pro on
Wed Aug 17 12:22:39 2005.
There are several "main" programs that may be useful to calculate the mass or electron density (columnar) in CMEs. The mass of a CME is computed from the excess brightness after having subtracted off the pre-event brightness. The technique is to recognize that a single electron at a certain point in the atmosphere will scatter a known amount of the solar disk intensity. Then by knowing the observed intensity, and by assuming that all of the mass is in a single volume element, we can compute the number of electrons. Then assuming charge neutrality, the mass can be computed. The various procedures that can be used to compute electron density or mass are: C3_CME: A function to calibrate C3 images and calculate the mass of a CME given the base and cme image. C3_CME_FRONT: A function to calibrate C3 images and to calculate the mass of the CME front. C3_MASSIMG: A function to calibrate C3 images and calculates the mass of a CME. The output is a file that is a mass (or electron density image). CME_MASSIMG2TOTAL: This function allows you to specify the area of features for which to calculate the mass of a CME from mass images. rah 3/26/99
NAME:
ABBRV_FILPOL
PURPOSE:
This function returns an abbreviated code for the filter
and polarizer/sector wheels.
CATEGORY:
UTIL
CALLING SEQUENCE:
Result = ABBRV_FILPOL(Filter)
INPUTS:
Filter = String giving the filter or polarizer/sector value
OPTIONAL INPUTS:
None
OUTPUTS:
The function result is a string containing the code for the filter
wheel or the polarizer wheel. Each wheel posisiton is a two
character string.
PROCEDURE:
The wheel position is decoded and converted to a 2 character string.
EXAMPLE:
MODIFICATION HISTORY:
Written, RA Howard, NRL, 7 October 1996
15 Oct 96 RAH Added removing whitespace from filter
Corrected filter/polarizer/sector cases
@(#)abbrv_filpol.pro 1.3 10/15/96 LASCO IDL LIBRARY
NAME: ADD_LASCO_LOGO PURPOSE: This function inserts the LASCO logo into the corner of an image CATEGORY: LASCO_SYNOPTIC CALLING SEQUENCE: Result = ADD_LASCO_LOGO(Img) INPUTS: Img: Input image KEYWORDS: LEFT When set, puts logo on lower left corner OUTPUTS: Result: Output image with same type and dimenstion as input COMMON: ADD_LASCO_LOGO_COMMON, w_logo Temporary storage for the logo PROCEDURE: Checks to see if the logo array has been read in, and restores it if not. Then inserts the logo into the lower, right hand corner. MODIFICATION HISTORY: Written by: Scott Paswaters, NRL, Dec 1997 99/07/14 N Rich Add LEFT keyword @(#)add_lasco_logo.pro 1.3 07/14/99 LASCO IDL LIBRARY
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
NAME:
ADJUST_DATE_OBS
PURPOSE:
This function returns a structure of two string elements containing the
adjusted date-obs and time-obs for a given C1, C2, or C3 image header.
c2_time_offsets.dat file is used to get the time offset using first
value extend, interpolation, or last value extend. It then calculates
the corrected date-obs and time-obs and returns them.
CATEGORY:
LASCO DATA_ANAL
CALLING SEQUENCE:
adj = adjust_date_obs(hdr)
INPUTS:
hdr: A C1, C2, or C3 image header
OPTIONAL INPUTS:
verbose: print diagnostic messages.
adj = adjust_date_obs(hdr,/verbose)
OUTPUTS:
A two element structure of DATE and TIME containing the adjusted
DATE_OBS and TIME_OBS.
Example:
hdr.DATE_OBS = '1998/01/01'
hdr.TIME_OBS = '00:10:11.181'
adj = adjust_date_obs(hdr)
adj.DATE = '1998/01/01'
adj.TIME = '00:13:06.590'
MODIFICATION HISTORY:
Written by: Ed Esfandiari, Feb 1999
7/24/00, nbr - Add SCCS version, reduce_history commmon block
11. 6.01, nbr - Use OPENR instead of OPENU
11.30.01, nbr - Change fnm for windows SSW compatibility
7. 5.02, nbr - Fix SCCS version syntax
@(#)adjust_date_obs.pro 1.7, 07/05/02 - NRL LASCO IDL LIBRARY
Name:
ADJUST_HDR_TCR
Purpose:
To return an IDL structure containing corrected date-obs, sun-center, and roll-angle
for a input level 0.5 image header. These can then be used to adjust the level-1 image
headers in the level-1 processing.
Input Parameters:
HDR - A C1, C2, C3, or C4 (EIT) header. For C1 and C4, only the returned
date-obs is valid (roll is set to zero and center is not changed).
Output:
None
RETURN VALUE: - This function returns an IDL structure containing the following tags:
DATE: adjusted date-obs (string)
TIME: adjusted time-obs (string)
ERR : delta-erros from the time_correction routine (string)
XPOS: adjusted x-center (float)
YPOS: adjusted y-center (float)
ROLL: roll angle (float) degrees
Keywords:
VERBOSE - If set, print out information from various steps of the processing.
Calling Sequence:
adj = ADJUST_HDR_TCR(hdr,/verbose)
History:
2003 March 11 - Ed Esfandiari (first version).
2003 March 11, nbr - Add version info to header; change path derivation of data files
2004 April 1 , nbr - Adjust HISTORY kewyords for header
2004 July 17, nbr - good thru March 31, 2004
2004 Oct 4, nbr - good thru Aug 15, 2004
2004 Nov 24, AEE - read in last day from a .sav file instead of hard coded date.
2005 Jan 25, AEE - changed linterp call linear_interp.
ersion= '@(#)adjust_hdr_tcr.pro 1.6, 11/24/04 using: ' ; LASCO IDL Library (NRL)
NAME: air2vac PURPOSE: Convert air wavelength to vacuum wavelength CALLING SEQUENCE: air2vac INPUTS: wa - air wavelength (Angstroms) OPTIONAL INPUTS: none KEYWORD PARAMETERS: none OUTPUTS: The value returned is the vacuum wavelength (in Angstroms) corresponding to the input air wavelength. OPTIONAL OUTPUTS none COMMON BLOCKS: None SIDE EFFECTS: None RESTRICTIONS: Results are valid only between 2960 and 13000 Angstroms PROCEDURE: This procedure is the same algorithm used by Kurucz, et. al. "Solar Flux Atlas From 296 to 1300 nm", National Solar Observatory Atlas No. 1, June 1984. MODIFICATION HISTORY: Adapted from a FORTRAN program provided by R. Kurucz via private communication. Adapted by Paul Reiser July 22, 1997.
NAME:
ALIGN1.PRO
PURPOSE:
Takes two images of EO frange, corrects it from the dark and
sums both, loading the result into X_display
CATEGORY:
??
CALLING SEQUENCE:
ALIGN1, nom_image1,nom_image2,nom_dark,imas,itest
INPUTS:
nom_image1 one of frange images
nom_image2 frange image in oposite side
nom_dark dark image name
itest 'V' or 'H' horizontal or vert alignement
KEYWORD PARAMETERS:
None
OUTPUTS:
imas resulting composite image
COMMON BLOCKS:
None.
SIDE EFFECTS:
None
RESTRICTIONS:
PROCEDURE:
Straightforward.
MODIFICATION HISTORY:
Written by A.LL v.1.0 LAS 08/25/93
NAME: dvpt_fra.pro
PURPOSE: make a polar development of OE fringe or
of OI blocked fringe
CATEGORY: Processing high level
CALLING SEQUENCE: dvpt_fra,ima_in,Xc,Yc,R,delta_R,ima_out
INPUTS: ima_in reference's image
OPTIONAL INPUT PARAMETERS: Xc,Yc fringe's center
R internal radius
delta_R width of fringe
KEYWORD PARAMETERS: None
OUTPUTS: ima_out result frame
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: None
RESTRICTIONS: Applications limited to 512*512 frames
PROCEDURE:
MODIFICATION HISTORY: defined by M.B 09/24/93
modified by M.B 02/17/94 : LAS
SCCS variables for IDL use
@(#)dvpt_fra.pro 1.0 09//93 :LAS
NAME: gener_mask.pro
PURPOSE: make a circular mask for photometry's studies
CATEGORY: Processing high level
CALLING SEQUENCE: gener_mask,ima_name,npix,Xc,Yc,R,intval,extval
INPUTS: ima_name Name of mask
npix dimension
OPTIONAL INPUT PARAMETERS: Xc,Yc circle's coords
R radius of mask
intval value inside
extval value outside
KEYWORD PARAMETERS: None
OUTPUTS: ima_name mask's frame
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: None
RESTRICTIONS: None
PROCEDURE:
MODIFICATION HISTORY: defined by M.B 09/10/93
modified by M.B 02/17/94 : LAS
SCCS variables for IDL use
@(#)gener_mask.pro 1.0 09/10/93 :LAS
NAME: ipolarfra.pro
PURPOSE: make the inverse of polar transformation
for OE developped fringe or for OI blocked
developped fringe
CATEGORY: Processing high level
CALLING SEQUENCE: ipolarfra,ima_in,Xc,Yc,R,delta_R,ima_out
INPUTS: ima_in reference's image
OPTIONAL INPUT PARAMETERS: Xc,Yc fringe's center
R internal radius
delta_R width of fringe
KEYWORD PARAMETERS: None
OUTPUTS: ima_out result frame
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: None
RESTRICTIONS: Applications limited to 512*512 frames
PROCEDURE:
MODIFICATION HISTORY: defined by M.B 02/17/94 : LAS
SCCS variables for IDL use
@(#)ipolarfra.pro 1.0 02/17/94 : LAS
NAME: diafrai.pro
PURPOSE: apply a circular mask for photometry's studies
to a selected frame
(define a circular ROI or apply a diaphragm)
CATEGORY: Processing high level
CALLING SEQUENCE: diafrai,ima_name,Xc,Yc,R,intval,extval
INPUTS: ima_name Name of image
OPTIONAL INPUT PARAMETERS: Xc,Yc circle's coords
R radius of mask
intval value inside to be multiplied
extval value outside to be multiplied
KEYWORD PARAMETERS: None
OUTPUTS: ima_name image with mask
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: None
RESTRICTIONS: None
PROCEDURE:
MODIFICATION HISTORY: defined by M.B 02/17/94 : LAS
SCCS variables for IDL use
@(#)diafrai.pro 1.0 02/17/94 :LAS
NAME: ALL_NONOP_TEMPS PURPOSE: Reads in the SVM HK files, saved by DACS, and plots the non- operational (S/C monitored) temperatures for LASCO, UVCS, MDI, CELIAS CATEGORY: PACKETS CALLING SEQUENCE: ALL_NONOP_TEMPS,Td INPUTS: Td: Date string in form YYMMDD KEYWORD PARAMETERS: LASCO: If present then the LASCO temperatures will be plotted UVCS: If present then the UVCS temperatures will be plotted MDI: If present then the MDI temperatures will be plotted CELIAS: If present then the CELIAS temperatures will be plotted ALL: If present then all 4 instrument temperatures will be plotted PRINT: If present then the plot is sent to the printer MODIFICATION HISTORY: Written by: RAH, NRL, Dec 1994 @(#)all_nonop_temps.pro 1.2 03/08/97 LASCO IDL LIBRARY
NAME:
ANALYZE_IMG
PURPOSE:
This procedure reads the headers of raw *.img files and looks
for summing buffer usage and header only files. It will match the
headers and summing buffer files and write the fixed headers to
a specified directory
CATEGORY:
Reduction
CALLING SEQUENCE:
ANALYZE_IMG, Root_dir,Outdir,Udates,Error_flag
INPUTS:
Root_dir: Directory to search for input *.img files
Outdir: Directory to put output *.img files
KEYWORD PARAMETERS:
NOWRITE - Analyze only
OUTPUTS:
Udates: String array with Unique dates
Error_flag: Integer array with value for each datei
0 = OK 1 = possible error 2 = serious error
RESTRICTIONS:
PROCEDURE:
Read all the *.img files and analyze them to find the files from the
summing buffers and headers for summing buffer files. Match the
first header with the first file etc. for each summing buffer.
This works so long as the directory contains complete sets of
headers and files. The procedure also checks that the OS_NUM
aka CAMPAIGN_ID is the same header and file for each set. Normal
files (e.g. not from a summing buffer) should be ignored.
EXAMPLE:
ANALYZE_IMG,'/ql/raw','/ql/fixed',error_flag
MODIFICATION HISTORY:
Written by: Dennis Wang - 27 Jun 2000
14 Jul 2000 DW - Changed OS_num ranges, Read 200 bytes for header
08 Aug 2000 DW - Reduced error level of OS_NUM mismatch to possible
error rather than serious error
17 Oct 2000 DW - Added NOWRITE keyword and multiple date warning
17 Oct 2000 DW - Added day by day analysis
17 Dec 2001 NR - Moved 'CD, old_dir' out of FOR loop to end
@(#)analyze_img.pro 1.6, 12/17/01 - NRL LASCO IDL LIBRARY
NAME:
ASPECT
PURPOSE:
This function calculates and returns the normalized position
coordinates necessary to put a plot with a specified aspect ratio
into the currently active graphics window. It works on the display
output window as well as in a PostScript output window.
AUTHOR:
FANNING SOFTWARE CONSULTING
David Fanning, Ph.D.
1645 Sheely Drive
Fort Collins, CO 80526 USA
Phone: 970-221-0438
E-mail: davidf@dfanning.com
Coyote's Guide to IDL Programming: http://www.dfanning.com/
CATEGORY:
Graphics
CALLING SEQUENCE:
position = ASPECT(aspectRatio)
INPUTS:
aspectRatio: A floating point value that is the desired aspect
ratio (ratio of heigth to width) of the plot in the current
graphics output window. If this parameter is missing, an aspect
ratio of 1.0 (a square plot) is assumed.
KEYWORD PARAMETERS:
MARGIN: The margin around the edges of the plot. The value must be
a floating point value between 0.0 and 0.5. It is expressed in
normalized coordinate units. The default margin is 0.15.
WINDOWASPECT: The aspect ratio of the target window. If not provided,
the value is obtained from the current graphics window.
OUTPUTS:
position: A four-element floating array of normalized coordinates.
The order of the elements is [x0, y0, x1, y1], similar to the
!P.POSITION system variable or the POSITION keyword on any IDL
graphic command.
EXAMPLE:
To create a plot with an aspect ratio of 1:2 and a margin of
0.10 around the edge of the output window, do this:
plotPosition = ASPECT(0.5, Margin=0.10)
PLOT, Findgen(11), POSITION=plotPosition
Notice this can be done in a single IDL command, like this:
PLOT, Findgen(11), POSITION=ASPECT(0.5, Margin=0.10)
MODIFICATION HISTORY:
Written by: David Fanning, November 1996.
Added better error checking, 18 Feb 1997, DWF.
Added WindowAspect keyword. 10 Feb 2000. DWF
NAME: AWIN PURPOSE: This procedure opens a window of the same size as the input array CATEGORY: UTIL CALLING SEQUENCE: AWIN, Arr INPUTS: Arr: A two dimensional array of any type OUTPUTS: None SIDE EFFECTS: A blank window is displayed. EXAMPLE: Open a window of the same size as an arbitrary image array AWIN, image MODIFICATION HISTORY: Written by: SE Paswaters, NRL, June 1996 @(#)awin.pro 1.2 05/14/97 LASCO IDL LIBRARY
PROJET
SOHO-LASCO
NAME:
B32TOINT
PURPOSE:
Convert a base 32 number to integer
CATEGORY:
Mathematics
CALLING SEQUENCE:
DESCRIPTION:
INPUTS:
INPUT KEYWORD:
OUTPUTS:
PROCEDURE:
CALLED ROUTINES:
HISTORY:
V1 A.Thernisien 10/07/2001
CVSLOG:
$Log: b32toint.pro,v $
Revision 1.2 2002/07/11 07:24:12 arnaud
Insertion of the Log in each header
NAME:
BK
PURPOSE:
This function returns a K-coronal image from the total B image by
subtracting off the F-coronal model.
CATEGORY:
DATA_ANAL
CALLING SEQUENCE:
Result = BK(Img,Hdr)
INPUTS:
Img: Array containing an image of total brightness. It is the output
from level 1 processing (for polarizer=clear)
Hdr: FITS image header
OUTPUTS:
This routine returns an image of the K-brightness.
MODIFICATION HISTORY:
Written by: R.A. Howard, NRL, 6 Nov 1996
@(#)bk.pro 1.1 10/04/96 LASCO IDL LIBRARY
NAME: BROWSE_DISP PURPOSE: This procedure displays an image of an input string of hex values. CATEGORY: UTIL CALLING SEQUENCE: BROWSE_DISP, Img_str INPUTS: Img_str: A string array of image intensities OPTIONAL INPUTS: Img_name: The name of the image OUTPUTS: None PROCEDURE: This pro displays an image. It requires an input string of hex values that is, normally, result of a sybase query for a browse image. Note that a browse image is stored in sybase and retured by a query as a string of hex values. To display it, we must change it to its original byte array format, save it to a file, and use "read_jpeg" and "tvscl" to display it. It also accepts a second (optional) input string that will be displayed, as is, in the lower left corner of the display. It can be used to display such information as name, date, etc., about the image. MODIFICATION HISTORY: Written by: Ed Esfandiari Feb 1996 @(#)browse_disp.pro 1.1 10/05/96 LASCO IDL LIBRARY
NAME: BSV2ARCSEC PURPOSE: This procedure generates a file giving the conversion of the boresighter and PES from volts to arc seconds. CATEGORY: LASCO PACKETS CALLING SEQUENCE: BSV2ARCSEC INPUTS: None OUTPUTS: This procedure generates a file, in the current directory, containing the conversion of the BS and PES for each DN to voltages and to arc seconds. It also generates 4 plots on the screen of the BS-X, BS-Y, PES-X and the PES-Y. MODIFICATION HISTORY: Written by: RA Howard, NRL, 16 Mar 1996 @(#)bsv2arcsec.pro 1.2 09/22/96 LASCO IDL LIBRARY
PROJET:
SOHO-LASCO
NAME:
build_c3_back.pro
PURPOSE
build a edge image (i.e. a planar image) varying in y for C3 background correction
INPUT
c3mask mask of useful pixels of c3 images
KEYWORD INPUT:
ROI=roi defines a specific area of CCD ( define it in
the same unit than c3mask pixel coordinates)
[x1,y1,x2,y2]
XY={0,1} To build two edges (in X and Y)
OUTPUT:
c3back_y planar image varying in y (slope = 1 per pixel)
c3back_x planar image varying in x (slope = 1 per pixel)
RESTRICTIONS
initial image must be square
ro build_fraoe, image1, image2, image3, image4, oefringe
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
NAME:
BUILD_FRAOE
PURPOSE:
Takes four images of EO fringe, corrects them from the dark and
builds composit frame, loading the result into X_display.
CATEGORY:
calibration, manipulation
CALLING SEQUENCE:
BUILD_FRAOE, image1, image2, image3, image4, oefringe
INPUTS:
image1 first arc of fringe (up)
image2 second & opposite arc of fringe (down)
image3 third arc of fringe (left)
image4 fourth & opposite arc of fringe (right)
KEYWORD PARAMETERS:
None
OUTPUTS:
oefringe resulting composit image
COMMON BLOCKS:
None
SIDE EFFECTS:
None
RESTRICTIONS:
None
PROCEDURE:
Straightforward.
MODIFICATION HISTORY:
Written by M.B v.1.0 LAS 03/03/94
Project : SOHO - LASCO/EIT
Name : BUILD_LASCO_HELP
Purpose : Create html help files for all LASCO IDL library routines.
Use : BUILD_LASCO_HELP
Inputs : None.
Outputs : None.
Keywords : None.
Restrictions: Must have write permission to $NRL_LIB/lasco directories.
Side effects: Creates files in the subdirectories of $NRL_LIB/lasco of the form:
help_subdir.html. Ex. help_data_anal.html
Category : Help.
Prev. Hist. : None.
Written : Scott Paswaters, NRL, Mar. 1996.
Modified : RAH, NRL, 3/31/99. Added inout and expfac directories
Version :
@(#)build_lasco_help.pro 1.5 03/31/99 :LASCO IDL LIBRARY
NAME:
C2_CALFACTOR
PURPOSE:
This function returns the calibration factor for a given C2 image
CATEGORY:
REDUCE
CALLING SEQUENCE:
result = C2_CALFACTOR(Header)
INPUT:
Header: image header, either fits or lasco structure
Keywords:
NOSUM If set, do not correct for summing
OUTPUT:
Image calibration factor in (B/Bsun)/(DN/pixel-second)
PROCEDURE:
Same as C3_CALFACTOR.pro
the output is automatically scaled for pixel summing
MODIFICATION HISTORY:
Written Clarence Korendyke, NRL
Added C2/C3 Orange ratio as c2c3match - DW 07/09/99
NBR Nov 7 2001 - Change Version to use SCCS version; change header HISTORY
NBR Mar 11 2003 - Add /NOSUM
SCCS variables for IDL and Header use
er= '@(#)c2_calfactor.pro 1.5, 03/14/03' ;NRL LASCO IDL LIBRARY
NAME:
C2_CALIBRATE
PURPOSE:
This function calibrates a C2 image to mean solar brightness units
CATEGORY:
REDUCE
CALLING SEQUENCE:
Result = C2_CALIBRATE(Img,Header)
INPUTS:
Img: A 2-D image array in units of DN
Header: An image header (FITS or LASCO header structure)
OUTPUTS:
The calibrated image is returned. The units are mean solar
brightness. The header is also modified.
KEYWORDS:
NEW Force read of calib arrays
NO_UPDATE Do not use log files and force read of calib arrays
NO_CALFAC Do not apply calibration factor (set = 1d)
COMMON BLOCKS:
C2_CAL_IMG, DBMS
RESTRICTIONS:
Only handles clear polarizer except for H-alpha
Must have LASCO IDL Library
Must have environment $LASCO_DATA defined
PROCEDURE:
The routine reads in the vignetting and a mask array from the
$LASCO_DATA/calib directory. To obtain the calibration
factors, it calls the C2_CALFACTOR procedure.
MODIFICATION HISTORY:
Written by: Ed Esfandiari April 08, 1999
V1 aee Apr 08, 99 First version (based on c3_calibrate).
V2 dw Sep 18, 99 Added no_calfac keyword (apply summing and vignetting only)
V3 aee Apr 25, 00 Removed !Version.os eq 'OSF' statement. It is not needed since
C2 vignetting is a .fts file which is machine independent.
nbr Nov 7 2001 - Add-ons for reduce_level_1: add HISTORY comments in header; use
$LASCO_DATA; use SCCS version
nbr Jun 25 2002 - Update get_cal_name argument
nbr Mar 10 2003 - Add functionality for non-PB summed images
nbr May 14 2003 - Remove errant stop
nbr Aug 20 2003 - Name vig file explicitly
Variables for SCCS and FITS header
er= '@(#)c2_calibrate.pro 1.10, 09/08/03' ;NRL LASCO IDL LIBRARY
NAME:
C2_DISTORTION
PURPOSE:
This function returns distance in arcseconds, given distance
in pixels.
CATEGORY:
DATA_ANAL
CALLING SEQUENCE:
RESULT = C2_DISTORTION(data)
INPUTS:
Data: distances in pixels
OUTPUT:
Result: distances in arcseconds
OPTIONAL OUTPUTS:
None
PROCEDURE:
Given the distance between the sun center and a point (x, y)
on the CCD, in pixels, this function returns the distance to
(x, y) in arcseconds. This function is returns a position
accurate to within less than one pixel, for all possible
distances. However, this function does not work as well for
points in the same quadrant as the post supporting the
occulter.
MODIFICATION HISTORY:
Written by: D.A. Biesecker, 24 Nov 1998
Ed Esfandiari 24 Nov 1998 - used DISTORTION_COEFFS to
get the coefficients.
vignetting function for C2 INPUT: suncen_x, suncenter_y OUTPUT: vignetting array (floating point array) Created: Dennis Wang @(#)c2_vig1.pro 1.2 02/12/99 NRL LASCO IDL LIBRARY
NAME:
C2_WARP
PURPOSE:
This function distorts a C2 image and returns it.
CALLING SEQUENCE:
Result = C2_WARP(Image,Header)
INPUTS:
Image : C2 image to be distorted
Header: C2 image header
OUTPUTS:
The distorted image is returned. Control points at every 32 pixels
are used for distortion.
COMMON BLOCKS:
NONE
MODIFICATION HISTORY:
Written Ed Esfandiari, NRL
Version 1 aee 19 Nov 1998 Initial release (based on C3_WARP)
aee 24 Nov 1998 changed get_sun_center call to occltr_cntr.
dw 10 Dec 1998 Corrected handling of summed images
NBR 24 Aug 2000 Switch x/y and x0/y0 around in call to WARP_TRI;
Add reduce_history COMMON block
KNOWN BUGS:
1. Subfield images are not handled correctly - dw
ersion= '@(#)c2_warp.pro 1.4 08/24/00' ; LASCO IDL LIBRARY
NAME:
C3_CALFACTOR
PURPOSE:
This function returns the calibration factor for a given C3 image
CATEGORY:
REDUCE
CALLING SEQUENCE:
result = C3_CALFACTOR(Header)
INPUT:
Header: image header, either fits or lasco structure
Keywords:
NOSUM If set, do not correct for summing
OUTPUT:
Image calibration factor in (B/Bsun)/(DN/pixel-second)
PROCEDURE:
The document describes the C3 calibration factor derived from the laboratory
images taken in April 1994.
The calibration factor is in 10^-10 (B/Bsun)/(DN/pixel-second).
The units of the image to be multiplied need to be DN/pixel-second.
The calibration factor is then scaled appropriately for pixel summation.
Additional work will be required to remove a number of other factors.
The calibration factor numbers need the port amplifier
effect removed; color effects removed (IR filter affected greatly) and a
number of other corrections. The photometric effect of pixel summation will
have to be examined.
preliminary calibration factors for C3 (3/17/96):
filter polarizer calibration factor
(10^-10B/Bsun)/(DN/pixel-second)
clear clear 0.00503
blue clear 0.1033
orange clear 0.0286
deep red clear 0.01937
infrared clear 0.1055
clear Halpha 1.541
These were evaluated with the flat field response set to 1.0 at 20Rsun
altitude. Areas of the field inside and outside 20Rsun will be somewhat
effected by the flat field calibration (+/- 10-15%).
the output is automatically scaled for pixel summing
MODIFICATION HISTORY:
Written Clarence Korendyke, NRL
V1 3/15/96 CMK raw calibration factors computed with tabulated exposure durations
V2 3/17/96 CMK calibration factor corrected for exp cmd and exp duration and exp2
V3 6/13/98 RAH modified to allow polarizer coeffs to be different for each filter
updated coeffs for latest values, obtained from calibration window
ratios with door closed
7/19/00 NBR Change Version to use SCCS version; change header HISTORY
1/19/01 NBR Change clear-clear factor to match above comments
3/11/03 NBR Add /NOSUM
6/8/05 RAH Add time variable calibration coefficient
6/22/05 Karl B Small bug fix.
SCCS variables for IDL use
er= '@(#)c3_calfactor.pro 1.13 06/22/05' ;LASCO IDL LIBRARY
NAME:
C3_CALFACTOR
PURPOSE:
This function returns the calibration factor for a given C3 image
CATEGORY:
REDUCE
CALLING SEQUENCE:
result = C3_CALFACTOR(Header)
INPUT:
Header: image header, either fits or lasco structure
Keywords:
NOSUM If set, do not correct for summing
OUTPUT:
Image calibration factor in (B/Bsun)/(DN/pixel-second)
PROCEDURE:
The document describes the C3 calibration factor derived from the laboratory
images taken in April 1994.
The calibration factor is in 10^-10 (B/Bsun)/(DN/pixel-second).
The units of the image to be multiplied need to be DN/pixel-second.
The calibration factor is then scaled appropriately for pixel summation.
Additional work will be required to remove a number of other factors.
The calibration factor numbers need the port amplifier
effect removed; color effects removed (IR filter affected greatly) and a
number of other corrections. The photometric effect of pixel summation will
have to be examined.
preliminary calibration factors for C3 (3/17/96):
filter polarizer calibration factor
(10^-10B/Bsun)/(DN/pixel-second)
clear clear 0.00503
blue clear 0.1033
orange clear 0.0286
deep red clear 0.01937
infrared clear 0.1055
clear Halpha 1.541
These were evaluated with the flat field response set to 1.0 at 20Rsun
altitude. Areas of the field inside and outside 20Rsun will be somewhat
effected by the flat field calibration (+/- 10-15%).
the output is automatically scaled for pixel summing
MODIFICATION HISTORY:
Written Clarence Korendyke, NRL
V1 3/15/96 CMK raw calibration factors computed with tabulated exposure durations
V2 3/17/96 CMK calibration factor corrected for exp cmd and exp duration and exp2
V3 6/13/98 RAH modified to allow polarizer coeffs to be different for each filter
updated coeffs for latest values, obtained from calibration window
ratios with door closed
7/19/00 NBR Change Version to use SCCS version; change header HISTORY
1/19/01 NBR Change clear-clear factor to match above comments
3/11/03 NBR Add /NOSUM
6/8/05 RAH Add time variable calibration coefficient
SCCS variables for IDL use
er= '@(#)c3_calfactor.pro 1.12 06/08/05' ;LASCO IDL LIBRARY
NAME:
C3_CALIBRATE
PURPOSE:
This function calibrates a C3 image to mean solar brightness units
CATEGORY:
REDUCE
CALLING SEQUENCE:
Result = C3_CALIBRATE(Img,Header)
INPUTS:
Img: A 2-D image array in units of DN
Header: An image header (FITS or LASCO header structure)
OUTPUTS:
The calibrated image is returned. The units are mean solar
brightness. The header is also modified.
KEYWORDS:
NO_VIG Do not apply vignetting correction or pylon mask (set = 1.)
NO_MASK Do not apply pylon/occulter mask to vig correction
FUZZY Interpolate gaps with fuzzy logic procedure
NEW Force read of calib arrays
NO_UPDATE Do not use log files and force read of calib arrays
NO_CALFAC Do not apply calibration factor (set = 1d)
COMMON BLOCKS:
C3_CAL_IMG, DBMS
RESTRICTIONS:
Only handles clear polarizer except for H-alpha
PROCEDURE:
The routine reads in the vignetting and a mask array from the
$LASCO_DATA/calib directory. To obtain the calibration
factors, it calls the C3_CALFACTOR procedure.
MODIFICATION HISTORY:
Written by: RA Howard, 4/96
V1 rah Apr 04 96 First version.
V2 aee Sep 30 97 Added exposure factor and header updates.
V3 rah Oct 31 97 Call to READ_EXP_FACTOR changed to GET_EXP_FACTOR
V4 rah Nov 07 97 reference to FILEORIG changed to use DATE_OBS
V5 dw Sep 10 98 Added more polariz id flags beside PB
V6 dab Nov 25 98 Added SWAP_ENDIAN for OSF operating systems
V7 dw Feb 10 99 Changed from IMG_SUM_2x2 to rebin for summed images
V8 av Mar 17 99 Added SL ramp correction
V9 dw Mar 28 99 changed SL ramp correction to ramp_fn(0)
V9a rh Apr 9 99 changed ramp to ramp_full in common
V10 aee Apr 09 99 Added no_update keyword (used in image_profiles).
V11 dw Apr 09 99 Added no_calfac keyword (apply summing and vignetting only)
nbr Jul 12 2000 - Change version init, header update
nbr Jul 27 2000 - Apply ramp before vignetting correction
nbr Aug 4 2000 - CD to calib directory instead of using full path;
edit HISTORY in header
nbr Aug 7 2000 - Change call to GET_EXP_FACTOR
nbr Oct 2 2000 - Add FUZZY, NO_VIG keywords
nbr Oct 25 2000 - Use READFITS to read vig and mask arrays
nbr Jan 18 2000 - Change vig to vig_full in common block
nbr Jan 24 2001 - Add bkg, mask_blocks to common block
nbr Nov 6 2001 - Subtract ramp AFTER vignetting correction and add better
documentation; different order; do not apply
mask to ramp
av Nov 20 2001 - Input image is now returned unchanged.
nbr Jun 25 2002 - Update get_cal_name argument
nbr Jul 5 2002 - Change bkg used for fuzzy_image
nbr Mar 10 2003 - Add functionality for sub-fields and non-PB summed images;
define mask even if NO_MASK is set; only one vig and one mask
nbr Apr 10 2003 - Change bkg and order of operations around fuzzy_image
nbr Aug 20 2003 - Name vig and mask files explicitly
nbr Sep 8 2003 - Comment changes, use A.Thernisien vignetting
nbr Nov 5 2003 - Use inverted A.Thernisien vignetting
nbr Nov 6 2003 - Use expanded A.Thernisien vignetting
nbr Nov 7 2003 - Fix mask application
nbr Jan 2 2004 - Update mask
nbr Apr 2 2004 - Remove comment about fuzzy_image; new mask
nbr Apr 8 2004 - New mask
K.Battams 6/22/2005 - Another new A.Thernisien vignetting function...
This time there are two for pre- and post- interruption.
K.Battams 7/28/2005 - New vig function (previous function shifted half-pixel left)
- New C3 cl mask (very slightly larger)
Variables for SCCS and FITS header
er= '@(#)c3_calibrate.pro 1.51, 08/01/05' ; NRL LASCO IDL LIBRARY
NAME:
C3_CME
PURPOSE:
This function calibrates C2 & C3 images and calculates the mass of a CME
CATEGORY:
CME
CALLING SEQUENCE:
Result = C3_CME,Bn,Fn
INPUTS:
Bn: String containing the filename of the base image
Fn: String containing the filename of the CME image
KEYWORD PARAMETERS:
MINSCL: Set this keyword with the value to use for the minimum value
in scaling the image. The default value is to use -1.e-11 msb
MAXSCL: Set this keyword with the value to use for the maximum value
in scaling the image. The default value is to use +1.e-11 msb
SAVE: Set this keyword with the filename to save the mass information to
OUTPUTS:
This function returns the mass calculated for the ROI selected
RESTRICTIONS:
Only works for C3
EXTERNAL CALLS:
DEFROI, C2_CALIBRATE, C3_CALIBRATE, LASCO_READFITS, CALC_CME_MASS
PROCEDURE:
The files for the base and CME images are read in and calibrated.
The images are then adjusted to have the same area and summing.
The images are differenced, displayed and then DEFROI is called
to get the desired region of interest. CALC_CME_MASS is called to
compute the CME mass.
EXAMPLE:
To find the mass of a CME, where the base image is '320004.fts' and
the CME image is in '320005.fts', and saving the mass information in 'mass.lst':
Mass = C3_CME ('320004.fts','320005.fts',save='mass.lst')
MODIFICATION HISTORY:
Written by: RA Howard, NRL, 5/19/97
MOdified: RAH 3/14/98, changed rebin of b to calb
@(#)c3_cme.pro 1.3 10/03/99 LASCO IDL LIBRARY
NAME:
C3_CME_FRONT
PURPOSE:
This function calibrates C3 images and calculates the mass of a CME
CATEGORY:
CME
CALLING SEQUENCE:
Result = C3_CME_FRONT,Bn,Fn
INPUTS:
Bn: String containing the filename of the base image
Fn: String containing the filename of the CME image
KEYWORD PARAMETERS:
MINSCL: Set this keyword with the value to use for the minimum value
in scaling the image. The default value is to use -1.e-11 msb
MAXSCL: Set this keyword with the value to use for the maximum value
in scaling the image. The default value is to use +1.e-11 msb
SAVE: Set this keyword with the filename to save the mass information to
NEW: Set this keyword if the base image is new
SECTOR: Set this keyword if the ROI is a sector, centered on the sun
RADII: Set this keyword with a 2-element array of the inner and
outer radii (in solar radii) for the sector ROI
ANGLES: Set this keyword with a 2-element array of the left and right
hand boundaries (viewed from sun-center) for the sector ROI
OUTPUTS:
This function returns the mass calculated for the ROI selected
RESTRICTIONS:
Only works for C3
EXTERNAL CALLS:
DEFROI, C3_CALIBRATE, LASCO_READFITS, CALC_CME_MASS, ROI_SECTOR
AWIN, AVERAGE
PROCEDURE:
The files for the base and CME images are read in and calibrated.
The images are then adjusted to have the same area and summing.
The images are differenced, displayed and then DEFROI is called
to get the desired region of interest. CALC_CME_MASS is called to
compute the CME mass.
EXAMPLE:
To find the mass of a CME, where the base image is '320004.fts' and
the CME image is in '320005.fts', and saving the mass information in 'mass.lst':
Mass = C3_CME_FRONT ('320004.fts','320005.fts',save='mass.lst')
MODIFICATION HISTORY:
Written by: RA Howard, NRL, 5/19/97
@(#)c3_cme_front.pro 1.2 10/03/99 LASCO IDL LIBRARY
NAME:
C3_DISTORTION
PURPOSE:
This function returns distance in arcseconds, given distance
in pixels.
CATEGORY:
DATA_ANAL
CALLING SEQUENCE:
RESULT = C3_DISTORTION(data)
INPUTS:
Data: distances in pixels
OUTPUT:
Result: distances in arcseconds
OPTIONAL OUTPUTS:
None
PROCEDURE:
Given the distance between the sun center and a point (x, y)
on the CCD, in pixels, this function returns the distance to
(x, y) in arcseconds. This function is returns a position
accurate to within less than one pixel, for all possible
distances. However, this function does not work as well for
points in the same quadrant as the post supporting the
occulter.
MODIFICATION HISTORY:
Written by: D.A. Biesecker, 29 September 1996
10/5/98 by N B Rich use coefficients from A. Llebaria
11/24/98 Ed Esfandiari used DISTORTION_COEFFS to get the coefficients.
@(#)c3_distortion.pro 1.2 05/14/97 :NRL Solar Physics
NAME:
C3_MASSIMG
PURPOSE:
This function calibrates C3 images and calculates the mass of a CME
CATEGORY:
CME
CALLING SEQUENCE:
Result = C3_MASSIMG(Bn,Fn)
INPUTS:
Bn: String containing the filename of the base image
Fn: String containing the filename of the CME image
KEYWORD PARAMETERS:
SAVE: If set, appends the total mass into a file. If the
keyword is a string, then the filename is the string
otherwise the user is prompted for the file name.
ONLY_NE:If set, then compute electron density rather than mass
NEW: If set, then process the base image, even if it has been done
OUTPUTS:
This function returns an image of the calculated mass
RESTRICTIONS:
Only works for C3
EXTERNAL CALLS:
C3_CALIBRATE, LASCO_READFITS, CALC_CME_MASS
PROCEDURE:
The files for the base and CME images are read in and calibrated.
The images are then adjusted to have the same area and summing.
The images are differenced. CALC_CME_MASS is called to
compute the CME mass.
EXAMPLE:
To find the mass of a CME, where the base image is '320004.fts' and
the CME image is in '320005.fts', and saving the total mass information
in 'mass.lst':
Massimg = C3_MASSIMG ('320004.fts','320005.fts',save='mass.lst')
MODIFICATION HISTORY:
Written by: RA Howard, NRL, 6/9/97
RAH 5/23/98, Make work and make similar to c3_cme_front
@(#)c3_massimg.pro 1.4 10/03/99 LASCO IDL LIBRARY
NAME:
C3_WARP
PURPOSE:
This function distorts a C3 image and returns it.
CALLING SEQUENCE:
Result = C3_WARP(Image,Header)
INPUTS:
Image : C3 image to be distorted
Header: C3 image header
OUTPUTS:
The distorted image is returned. Control points at every 32 pixels
are used for distortion.
COMMON BLOCKS:
reduce_history
SIDE EFFECTS:
changes cmnver (procedure and version info) in reduce_history common block
MODIFICATION HISTORY:
Written Ed Esfandiari, NRL
Version 1 aee 28 Oct 1997 Initial release
aee 24 Nov 1998 changed get_sun_center call to occltr_cntr.
dw 10 Dec 1998 Corrected handling of summed images
NBR 24 Aug 2000 Switch x/y and x0/y0 around in call to WARP_TRI;
Add reduce_history COMMON block
NBR, 6 Nov 2001 - Simplify header handling
NBR, 14 Mar 2003 - Add subfield functionality
KNOWN BUGS:
ersion= '03/14/03 @(#)c3_warp.pro 1.7' ; NRL LASCO IDL LIBRARY
NAME: CALC_CME_MASS PURPOSE: Computes the CME mass in an image given a box defining the area CATEGORY: CME CALLING SEQUENCE: Result = CALC_CME_MASS (Img, Hdr, Box) INPUTS: Img: The 2-D difference image containing the CME. The units are in mean solar brightness units Hdr: The lasco header structure of the image Box: An array containing the coordinates of the region of interest KEYWORD PARAMETERS: FNAME: If present, this string defines the name of a file to store the mass value in. The information will be appended to an existing file or will create a new file. The default is not to save the information. CONT: If set this parameter indicates that a continuing CME sequence is being computed and various parameters will be not be computed. The default is to compute the parameters. POS: If present, this allows the angle from the plane of the sky to be specified. The default is to set the angle to 20 degrees. ROI: If present, then box contains the ROI indices rather than coordinates ALL: If present, then the entire image is processed ONLY_NE:If present, electron density is returned, rather than mass MAXVAL: If present, the maximum value in the region is computed MEDVAL: If present, the median value in the region is computed PB: If present, the input image is a pB image OUTPUTS: This function returns the mass contained within the ROI box in grams. COMMON BLOCKS: CME_MASS,Dist,Angle,B,Conv Dist = Distance of pixel in solar radii from sun center Angle = Angle of pixel in degrees from solar north B = brightness array of one electron Conv = Conversion factor from MSB to grams This common block is used to store a previous computation of the distance matrix to save time. SIDE EFFECTS: None RESTRICTIONS: The coordinates of the sun center must be in the header. PROCEDURE: An array in which the elements are the distance of that pixel from sun center is computed. Then ELTHEORY is called to compute the brightness and polarization properties of a single electron. MODIFICATION HISTORY: Written by: R.A. Howard, NRL, 18 September 1996 RAH 22 Mar 1997, Added Keyword POS and corrected mass/e RAH 16 May 1997, Changed header from FITS to header structure RAH 19 Sep 1997, Added Keyword ONLY_NE, added function of date RAH 18 Apr 1999, Put Ne to mass conversion into separate routine RAH 28 Sep 1999, Put POS (Plane of sky) angle to 0 instead of 20 RAH 03 Oct 1999, Added capability for pB image @(#)calc_cme_mass.pro 1.9 10/03/99 :NRL Solar Physics
NAME: CALC_DARK_BIAS PURPOSE: This procedure calculates minimum, mean, average and std dev of dark images CATEGORY: LASCO REDUCE CALLING SEQUENCE: CALC_DARK_BIAS,Files INPUTS: Files: If optional parameter, h, not present: String array of the file names to process If optional parameter, h, is present: image data array OPTIONAL INPUTS: H: Lasco header structure corresponding to image data in Files OUTPUTS: Write information to file in $NRL_LIB/lasco/data/bias PROCEDURE: Cacluates the average, standeard deviation, minimum (non-zero) value and the median value. Also gets the current value for the offset bias. Then appends the information to the file dark_bias_cX.dat, where X is the telescope number. EXAMPLE: For only one parameter, the input parameter is a list of files f = wlister() CALC_DARK_BIAS,f For two parameters, pass the image and the header: a = LASCO_READFITS(f,h) CALC_DARK_BIAS,a,h MODIFICATION HISTORY: Written by: RA Howard, 6/12/98 @(#)calc_dark_bias.pro 1.1 04/09/99 LASCO IDL LIBRARY
NAME: WRITE_IMA
PURPOSE: write image and header to disk file
CATEGORY: BASIC_INTERFACE
CALLING SEQUENCE: WRITE_IMAGE,ima_name,image,hdr
INPUTS: ima_name = string of header filename
image = array containing the image
hdr = header to write to disk
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: Writes to disk
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: Creates a new disk file
RESTRICTIONS: Assumes file extensions of .img and .hdr
PROCEDURE:
MODIFICATION HISTORY: RAH 7/2/90
M.BOUT 93/11/16 runs for the new structures
arrays and headers and saves them in two files
NOTE: the procedure VISU_IMA is convenient for the displaying of the saved
files. It's not the case of VISU_CAL.
@(#)write_ima.pro 1.2 4/10/93 :NRL Solar Physics
common ccd_header,header,nt,tags ; Modif. A.LL. 93/05/28
NAME: write_hdr.pro
PURPOSE: write image header to disk file
CATEGORY: General tools low level routine
CALLING SEQUENCE: write_hdr,ima_name,hdr
INPUTS: ima_name = string of header filename
hdr = header to write to disk
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: Writes to disk
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: Creates a new disk file
RESTRICTIONS: Assumes a file extension of .hdr
PROCEDURE:
MODIFICATION HISTORY: RAH 10/1/89
RAH 8/20/91 to use = as keyword delimiter
SCCS variables for IDL use
@(#)write_header.pro 1.2 4/10/93 :NRL Solar Physics
NAME: show_hdr.pro
PURPOSE: visualize keywords in Calibration headers
CATEGORY: General tools high level routine
CALLING SEQUENCE: show_hdr or show_hdr,/FULL
INPUTS: None
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: /FULL
OUTPUTS: A list of ima_header
OPTIONAL OUTPUT PARAMETERS:
COMMON BLOCKS: None
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
All 4/25/93 for VMS files in general
SCCS variables for IDL use
@(#)show_hdr.pro 1.3 4/25/93 :LAS
NAME: show_ima_hdr.pro
PURPOSE: visualize keywords from file headers
CATEGORY: General tools high level routine
CALLING SEQUENCE: show_ima_hdr, hdr_name
show_ima_hdr, hdr_name,/FULL
INPUTS: hdr_name Name of header file
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: /FULL
OUTPUTS: A list of ima_header
OPTIONAL OUTPUT PARAMETERS:
COMMON BLOCKS: None
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
All 4/25/93 for VMS files in general
corrected by M.B according to the new features of headers
11/03/93
SCCS variables for IDL use
@(#)show_ima_hdr.pro 1.3 4/25/93 :LAS
NAME: set_cal_hdr.pro
PURPOSE: set some keywords in Calibration headers
CATEGORY: General tools low level routine
CALLING SEQUENCE: set_ima_hdr,ima_header,refpix_x,refpix_y
INPUTS: ima_header = structure
refpix_x = float, (position of reference 0.,0.)
refpix_y = float, (position of reference 0.,0.)
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: ima_header
OPTIONAL OUTPUT PARAMETERS:
COMMON BLOCKS: None
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
All 4/25/93 for VMS files in general
SCCS variables for IDL use
@(#)set_ima_header.pro 1.3 4/10/93 :NRL Solar Physics
NAME: copy_ima_hdr.pro
PURPOSE: procedure to copy a heder structure in other
header structure
CATEGORY: CCD
CALLING SEQUENCE: copy_ima_hdr,header_in,header_out
INPUTS: header_in = header input,
header_out = new header structure
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: header_out = filled new header
OPTIONAL OUTPUT PARAMETERS:
SIDE EFFECTS:
RESTRICTIONS: corresponding tags must be of same element type
PROCEDURE:
MODIFICATION HISTORY: All 4/25/93 for VMS files from Fusion
SCCS variables for IDL use
@(#)copy_ima_hdr.pro 1.3 4/10/93 :NRL Solar Physics
NAME: w512.pro PURPOSE: create a 512*512 window CATEGORY: General tools high level routine CALLING SEQUENCE: extract_ima2, iin, hin, x1, x2, y1, y2, iout, hout INPUTS: n Window number OPTIONAL INPUT PARAMETERS: None KEYWORD PARAMETERS: None OUTPUTS: A image Window in the screen OPTIONAL OUTPUT PARAMETERS: None COMMON BLOCKS: None SIDE EFFECTS: RESTRICTIONS: PROCEDURE: MODIFICATION HISTORY: defined by ALL 6/24/93 SCCS variables for IDL use @(#)extract_ima2.pro 1.0 25/6/93 :LAS
NAME: LOAD_IMA.PRO
PURPOSE: Visualize a image array yet in memory
CATEGORY: General tools high level routine
CALLING SEQUENCE: ima, lcut, hcut, kx, ky
INPUTS: ima image array
lcut,hcut low and hight cut
kx, ky zoom parameters
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: image on screen
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)load_ima.pro 1.0 25/6/93 :LAS
NAME: VISU_IMA.PRO
PURPOSE: Put in virtual memory an image array & visualize it
CATEGORY: Visualization high level routine
CALLING SEQUENCE: VISU_IMA, ima_name, hima, ima, kx, ky, lcut, hcut
INPUTS: ima_name image_name
hima,ima IDL assoc names
kx, ky zoom parameters
lcut, hcut cuts values
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: Image on screen
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: None
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
modified by M.B 11/04/93
SCCS variables for IDL use
@(#)visu_ima.pro 1.0 25/6/93 :LAS
NAME: LOAD_CAL.PRO
PURPOSE: Visualizes a array image of calibration
(in memory yet)
CATEGORY: Preprocessing high level routine
CALLING SEQUENCE: iout = LOAD_CAL ( ima, lcut, hcut, itest,
nx_out, ny_out )
INPUTS: ima image array
lcut,hcut low an hight cuts
itest operating mode for big images
itest eq 1 not rebin
itest ne 1 rebin by 2 if 1124 pix
images ; OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: Image on screen
iout
nx_out
ny_out
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: None
RESTRICTIONS: None
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)load_cal.pro 1.0 25/6/93 :LAS
CALIB5.PRO
Upper level routines
Stat
Pro EXTRACT_IMA2, iin, hin, x1, x2, y1, y2, iout, hout
; extracts a subimage
Pro STAT_2D_FRM, ima, kx, ky, imb, imc ;Gives local stats over all
;image
Pro STAT_IMA, ima, x1,y1,x2,y2,z ;gives stas in a ROI
Function MIN_2D_FRM, ima, kx,ky
Function STATIMA, ima, x1,y1,x2,y2 ;
Visu
Pro W512, n ;Creates a 512*512 display
Pro VISU_IMA, ima_name, hima, ima, kx, ky, lcut, hcut ;Visualizes an image
Function LOAD_IMA, ima, lcut, hcut, kx, ky ;Visualizes a loaded ima;
Calib. processing
Pro VISU_CAL,ima_name, iout, hout ;Gets a CAL ima, rectifies
and visu. it
Pro VISU_CAL_CLEAN, ima_name, backg, iout, hout ;Gets a CAL ima, rectifies
subtracts and visu. it
Pro READ_CAL,ima_name, itest, iout, hout ;Gets a CAL ima. rectified
Pro CLEAN_CAL, ima, hima, itest, iout, hout ;rectifies a CAL image
Function LOAD_CAL(ima,hima,lcut,hcut,itest,hout) ;rectifies a CAL image and
visu. it
Pro SET_CAL_HDR, hdr, refpix_x, refpix_y ;Sets cal parameters
Catalogs of images
Pro DARK_CATA ; (CATA)
Pro SHOW_CATALOG ; (CATA)
Pro CHOOSE_DARK, dark_new_name, drk, hdrk ; (CATA)
Pro PRO_CAL, ima_name, drk, hdrk, ima, hima ;process a CAL with
catalogued darks (CATA)
Pro GET_DRK_NAME, ima_name, ass_name ; (CATA)
Pro SET_CATALOG, template, db_ima, nima, ima_name
Pro FIND_IMA, hdr, ima_db, ima_name
Pro IMA_LIST, template, ima_db, nfiles
Function DEFINE_CATALOG( nfiles )
Basic I/O
Pro WRITE_IMA, ima_name, ima, hdr ;Stores an image and a hdr
Pro SHOW_HDR, ima_hdr, FULL = I ;Shows some hdr parameters
Pro COPY_IMA_HDR, hdr_in, hdr_out ;Copies a header
Function READ_IMA( ima_name, hdr, ichoice ) ;opens an image from stor.
Low level routines
Function GETTOK(st,char)
Function DATE_CAL( date, hour )
Pro DATE_NUM_TEXT,year,month,day,hour
Function DEFINE_IMA_HDR( dummy )
Function DEFINE_CAL_HDR( dummy )
Function DEFINE_BSC_HDR( dummy )
Function DEFINE_C1_HDR( dummy )
Function DEFINE_CCD_HDR( dummy )
Function READ_IMA_HDR( ima_name, hdr, itest )
Function READ_IMA_FRAME( ima_name, bitpix, nx, ny )
Pro WRITE_HDR,ima_name, hdr
Pro CHECK_IMGDIR, dummy
Pro CHECK_FILENAME, filename, path, extension
A.LL.
NAME: visu_cal_clean.pro
PURPOSE: Gets a calib. image from disk, subtracts dark, and visualizes it
CATEGORY: Calibration high level routine
CALLING SEQUENCE: VISU_CAL_CLEAN, ima_name, backg, ima, hdr
INPUTS: ima_name image name of calibration
backg background image array
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: Image on screen
ima image array
hdr header of image array
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: hdr array is defined as DEFINE_IMA_HDR
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)visu_cal_clean.pro 1.0 25/6/93 :LAS
NAME: read_cal.pro
PURPOSE: Gets a calibration image from disk and visualizes it
CATEGORY: Calibrations high level routine
CALLING SEQUENCE: READ_CAL, ima_name, itest, ima, hdr
INPUTS: ima_name image name of calibration
itest =0 rebin si nx = 1124
=1 no rebin pour nx = 1124
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: Image on screen
ima image array
hdr header of image array
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: hdr array is defined as DEFINE_IMA_HDR
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)read_cal.pro 1.0 25/6/93 :LAS
NAME: visu_cal.pro
PURPOSE: Gets a calibration image from disk and visualizes it
CATEGORY: Calibrations high level routine
CALLING SEQUENCE: VISU_CAL, ima_name, ima, hdr
INPUTS: ima_name image name of calibration
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: Image on screen
ima image array
hdr header of image array
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: hdr array is defined as DEFINE_IMA_HDR
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)visu_cal.pro 1.0 25/6/93 :LAS
NAME: CLEAN_CAL.PRO
PURPOSE: Resizes and rotates a calibration image array
CATEGORY: Calibrations high level routine
CALLING SEQUENCE: CLEAN_CAL, ima, hima, itest, iout, hout
INPUTS: ima image array of calibration
hima header
itest operating mode for big images
itest eq 1 not rebin
itest ne 1 rebin by 2 if 1124 pix
images
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS:iout image array
hout header of image array
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: hdr array is defined as DEFINE_IMA_HDR
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)clean_cal.pro 1.0 25/6/93 :LAS
NAME: stat_2d_frm.pro
PURPOSE: Build a image of means and a image of sd (standard deviations)
CATEGORY: General tools high level routines, Statistics.
CALLING SEQUENCE: stat_2d_frm, ima,kx,ky,imb,imc
INPUTS: ima image array
kx step_size in x
ky step_size in y
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS:imb image array of means
imc image array of sd. deviations
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)stat_2d_frm.pro 1.0 25/6/93 :LAS
NAME: stat_ima.pro
PURPOSE: local statistics in a image array (in memory)
CATEGORY: General tools high level routine
CALLING SEQUENCE: stat_ima, ima, x1, x2, y1, y2, z
INPUTS: ima image array
x1,x2 x interval of rectangle
y1,y2 y interval of rectangle
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS:z array of values
z(0) = ntot
z(1) = sum
z(2) = moy
z(3) = std
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)stat_ima.pro 1.0 25/6/93 :LAS
NAME: MIN_2D_FRM.PRO
PURPOSE: make an image of local minima
CATEGORY: General tools high level routine
CALLING SEQUENCE: ima_out = min_2d_frm( ima_in, kx, ky)
INPUTS: ima_in image array
kx step_size in x
ky step_size in y
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS:ima_out mapping of local minima
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: None
RESTRICTIONS: None
PROCEDURE:
MODIFICATION HISTORY: defined by M.B and A.LL 26/10/93
SCCS variables for IDL use
@(#)min_2d_frm.pro 1.0 26/10/93 :LAS
NAME: statima.pro
PURPOSE: extract a image from another
CATEGORY: General tools high level routine
CALLING SEQUENCE: extract_ima2, iin, hin, x1, x2, y1, y2, iout, hout
INPUTS: iin image array
hin header of image array
x1,x2 x interval of rectangle
y1,y2 y interval of rectangle
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS:iout extracted image array
hout header for extracted image
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: opens a catalog of darks
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)extract_ima2.pro 1.0 25/6/93 :LAS
NAME: extract_ima2.pro
PURPOSE: extract a image from another
CATEGORY: General tools high level routine
CALLING SEQUENCE: extract_ima2, iin, hin, x1, x2, y1, y2, iout, hout
INPUTS: iin image array
hin header of image array
x1,x2 x interval of rectangle
y1,y2 y interval of rectangle
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS:iout extracted image array
hout header for extracted image
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: opens a catalog of darks
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
corrected by M.B 11/03/93 for header's filling
SCCS variables for IDL use
@(#)extract_ima2.pro 1.0 25/6/93 :LAS
NAME:DEFINE_CATALOG.pro PURPOSE Sets a array of structures for a image catalog CATEGORY: Preprocessing low level CALLING SEQUENCE: db = DEFINE_CATALOG(nfiles) INPUTS: nfiles Nombre max of files in catalog OPTIONAL INPUT PARAMETERS: None KEYWORD PARAMETERS: None OUTPUTS: a array structure for catalog OPTIONAL OUTPUT PARAMETERS: None COMMON BLOCKS: None SIDE EFFECTS: None RESTRICTIONS: PROCEDURE: MODIFICATION HISTORY: defined by ALL 6/24/93 SCCS variables for IDL use @(#)DEFINE_CATALOG.pro 1.0 25/6/93 :LAS
NAME: DATE_NUM_TEXT.PRO PURPOSE: Gives a set of date strings, ex: 12, 09, 1994 (for the 12 Sep 1994) A.LL.
NAME: define_ima_hdr
PURPOSE: defines a image header structure
CATEGORY: BASIC_INTERFACES
CALLING SEQUENCE: hdr = define_ima_hdr(0)
INPUTS: None
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: structure array containing initialized an header
OPTIONAL OUTPUT PARAMETERS:
COMMON BLOCKS: None
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: RAH 10/1/89
RAH 8/20/91 Added AES BSBD camera keywords
ALL 04/27/93 takes only standard KEYWORDS
SCCS variables for IDL use
@(#)define_ima_hdr.pro 1.1 7/6/92 :NRL Solar Physics
;;common ccd_header,header,nt,tags
NAME: IMA_LIST.pro
PURPOSE: list the catalog of images (corresp to a template)
CATEGORY: Preprocessing low level routine
CALLING SEQUENCE: DARK_LIST, template, ima_db, nfiles
INPUTS: template Template to define the list of images
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS:ima_db image catalog
nfiles Number of images in catalog
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: opens a catalog of darks
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)ima_list.pro 1.0 25/6/93 :LAS
NAME: find_ima.pro
PURPOSE: From the image header finds the asociate dark in dark catalog
CATEGORY: Preprocessing low level
CALLING SEQUENCE: find_ima, hdr, ima_db, ima_name
INPUTS: hdr image header
ima_db image catalog
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS:ima_name name of associated image in catalog
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: None
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
corrected by M.B 11/03/93 for darks without shutter
SCCS variables for IDL use
@(#)find_ima.pro 1.0 25/6/93 :LAS
NAME: SET_CATALOG.PRO
PURPOSE: Set a catalog of images in memory
CATEGORY: Preprocessing high level routine
CALLING SEQUENCE: SET_CATALOG
INPUTS: template Template For image names
db_dark Liste of images
ndarks Number of images in catalog
drk_name Associate dark name
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: catalog list in the screen
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: opens a catalog of darks if it don't exists
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)set_catalog.pro 1.0 25/6/93 :LAS
NAME: show_catalog.pro PURPOSE: list the catalog in memory CATEGORY: Preprocessing CALLING SEQUENCE: SHOW_CATALOG INPUTS: None OPTIONAL INPUT PARAMETERS: None KEYWORD PARAMETERS: None OUTPUTS: catalog list in the screen OPTIONAL OUTPUT PARAMETERS: None COMMON BLOCKS: CATA, db_dark, ndarks, drk_name SIDE EFFECTS: opens a catalog of darks if this dont exists RESTRICTIONS: PROCEDURE: MODIFICATION HISTORY: defined by ALL 6/24/93 SCCS variables for IDL use @(#)show_catalog.pro 1.0 25/6/93 :LAS
NAME: list_ima_param.pro PURPOSE: list the catalog in memory CATEGORY: Preprocessing CALLING SEQUENCE: CHOOSE_DARK, drk_new_name, drk, hdrk INPUTS: template Template of files names to list OPTIONAL INPUT PARAMETERS: None KEYWORD PARAMETERS: None OUTPUTS: catalog lis in the screen OPTIONAL OUTPUT PARAMETERS: None COMMON BLOCKS: None SIDE EFFECTS: None RESTRICTIONS: PROCEDURE: MODIFICATION HISTORY: defined by ALL 6/24/93 SCCS variables for IDL use @(#)list_ima_param.pro 1.0 25/6/93 :LAS
NAME: choose_dark.pro
PURPOSE: defines a dark frame as the active dark
CATEGORY: Preprocessing
CALLING SEQUENCE: CHOOSE_DARK, drk_new_name, drk, hdrk
INPUTS drk_new_name Name of dark array
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: drk array of data
hdrh header of data array
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: CATA, db_dark, ndarks, drk_name
SIDE EFFECTS: fullfills the dark catalog common
if it don't exists
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)choose_dark.pro 1.0 25/6/93 :LAS
NAME: get_drk_name.pro
PURPOSE: founds de associate dark frame for
a image and gets their name
CATEGORY: Preprocessing high level
CALLING SEQUENCE: get_drk_name, ima_name, drk_name
INPUTS: ima_name Name of image
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: ass_name Name of associate dark frame
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: CATA, db_dark, ndarks, drk_name
SIDE EFFECTS: 1) defines de found dark as the active dark
2) fullfills the dark catalog common if it
don't exists
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)get_drk_name.pro 1.0 25/6/93 :LAS
NAME: DARK_CATA.pro
PURPOSE: Set a catalog of darks in memory
CATEGORY: Preprocessing high level routine
CALLING SEQUENCE: SET_CATALOG
INPUTS: None
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: catalog list in the screen
Modifies CATA common
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: CATA, db_dark, ndarks, drk_name
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)set_catalog.pro 1.0 25/6/93 :LAS
NAME: pro_cal.pro
PURPOSE: get in memory an image and
substracts the right dark
CATEGORY: Preprocessing high level routine
CALLING SEQUENCE: PRO_CAL, ima_name, drk, hdrk, iout, hout
INPUTS: ima_name Name of image to process
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: drk Associate dark array
hdrk Associate header of dark
iout Corrected image array
hout Header for corrected image array
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: CATA, db_dark, ndarks, drk_name
SIDE EFFECTS: opens a catalog of darks if this doesn't exist
and associates a dark to frame
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
rewritted and corrected by M.B 11/04/93
SCCS variables for IDL use
@(#)pro_cal.pro 1.0 25/6/93 :LAS
NAME: define_C1_Hdr PURPOSE: defines the C1 (PF) header structure CATEGORY: General tools Low level routine CALLING SEQUENCE: h=define_C1_hdr (0) INPUTS: None OPTIONAL INPUT PARAMETERS: None KEYWORD PARAMETERS: None OUTPUTS: h struct. array containing initialized an header OPTIONAL OUTPUT PARAMETERS: COMMON BLOCKS: none SIDE EFFECTS: RESTRICTIONS: PROCEDURE: MODIFICATION HISTORY: define_ccd_hdr RAH 10/1/89 RAH 8/20/91 define_ccd_hdr Added AES BSBD camera keywords ALL 6/24/93 Remove common, changes to define_C1_hdr SCCS variables for IDL use @(#)define_c1_hdr.pro 1.1 7/6/92 :NRL Solar Physics
NAME: define_cal_hdr PURPOSE: defines header structure for cal. images of C2 and C3 CATEGORY: General tools low level routines CALLING SEQUENCE: h=define_cal_hdr (0) INPUTS: None OPTIONAL INPUT PARAMETERS: None KEYWORD PARAMETERS: None OUTPUTS: h struct. array containing initialized an header OPTIONAL OUTPUT PARAMETERS: COMMON BLOCKS: none SIDE EFFECTS: RESTRICTIONS: PROCEDURE: MODIFICATION HISTORY: define_ccd_hdr RAH 10/1/89 RAH 8/20/91 define_ccd_hdr Added AES BSBD camera keywords ALL 6/24/93 Remove common, changes to define_cal_hdr SCCS variables for IDL use @(#)define_ccd_hdr.pro 1.1 7/6/92 :NRL Solar Physics
NAME: define_BSC_Hdr PURPOSE: defines the basic header structure for lasco images CATEGORY: General tools low level routine CALLING SEQUENCE: h=define_bsc_hdr (0) INPUTS: None OPTIONAL INPUT PARAMETERS: None KEYWORD PARAMETERS: None OUTPUTS: struct. array containing initialized an header OPTIONAL OUTPUT PARAMETERS: COMMON BLOCKS: none SIDE EFFECTS: RESTRICTIONS: PROCEDURE: MODIFICATION HISTORY: RAH 10/1/89 RAH 8/20/91 Added AES BSBD camera keywords ALL 6/24/93 Remove common, adapts for a basic set of KEYWORDS SCCS variables for IDL use @(#)define_bsc_hdr.pro 1.1 7/6/92 :NRL Solar Physics
NAME: define_CCD_Hdr
PURPOSE: defines the CCD header structure
CATEGORY: CCD low level routine
CALLING SEQUENCE: h=define_CCD_hdr (0)
INPUTS: None
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: struct. array containing initialized an header
OPTIONAL OUTPUT PARAMETERS:
COMMON BLOCKS: ccd_header,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: RAH 10/1/89
RAH 8/20/91 Added AES BSBD camera keywords
SCCS variables for IDL use
@(#)define_ccd_hdr.pro 1.1 7/6/92 :NRL Solar Physics
NAME: read_ima_hdr
PURPOSE: function procedure to read header from disk file, f
and store in a standard header structure type
CATEGORY: BASIC_INTERFACES
CALLING SEQUENCE: read_ima_hdr,ima_name,ima_header
INPUTS: ima_name = string containing the header filename
ima_header = structure
verbose = 1, print all absent variables
verbose = 0, print only a resumee
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: ima_header = header structure from disk
OPTIONAL OUTPUT PARAMETERS:
COMMON BLOCKS: None
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: RAH 10/1/89, ACG 11/21/89, rah 1/9/91
rah 3/15/91 to account for unrecognized keyword
rah 8/20/91 to trim leading and trailing blanks
DW 8/27/91 change delimiter to '='
DW 2/26/93 put TEMP_FNG in TEMP as well
All 4/25/93 for VMS image files in general
Common supression
SCCS variables for IDL use
@(#)read_ima_header.pro 1.3 4/10/93 :NRL Solar Physics
NAME: READ_IMA_FRAME
PURPOSE: reads a image frame from disk
CATEGORY: BASIC_INTERFACE
CALLING SEQUENCE: a = read_ima_frame(name,bitpix,nx,ny)
INPUTS: name = string of the name of the file to read
bitpix = nb of bits/pixel
nx = nb de pixels en x
ny = nb de pixels en y
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: a = array containing the image
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: RAH 7/2/90
rah 3/21/90 to account for non-integer input fil
es
rah 3/33/90 to check for datamax & datamin
ALL 5/12/93
SCCS variables for IDL use
@(#)read_ima_frame.pro 1.3 4/10/93 :NRL Solar Physics
NAME: read_ima
PURPOSE: reads a image and their header
CATEGORY: BASIC_INTERFACES
CALLING SEQUENCE: ima = read_ima(ima_name, hdrima, ichoice)
INPUTS: ima_name Name of image
hdrima Header structure
ichoice Type of header
0 = IMA, 1 = BSC, 2=CAL, 3=C1
4 = CCD. else external header
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: ima Image frame
hdrima Filled header structure
OPTIONAL OUTPUT PARAMETERS:
COMMON BLOCKS: None
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: RAH 10/1/89
RAH 8/20/91 Added AES BSBD camera keywords
ALL 04/27/93 takes only standard KEYWORDS
SCCS variables for IDL use
@(#)read_ima.pro 1.1 7/6/92 :NRL Solar Physics
PROJET:
SOHO-LASCO
NAME:
calib_c3_sqima.pro
PURPOSE:
Prepare a clean C3 image (image must be square)
USE:
calib_c3_sqima,imain,bias,exptime,imacorr,irebin,izero,nzero,c3msk,coef,jpix,prfle_xy,bkgd, $
IPIXN=ipixn, JPIXN=jpixn, IPOS=ipos, THRESH=thresh, vig_c3=vig_c3
INPUT:
imain image get from a readfits(name,hdr) for instance
bias bias value
exptime time exposure
irebin rebin level : 1 1024x1024; 2 512x512; 3 256x256
leb_rebin rebin level from LEB
KEYWORD INPUT:
THRESH=thresh treshold to add (default = 0.)
VIG_C3=vig_c3 vignetting correction array
OUTPUT:
imacorr corrected image (background gradient and photometry)
izero list of zero values (from not transmited blocks)
nzero number of zero values
c3msk mask of values for C3
KEYWORD OUTPUT:
IPIXN=ipixn for verification of get_c3_bkgd (debug purposes)
JPIXN=jpixn for verification of get_c3_bkgd
IPOS=ipos for verification of get_c3_bkgd
RESTRICTIONS:
works only with square images
MODIFICATIONS:
nbr, 11/30/00 - Compute vig_c3 separately before multiplying
NAME:
CARRDATE
PURPOSE:
This function converts a carrington number and longitude into a
CDS date structure.
CATEGORY:
LASCO Synoptic
CALLING SEQUENCE:
Result = CARRDATE ( Cr, Clong)
INPUTS:
Cr: Carrington Rotation Number
Clong: Carrington Longitude
OPTIONAL INPUTS:
None
KEYWORDS:
EL: This keyword specifies that the date should be returned as an
East Limb Date
WL: This keyword specifies that the date should be returned as a
West Limb Date
CMP: This keyword specifies that the date should be returned as a
central meridian Date. This is the default.
OUTPUTS:
Result: The function result is the date as a CDS date structure
COMMON BLOCKS:
carr_long: Contains the start date of the carrington rotations
from the almanac. Generated by READ_CARR_LONG
MODIFICATION HISTORY:
Written by: RA Howard, NRL, 3/18/96
10/17/96 RAH, Added check for cday being defined
, Changed output to CDS structure
@(#)carrdate.pro 1.3 10/17/96 LASCO IDL LIBRARY
NAME:
CARRDATE
PURPOSE:
This function converts a carrington number and longitude into a
date.
CATEGORY:
LASCO Synoptic
CALLING SEQUENCE:
Result = CARRDATE ( Cr )
INPUTS:
Cr: Carrington Rotation Number
OPTIONAL INPUTS:
None
KEYWORDS:
EL: This keyword specifies that the date should be returned as an
East Limb Date
WL: This keyword specifies that the date should be returned as a
West Limb Date
CMP: This keyword specifies that the date should be returned as a
central meridian Date. This is the default.
Clong: Carrington Longitude
OUTPUTS:
Result: The function result is returned as a fractional modified
Julian date.
COMMON BLOCKS:
carr_long: Contains the start date of the carrington rotations
from the almanac. Generated by READ_CARR_LONG
MODIFICATION HISTORY:
Written by: RA Howard, NRL, 3/18/96
11/20/96 by N. RIch added read_carr_long call if cday=0; changed
cday(n-1) to cday(n) and cday(n) to cday(n+1);
made dte variable same as day; initialized clong
to 360 if not set and change clong to keyword;
changed +/- in computing el and wl day
12/30/96 by N. Rich changed output to CDS structure
@(#)carrdate.pro 1.1 10/05/96 LASCO IDL LIBRARY
NAME: CARRLONG PURPOSE: This procedure computes the carrington number and longitude given the date. CATEGORY: LASCO Synoptic CALLING SEQUENCE: CARRLONG, Date, Cr, Clong INPUTS: Date: The date in CDS date/time structure OPTIONAL INPUTS: None KEYWORD PARAMETERS: EL: Set this keyword to obtain information for East Limb date WL: Set this keyword to obtain information for West Limb date CMP: Set this keyword to obtain information for central meridian This is the default. OUTPUTS: Cr: The carrington rotation number corresponding to the input date Clong: The carrington longitude corresponding to the input date COMMON BLOCKS: carr_long: Contains the start date of the carrington rotations from the almanac. Generated by READ_CARR_LONG EXAMPLE: CARRLONG, date, cnum, clong, /EL MODIFICATION HISTORY: Written by: RA Howard, NRL, 3/18/96 10/17/95 RAH, Converted dates to CDS time structure 13/10/00 nbr, Changed "tai LT cday" to "tai LE cday" @(#)carrlong.pro 1.4 11/05/01 LASCO IDL LIBRARY
ro carrmapdisp, limb, r, RANGE=range, VERTICAL=vertical, CMAPDIR=cmapdir Purpose: Display carrington maps in a scrollable format (NOTE: previous carrmapdisp.pro renamed carrmapdisp0.pro) Optional Inputs: limb STRING 'w', 'e' or search parameter r FLOAT height of desired map KEYWORDS: RANGE = [cn0, cn1] INTARR range of carrington numbers to display /VERTICAL If set, display maps stacked, not side-by-side CMAP='/path/of/fits/files' defaults to location at NRL Written 980917 by Nathan Rich, Interferometrics/NRL 030821, nbr - add RANGE, vertical display options, rename from slide_carrmap.pro 030829, nbr - fix bug in list=findfile() @(#)carrmapdisp.pro 1.2 09/02/03 - LASCO NRL IDL Library
Procedure: CARRMAPMAKER2
PURPOSE:
Returns carrington maps at multiple radii for a passed
carrington number at radii read from user in this routine.
Program only works for maps beginning after
January,6 1996.
INPUTS:
cn INT: carrington number
cam STRING: camera, i.e. 'c2'
num_r INT: number of radii to make maps for
rad FLTARR(num_r): radii for maps
cmap FLTARR(mapsize,ht,num_r): passed empty
pol STRING: 'p','u' or ''; indicates polarizer value
limb INTARR: 0 or 1 tells which limb for carrdate procedure
level STRING: 'ql' for quick-look, 'r' for doing ratio
disp INT: 1 t