[Previous]
[Next]
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)
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], FXADDPAR [1], FXADDPAR [2]
LASCO_FITSHDR2STRUCT, STR2UTC [1], STR2UTC [2], STR2UTC [3], TRIM
CALLED BY:
C2_CALIBRATE
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
KB/RAH Aug 29,2005 - Add new orcl calfactor of 0.06047 and removed fudge factor
9/20/05 RAH Add time variable calibration coefficient for orange
SCCS variables for IDL and Header use
ver= '@(#)c2_calfactor.pro 1.8, 11/01/05' ;NRL LASCO IDL LIBRARY
[Previous]
[Next]
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)
CALLS: ***
C2_CALFACTOR, DATATYPE [1], DATATYPE [2], DATATYPE [3], FILE_DATE_MOD
FXADDPAR [1], FXADDPAR [2], GET_EXP_FACTOR [1], GET_EXP_FACTOR [2]
LASCO_FITSHDR2STRUCT, READFITS [1], READFITS [2], READFITS [3], STR2UTC [1]
STR2UTC [2], STR2UTC [3], UTC2YYMMDD
CALLED BY:
C3_CME, GET_PT, POLARIZ_CALC, REDUCE_LEVEL_1
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
K.Battams 9/20/05 - New vig function (final release!)
K.Battams 9/30/05 - Add a blank space before each HISTORY entry.
Oct03,05 KarlB - Remove "tab" spaces from HISTORY comments
Variables for SCCS and FITS header
ver= '@(#)c2_calibrate.pro 1.13, 10/03/05' ;NRL LASCO IDL LIBRARY
[Previous]
[Next]
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
CALLS: ***
DISTORTION_COEFFS, SUBTENSE
CALLED BY:
C2_WARP, STARFIELD, WRUNMOVIEM, WRUNMOVIEM3, WRUNMOVIEM_RT, polariz_display
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.
[Previous]
[Next]
vignetting function for C2
INPUT: suncen_x, suncenter_y
OUTPUT: vignetting array (floating point array)
Created: Dennis Wang
Modified:
Karl Battams, 06/06/21 Point to new vignetting function
%W% %H% NRL LASCO IDL LIBRARY
CALLS:
CALLED BY
POLARIZ_CALC
[Previous]
[Next]
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.
CALLS: ***
C2_DISTORTION, DATATYPE [1], DATATYPE [2], DATATYPE [3], GET_SEC_PIXEL
LASCO_FITSHDR2STRUCT, OCCLTR_CNTR, STRUCT2FITSHDR, WARP_TRI
CALLED BY:
ADD_MISSING_BLOCKS, MKMOVIE, MKMOVIE0 obsolete version of mkmoviepro, MK_IMG
REDUCE_LEVEL_1
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
version= '@(#)c2_warp.pro 1.4 08/24/00' ; LASCO IDL LIBRARY
[Previous]
[Next]
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)
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], FXADDPAR [1], FXADDPAR [2]
LASCO_FITSHDR2STRUCT, STR2UTC [1], STR2UTC [2], STR2UTC [3], TRIM
CALLED BY:
C3_CALIBRATE, GET_PT
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.
11/01/05 RAH/KB Modify calfactor for C3 clear (subtract 50000 from mjd)
SCCS variables for IDL use
ver= '@(#)c3_calfactor.pro 1.16 11/02/05' ;LASCO IDL LIBRARY
[Previous]
[Next]
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)
CALLED BY:
C3_CALIBRATE, GET_PT
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
ver= '@(#)c3_calfactor.pro 1.12 06/08/05' ;LASCO IDL LIBRARY
[Previous]
[Next]
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)
CALLS: ***
C3_CALFACTOR [1], C3_CALFACTOR [2], DATATYPE [1], DATATYPE [2], DATATYPE [3]
FILE_DATE_MOD, FUZZY_IMAGE, FXADDPAR [1], FXADDPAR [2], GET_EXP_FACTOR [1]
GET_EXP_FACTOR [2], LASCO_FITSHDR2STRUCT, LASCO_READFITS [1]
LASCO_READFITS [2], READFITS [1], READFITS [2], READFITS [3], STR2UTC [1]
STR2UTC [2], STR2UTC [3], UTC2YYMMDD
CALLED BY:
C3_CME, C3_CME_FRONT, C3_MASSIMG, CME_MASS, GET_PT, POLARIZ_CALC, REDUCE_LEVEL_1
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)
K.Battams 9/30/2005 - Add a blank space before each HISTORY entry.
Variables for SCCS and FITS header
ver= '@(#)c3_calibrate.pro 1.53, 10/03/05' ; NRL LASCO IDL LIBRARY
[Previous]
[Next]
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
CALLS: ***
AVERAGE, AWIN, C2_CALIBRATE, C3_CALIBRATE, CALC_CME_MASS, DEFROI [1], DEFROI [2]
GET_SOLAR_RADIUS, LASCO_READFITS [1], LASCO_READFITS [2], PICKFILE, XLOADCT [1]
XLOADCT [2], XLOADCT [3]
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
%W% %H% LASCO IDL LIBRARY
[Previous]
[Next]
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
CALLS: ***
AVERAGE, AWIN, C3_CALIBRATE, CALC_CME_MASS, DEFROI [1], DEFROI [2], GET_SOLAR_RADIUS
GET_SUN_CENTER [1], GET_SUN_CENTER [2], GET_SUN_CENTER [3], LASCO_READFITS [1]
LASCO_READFITS [2], PICKFILE, RDPIX, ROI_SECTOR, XLOADCT [1], XLOADCT [2]
XLOADCT [3]
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
[Previous]
[Next]
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
CALLS: ***
DISTORTION_COEFFS, SUBTENSE
CALLED BY:
C3_WARP, STARFIELD, WRUNMOVIEM, WRUNMOVIEM3, polariz_display
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
[Previous]
[Next]
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
CALLS: ***
AVERAGE, C3_CALIBRATE, CALC_CME_MASS, DERIVFITSHDR, FXADDPAR [1], FXADDPAR [2]
LASCO_READFITS [1], LASCO_READFITS [2], WRITEFITS [1], WRITEFITS [2]
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
[Previous]
[Next]
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.
CALLS: ***
C3_DISTORTION, DATATYPE [1], DATATYPE [2], DATATYPE [3], GET_SEC_PIXEL
LASCO_FITSHDR2STRUCT, OCCLTR_CNTR, REDUCE_STD_SIZE, WARP_TRI
CALLED BY:
ADD_MISSING_BLOCKS, MKMOVIE, MKMOVIE0 obsolete version of mkmoviepro, MK_IMG
REDUCE_LEVEL_1
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:
version= '03/14/03 @(#)c3_warp.pro 1.7' ; NRL LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - CDS
Name : CAL_AUXREAD()
Purpose : Read block of auxiliary data from a CDS FITS level-1 file.
Explanation : READCALCOL is used to read all information
about the auxiliary data with 'TTYPEx' == NAME.
The data is returned in an IDL structure,
with the tags DATA, which contains the actual
data, and DESC, which contains the CDS QL Data Format
auxiliary data descriptor.
If the specified auxiliary data are not found,
the tags will have a value of zero.
Use : AUX = CAL_AUXREAD(UNIT,HEADER,NAME)
Inputs : UNIT = the file unit associated with the FITS file.
HEADER= the header of the FITS file
NAME = the type/label name of the desired auxiliary
data.
Opt. Inputs : None.
Outputs : Returns structure with auxiliary data and descriptor.
Opt. Outputs: None.
Keywords : STATUS : Set to initialized variable in order to return
error message instead of crashing on error. Returns
empty string if ok.
Calls : ***
CAL_MKAUXDESC, FXBFIND [1], FXBFIND [2], READCDSCOL, TRIM
CALLED BY:
GT_MIRRPOS, GT_SLITPOS, GT_START, PLOT_DELTAT, READCALFITS
Common : None.
Restrictions: The file has to be a CDS FITS level-1 file.
Side effects: None.
Category : Data_Handling, I_O, CDS, FITS, Calibration
Prev. Hist. : None.
Written : Stein Vidar Hagfors Haugan, 27 September 1993
Modified : SVHH, 24 May 1994, Version 2
Added status=status
SVHH, 11 June 1994, Version 2.1
Shortened name of tags to D and DD, due to
EXECUTE string length problem.
Version 3, 04-Jun-1998, William Thompson, GSFC
Use READCDSCOL instead of READ_CDS
Version : Version 3, 04-Jun-1998
[Previous]
[Next]
Project : SOHO - CDS
Name : CAL_DETREAD()
Purpose : Reads detector data from CDS FITS level-1 file.
Explanation : Based on information from CAL_DETSELECT(), read and store
detector data from the file into one contiguous array,
QLDS.DetData, with descriptors (indexes & wavelength
information) in QLDS.DetDesc(WndNo)
Use : Det = Cal_Detread(UNIT,HEADER)
Inputs : UNIT = Device unit associated with the FITS file
HEADER = Header (string array) of the FITS file
QLDS = The QuickLook data structure to put data into.
SELECTION_DATA = Structure from DETSELECT() with
information on windows etc.
Opt. Inputs : None.
Outputs : Places the data from the file into the QLDS.
Opt. Outputs: None.
Keywords : STATUS : Set to an initialized, named variable to
return an error message instead of crashing. If
everything's ok, a null string will be returned.
Calls : ***
CAL_MKDETWDESC, CAL_STORE_WND, FXBDIMEN [1], FXBDIMEN [2], READ_CALFITS, TRIM
CALLED BY:
GT_NUMWIN, GT_WLABEL, GT_WNUM, READCALFITS
Common : None.
Restrictions: UNIT/HEADER must refer to a CDS FITS level-1 file.
Normally used internally from READCDSFITS.
Side effects: None.
Category : Data_Handling, I_O, CDS, FITS, QuickLook
Prev. Hist. : None.
Written : Stein Vidar Hagfors Haugan, 27 September 1993
Modified : SVHH, 1 October 1993 -- accomodate possible LONG INTEGER
format.
SVHH, 26 October 1993
Changed FXBPARSETDIM -> FXBTDIM
and FXBPARSETFORM -> FXBTFORM
CDP, 4-Mar-94 Changed reference from TDETY to TDETX in call
to FXBFIND
Version 3, William Thompson, GSFC, 4 March 1994
Changed to call FXBDIMEN
SVHH, 19 May 1994
Removed printing of selected window numbers
SVHH, 24 May 94 Version 4
Added /header, /auto, memlimit=memlimit,
status=status.
Rewrote the window selection procedures.
SVHH, 25 May 94, Version 4.1
Cut temp. storage of data array -> less memory used.
SVHH, 27 May 94, V 4.2
Included /header keyword in call to READ_CALFITS,
and ghost DetDesc.ixstart/ixstop values.
SVHH, 2 June 94, V 4.3
Fixed bug in ghost indexes with F_rows set.
SVHH, Version 5, 11-June-1994,
Split in two (CAL_DETSELECT + CAL_DETREAD) to minimize
memory overhead.
Version : Version 5, 11 June 1994
[Previous]
[Next]
Project : SOHO - CDS
Name : CAL_DETSELECT()
Purpose : Select detector data from CDS FITS level-1 file.
Explanation : Figure out how much space will be needed to store all
detector data in this file into one contiguous array,
Det.DetData, and return information necessary for
DETREAD to actually read the data and store them.
Use : Det = Cal_Detselect(UNIT,HEADER)
Inputs : UNIT = Device unit associated with the FITS file
HEADER = Header (string array) of the FITS file
Opt. Inputs : None.
Outputs : Structure with information for DETREAD.
Opt. Outputs: None.
Keywords : SELECT : set to enable selection of some data windows
For the windows that are not selected, descriptive
information (DetDesc's) are created, but no detector
data is stored. For windows that are not selected,
ixstart will be all zeros, while ixstop will have
a negative lambda entry, but by using absolute values,
the sizes of the potential data block can be found.
Note that, as with selected data, the size of
dimension i is now: sz = abs(ixstop(i)) - ixstart(i) + 1
/HEADER : Set to only read descriptive information
about detector data windows -- no data will be loaded
/AUTO : Set to force automatic, silent truncation of the data
by reading just those detector data windows that
fit below the memory limit. If the memory limit is exceeded
withouth this flag set, the user is prompted for either
setting the /HEADER flag or making a manual selection of
the data windows.
MEMLIMIT : Set to the maximum size of memory that
the detector data are allowed to occupy.
STATUS : Set to a initialized, named variable to
return an error message instead of crashing. If
everything's ok, a null string will be returned.
Calls : ***
Bell, CAL_MKDETWDESC, FXBDIMEN [1], FXBDIMEN [2], FXBFIND [1], FXBFIND [2]
FXBTFORM [1], FXBTFORM [2], FXPAR [1], FXPAR [2], READ_CALFITS, TRIM, YES_NO
CALLED BY:
GT_NUMWIN, GT_WINSIZE, GT_WLABEL, GT_WNUM, READCALFITS
Common : None.
Restrictions: UNIT/HEADER must refer to a CDS FITS level-1 file.
Normally used internally from READCDSFITS.
Side effects: None.
Category : Data_Handling, I_O, CDS, FITS, QuickLook
Prev. Hist. : Taken out of the old CAL_DETREAD. Split done to minimize
memory overhead. Also fixed a bug that was making all data
storage LONGs (instead of INTs whenever possible).
Written : Stein Vidar Hagfors Haugan, 11 June 1994
Modified : Never.
Version : Version 1, 11-June-1994
[Previous]
[Next]
Project : SOHO - CDS
Name : CAL_HDR_UPDATE
Purpose : To update primary and binary table headers of a FITS file.
Explanation : The routine FXHMODIFY is called to update the primary and
binary extension headers of a calibration FITS file.
Use : IDL> cal_hdr_update, filename, item_name, value
Inputs : filename - the FITS file name
item_name - the name of the FITS header item
value - the new value to be associated with item_name
Opt. Inputs : None
Outputs : The input file headers are updated.
Opt. Outputs: None
Keywords : None
Calls : ***
FXHMODIFY [1], FXHMODIFY [2]
Common : None
Restrictions: None
Side effects: None
Category : Data_handling, FITS, i_o
Prev. Hist. : None
Written : CDP, RAL, 4-Mar-94
Modified :
Version : Version 1, 4-Mar-94
[Previous]
[Next]
Project : SOHO - CDS
Name : CAL_HDRREAD()
Purpose : Read basic header information from CDS FITS level-1 file.
Explanation : Straightforward. Returns IDL structure described in
CDS QL Data Format.
Use : HDR = CAL_HDRREAD(HEADER)
Inputs : HEADER= The header (array of strings of a CDS FITS
level-1 file.
Opt. Inputs : None.
Outputs : Return value, see above.
Opt. Outputs: None.
Keywords : None.
Calls : ***
FXPAR [1], FXPAR [2], TRIM
Common : None.
Restrictions: See HEADER above.
Side effects: None.
Category : Data_Handling, I_O, CDS, FITS, QuickLook
Prev. Hist. : None.
Written : Stein Vidar Hagfors Haugan, 27 September 1993
Modified : To fix naming of obs_date parameter, CDP, 14-May-94
SVHH, 24 May 94 Fixed types for all tags
Version : Version 3, 24-May-94
[Previous]
[Next]
NAME:
cal_log
PURPOSE:
To create a full listing of the calibration data available
HISTORY:
V1.0 13-May-94 by M.Morrison
V2.0 25-May-94 (MDM) - Added CCD and Oven temperature information
- Added check of CMD_HIST for control file that was
run.
V2.1 31-May-94 (MDM) - Modified to not print out the scratch disk number
if the data is on-line.
V2.2 1-Jun-94 (MDM) - Modified to not print the temperatures if they are
more than 200 degrees or less than -200
V2.3 15-Jun-94 (MDM) - Modified to check DSDS for datasets
[Previous]
[Next]
Project : SOHO - CDS
Name : CAL_MKAUXDESC()
Purpose : Return auxiliary data descriptor of correct type.
Explanation : Based the dimenstionality of the data in DATA the correct
type of auxiliary data descriptor is returned,
with the descriptor values from DATA copied
into the new structure.
Use : AUXDESCRIPTOR = CAL_MKAUXDESC(DATA)
Inputs : DATA = a structure variable of the form that
is returned by READ_CDS
Opt. Inputs : None.
Outputs : IDL auxiliary data descriptor, see CDS QL Data Format.
Opt. Outputs: None.
Keywords : None.
Calls : ***
TRIM
CALLED BY:
CAL_AUXREAD
Common : None.
Restrictions: DATA must adhere to the format returned by READ_CDS
Normally used by AUXREAD()
Side effects: None.
Category : Data_Handling, I_O, FITS, CDS, QuickLook
Prev. Hist. : None.
Written : Stein Vidar Haugan, 27 September 1993
Modified :
Version : 1.0
[Previous]
[Next]
Project : SOHO - CDS
Name : CAL_MKDETWDESC()
Purpose : Return detector data descriptor of correct type.
Explanation : Based on DETECTOR (= 'NIS'/'GIS') and the
dimenstionality of the data in DATA the correct
type of detector data descriptor is returned,
with the descriptor values from DATA copied
into the new structure.
Use : DETDESCRIPTOR = CAL_MKDETWDESC(DETECTOR,DATA,NDIMS)
Inputs : DETECTOR = 'NIS' / 'GIS'
DATA = a structure variable of the form that
is returned by READ_CDS
NDIMS = Number of dimensions in the data
Opt. Inputs : None.
Outputs : IDL detector data descriptor, see CDS QL Data Format.
Opt. Outputs: None.
Keywords : None.
Calls : ***
TRIM
CALLED BY:
CAL_DETREAD, CAL_DETSELECT
Common : None.
Restrictions: DATA must adhere to the format returned by READ_CDS
Normally used by DETREAD()
Side effects: None.
Category : Data_Handling, I_O, FITS, CDS, QuickLook
Prev. Hist. : None.
Written : Stein Vidar Haugan, 27 September 1993
Modified : SVHH, 21 October 1993
Added Max/Min tags (for use by display routines)
SVHH, 3 November 1993
Fixed bugs concerning GIS data (TDETY)
SVHH, Version 1.2, 27 May 1994
Version : 1.2, 27 May 1994
[Previous]
[Next]
Project : SOHO - CDS
Name : CAL_STORE_WND
Purpose : Store data from read_cds into a CDS QLDS
Explanation : Stores detector data from Data.Array into:
Det.DetData(currentix:stopix
[,0:size_dimension_2
[,0:size_dimension_3]] )
The number of indexes depends on the dimensionality of the
data.
- Updates CurrentIx to point to the next free index.
- Stores indexes (to Det.DetData) for this data window into
Det.DetDesc(WndNo).ixstart/ixstop
Use : CAL_STORE_WND,WINDOW_NO,CURRENT_INDEX,DET,DATA
Inputs : WINDOW_NO :
The index (into DET.DETDESC) of the
detector data window in question.
CURRENT_INDEX:
The index (into DET.DETDATA's first dimension) of
where a block of detector data may be placed.
DET : An IDL structure containing the tags DetDesc and
DetData, as described in the CDS QL Data Format.
DATA: An IDL structure returned from READ_CDS after
a successful read of detector data.
Opt. Inputs : None.
Outputs : CURRENT_INDEX:
is updated to point to the room after
the current block of data in DET.DETDATA
DET.DETDATA: The data from DATA.ARRAY i stored here.
DET.DETDESC.IXSTART,
DET.DETDESC.IXSTOP:
Indexes into DET.DETDATA for the current detector
data window.
Opt. Outputs: None.
Keywords : None.
Calls : SIZE
CALLED BY:
CAL_DETREAD
Common : None.
Restrictions: See the data formats.
Side effects: None.
Category : Data_Handling, CDS, QuickLook, Internal
Prev. Hist. : None.
Written : Stein Vidar Hagfors Haugan, 27 September 1993
Modified :
Version : 1.0
[Previous]
[Next]
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.
CALLS: ***
ELTHEORY, NE2MASS, SOLAR_EPHEM, SUBTENSE, SUNDIST, TELESCOPE_POINTING
CALLED BY:
C3_CME, C3_CME_FRONT, C3_MASSIMG, CME_MASS, MLO_MASSIMG
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
[Previous]
[Next]
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
CALLED BY:
REDUCE_LEVEL_05
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.
CALLS: ***
LASCO_READFITS [1], LASCO_READFITS [2], OFFSET_BIAS, STDEV
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
Karl Battams 2 Nov 2005 - Add swap_if_little_endian keyword for opening binary data files
@(#)calc_dark_bias.pro 1.2 11/02/05 LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
CALC_LOI_ROLL
PURPOSE
Given an LOI image (180 bytes, linear array), calculate the
SOHO roll angle, in degrees counterclockwise from (up=north)
CALLING SEQUENCE
roll = CALC_LOI_ROLL(LOI)
INPUT PARAMETERS
IN - a list of fits files, or a list of LOI images
OPTIONAL KEYWORD PARAMETERS
CALIB - If specified, this either a calibration offset LOI image,
or a name of a FITS file that contains one.
VARBOSE - (flag) if specified, print a bunch of messages
TREF - Array of reference times forthe LOI images in IN.
Required if IN is an array of data, rather than filenames.
ECLIPTIC - (flag) if set, then the output is in ecliptic coords rather
than P-angle coords.
L1 - (flag) not SOHO's position; flags level-1 data (in calibrated m/s)
if an array is fed in. Default is level-0; if fits
files (or headers) are fed in, then they are checked instead.
HDR - if LOI data are fed in as arrays, HDR may be used to send in a
corresponding fits header. This obviates the need to
specify TREF or L1.
RETURNS
An array of roll angles, one per LOI image.
METHOD
Uses the solar rotation to determine angle by the arctan method,
with some corrections for orbitalvelocity and
MDI calibration. Method belongs to Phil Scherrer.
HISTORY
Written 29-Mar-99 CED
Fixed-up for calibrated data of various sorts, 1-Apr-99 CED
Added return of orbit calculation method, Mid-april 1999 CED
Allowed separate pass-out of sun_ecliptic_p by keyword;
added automatic fallback to calculated orbits. 10-May-1999 CED
Fixed minor logic error 8-Jun-99 CED
Made all print statements subject to verbose flag 8-Dec-1999 RIB
CALLS:
CALLED BY
DISPLOI_MON5K
[Previous]
[Next]
NAME:
calc_move
PURPOSE:
calculates necessary Alignment Mechanism steps for desired image motion
INPUT:
[delta-X,delta-Y]= desired IMAGE motion on (FD PIXELS)
OUTPUT:
function returns [AM1 steps, AM2 steps] properly rounded; intarr(2)
SAMPLE CALLING SEQUENCE:
legs=calc_pos([-100,-2.5])
HISTORY:
Written 20-Mar-96 by I.Zayer
[Previous]
[Next]
NAME:
calc_mtm_therm
PURPOSE:
Calculate the thermal load from MTM moves. Evaluates
framelists for compatability with PRIME30 load
SAMPLE CALLING SEQUENCE:
calc_mtm_therm
calc_mtm_therm, 'xyz.obs'
calc_mtm_therm, infil, outfil=outfil
INPUTS:
infil - If not passed in, it does all .obs files in
/mdisw/cfl/dev/dep
outfil - If set, write the output to the file
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], break_file [4], deriv_arr [1]
deriv_arr [2], file_list [1], file_list [2], rd_tfile [1], rd_tfile [2]
HISTORY:
Written 10-May-96 by M.Morrison
7-Aug-96 (MDM) - Renamed to calc_mtm_therm (from calc_mtm)
- Made into a procedure
- Added % off from nominal
[Previous]
[Next]
NAME:
calc_pos
PURPOSE:
calculates change of pointing when given Alignment Mechanism steps
INPUT:
steps: intarr(2) = [AM1 steps, AM2 steps]
OUTPUT:
function returns [delta-X,delta-Y] = resulting IMAGE motion on CCD in
FD PIXELS; fltarr(2)
SAMPLE CALLING SEQUENCE:
shift=calc_pos([34,-56])
HISTORY:
Written 20-Mar-96 by I.Zayer
[Previous]
[Next]
Project : SOHO - CDS
Name : CALC_RAS_DUR()
Purpose : Calculate the duration of a raster.
Explanation : Uses the raster definition to calciulate the expected duration
of the raster. Takes account of exposure time, telemetry load
and mechanism motion.
Use : IDL> dur = calc_ras_dur(tp_raster_str) or
dur = calc_ras_dur(raster_str) or
dur = calc_ras_dur(ras_id, ras_var_id)
Inputs : tp_raster_str - structure as used by technical planning
mk_raster (ie for use in mk_raster or
with the structure returned by mk_raster)
or
raster_str - the raster structure returned by get_raster
or
ras_id - the fundamental raster ID and
ras_var_id - the raster variation ID
Opt. Inputs : None
Outputs : Function returns the duration in seconds.
Opt. Outputs: None
Keywords : TIME2DUMP - returns the telemetry time per exposure in secs.
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], GET_DATAWIN, GET_RASTER, GET_UTC
GET_VDS_STATE, GET_VDS_WIN, ROUND_OFF, UTC2TAI
CALLED BY:
UPDATE_RAS_DUR
Restrictions: None
Side effects: None
Category : Technical planning.
Prev. Hist. : None
Written : C D Pike, RAL, 9-May-95
Modified : Make so that exposure time and VDS readout are added to
telemetry dump time for first exposure. Thereafter take the
greater of the two. CDP, 2-Jun-95
Isolate numerical variables used and add overall fudge
factor. CDP, 2-Jun-95
Change state database call to cp_get_state. CDP, 07-Sep-95
Fix typo in sum over window compression. CDP, 25-Sep-95
Fix duration calculated for sum over windows. CDP, 26-Sep-95
Fix bug when input is get_raster output. CDP, 6-Oct-95
Change compression factor for VBLW (mode 3) from 2.0 to
1.25 (based on results of SYNOP study). CDP, 13-Oct-95
Update sum compression scheme IDs. CDP, 2-Nov-95
Cut out fudge factor and add 1.0 second overhead per
exposure. CDP, 22-Nov-95
Include extra factor for NIS pixel scale change and
when default NIS extraction is used assume the
default cover-all extraction (because of slope)
CDP, 16-Feb-96
Change telemetry rate used to be actual 11.14 Kbits/s rather
than estimated 10.0. CDP, 19-Feb-96
Change call to cp_get_state to get_vds_state. CDP, 23-Feb-96
Allow for window ht variation when default NIS extraction
used. CDP, 28-Mar-96
Version : Version 13, 28-Mar-96
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
CALCSTEP
PURPOSE:
Compute Number of Steps for Move
CATEGORY:
EXPLANATION:
SYNTAX:
calcstep,
CALLED BY:
TKI_CALCMOT
EXAMPLES:
INPUTS:
sstepsremain - Steps to proceed
fhz - frequecy for stepping in Hz
OPTIONAL INPUTS:
None.
OUTPUTS:
ftime - Motiontime
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
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.
[Previous]
[Next]
Project:
SOHO - SUMER
Name:
CALL_TRIWARP
Purpose:
A shell to call sum_triwarp, a program to do dewarp SUMER data to
pixel level accuracy.
Comments:
The program to de-warp to pixel level accuracy does not include
the band 15 pixels from the boarder of the detector.
Use:
call_triwarp,index_in,data_in,index_out,data_out,$
wavelength=[1403.11,1405.25],bte=[2,3]
Inputs
index - index structure for data.
data - Data structure;
Output
index_out - index for output dataq structure
Data_Out - Corrected data
Calls: ***
MAKE_STR [1], MAKE_STR [2], SGT_CRPIX, SSEL_DATCOL, SUM_TRIWARP, sgt_bin, sgt_dims
sgt_refpix, sgt_slit
Common:
None
Written:
Terry Kucera, Aug 13, 1996
Modifications
[Previous]
[Next]
Project:
SOHO - SUMER
Name:
CALL_WARP
Purpose:
A shell to call sumer_warp, a program to do dewarp SUMER data to
pixel level accuracy.
Use:
data_out = call_warp(data,slit,BinX,BinY,RefPix)
Inputs
data - Data cube of dimentions, Wavelength x Y_solar x exposures
BinW - Binning in W direction
BinY - Binning in Y Direction
RefPix - Reference Pixel in Wavelength direction
Output
Data_Out - Corrected data
Calls: ***
SUM_TRIWARP
CALLED BY:
mk_atlas
Common:
None
Written:
Terry Kucera, May 21, 1996
[Previous]
[Next]
NAME:
cam_run_sum
PURPOSE:
To look through the Sequence ID and log all times when a campaign
was running
SAMPLE CALLING SEQUENCE:
cam_run_sum, '18-dec-95', !stime
cam_run_sum, month='Jan-96', outfil='$MDI_CAL_INFO/9601.cam_run_sum
cam_run_sum, sttim, entim, outfil=outfil, month=month, info=info
INPUTS:
sttim - starting time
entim - ending time
CALLS: ***
MASK, SEQ_SUM_P3, UNIQ [1], UNIQ [2], UNIQ [3], anytim2ex [1], anytim2ex [2]
anytim2ints [1], anytim2ints [2], data_type [1], data_type [2], fmt_tim [1]
fmt_tim [2], get_hk_info [1], get_hk_info [2], gt_day [1], gt_day [2], gt_time [1]
gt_time [2], hk_time_sort, int2secarr [1], int2secarr [2], restgen [1]
restgen [2], ut_time [1], ut_time [2]
CALLED BY:
MDI_SUMMARY
OPTIONAL KEYWORD INPUT:
outfil - an output file name to write to
month - Optionally specify the month rather than the sttim/entim
info - The get_hk_info returned structure
HISTORY:
Written 2-Feb-96 by M.Morrison
22-Feb-96 (MDM) - patched sttim/entim argument error
V2.0 21-Mar-96 (MDM) - Modified to show when structure was running
- Screen out the new OBS_PRIME00 obs-id
- Display the time when it was run in UT
V2.1 29-Mar-96 (MDM) - Modified the logic for what to do if the sequence is
already running for the first sample point
V3.0 16-Apr-96 (MDM) - Modified to show when we have dynamics versus structure (vc data)
- Modified to show fraction of VC2/VC3 in the obs line
- Modified to show when structure is stopped
- Added logging capability of jitter runs
- Flag on the summary line whether it was VC2 and/or VC3
V3.1 11-Nov-96 (MDM) - Added more more character for the campaign name
V3.2 9-May-97 (MDM) - Modified to log the last (current) campaign running
(previously recorded N-1 campaigns)
V3.3 22-May-97 (MDM) - Added protection for single run (9-May added an error)
[Previous]
[Next]
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
CALLS: ***
READ_CARR_LONG, TAI2UTC
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
[Previous]
[Next]
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.
CALLS: ***
CARRDATE2, READ_CARR_LONG, TAI2UTC
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
[Previous]
[Next]
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
CALLS: ***
READ_CARR_LONG, UTC2TAI
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
[Previous]
[Next]
pro 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
CALLS:
[Previous]
[Next]
CALLS: ***
CARRDATE2, CONGRID [1], CONGRID [2], CONGRID [3], GET_ROLL_OR_XY
LASCO_READFITS [1], LASCO_READFITS [2], MK_IMG, QDB, READFITS [1], READFITS [2]
READFITS [3], REDUCE_STD_SIZE, REVERSE, SOLAR_EPHEM, STR2UTC [1], STR2UTC [2]
STR2UTC [3], TRIM, UTC2STR, UTC2TAI, UTC2YYMMDD
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 to display images
wlimb STRING: 'wl' or 'el'
hdr STRUCT: dummy header sent back to carrmap3 for fits header
KEYWORDS:
FULL360 If set, go all the way around, not just 180 deg.
MAP_SIZE IF set, then use it's value for horizontal size
This routine can ask the user for each radius.
OUTPUTS: rad = fltarr(num_r) : radii of maps
cmap = fltarr([360 or 720],ht,num_r): carrington maps, one per radius
ROUTINES CALLED:
qdb.pro
carrdate2.pro
resize2.pro
getc2c3norm2.pro
AUTHOR: Nathan Rich, NRL, Nov. 1996
Julia Kraemer, NRL, June 7, 1996
MODIFIED:
961129 by N. RIch each image subtends one pixel; checks for other
values of val0 if 0 when k=0
961203 by N. RIch if more than one pixel between images, use
congrid to fill space
961206 by N. Rich Create log file; rotate images from 960521;
Check median = 85 (for 1024x576 images)
961209 by N. Rich change CONGRID statement; moved carrmap_x
increment statement to after validity check
961210 by N. Rich print time0 and time1; if mapdelta GT 10, don't
do congrid
961211 by N. Rich skip bad files
961213 by N. Rich add level variable; if mapdelta GT 20, don't do
congrid; check for forward time
961217 by N. Rich add disp variable for displaying image
970102 by N. Rich make time units consistent
970103 by N. Rich rotate images for Nov. 21,22
970103 by N. Rich add white strip to top of gaps
970108 by J. Kraemer add east limb option
970123 by N. Rich changed to val0(r)=median(strip(115:135))
970213 by N. Rich changed check for Out of Order
970226 by N. Rich do normalization for whole image rather than
each strip
970311 by N. Rich make map display scale vary with camera
970402 by N. RIch add empty space to final columns if no images
970414 by N. Rich accept c1 images for Clarence
9705 by N. Rich use c1 images generally
970714 by N. Rich change criteria for data gaps
970715 by N. Rich fix final gap coverer
970722 by N. Rich check each strip against previous and reject
image if it is too different
970730 by N. Rich sort s by date_obs
970801 by N. Rich skip image if mapdelta LE 0
970807 by N. Rich scan strip ends; move imdisplay part around
970827 by N. Rich change scale; modify name of log files
970915 by N. Rich add get_im common block, compute ff_ratio; change
cx,cy for c1
971021 by N. Rich compute rconv for each image separately for c2 and c3
971103 by N. Rich prompt for mapsize
971107 by N. Rich move log print line; prompt for median skip; don't
check image median
971110 by N. Rich add skiplast variable
971114 by N. Rich use strip files if available
971216 by N. Rich make automatic (auto-enter radii, mapsize)
971217 by N. Rich if error in readfits, enter in log
980212 by N. Rich added variable boxes for normalization
980312 by N. Rich cancel box normalization; auto choose mapsize
980313 by N. Rich do not multiply image by constant (of about 0.12)
980413 by N. Rich use m = median(im(*,y21:y12))
980514 by N. Rich change upper limit of strip median, ends
980610 by N. Rich extend warpit COMMON block for fits header
980612 by N. Rich pass rad (radii) already full
980629 by N. Rich use reduce_std_size instead of resize2
981216 by N. Rich Use ht variable instead of 181 for mapheight
990114 by N. Rich Add FULL360 keyword
Feb 2000 by N. RIch Remove source from query; change GET_BKG init.;
Base level on LZ keyword, levelstr; Replace strip with
strp to avoid IDL conflict
Apr 2000, NBR, Add half a column's time to t_start; always use first image (k=0)
May 2000, NBR, Use mk_img instead of getc123; don't use avg_strip_ends
Aug 2000, NBR, Add MAP_SIZE keyword and take it out of common block; compare strip,stripends
2001.11.05, NBR - Add SCCS version tag
2002.03.14, NBR - Add skipwait, medianhist, variable sunc from mk_img, roll in mk_img
2002.09.03, nbr - Expand logging, add l1 to COMMON get_im
04.05.05, nbr - fix C1 center, tinker with disp_factor and df and ffv
06.04.25, nbr - Add filetype so does not pick up Level-1 images; remove date_mod
from query for LZ images
06.10.03, nbr - Make missing-bar min. of 5
10/03/06 @(#)carrmapmaker2.pro 1.9 - IDL NRL LASCO Library
[Previous]
[Next]
NAME : CAT_DIRECTORY
PURPOSE : Locate requested catalog
CATEGORY : EIT Catalog
EXPLANATION :
SYNTAX :
CALLED BY:
CATRD_DAILY, EIT_CATRD [1]
EXAMPLES : none
CALLED BY : EXP
CALLS TO : none
ARGUMENTS :
IN_DATE : If present, a string date in the format "yyyy/mm/dd"
of the daily catalog to be searched.
Default is the date of the most recent catalog.
New feature for the EIT_DISPLAY program is that the DATE
argument can be used to input a psuedo YESTER keyword as
a string. Using "/Y" or "Y=", do not spell out YESTER
(ex: print,catrd_daily("/y") for yesterday or
print,catrd_daily("y=3") for three days ago.
KEYWORDS
YESTER If present, indicates the number of 'days/catalogs' backward
in time you want as the catalog input. Note that this is
really the number of backward catalogs, so days may not
line up as expected, but they should.
CUR_DIR_CNT : Return the index of DIR for the selected catalog.
USE_LAST_REC : Return which record is to be displayed first.
0 = once cat file is found display first rec
1 = once cat file is found display last rec
NO_NEXT : if present, don't just supply the next available
catalog, return a null string.
DIR_CNT : Return the number of catalogs found.
OUTPUTS :
Returns the results of the find_file on the catalogs found.
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3]
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FILE_EXIST [2], FIND_FILE
IS_GSFCVMS, UTC2TAI, VALID_TIME, break_file [4], concat_dir [4], file_exist [1]
file_exist [3], rd_tfile [1], rd_tfile [2]
COMMON : none
RESTRICTIONS: none
SIDE EFFECTS: none
PROJECT : SOHO - EIT
HISTORY : V1, Elaine Einfalt (HSTX)
1996 march 31, added /NO_NEXT
1996 May 13, allow YESTER pseudo format in the DATE argument
1996 May 24, Sam Freeland - for UNIX, read dirs from file
1997 Jan 16, Sam Freeland - handle all cats in $EIT_QLK_CATALOG
1997 Jan 21, J. Newmark - handle specific is_gsfcvms case
(including not all SSW), and generic VMS installation
1997 Oct 27, Einfalt - modified to distinguish between
Goaddard-like VMS with local catalog and with out catalogs
If VMS without catalogs, must define logical EIT_QUICKLOOK
like: $DEFINE/syst/exec/trans=conc -
EIT_QUICKLOOK DNFS5:[QUICKLOOK.]
2002 Aug 14, F. Auchere changed calls to findfile to calls to
find_file to fix a long catalog list problem
CONTACT : eit@xanado.nascom.nasa.gov
[Previous]
[Next]
Project : SOHO - CDS
Name : CAT_DURATION
Purpose : Lists the durations of rasters performed on the CDS.
Explanation : Reads the start and end times from the FITS file header
and lists the duration together with the Study ID
Use : IDL> cat_duration, study_num
Inputs : study_num - the study number of the FITS files to be processed
if not given then all files are processed.
Opt. Inputs : None
Outputs : data are written to the file study_duration.list
Opt. Outputs: None
Keywords : QUIET - if given then no output to screen
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3]
Bell, CDSHEADFITS, FIND_FILES, FIND_WITH_DEF [1], FIND_WITH_DEF [2]
FIND_WITH_DEF [3], GET_RASTER, PRINT_STR, STRPAD, STR_PICK, TRIM, UTC2TAI, YES_NO
break_file [4]
Common : None
Restrictions: None
Side effects: None
Category : Telemetry, FITS
Prev. Hist. : None
Written : C D Pike, RAL, 9-May-96
Modified : Use CDSHEADFITS. CDP, 23-Aug-96
Version : Version 2, 23-Aug-96
[Previous]
[Next]
Project : SOHO - CDS
Name : CAT_FITS()
Purpose : Cataslogues available FITS files and optional info.
Explanation : Lists the available FITS files in the official directory or
user's own directory.
Use : IDL> cat_fits([,filter, /quiet, ascii=hardcopy_file, info=info])
Inputs : None
Opt. Inputs : filter - string which returned file names must contain.
Outputs : Function returns a string array
Opt. Outputs: None
Keywords : QUIET - if present the results are not listed to the screen
ASCII - if present specifies the ascii file in which results
are saved.
INFO - if given as an output keyword variable the header
information is returned in it.
TIMERANGE - allows selection of files by date. If only one
value is given, it is taken as a 'start" date/time
Calls : ***
ANYTIM2CAL, ANYTIM2UTC [1], ANYTIM2UTC [2], Bell, DATATYPE [1], DATATYPE [2]
DATATYPE [3], FIND_FILES, HEADFITS [1], HEADFITS [2], HEADFITS [3], PRINT_STR
REPCHAR, REPSTR [1], REPSTR [2], REPSTR [3], STR2UTC [1], STR2UTC [2], STR2UTC [3]
STRPAD, STR_PICK, TAI2UTC, UTC2TAI
Common : None
Restrictions: None
Side effects: None
Category : Help, FITS
Prev. Hist. : Based on LIST_FITS
Written : C D Pike, RAL, 20-Mar-96
Modified : Fudge FINDFILE to cope with many files. CDP, 21-Mar-96
Use LOC_FILE for above. Separate HARDCOPY and ASCII keywords
CDP, 25-Mar-96
Cut any wildcard characters from input (they are assumed
anyway). CDP, 28-Mar-96
Refix file finding. CDP, 1-Apr-96
Use find_files instead of above fix. CDP, 8-May-96
Version : Version 6, 8-May-96
[Previous]
[Next]
NAME :
CAT_OPEN
PURPOSE : Open and associate catalog to structure.
CATEGORY : EIT Catalog
EXPLANATION :
SYNTAX :
CALLED BY:
CATRD_DAILY, EIT_CATRD [1]
EXAMPLES : none
CALLED BY :
CALLS TO : none
ARGUMENTS : none
KEYWORDS :
FILE : A string, the catalog file name
LONG : When set, don't sort or remove duplicates in catalog
OUTPUTS :
Returns the associated catalog
LUN : the logical unit that is associated with the cat file
N_REC : the total number of cat entries in the catalog, including
duplicates but excluding the header.
U_REC : the number of cat entries to be used. If /LONG is set
this is the same as N_REC
RECORDS : an long array of the records of the catalog in the selected
order (or unordered).
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], IS_GSFCVMS, REVERSE, REV_SWAP [1], REV_SWAP [2]
UNIQ [1], UNIQ [2], UNIQ [3], UTC2TAI
COMMON : none
RESTRICTIONS: none
SIDE EFFECTS: none
PROJECT : SOHO - EIT
HISTORY : V1, Elaine Einfalt (HSTX)
: V1.1 D.M. fecit, to account for different lengths of
structures
: V1.2 JSN fixed byte padding, necessary for UNIX version
6/12/96
: V2.1 Einfalt reduced pad to make room for 24-char SCI_OBJ
Since SCI_OBJ can be all 0B, it's a direct steal.
; V2.2 JSN -fixed little_endian vs big_endian bug for Sun's
20-jan-1998
: 11-nov-2002 F.Auchere Speeds up catalog reading.
CONTACT : eit@xanado.nascom.nasa.gov
[Previous]
[Next]
NAME :
CAT_OPEN
PURPOSE : Open and associate catalog to structure.
CATEGORY : EIT Catalog
EXPLANATION :
SYNTAX :
CALLED BY:
CATRD_DAILY, EIT_CATRD [1]
EXAMPLES : none
CALLED BY :
CALLS TO : none
ARGUMENTS : none
KEYWORDS :
FILE : A string, the catalog file name
LONG : When set, don't sort or remove duplicates in catalog
OUTPUTS :
Returns the associated catalog
LUN : the logical unit that is associated with the cat file
N_REC : the total number of cat entries in the catalog, including
duplicates but excluding the header.
U_REC : the number of cat entries to be used. If /LONG is set
this is the same as N_REC
RECORDS : an long array of the records of the catalog in the selected
order (or unordered).
COMMON : none
RESTRICTIONS: none
SIDE EFFECTS: none
PROJECT : SOHO - EIT
HISTORY : V1, Elaine Einfalt (HSTX)
: V1.1 D.M. fecit, to account for different lengths of
structures
: V1.2 JSN fixed byte padding, necessary for UNIX version
6/12/96
: V2.1 Einfalt reduced pad to make room for 24-char SCI_OBJ
Since SCI_OBJ can be all 0B, it's a direct steal.
; V2.2 JSN -fixed little_endian vs big_endian bug for Sun's
20-jan-1998
: 11-nov-2002 F.Auchere Speeds up catalog reading.
CONTACT : eit@xanado.nascom.nasa.gov
[Previous]
[Next]
NAME:
CAT_PHASER
PURPOSE:
This procedure displays 64x64 fits images on phaser for cataloging
CATEGORY:
UTIL
CALLING SEQUENCE:
CAT_PHASER, Fname
INPUTS:
Fname: root name of the fits images to search for
eg: fname = 'c1' will search for all files whose
file names begin with c1: c1*.fts
OUTPUTS:
An IDL plot file is generated.
PROCEDURE:
A 512 x 512 plotting area is established, and a series of 64 x 64
images are displayed.
CALLS: ***
CONGRID [1], CONGRID [2], CONGRID [3], READFITS [1], READFITS [2], READFITS [3]
EXAMPLE:
To display the series of
MODIFICATION HISTORY:
Written by: RA Howard, NRL, 12 Jan 1996
@(#)cat_phaser.pro 1.1 10/05/96 LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - CDS
Name : CAT_RAW.PRO
Purpose : To catalogue and/or combine new raw (and pha) files
Explanation : STM automatically creates .raw and .pha files when the GIS is
in raw data mode. This routine combines files, if necessary,
and optionally adds them to the raw database.
The files are renamed when added to the database
Use : IDL> cat_gis[, filename='rawfilename']
If rawfilename contains a '*', then it will be treated as a
filter to select the actual file.
Inputs : prompts for rawfilename, if not supplied
if rawfilename contains a '*', the name is used as a filter
promts for Zone ID (where the file was taken)
prompts for a comment to add to the file
Opt. Inputs : rawfilename
Outputs : Two files containing all the raw/pha data, with all headers
except the last removed. All trailing zeros also removed.
Opt. Outputs: None
Keywords : filename
Calls : ***
ADD_RAW, FILE_EXIST [2], GIS_RAW_HEADER, PICKFILE, ROUND_OFF, STRIP_DIRNAME [1]
STRIP_DIRNAME [2], UTC2TAI, file_exist [1], file_exist [3]
Common : None
Restrictions: Can only be run under UNIX (uses spawn)
Side effects: !
Category : Telemetry
Prev. Hist. : None
Written : E Breeveld (erb@mssl.ucl.ac.uk) 6 March 1996
From COMBINE_GIS_RAW
Modified : ERB, 6 Mar 1996, v1.1, Seperated gis_raw_header function
ERB, 16 Apr 1996, v1.2, rewrite original files with new header
ERB, 19 Apr 1996, v1.3, return if picked file is empty
ERB, 24 Apr 1996, v1.4, add filename filter processing
ERB, 15 Jul 1996, v1.5, fixed filament id 'feature'
ERB, 24 Jun 1998, v1.6, use getenv in pickfile call
Version : 1.6
[Previous]
[Next]
NAME : CAT_TO_TEXT
PURPOSE : Convert "raw" catalog entries into string array
CATEGORY :
EXPLANATION :
SYNTAX :
CALLED BY:
CATRD_DAILY, EIT_CATRD [1]
EXAMPLES : none
CALLED BY :
CALLS TO : none
ARGUMENTS : none
KEYWORDS : none
OUTPUTS : none
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], UTC2TAI
COMMON : none
RESTRICTIONS: none
SIDE EFFECTS: none
PROJECT : SOHO - EIT
HISTORY : V1, Elaine Einfalt (HSTX)
1996 March 20, einfalt - modified filter labels to mathc reality
1996 May einfalt - modification to text printout display,
added summing info,
changed pixels to blocks, added readout area
change order of some things, added /SHORT.
1997 March 11, einfalt - handle decimal exposure times for
version 2.0 and above
1997 April 07, einfalt - output SCI_OBJ instead of IP steps.
1997 Aug 14 - einfalt - added ip steps after thres
CONTACT : eit@xanado.nascom.nasa.gov
[Previous]
[Next]
NAME : CATRD_DAILY
PURPOSE : Read the daily catalogs and return entries as requested output
CATEGORY :
EXPLANATION :
SYNTAX :
CALLED BY:
eit_catrd [3]
EXAMPLES : none
CALLED BY :
CALLS TO : none
ARGUMENTS :
DATE If present, a string date in the format "yyyy/mm/dd"
of the daily catalog to be searched.
Default is the date of the most recent catalog.
KEYWORDS :
YESTER If present, indicates the number of 'days/catalogs' backward
in time you want as the catalog input. Note that this is
really the number of backward catalogs, so days may not
line up as expected, but they should.
New feature: print,catrd_daily("y=3") for three days ago.
NO_NEXT If present and set then return a null string if the specified
date does not have a catalog.
SHORT_TEXT If present and set and TEXT is the output mode then the
displayed text will fit in 80 characters w/ less info.
RECORDS If present, then return catalog file record numbers matching
the entries in the returned variable. This is the VMS
record number.
LONG If present and set, then all catalog entries are considered,
including duplicates and entries are left in unsorted,
reform order.
RAW If present and set , return the catalog entries as the raw
data structure instead of the default of a strarr of text
entries.
NOTE: the default is to return a string array of entries.
FILENAME If present, then return the fits file names matching
the entries in the returned variable.
TAI If present, then return the TAI time matching
the entries in the returned variable.
OUTPUTS :
Return a string arrar of catalog entries, unless the /RAW keyword
is set then return raw structure of entries.
If the /LONG keyword is set then return all catalog entries and
do not sort.
If any value was
CALLS: ***
CAT_DIRECTORY, CAT_OPEN [1], CAT_OPEN [2], CAT_TO_TEXT, UTC2TAI
COMMON : none
RESTRICTIONS: none
SIDE EFFECTS: none
PROJECT : SOHO - EIT
HISTORY : V1, Elaine Einfalt (HSTX)
1996 March 31, added /NO_NEXT keyword
1996 May 13, allow YESTER to use numerical values
CONTACT : eit@xanado.nascom.nasa.gov
[Previous]
[Next]
CC0 - cross correlation at zero offset of 2 images.
CALLED BY
mk_minim, mk_stdim_list
[Previous]
[Next]
NAME:
ccd_hdr_info
PURPOSE:
To extract information from the telemetry CCD header array
SAMPLE CALLING SEQUENCE:
ccd_temps = ccd_hdr_info(ccd_hdr, /ccdtemps)
framen = ccd_hdr_info(ccd_hdr, 'FRAMEN')
print, ccd_hdr_info('0051.ccdh', 'offset_str')
INPUT:
ccd_hdr - the integer array telemetry header
OPTIONALLY the .CCDH file
OPTIONAL INPUT:
item - Tells which item to return. Options are:
DPC - to return the data product code
SEQID - to return the sequence ID
FRAMEN - to return frame number in the minute (typically
from 1-20 or 1-10.
OFFSET - to return the offset subscript
OFFSET_STR - to return the offset in X,Y in
string format
== offset mod 1024, offset/1024
DEP_REG00-return DEP register 0
.
.
DEP_REG15-return DEP register 15
CALLS: ***
FILE_EXIST [2], UNSIGN, anytim2ints [1], anytim2ints [2], data_type [1]
data_type [2], dec2sun [1], dec2sun [2], file_exist [1], file_exist [3]
fmt_tim [1], fmt_tim [2]
CALLED BY:
check_ff_load, disp_sci160k [1], disp_sci160k [2], mdi_comp_eff, mdi_display
mk_mdi_fits, rd_obs4, read_mdi, read_mdi16, xdisp_tfr
OPTIONAL KEYWORD INPUT:
ccdtemps- If set, return the CCD temperatures
m1tune - If set, return the M1 tuning value
m2tune - If set, return the M2 tuning value
nwords - If set, return the total number of words telemetered
down for the data product (includes camera/IP header
of 549 words)
HISTORY:
Written 5-Apr-94 by M.Morrison (taking GET_CAMERA_TEMPS from LTC.PRO)
6-Apr-94 (MDM) - Added /M1TUNE and /M2TUNE
12-Apr-95 (MDM) - Added /NWORDS option
8-Aug-95 (MDM) - Modified how M1TUNE and M2TUNE are calculated (use MOD)
25-Oct-95 (MDM) - Moved DPC and SEQID calculation code out of READ_MDI
into CCD_HDR_INFO
- Added FRAMEN output - switched with second parameter for
what to return
11-Jan-96 (MDM) - Corrected offset used to grab the CCD camera temperatures
(changed offset from 514 to 510)
2-Apr-96 (MDM) - Added OFFSET and OFFSET_STR options
- Added DPC_STR option
30-Apr-96 (MDM) - Patched to work properly on SAG (alpha) machine for
DPC and SEQID
- Added SEQID_STR
25-Jul-96 (MDM) - Allowed .CCDH file to be passed in
[Previous]
[Next]
Name: ccd_sunc
Purpose: maintain ccd sun center coordinate data file
Optional Keyword Parameters:
update - 2 element array containing new CCD SUNC coord ([EW,NS])
norange - bypasses range checks on update parameters
comment - input or output depending on calling sequence below
history - output array ALL coordinate entries (structure)
Calling Sequences:
Two major functions are provided
1 - Obtain most recent coordinates:
coord=ccd_sunc([history=history])
function returns 2 element vector: [EW,NS] CCD coord SunC.
Optional output is vector of all entries - include
comments , entry dates, etc.
2 - Update Sun Center coordinates:
coord=ccd_sunc(update=newcoord [,comment=comment])
Will update the Coordinate file with new coordinates
Optional comment can include reason for update (offpoint)
(Name of updater and update time are included automatically in
entry so dont include in comment)
Method: uses generic file
History: slf, 15-April-1992
5-Jun-93 (MDM) - Modified to only save the last updated value
18-Aug-93 (MDM) - Added "software" to authorized list
CALLS: ***
FILE_EXIST [2], MAKE_STR [1], MAKE_STR [2], file_exist [1], file_exist [3]
fmt_tim [1], fmt_tim [2], restgen [1], restgen [2], savegen [1], savegen [2]
syst2ex [1], syst2ex [2], syst2ex [3]
Restrictions: range check not implemented yet so be careful
[Previous]
[Next]
Project : SOHO - SUMER
Name : CD_BUILD_CDROMCAT
Purpose : Add cdrom data not yet processed to CATALOG.
Explanation : Add new SC or HK cdrom data to SC or HK catalog files.
Syntax : CD_BUILD_CDROMCAT
Inputs : CD_DIR - Directory where the CDROM data resides.
Outputs : None.
Keywords : TYPE - Type of data files to be added to catalog.
ERRMSG - if defined and passed, then any error message will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. In order to
use this feature ERRMSG must be defined first, e.g.
ERRMSG=''
CD_BUILD_CDROMCAT, CD_DIR, ERMSG=errmsg,...
if errmsg eq '' then ...
Calls : ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], concat_dir [4]
CALLED BY:
CD_SUMER
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : Version 1, Nicolas Morisset, 30-APR-1996
Update, Nicolas Morisset, 20-JAN-1998
Update the sclastfile_cd.cat
History : Addated for the CDROM interface, J. Santana, Hughes STX,
07-JAN-1997
[Previous]
[Next]
Project : SOHO - SUMER
Name : CD_DELETE_FILES
Purpose : Delete CDROM data files from hard disk.
Explanation : Delete CDROM files that were previouly loaded to hard disk
Syntax : CD_DELETE_FILES, CD_DIR
Inputs : CD_DIR - Name of directory where files reside.
CD_DIR can be a predefined logical name.
Outputs : None.
Category : OS VMS
Keywords : ERRMSG - if defined and passed, then any error message will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. In order to
use this feature ERRMSG must be defined first, e.g.
ERRMSG=''
CD_DELETE_FILES, CD_DIR, ERMSG=errmsg,...
if errmsg eq '' then ...
Calls : ***
CD_DELETE_FILES_EVENT, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], MK_DFONT
XACK, XANSWER, XMANAGER, concat_dir [4]
CALLED BY:
CD_SUMER
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, Jairo Santana, Hughes, STX, 15-Dec-1996
Version 2, Jairo Santana, Hughes, STX, 18-Mar-1997
Added option to select more than one file for
deletion and to cancel any selection.
Version 3, Jairo Santana, Hughes, STX, 26-Mar-1997
Modified code to better handle deletion of files by
Writting files to be deleted to a temporary file.
Version 4, Jairo Santana, Hughes, STX, 22-May-1997
Fix a bug when calling routine XACK
Version 5, Jairo Santana, Hughes, STX, 01-Jul-1997
Add option to remove selected files from a selection
list.
Eliminate the need to write selected files to a
temporary file.
Version 6, Jairo Santana, Hughes, STX, 03-Jul-1997
Desensitize "VALID" and "CANCEL" buttons when not needed.
Call xanswer for confirmation when deleting a file.
Version 7, Jairo Santana, Hughes, STX, 15-Jul-1997
Add call to MK_DFONT for font selection.
Add call to XANSWER for confirmation on deleting files.
Remove unnecessary lines of cod.
[Previous]
[Next]
Project : SOHO - SUMER
Name : CD_DISK_SPACE
Purpose : DISPLAY disk space status both of CDROM and hard disk.
Explanation : Display size of files contained in CDROM as well as disk
space on hard disk and display info on space needed to
load CDROM files.
Syntax : CD_DISK_SPACE, CD_DIR, CD_DRIVE, ERRMSG=errmsg
Inputs : CD_DRIVE - name of CD drive.
DISK_NAME - hard disk name specification.
Outputs : None.
Category : OS VMS
Keywords : ERRMSG - if defined and passed, then any error message will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. In order to
use this feature ERRMSG must be defined first, e.g.
ERRMSG=''
CD_DISK_SPACE, CD_DRIVE, DISK_NAME, ERMSG=errmsg,..
if errmsg eq '' then ...
Calls : ***
CD_DISK_SPACE_EVENT, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], XACK
XMANAGER, concat_dir [4]
CALLED BY:
CD_SUMER
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, Jairo Santana, Hughes, STX, 15-Dec-1996
[Previous]
[Next]
Project : SOHO - SUMER
Name : CD_DISM_CDROM
Purpose : Dismount CD drive
Explanation : Execute VMS DISMOUNT command on the CD drive.
Syntax : CD_DISM_CDROM, CD_DRIVE
Inputs : CD_DRIVE - Name of CD drive to be offlined.
Outputs : None.
Category : OS VMS
Keywords : ERRMSG - if defined and passed, then any error message will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. In order to
use this feature ERRMSG must be defined first, e.g.
ERRMSG=''
CD_DISM_CDROM, CD_DRIVE, ERMSG=errmsg,...
if errmsg eq '' then ...
Calls : ***
XACK
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, Jairo Santana, Hughes, STX, 07-JAN-1997
[Previous]
[Next]
Project : SOHO - SUMER
Name : CD_FIND_DBASE
Update : 16-JUL-1998 Nicolas Morisset
Sequence string incorrect over 2 digits
Purpose : Search the CDROM DATABASE
Category : FUNCTION
Explanation : Search the CDROM database for records matching a given
sequence and/or volume numbers and return number of matches
found.
Syntax : status = CD_FIND_DBASE( SEQ_NO, VOL_NO, ERRMSG=errmsg)
Inputs : SEQ_NO, VOl_NO - Sequence and volume numbers of CDROM.
Outputs : None.
Keywords : ERRMSG - if defined and passed, then any error message will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. In order to
use this feature ERRMSG must be defined first, e.g.
ERRMSG=''
status = (CD_FIND_DBASE, SEQ_NO, VOL_NO, ERMSG=errmsg)...
if errmsg eq '' then ...
Calls : ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], concat_dir [4]
CALLED BY:
CD_REG_CDROM
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, Jairo Santana, Hughes, STX, 07-JAN-1997
Version 2, Joan Hollis, Raytheon ITSS, 23-APR-1999
Adapted for seq_no gt 999.
[Previous]
[Next]
Project : SOHO - SUMER
Name : CD_LOAD_CDROM
Purpose : Load CDROM data onto hard disk.
Explanation : Load data files off CDROM media onto hard disk.
Use CD_DELETE_FILES to delete files priviously loaded files.
Syntax : CD_LOAD_CDROM, CD_DRIVE, CD_DIR, FILE_TYPE, ERRMSG=errmsg
Inputs : CD_DRIVE - Name of available CD drive to be used.
CD_DRIVE can be a predefined logical name
CD_DIR - Name of disk/directory destination.
CD_DIR can be a predefined logical name
FILE_TYPE - Types of files to be loaded ( SC or HK )
Outputs : None.
Category : OS VMS
Keywords : ERRMSG - if defined and passed, then any error message will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. In order to
use this feature ERRMSG must be defined first, e.g.
ERRMSG=''
CD_LOAD_CDROM, CD_DRIVE, CD_DIR, FILE_TYPE, ERMSG=errmsg,...
if errmsg eq '' then ...
Calls : ***
CD_LOAD_CDROM_EVENT, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], CW_FIELD
DATATYPE [1], DATATYPE [2], DATATYPE [3], MK_DFONT, XACK, XKILL, XMANAGER, XMESSAGE
concat_dir [4]
CALLED BY:
CD_SUMER
Common : CD_LOAD_CDROM - widget id's.
Restrictions: A given CDROM should be registered in the database prior to
loading the files contained on it.
Side effects: None.
Prev. Hist. : None.
History Version 1, Jairo Santana, Hughes, STX, 15-Dec-1996
Version,2, Jairo Santana, Hughes, STX, 03-Feb-1997
Added CD_DIR input widget to window.
Modified code to load one or more CDROM files
in one action.
Version,3, Jairo Santana, Hughes, STX, 17-Mar-1997
Added option to cancel a selection already made.
VALID and CANCEL widget buttons added.
Added CD_DIR input to calling sequence.
Version,4, Jairo Santana, Hughes, STX, 23-May-1997
Fix bug when calling routine XACK
Version,5, Jairo Santana, Hughes, STX, 23-Jun-1997
Add a window to display selected files and the option
to remove a file from the selection list.
Eliminate the need to store the selected files in
a temporary file.
Version,6, Jairo Santana, Hughes, STX, 03-Jul-1997
Desensitize "VALID" and "CANCEL" buttons when not needed.
Version,7, Jairo Santana, Hughes, STX, 15-Jul-1997
Add call to MK_DFONT for font selection.
Add call to XMESSAGE when loading files.
Remove unnecessary lines of cod.
Version,8, Nicolas Morisset, SAC, 16-Jul-1998
Sequence string incorrect over 2 digits
[Previous]
[Next]
Project : SOHO - SUMER
Name : CD_MOUNT_CDROM
Purpose : Mount CD drive
Explanation : Execute VMS command to mount CD drive.
Syntax : CD_MOUNT_CDROM, CD_DRIVE
Inputs : CD_DRIVE - Name of CD drive use (CD_DRIVE can be a predefined
logical name
Outputs : None.
Category : OS VMS
Keywords : ERRMSG - if defined and passed, then any error message will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. In order to
use this feature ERRMSG must be defined first, e.g.
ERRMSG=''
CD_MOUNT_CDROM, CD_DRIVE, ERMSG=errmsg,...
if errmsg eq '' then ...
Calls : ***
XACK
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, Jairo Santana, Hughes, STX, 07-JAN-1997
Version 2, Jairo Santana, Hughes, STX, 10-mar-1997
Modified code to check allocation of CD device before
issuing the DCL mount command.
Version 3, Jairo Santana, Hughes, STX, 21-may-1997
Remove XACK call when DEVICE is mounted successfully.
Version 4, Jairo Santana, Hughes, STX, 23-may-1997
Modify code to better handle STRING handling functions.
[Previous]
[Next]
Project : SOHO - SUMER
Name : CD_REG_CDROM
Purpose : Register information contained in CDROM into database
Explanation : Reads *.SFD files contained in the CDROM to extract information
about sequence and volume numbers of CDROM as well as file
names, start time and stop time of the data contained on
the CDROM. Then it catalogs the information on the Database.
Syntax : CD_REG_CDROM, CD_DRIVE
Inputs : CD_DRIVE - Name of CD drive use.
Outputs : None.
Keywords : ERRMSG - if defined and passed, then any error message will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. In order to
use this feature ERRMSG must be defined first, e.g.
ERRMSG=''
CD_REG_CDROM, CD_DRIVE, ERMSG=errmsg,...
if errmsg eq '' then ...
Calls : ***
CD_FIND_DBASE, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1]
DATATYPE [2], DATATYPE [3], XACK, concat_dir [4]
CALLED BY:
CD_SUMER
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, Jairo Santana, Hughes STX, 15-Dec-1996
Version 2, Joan Hollis, Raytheon ITSS, 21-Jan-1999
(changes on lines 248 & 310 to enable High Rate
and HK entry reading for update of DB).
Version 3, Joan Hollis, L-3 Com Analytics Corp.,
07-Mar-2002: Updated to use SUMOP2$DKB300 disk
instead of CDROM.
[Previous]
[Next]
Project : SOHO - SUMER
Name : CD_SEARCH_DBASE
Purpose : Search entries in the CDROM database.
Explanation : Search entries in database matching a given sequence and
volume numbers or date of the data contained on it.
Syntax : CD_SEARCH_DBASE, DUMMY, VOL_NO=VOL_NO, TYPE=TYPE, ERRMSG=errmsg
Inputs : SEQ_NO - Sequence number of CDROM or START TIME of data files.
The Sequence number of the CDROM taken from the label
"SO_CDS_LZ_0002" on the cover.
VOL_NO - Volume number of CDROM or END TIME of data files for
the search.
TYPE - Type of files being search ( SC or HK )
VOLUME = The volume number of the CDROM, taken from the
file voldesc.sfc. For example, if the volume
number was 4, then the CDROM cover might say
something like "4 of 9" on the cover.
Outputs : None.
Keywords : ERRMSG - if defined and passed, then any error message will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. In order to
use this feature ERRMSG must be defined first, e.g.
ERRMSG=''
CD_SEARCH_DBASE, DUMMY, VOL_NO=VOL_NO,TYPE=TYPE $
ERMSG=errmsg,...
if errmsg eq '' then ...
Calls : ***
CD_SEARCH_DBASE_EVENT, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
DATATYPE [1], DATATYPE [2], DATATYPE [3], XMANAGER, concat_dir [4]
CALLED BY:
CD_SUMER
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, Jairo Santana, Hughes, STX, 15-Dec-1996
History : Version 2, Jairo Santana, Hughes, STX, 30-Jun-1997
Added option to search the CDROM database records
within time range given by the user.
Change calling sequence to CD_SEARCH_DBASE
[Previous]
[Next]
Project : SOHO - SUMER
Name : CD_SORT_DBASE
Purpose : SORT CDROM DATABASE
Explanation : Sort entries in database by sequence number of CDROM or
by date contained in data files
Syntax : CD_SORT_DBASE
Inputs : None.
Outputs : None.
Keywords : SORT - Type of sort to be performed on database.
TYPE - Type of database to be sorted (SC or HK)
ERRMSG - if defined and passed, then any error message will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. In order to
use this feature ERRMSG must be defined first, e.g.
ERRMSG=''
CD_SORT_DBASE,SORT=SORT,TYPE=TYPE, ERMSG=errmsg,...
if errmsg eq '' then ...
Calls : ***
CD_SORT_DBASE_EVENT, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
DATATYPE [1], DATATYPE [2], DATATYPE [3], XMANAGER, concat_dir [4]
CALLED BY:
CD_SUMER
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, Jairo Santana, Hughes, STX, 07-JAN-1997
[Previous]
[Next]
Project : SOHO - SUMER
Name : CD_SUMER
Purpose : Widget interface for managing CDROM database.
Explanation : Provides a widget interface to registering CDROMs and
managing the CDROM database. Functions that can be performed:
- Register CDROMs in the database
- Load data files off of a CDROM
- Delete CDROM data files from hard disk.
- View, search and sort CDROM database
- Process CDROM data ( Build catalog,Format Data, and
Generate FITS files)
Syntax : CD_SUMER
Inputs : None.
Outputs : None.
Keywords : GROUP = The widget identification of the group leader.
Calls : ***
CD_BUILD_CDROMCAT, CD_DELETE_FILES, CD_DISK_SPACE, CD_LOAD_CDROM, CD_REG_CDROM
CD_SEARCH_DBASE, CD_SORT_DBASE, CD_SUMER_EVENT, CD_VIEW_DBASE, CW_FIELD, CW_PDMENU
MK_DFONT, WIDG_HELP, XACK, XMANAGER, XREGISTERED
Common : CD_SUMER is an internal common block containing widget IDs and
other parameters.
Restrictions: Only one copy of XCDROM can be running at any one time.
Only runs under VMS environment.
Side effects: None.
Prev. Hist. : None.
History : Version 1, Jairo Santana, Hughes, STX, 15-Dec-1996
Version 2, Jairo Santana, Hughes, STX, 03-Feb-1997
Remove CD_DIR input in calling sequence to
CD_LOAD_CDROM.PRO
Version 3, Jairo Santana, Hughes, STX, 18-Mar-1997
Add option to define CD_DIR and CD_DRIVE input
as logical names.
Version 4, Jairo Santana, Hughes, STX, 18-Mar-1997
Add CD_DIR input to calling sequence to
CD_LOAD_CDROM
Version 5, Jairo Santana, Hughes, STX, 21-May-1997
Remove window with HELP text. Add 'HELP' button.
Add window to display stutus of CDROM device
Version 6, Jairo Santana, Hughes, STX, 30-Jun-1997
Modified calling sequence to CD_SEARCH_DBASE.
Add field END TIME for searching database records
in a given time range.
Version 7, Jairo Santana, Hughes, STX, 15-Jul-1997
Add call to MK_DFONT for font selection.
Version 8, Jairo Santana, Hughes, STX, 22-Jul-1997
Set destination directory to point to a predefined
logical name defined by SUMER_CD.
Version 8a, Joan Hollis, L-3 Com/Analytics Corp., 11-Mar-02
Disabled mount/dismout option since now using
files on disk instead of from a CD. (to revert to
using CD drive use cd_sumer.old instead)
[Previous]
[Next]
Project : SOHO - SUMER
Name : CD_VIEW_DBASE
Purpose : Display registered entries of the CDROM database
Explanation : Display all SCIENCE or HOUSEKEEPING entries registered
in the CDROM database
Syntax : CD_VIEW_DBASE
Inputs : None.
Outputs : None.
Keywords : FILE_TYPE - Type of database records to be displayed
ERRMSG - if defined and passed, then any error message will
be returned to the user in this parameter rather
than depending on the MESSAGE routine in IDL. In
order to use this feature ERRMSG must be defined
first, e.g.
ERRMSG=''
CD_VIEW_DBASE, FILE_TYPE=FILE_TYPE, ERMSG=errmsg,...
if errmsg eq '' then ...
Calls : ***
CD_VIEW_DBASE_EVENT, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
DATATYPE [1], DATATYPE [2], DATATYPE [3], XMANAGER, concat_dir [4]
CALLED BY:
CD_SUMER
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, Jairo Santana, Hughes, STX, 07-JAN-1997
[Previous]
[Next]
NAME:
cdf_cat_file
PURPOSE:
Print information about a CDF to an ASCII file.
CALLING SEQUENCE:
cdf_cat_file,cdfname,file
INPUTS:
cdfname: name of CDf to be opened.
file: name of ASCII file to be created (defaults to
cdf_info.dat).
HISTORY:
Adapted from routine cdf_cat in IDL distribution.
Simon Plunkett, 29 March 1996.
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS2JD()
Purpose : Converts any CDS time format to full Julian day.
Explanation : Converts any CDS time format to the equivalent Julian
day value. Returns result in a structure with the
tags int (long) and frac (double).
Use : IDL> jd = cds2jd(any_format)
Inputs : any_format - date/time in any of the acceptable CDS
time formats -- for acceptable formats see file
aaareadme.txt.
Opt. Inputs : None
Outputs : Function returns JD in a structure {int:0L,frac:0.0d0}.
Opt. Outputs: None
Keywords : ERRMSG = If defined and passed, then any error messages will
be returned to the user in this parameter rather
than being printed to the screen. If no errors are
encountered, then a null string is returned. In
order to use this feature, the string ERRMSG must
be defined first, e.g.,
ERRMSG = ''
JD = CDS2JD ( DT, ERRMSG=ERRMSG, ...)
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], INT2UTC, JULDAY
CALLED BY:
GET_SOLAR_RADIUS, POINTING3, STARFIELD, SUN_EPHEM, get_soho_ephem
Common : None
Restrictions: None
Side effects: None
Category : Util, time
Prev. Hist. : None
Written : C D Pike, RAL, 16-May-94
Modified : Version 1, C D Pike, RAL, 16-May-94
Version 2, William Thompson, GSFC, 14 November 1994
Changed .DAY to .MJD
Version 3, Donald G. Luttermoser, GSFC/ARC, 20 December 1994
Added the keyword ERRMSG. Included ON_ERROR flag.
Version 4, Donald G. Luttermoser, GSFC/ARC, 30 January 1995
Added ERRMSG keyword to internally called procedured.
Made error handling routine more robust.
Version 5, Donald G. Luttermoser, GSFC/ARC, 13 February 1995
Allowed for input to be either scalar or vector.
Version : Version 5, 13 Februaryy 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_ADEF_PARSEFILE
Purpose : Parse file names++ according to a CDS Analysis Definition
Explanation : A CDS Analysis Definition (ADEF) contains a pattern for
automatic generation of the analysis file name.
This routine is used to convert the pattern into a file name,
by replacing strings in the pattern, based on the current file
name of the ADEF and the supplied QLDS.
Given an ADEF file name of e.g.,
/usr/myhome/mydef_r10v7_w_0.adef
then the following patterns will be replaced with:
%path => /usr/myhome/
%base => mydef_
%rid => r10v7
%winspec => w_0
%raster => s*r*
If a QLDS is supplied, "%raster" will be replaced by the
corresponding file name (e.g., s5050r00).
By default, the pattern for the output ANA_FILENAME will be
taken from the ADEF.ANA_FILENAME, but you may specify a
different pattern through the keyword INAME.
You may also retrieve the values of the %path, %base,
etc. patterns, through the output parameters with
corresponding names, e.g.:
CDS_ADEF_PARSEFILE,ADEF,OUTPUT_NAME,QLDS,PATH,BASE,$
RID,RASTER,WINSPEC
PRINT,"Raster id/variation string: "+RID
Use : CDS_ADEF_PARSEFILE,ADEF,ANA_FILENAME [ ,QLDS ]
Inputs : ADEF : CDS Analysis Definition
Opt. Inputs : QLDS : QuickLook Data Structure
Outputs : ANA_FILENAME : Contains the parsed analysis file name (or the
parsed input INAME).
Opt. Outputs: PATH, BASE, RID,
RASTER, WINSPEC : Contain the strings that have been used to
replace the corresponding patterns.
Keywords : INAME : Input name - use to apply the pattern replacement to
strings other than the ADEF.ANA_FILENAME
Calls : ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], DATATYPE [1], DATATYPE [2], DATATYPE [3], REPSTR [1], REPSTR [2]
REPSTR [3], TRIM, break_file [4], concat_dir [4]
CALLED BY:
APPLY_CDS_ADEF, RESTORE_CDS_ADEF, SAVE_CDS_ADEF, XCDS_ANALYSIS
Common : None
Restrictions: ...
Side effects: ...
Category : Analysis
Prev. Hist. : None
Written : SVH Haugan, UiO, 21 October 1997
Modified : Not yet.
Version : 1, 21 October 1997
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_AR_OBS
Purpose : To find files which contain observations on a given AR.
Explanation : When the number of the given AR is entered, the files in
which there is reference to this AR will be located.
The filename, the old and new object ID, and the distance
from the centre of the observation to the position of the
AR can be returned for each file.
Descriptions used in new catalogue entry (eg for AR1234):
AR1234 - Observation was AT OR VERY NEAR the predicted
path of the AR within 2 days either side of
the AR's first and last mention in NOAA reports.
AR1234? - Observation was NEAR the predicted path of the
AR within 2 days either side of the AR's first
and last mention in NOAA reports.
AR0000 - The observer stated that an AR was being viewed
although there were no recognised ARs nearby.
(Possibly a small, non-NOAA AR being viewed)
<<AR1234 - The raster area covered the predicted location
of the AR but at a time more than 2 days prior
to its first mention in NOAA reports.
>>AR1234 - The raster area covered the predicted location
of the AR but at a time more than 2 days after
its last mention in NOAA reports.
AR_LIMB_EAST/WEST - AR1234 - Observer recorded AR in
catalogue. The AR in question had just
disappeared off (in the case of West Limb
observations) or was about to appear on (in
the case of East Limb observations) the limb
and so was not in NOAA reports on that day.
AR_LIMB_EAST/WEST? - Observation on limb, no recognised
AR's nearby and none just disappeared off
(WEST), or appearing on (EAST) limb, but
observer recorded AR in catalogue.
AR1234, AR2345, (AR3456) - Observation covered 2 (or 3)
AR's.
Use : IDL> cds_ar_obs, number [,file, catnew, dist, catold, /quiet]
Inputs : number - the number of the AR being searched for. Note special
case where number = 0
(If the first parameter is a string variable
beginning with the character 's' it is assumed
to be a FITS file name and the entry for that
is printed)
Opt. Inputs : None
Outputs : None
Opt. Outputs: file - the filename of the file in which the AR was
observed
catnew - the new catalogue entry detailing the AR's
to be found in the file
dist - the distance from the centre of the observation
to the position of the AR (arcsecs)
catold - the old catalogue entry detailing the AR's
to be found in the file
Keywords : Quiet - if set, no screen output.
Help - gives explanation of format of new AR associations.
Outfile - specifies file in which to save results
Calls : ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], DATATYPE [1], DATATYPE [2], DATATYPE [3], FILE_EXIST [2]
PRINT_STR, RD_ASCII [1], RD_ASCII [2], STRPAD, STR_PICK, TRIM, break_file [4]
concat_dir [4], file_exist [1], file_exist [3]
Common : None
Restrictions: None
Side effects: None
Category : Catalogues
Prev. Hist. : None
Written : A N Pike, RAL, 3/8/98
Modified : Add OUTFILE keyword, CDP, 25-Mar-99
Version : Version 1, 3/8/98
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_ASRUN_POINT
Purpose : create map structures for ASRUN CDS pointings from catalog
Category : planning
Syntax : IDL> cds_asrun_point,cmap,tstart,tend
Inputs : TSTART = plot start time [def=current date]
Opt. Inputs : TEND = plot end time [def = 24 hour window]
Outputs : CMAP = CDS pointings saved in MAP structures
Keywords : COUNT = # of pointings found
STUDY = study program number (e.g. s22906r04)
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4]
DPRINT, EXIST, GET_CDS_STUDY, IS_STRING, LIST_EXPER, MAKE_MAP, MERGE_STRUCT
delvarx [5], get_def_times, is_number [1], is_number [2]
CALLED BY:
RD_CDS_POINT
History : Written, 20-May-1998, D.M. Zarro (SM&A/GSFC)
: Modified, 23-Jul-2001, D.M. Zarro (EITI/GSFC) - added STUDY
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_AUTOFIT
Purpose : To attempt to automatically detect and characterise a CDS
spectrum in terms of a series of gaussian line fits.
Explanation : Given a structure containing a CDS spectrum (such as returned
by PLOT_SPEC) subdivide the spectrum into small segments and
search each for "lines" above a certain threshold. If found,
fit "lines" with either upto 3 gaussians. Optional return the
fitted gaussian parameters and continuum values for use with
other routines.
Use : IDL> cds_autofit, sp, [ results = gpars ]
Inputs : sp - a structure containing the input spectrum (wavelengths
and fluxes).
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: Return a structure containing the fitted parameters for each
line identified in the input spectrum.
Keywords : RESULTS - a structure contain all the relevant gaussian
parameters pertaining to the fit. It also includes
the CDS subset of lines from the list of Kelly that
lie in the fitted interval.
Calls : ***
CDS_LINES, CDS_MULTIG, CDS_PLOT_FIT, CDS_SLINE, LOADCT, POLY
Common : None
Restrictions: None
Side effects: None
Category : Data_Analysis
Prev. Hist. : None
Written : B J Kellett 2/12/95.
Modified :
Version : Version 1.0, 2-Dec-95
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_CLEAN
Purpose : Removes cosmic rays from CDS data
Category : Class3, Analysis
Explanation : This routine removes cosmic rays and missing pixels from NIS
data structures.
Cosmic rays are recognized as pixels which are very high
compared to neighboring exposures. Thus, this procedure can
only be used on data which contain three or more exposures.
Examples include images built up from rastering the slit
across the sun, or from a "sit-and-stare" type program.
The algorithm used to recognize cosmic rays is far from
perfect. Use it at your own risk.
Syntax : CDS_CLEAN, DATA
CALLED BY:
FIND_COSMIC_RAYS, GT_CDS_QL, XCDS_COSMIC
Examples : A = READCDSFITS('s3300r00.fits')
CDS_CLEAN, A
Inputs : DATA = CDS data structure to be cleaned.
Opt. Inputs : None.
Outputs : The input data structure is returned with the cosmic rays
removed.
Opt. Outputs: None.
Keywords : FILL_MISSING = If set, then the routine will attempt to fill in
missing pixels as well as removing cosmic rays.
NOFILL = If set, then cosmic rays are only marked as missing,
and are not filled in. When /NOFILL is used, then
the value of FILL_MISSING is ignored.
MINSIG = Minimum value to use when estimating the standard
deviation in the pixels.
Calls : ***
DETDATA, DETDESC, FILL_MISSING, ST_WINDATA, TRIM
Common : None.
Restrictions: None.
Side effects: Computationally intensive.
Prev. Hist. : Based on CDS_CLEAN_IMAGE.
History : Version 1, 09-Aug-1996, William Thompson, GSFC
Version 2, 12-Aug-1996, William Thompson, GSFC
Only average vertically.
Version 3, 17-Sep-1996, William Thompson, GSFC
Fix bug, use ST_WINDATA
Version 4, 25-Nov-1996, William Thompson, GSFC
Added keyword NOFILL
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_CLEAN_EXP
Purpose : Clean cosmic rays (based on local median) from QLDS data.
Explanation : CDS_CLEAN_EXP applies the function CLEAN_EXPOSURE to all the
data in the supplied QLDS, removing cosmic rays by comparing
pixels with the median of the surrounding pixels in the same
exposure.
Unless the keyword NOFILL is set, pixels identified as cosmic
rays will be filled in with the local median pixel
values. When NOFILL is set, the cosmic rays pixels are flagged
as MISSING. Pixels flagged as MISSING may be saved and
restored (for later sessions) through the routines
CDS_SAVE_MISSING/CDS_READ_MISSING.
The routine is specifically designed to work with slit
spectrograms, with the first dimension of the data being the
dispersion direction, and the second dimension along the
slit. The rectangular box used to calculate the local median
value is longer in the slit direction than in the dispersion
direction. The size of the median box can be set through the
keywords XBOX/YBOX.
The routine does a fairly good job of identifying cosmic rays
when comparing with cosmic rays identified by eye. The method
is, however, not foolproof. Both false alarms and undetected
cosmic rays do occur, so manual inspection is encouraged.
A pixel P is determined to be a (first approximation) cosmic
ray:
IF ( P LT LIMIT AND (P - MEDIAN) GT MAX_VAR_LOW )
OR ( P GE LIMIT AND (P / MEDIAN) GT MAX_FACTOR_HI )
where LIMIT, MAX_VAR_LOW and MAX_FACTOR_HI can be set through
keywords. They have useful default values for debiased CDS NIS
exposures.
Since this definition often leaves (minimally) affected pixels
on the borders of cosmic ray hits untouched, all pixels having
a (first approximation) cosmic ray neighbour to its left or
right, or directly above or below will be marked as cosmic
rays as well. This may be turned off by setting the keyword
NO_NEIGHBOUR, or modified by specifying the convolution KERNEL
that is used to flag neighbours.
Use : CDS_CLEAN_EXP,QLDS
Inputs : QLDS : Quicklook data structure.
Opt. Inputs : None.
Outputs : The data in the QLDS are altered.
Opt. Outputs: None.
Keywords : NOFILL : Set this flag to flag the cosmic ray pixels as
MISSING.
NO_NEIGHBOUR : Set this flag to avoid flagging nearest
neighbours (left, right, above, below) of first
approximation cosmic ray pixels as cosmic rays.
XBOX/YBOX: Determines the size of the box used to calculate
the local median.
LIMIT : Determines the dividing line between high/low pixels,
see the algorithm description.
MAX_VAR_LOW : See the algorithm description
MAX_FACTOR_HI : See algorithm description.
KERNEL : See algorithm description.
Calls : ***
CLEAN_EXPOSURE, EXIST, GT_DIMENSION, GT_WINDATA, ST_WINDATA, VDS_DEBIAS
CALLED BY:
MK_CDS_MAP, XCDS_COSMIC
Common : None.
Restrictions: The data in the QLDS should be debiased (will be done if
necessary) but *not* calibrated.
This routine may not work correctly with vertically binned data
(COMP_ID=8), and is not recommended for such data.
Side effects: None.
Category : Utility
Prev. Hist. : None.
Written : S.V.H. Haugan, UiO, 11 December 1996
Modified : Version 2, SVHH, 16 October 1997
Checking data units more sensibly.
Version 3, SVHH, 5 May 1998
Corrected typo causing ybox not to be propagated, and
added KERNEL keyword.
Version : 3, 5 May 1998
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_CLEAN_IMAGE
Purpose : Clean cosmic rays & missing pixels from NIS raster images
Category : Class3, Image-display
Explanation : This routine removes cosmic rays and missing pixels from NIS
raster images.
Cosmic rays are recognized as pixels which are very high
compared to neighboring exposures. Thus, this procedure can
only be used on images which are built up from rastering the
slit across the sun. The first dimension must represent the
raster dimension, and the second dimension must represent
points along the slit. Spectra are not supported.
The algorithm used to recognize cosmic rays is far from
perfect. It is recommended that this routine be used only for
image display purposes, and not for analysis.
Syntax : CDS_CLEAN_IMAGE, IMAGE [, MISSING=MISSING ]
CALLED BY:
CDS_MOSAIC, CDS_QUASI_FIT, CDS_SIMPLE_FITS, CDS_SNAPSHOT, CDS_THUMBNAIL
SHOW_SYNOPTIC, SNAP_MOVIE, XCOR_CDS, XTVSCALE
Examples : A = READCDSFITS('s2707r00.fits')
IMAGE = AVERAGE(DETDATA(A,1),1,MISSING=-1)
SETFLAG, MISSING=-1
CDS_CLEAN_IMAGE, IMAGE
EXPTV, IMAGE
Inputs : IMAGE = The image to be cleaned.
Opt. Inputs : None.
Outputs : IMAGE = The cleaned image is returned in the same parameter.
Opt. Outputs: None.
Keywords : MISSING = Value representing missing pixels. If not passed,
then the value set by SETFLAG is used, or the routine
assigns it's own value, to use for filtering out
pixels containing cosmic ray hits.
NOMISSING = If set, then only clean cosmic rays--don't try to
clean up missing pixels. However, the MISSING
value can still be passed, through either the
keyword or SETFLAG, to mark pixels that really are
missing.
MINSIG = Minimum value to use when estimating the standard
deviation in the pixels.
Calls : ***
FILL_MISSING, GET_IM_KEYWORD
Common : None.
Restrictions: None, except those noted above.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 17-May-1996, William Thompson, GSFC
Version 2, 05-Jun-1996, William Thompson, GSFC
Make more robust when roundoff errors occur
Version 3, 20-May-1997, Zarro, GSFC, stopped abrupt
return caused by MESSAGE
Version 4, 14-Aug-1997, William Thompson, GSFC
Added keyword NOMISSING
Version 5, 17-Apr-2000, William Thompson, GSFC
Extended version 3 change to other MESSAGE calls
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_CLEAN_SPIKE
Purpose : Removes cosmic rays from QLDS data.
Category : Utility
Explanation : Takes each set of window data from the QLDS and cleans it
with the CLEAN_SPIKE routine. If the data has not been
de-biased then VDS_DEBIAS is called first. Unless the keyword
NOFILL is set then the cosmic ray pixels are filled in,
otherwise they are given the MISSING value.
For more details of the cleaning process and the keywords
CUTOFF and BCKGRND see the CLEAN_SPIKE routine.
Syntax : CDS_CLEAN_SPIKE, QLDS, CUTOFF=CUTOFF, BCKGRND=BCKGRND, $
NOFILL=NOFILL, INFO=INFO
Examples : CLEAN_SPIKE, QLDS
CLEAN_SPIKE, QLDS, /NOFILL
Inputs : QLDS - Quicklook data structure.
Opt. Inputs : CUTOFF = Number for determining definition of spike.
BCKGRND = Number specifying level of background.
Outputs : None.
Opt. Outputs: None.
Keywords : NOFILL = Set this flag to flag the cosmic ray pixels as
MISSING.
INFO = If set, will give information about the number of
flagged cosmic ray pixels in each set of window data.
Calls : ***
CLEAN_SPIKE, GT_DIMENSION, GT_NUMWIN, GT_WINDATA, GT_WLABEL, REARRANGE, ST_WINDATA
VDS_DEBIAS
Common : None.
Restrictions: The QLDS data should not be calibrated.
Side effects: None.
Prev. Hist. : None.
Written : P.R. Young, Cambridge University, 13 February 1996
Modified : Not yet.
Version : 1, 13 February 1996
[Previous]
[Next]
Project : SOHO-CDS
Name : CDS_COMPRESS
Purpose : read and compress a sequence of CDS FITS QL files
Category : data analysis
Explanation :
Syntax : cds_compress,fstart,fend
Examples :
Inputs : FSTART,FEND = start/end FITS file numbers
Opt. Inputs : None
Outputs : Compressed FITS files in current directory
Opt. Outputs: None
Keywords : OUTDIR = output directory for compressed files
CALLS: ***
CHK_DIR [1], CHK_DIR [2], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
DATATYPE [1], DATATYPE [2], DATATYPE [3], EXIST, FIND_WITH_DEF [1]
FIND_WITH_DEF [2], FIND_WITH_DEF [3], LIST_EXPER, TEST_OPEN, TRIM, concat_dir [4]
Common : None
Restrictions: None
Side effects: None
History : Written 22 June 1997, D. Zarro, ARC/GSFC
Contact : dzarro@solar.stanford.edu
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_CORR_GRADIENT
Purpose : Apply local intensity gradient correction to line position.
Explanation : For NIS wavelength band 2, there is a tendency of the line
position to show a marked correlation with the local intensity
gradient along the slit (see Haugan 1999, "Anomalous line
shifts from local intensity gradients on the SOHO/CDS NIS
detector", Sol. Phys., in press. A preprint is available at
http://www.uio.no/~steinhh/CDS/anomalous.ps.gz )
Given maps of the total line intensity and the line position,
this routine offers a tentative "repair" procedure to
eliminate (at least partially) the induced line shift.
Statistically, the (asymmetric part of the) correlation
appears to be a shift of 0.23 pixels * d0, where d0 is the
normalized derivative of the line intensity along the
slit. Correcting for this, the residual correlations (with
pixels further away) are at least an order of magnitude
smaller.
However, it should be emphasized that the correction is only
strictly appropriate in a statistical sense. Some profiles
could end up with the *physcially correct* line position, even
after being affected by the tilted PSF. This correction will
then of course produce the "wrong" result for that line
profile.
Conversely, it is of course also possible (and quite likely)
that the correction should be larger than average for some
profiles. To test the effect of correcting more/less, use the
keyword FACTOR, which says how many times the default
correction should be applied (default is 1, 2 means correct
twice the normal amount, etc).
The recommendation is to use this routine with care. In my
personal opinion, the results after applying the correction
are *probably* more correct than before applying the
correction, but that doesn't mean they are completely correct.
A very good exercise is to blink an uncorrected and a
corrected velocity map against each other.
Personally, I would be very careful about discussing physical
interpretations based on uncorrected velocities that disappear
when applying this routine with FACTOR <= 2. Velocities that
are *strengthened* by this correction should be very safe,
though!
Use : CDS_CORR_GRADIENT,INTENSITY,POSITION,MISSING
or
CDS_CORR_GRADIENT,ANALYSIS
Inputs : INTENSITY : Data array containing the total line intensity
(i.e. Gaussian amplitude times width) at each
position of a raster (or series of rasters).
The array may have 2 or more dimensions, but the
important thing is that the "slit direction" is
oriented along the SECOND dimension.
INTENSITY is usually a two-dimensional image,
though a time series with dimensions (1,M,N) can
be used as well.
POSITION : Data array (of same size as INTENSITY) containing
the line position (in angstrom) to be
corrected. The line position is assumed to be first
order NIS2 band.
MISSING : The (scalar) value of MISSING data points.
Called with a single parameter:
ANALYSIS : CFIT analysis structure where
RESULT(0,*,*) is the amplitude,
RESULT(1,*,*) is the position, and
RESULT(2,*,*) is the width...
.. of a Gaussian which has been fitted to CDS data in the
NIS2 band. Pixels where the intensity gradient cannot be
calculated are flagged as MISSING.
If the line of interest is not the first component in the
fit, use the RESULT_OFFSET keword to indicate the index of
the first parameter of the Gaussian.
Opt. Inputs : None.
Outputs : Modifies the analysis result block (or POSITION input array).
Opt. Outputs: None.
Keywords : FACTOR : The correction applied is multiplied with FACTOR.
Default value 1.
RESULT_OFFSET : If the parameters of the Gaussian to be
corrected are not the first parameters in the
fit - e.g. if they are store in
RESULT(3:5,*,*) - this must give the offset (3
in this case) into the result array for the
first parameter of the Gaussian.
Calls : ***
CFIT_APATCH, DEFAULT, DIMREFORM, MAKE_SFIT_STC, PIX2WAVE, WAVE2PIX
Common : None.
Restrictions: This routine *only* applies to data taken before the
recommissioning.
Make sure the appropriate wavelength calibration is loaded
(needed to calculate the delta-lambda per pixel).
The data are assumed to have positions corresponding to
first-order wavelengths within NIS2.
Side effects: Flags the line fits for which the correction cannot be
calculated (due to edge effects, neighbouring missing points
etc) as FAILED (all parameters MISSING, constant, and all
components excluded).
The parameter values will no longer correspond to a data model
that is the best fit to the data!
Category : Analysis.
Prev. Hist. : None.
Written : S.V.H.Haugan, UiO, 3 February 1999
Modified : Version 2, SVHH, 22 February 1999
Added INTENSITY,POSITION,MISSING calling convention.
Version : 2, 22 February 1999
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_ENG_N1
Purpose : Widget to analyze VDS data from CDS engineering test N1.
Category : Data analysis, Engineering
Explanation : Widget interface to the CDS_ENG_N1 routines. The user is
prompted for a study counter to analyze. The analysis is then
done in the routine CDS_ENG_N1_AN.
Syntax : CDS_ENG_N1 [, RESULT]
Examples :
Inputs : None.
Opt. Inputs : None.
Outputs : None required.
Opt. Outputs: RESULT = A structure array containing the following tags:
AVG = Average value per quadrant.
SIGMA = Standard deviation per quadrant.
MIN = Minimum value in each quadrant.
MAX = Maximum value in each quadrant.
Each tag has four elements. Also, the tag
STUDY_COUNTER contains the value of STUDY_COUNTER
passed to this routine. The RESULT array has 4x2
elements representing the four exposure times and the
two phases.
Keywords : None.
Calls : ***
CDS_ENG_N1_AN, CDS_ENG_N1_EVENT, CDS_ENG_N1_PR, CDS_ENG_N1_VW, CW_FIELD
DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4], XACK, XMANAGER, XREGISTERED
delvarx [5]
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 24-Oct-1995, William Thompson, GSFC
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_ENG_N1_AN
Purpose : Analyze VDS data from CDS engineering test N1.
Category : Data analysis, Engineering
Explanation : Reads in the data generated by CDS engineering test N1. This
tests the NIS CCD dark count by taking a series of measurements
with no light falling on the CCD. The test proceeds in two
phases:
Phase 1. VDS high voltage powered off.
Phase 2. VDS high voltage powered on, but shuttered
off.
In each phase, a series of four exposures are made at times of
1, 10, 100, and 1000 seconds. The full CCD is read out.
Syntax : CDS_ENG_N1_AN, STUDY_COUNTER [, RESULT ]
CALLED BY:
CDS_ENG_N1
Examples : CDS_ENG_N1_AN, 100 ;Would read in s100r0.fits,
;s100r1.fits, etc.
Inputs : STUDY_COUNTER = The study counter that serves as a unique
identifier to the set of data files. Also
known as PROG_NUM.
Opt. Inputs : None.
Outputs : None required.
Opt. Outputs: RESULT = A structure array containing the following tags:
AVG = Average value per quadrant.
SIGMA = Standard deviation per quadrant.
MIN = Minimum value in each quadrant.
MAX = Maximum value in each quadrant.
Each tag has four elements. Also, the tag
STUDY_COUNTER contains the value of STUDY_COUNTER
passed to this routine. The RESULT array has 4x2
elements representing the four exposure times and the
two phases.
Keywords : ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors
are encountered, then a null string is returned. In
order to use this feature, ERRMSG must be defined
first, e.g.
ERRMSG = ''
CDS_ENG_N1_AN, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
AVERAGE, BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CDS_ENG_N1_PR
CDS_ENG_N1_RD, FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3], TRIM
break_file [4]
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 24-Oct-1995, William Thompson, GSFC
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_ENG_N1_PR
Purpose : Print results from CDS engineering test N1.
Category : Data analysis, Engineering
Explanation : Prints out the results from CDS engineering test N1, either to
the screen or to a file. Called from CDS_ENG_N1.
Syntax : CDS_ENG_N1_PR, RESULT [, FILENAME ]
CALLED BY:
CDS_ENG_N1, CDS_ENG_N1_AN
Examples :
Inputs : RESULT = Output structure from CDS_ENG_N1_AN.
Opt. Inputs : FILENAME = Name of file to write output to. If not passed,
then the output is written to the screen.
Outputs : None.
Opt. Outputs: None.
Keywords : WIDGET = If passed, then the output is written in the
specified text widget, instead of to a file or the
terminal window.
Calls : ***
TRIM
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 24-Oct-1995, William Thompson, GSFC
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_ENG_N1_RD
Purpose : Read VDS data from CDS engineering test N1.
Category : Data analysis, Engineering
Explanation : Reads in a data file generated by CDS engineering test N1.
Called from CDS_ENG_N1_AN. The array is read in, and the data
is returned to its original detector orientation.
Syntax : CDS_ENG_N1_RD, FILENAME, ARRAY
CALLED BY:
CDS_ENG_N1_AN, CDS_ENG_N1_VW
Examples : CDS_ENG_N1_RD, 's100r0.fits'
Inputs : FILENAME = Name of file to read in.
Opt. Inputs : None.
Outputs : ARRAY = Output array of 1024x1024 pixels, in detector
orientation.
Opt. Outputs: None.
Keywords : ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors
are encountered, then a null string is returned. In
order to use this feature, ERRMSG must be defined
first, e.g.
ERRMSG = ''
CDS_ENG_N1_RD, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DETDATA, READCDSFITS, REARRANGE
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 24-Oct-1995, William Thompson, GSFC
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_ENG_N1_VW
Purpose : View results from CDS engineering test N1.
Category : Data analysis, Engineering
Explanation : Allows the user to view any of the quadrants from CDS
Engineering test N1. Called from CDS_ENG_N1.
Syntax : CDS_ENG_N1_VW
CALLED BY:
CDS_ENG_N1
Examples :
Inputs : None.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : ***
CDS_ENG_N1_RD, CDS_ENG_N1_VW_EVENT, CW_BGROUP, CW_FIELD, SETWINDOW [1]
SETWINDOW [2], TRIM, XACK, XLOADCT [1], XLOADCT [2], XLOADCT [3], XMANAGER
XREGISTERED
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 24-Oct-1995, William Thompson, GSFC
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_ENG_N4
Purpose : Widget to analyze VDS data from CDS engineering test N4.
Category : Data analysis, Engineering
Explanation : Widget interface to the CDS_ENG_N4 routines. The user is
prompted for a study counter to analyze. The analysis is then
done in the routine CDS_ENG_N4_AN.
Syntax : CDS_ENG_N4 [, RESULT]
Examples :
Inputs : None.
Opt. Inputs : None.
Outputs : None required.
Opt. Outputs: RESULT = A structure array containing the following tags:
STUDY_COUNTER = The study counter value.
AVG = A 6x2 array containing the average calibrated
value in each of the six exposures and two
spectral bands. These numbers should be
approximately equal.
Keywords : None.
Calls : ***
CDS_ENG_N4_AN, CDS_ENG_N4_EVENT, CDS_ENG_N4_PR, CW_FIELD, DELVARX [1], DELVARX [2]
DELVARX [3], DELVARX [4], XACK, XMANAGER, XREGISTERED, delvarx [5]
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 25-Oct-1995, William Thompson, GSFC
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_ENG_N4_AN
Purpose : Analyze VDS data from CDS engineering test N4.
Category : Data analysis, Engineering
Explanation : Reads in the data generated by CDS engineering test N4. This
tests the NIS MCP amplification by taking a series of
measurements with different voltages:
Prog. Vol. #14 Equivalent
0 603
50 678
100 756
150 834
200 912
250 990
Syntax : CDS_ENG_N4_AN, STUDY_COUNTER [, RESULT ]
CALLED BY:
CDS_ENG_N4
Examples : CDS_ENG_N4_AN, 100 ;Would read in s100r0.fits,
;s100r1.fits, etc.
Inputs : STUDY_COUNTER = The study counter that serves as a unique
identifier to the set of data files. Also
known as PROG_NUM.
Opt. Inputs : None.
Outputs : None required.
Opt. Outputs: RESULT = A structure array containing the following tags:
STUDY_COUNTER = The study counter value.
AVG = A 6x2 array containing the average calibrated
value in each of the six exposures and two
spectral bands. These numbers should be
approximately equal.
Keywords : ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors
are encountered, then a null string is returned. In
order to use this feature, ERRMSG must be defined
first, e.g.
ERRMSG = ''
CDS_ENG_N4_AN, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
AVERAGE, BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CDS_ENG_N4_PR, DETDATA
FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3], READCDSFITS, TRIM
VDS_CALIB, VDS_DEBIAS, VDS_EXTR_BIASES, break_file [4]
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 25-Oct-1995, William Thompson, GSFC
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_ENG_N4_PR
Purpose : Print results from CDS engineering test N4.
Category : Data analysis, Engineering
Explanation : Prints out the results from CDS engineering test N4, either to
the screen or to a file. Called from CDS_ENG_N4.
Syntax : CDS_ENG_N4_PR, RESULT [, FILENAME ]
CALLED BY:
CDS_ENG_N4, CDS_ENG_N4_AN
Examples :
Inputs : RESULT = Output structure from CDS_ENG_N4_AN.
Opt. Inputs : FILENAME = Name of file to write output to. If not passed,
then the output is written to the screen.
Outputs : None.
Opt. Outputs: None.
Keywords : WIDGET = If passed, then the output is written in the
specified text widget, instead of to a file or the
terminal window.
Calls : ***
TRIM
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 25-Oct-1995, William Thompson, GSFC
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO-CDS
Name : CDS_FILES
Purpose : find CDS files
Category : data analysis
Explanation :
Syntax : files=cds_files(tstart,tend)
Examples :
Inputs : TSTART,TEND = tstart/tend to search
Opt. Inputs : None
Outputs : FILES = filenames found
Opt. Outputs: None
Keywords : ERR = error string
STUDY = study acronym to search for
INFO = some study info (name, date/time etc)
COUNT = # of files found
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DATATYPE [1], DATATYPE [2], DATATYPE [3]
FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3], FIX_ZDBASE, GET_UTC
SET_CDS_SDB, TRIM
Common : None
Restrictions: None
Side effects: None
History : Written 22 March 1998, D. Zarro, SAC/GSFC
Contact : dzarro@solar.stanford.edu
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_FILL_MISSING
Purpose : Fills MISSING pixels in QLDS
Explanation : This procedure goes through all data in a QLDS, filling in
pixels marked as MISSING.
For NIS data (withouth pixel binning) it tries to fill the
missing pixels by calculating the local median of neighbouring
pixels inside a rectangular box (3 by 9 pixels) on the same
exposure.
For those pixels where the above method fails, or for data
sets where the above method is not applied, the routine
FILL_MISSING is used to interpolate a given pixel's value
between neighbouring *exposures*.
Use : CDS_FILL_MISSING,QLDS
Inputs : QLDS : A Quicklook Data Structure
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : INTERPOLATE : Set this keyword to always use the FILL_MISSING
routine to interpolate between exposures. This
is the default for GIS spectra.
Calls : ***
FILL_MISSING, FMEDIAN, GT_DIMENSION, GT_WINDATA, QLMGR, ST_WINDATA, TRIM
CALLED BY:
GIS_SMOOTH, XCDS_COSMIC
Common : None
Restrictions:
Side effects: None.
Category : ?
Prev. Hist. : None.
Written : S.V.H. Haugan, UiO, 4 January 1997
Modified : Version 2, V. Andretta (NASA/GSFC), 19 March 1998
Fixed a problem with GIS one-dimensional sequences.
No informational message is issued if FILL_MISSING is
used and no call to FMEDIAN was possible/requested.
Version : 2, 19 March 1998
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_FIT_WAVE ()
Purpose : To fit upto 3 gaussians to a selected wavelength in a CDS spectrum
Explanation : Having supplied a spectrum to the routine (from PLOT_SPEC for
example), the user can supply a wavelength of interest and this
routine will select a small region of the spectrum around that
wavelength and then attempt to characterise the region with
up to 3 gaussians and a quadratic background.
Use : IDL> r = cds_fit_wave ( sp, wc [, width = gw, out = gp ] )
Inputs : sp - a structure containing the input spectrum (wavelengths
and fluxes).
wc - central wavelength of interest.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: Return a structure containing the fitted parameters for the
input spectrum.
Keywords : WIDTH - Specifies the width of the data region to be fitted (in
pixels). If not specified, 35 is taken as the default.
Calls : ***
CDS_MULTIG, CDS_SLINE, POLY
CALLED BY:
CDS_LINEFIT_WRAP, CDS_VEL_SLICE [2], DSPEXP
Common : None
Restrictions: None
Side effects: None
Category : Data_Analysis
Prev. Hist. : None
Written : B J Kellett 2/12/95.
Modified :
Version : Version 1.0, 2-Dec-95
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_GAUSS()
Purpose : Fits Gaussian with constant, linear or quadratic background.
Explanation : Uses the standard IDL curvefit to fit a gaussian but unlike
IDL's gaussfit, it allows the user to choose the background
type, ie zero, contant, linear or quadratic.
ie Fit y=F(x) where:
F(x) = a0*exp(-z^2/2) + a3 + a4*x + a5*x^2
and z=(x-a1)/a2
a0 = height of exp,
a1 = center of exp,
a2 = 1/e width,
a3 = constant term,
a4 = linear term,
a5 = quadratic term.
The parameters a0,a1,a2,a3 are estimated and then curvefit is
called.
Parameters a3, a4, and a5 are optional, depending on the value
of k
If the (max-avg) of Y is larger than (avg-min) then it is
assumed the line is an emission line, otherwise it is assumed
there is an absorption line. The estimated center is the
max or min element. The height is (max-avg) or (avg-min)
respectively. The width is found by searching out from the
extreme until a point is found < the 1/e value.
Use : yfit = cds_gauss(x,y,a,k)
Inputs : x = independent variable, must be a vector.
y = dependent variable, must have the same number of points
as x.
Opt. Inputs : k = determines the order of polynomial to be fitted in
addition to the gaussian part:
k = 3 : gaussian + a3 + a4*X + a5*X^2
k = 2 : gaussian + a3 + a4*X
k = 1 : gausian + a3
k = 0 or any other k: only gaussian
If k is not defined, it is assumed k=0
Outputs : Function returns value yfit = fitted function.
Opt. Outputs: a = coefficients. a (3+k) element vector as described above.
sigmaa = vector of coefficient uncertainties
Keywords : INTER - if given a value the output array is of that dimension
ie the fit is interpolated (eg for a smooth curve to
overplot). Note that the return value is then an
array of dimension (inter,2) containing both the
interpolated x and y values.
INITIAL_A : Array, same content as A. Set to supply initial
values of the fit parameters. Before CURVEFIT is
called, the parameter array a is updated with:
A(0) = INITIAL_A
Thus this array may contain fewer values than A
(so you can drop estimating the polynomial terms
if you like)
Calls : ***
CDS_GFUNCT, CURVEFIT, GAUSS_PUT, LAST_ITEM, POLY_FIT
CALLED BY:
CDS_GFUNCT, CDS_REPAIR_TOP, DSPWAV, EZFIT, PQLPROFILE
Common : None
Restrictions: None
Side effects: None
Category : Util, numerical
Prev. Hist. : Original - gaussfit
Background flexibility by A. Fludra (MSSL)
Written : CDS version by C D Pike, RAL, 7-Jan-94
Modified : Added INTER keyword. CDP, 27-Mar-96
Version 3, S.V.H.Haugan, UiO/GSFC, 26 November 1996
Added INITIAL_A keyword.
Version 4, Fix bug in INTERPOLATE mode.
version 5, Added sigmaa optional output, J A Klimchuk, 97-10-07
Version : Version 5, 9-Oct-97
[Previous]
[Next]
NAME:
CDS_GEN_HELP
PURPOSE:
This procedure goes through all the LASCO IDL directories and
generates a help file in HTML format of the form help_<directory>.html
CATEGORY:
Utility
CALLING SEQUENCE:
CDS_GEN_HELP
INPUTS:
NONE
KEYWORD PARAMETERS:
NONE
OUTPUTS:
HTML Help Files in each directory are generated
CALLS: ***
LASCO_MK_HTML_HELP, STR_SEP
EXAMPLE:
CDS_GEN_HELP
MODIFICATION HISTORY:
Written by: Dennis Wang
Created: 2 Feb 2001
%W% %H% LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_GFUNCT
Purpose : Evaluate gaussian and its partial derivatives.
Explanation : Used in call to curvefit from cds_gauss
Use : Only as parameter to curvefit
Inputs : X = VALUES OF INDEPENDENT VARIABLE.
A = PARAMETERS OF EQUATION DESCRIBED BELOW.
Opt. Inputs : None
Outputs : Value of function at each x value
Opt. Outputs: None
Keywords : None
Calls : ***
CDS_GAUSS, CURVEFIT, GAUSS_PUT, LAST_ITEM, POLY_FIT
CALLED BY:
CDS_GAUSS
Common : None
Restrictions: For use with cds_gauss and curvefit
Side effects: None
Category : Util, numerical
Prev. Hist. : As below for cds_gauss
Written : CDS version C D Pike, RAL, 7-Jan-94
Modified : Trap no data. CDP, 18-Jan-95
Version : Version 2, 18-Jan-95
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_IMAGE
Purpose : Reads a CDS image from a FITS file (QL or Level-1).
Explanation : This routine reads in a CDS image from a FITS file. Two kinds
of files are supported: simple FITS files with a single
two-dimensional image (quicklook files), or CDS FITS binary
table files (level-1). In the latter case, the routine reads
in a data column, and the data is then integrated over the
wavelength dimension so that a simple image is returned.
This routine was deliberately written to "stand alone" as much
as possible, so that a minimum of CDS library routines will be
needed to support it.
Use : CDS_IMAGE, FILENAME, DATA [, COLUMN ]
Inputs : FILENAME = Name of the CDS FITS file.
Opt. Inputs : COLUMN = Column in the binary table to read data from, either
as a character string containing a column label
(TTYPE), or as a numerical column index starting
from column one. If not passed, the user will be
asked to select from a list. Ignored if the file is
of basic FITS type with the array in the main part
of the FITS file.
Outputs : DATA = The output data will be read into an anonymous
structure variable with the following tag names:
ARRAY = The actual data array.
UNITS = The units of the data.
MISSING = Value representing missing data.
AXES = The labels for the axes of ARRAY.
ORIGIN = The value of the first point along
each of the axes of ARRAY.
SPACING = The pixel spacing along each axis.
ROTATION= The rotation of each axis relative to
the standard coordinate system. This
is only relevant for spatial
dimensions.
WAVELENGTH = Wavelength of observation, in
Angstroms.
WAVEMIN = Minimum wavelength.
WAVEMAX = Maximum wavelength.
Opt. Outputs: None.
Keywords : NANVALUE = Value signalling data dropout. All points
corresponding to IEEE NaN (not-a-number) are
converted to this number. Ignored unless DATA is of
type float, double-precision or complex. If used,
then the MISSING tag in the returned DATA structure
reflects this value. The default is -1.
It is anticipated that the CDS data files will
always be stored as integers, so that the use of
this keyword should be unnecessary.
Calls : ***
FILEPATH, FXBCLOSE [1], FXBCLOSE [2], FXBFIND [1], FXBFIND [2], FXBOPEN [1]
FXBOPEN [2], FXBOPEN [3], FXHREAD [1], FXHREAD [2], FXPAR [1], FXPAR [2], FXREAD [1]
FXREAD [2], READCDSCOL, REVERSE, VALID_NUM [1], VALID_NUM [2], VALID_NUM [3]
CALLED BY:
ITOOL_RD_FITS, RD_IMAGE_FITS
Common : None.
Restrictions: This version of the software is restricted to the current
(October 93) plan for the CDS FITS binary table files, which
are assumed to have the following properties:
- Either the file is a simple FITS file with a single
data array where the spectral information has already
been removed (quicklook), or
- There is only one FITS extension per file, which is
the CDS binary table (level-1), and
- There is only one row in the table.
Side effects: None.
Category : Data Handling, I/O, CDS Specific.
Prev. Hist. : None. However, part of the logic of this routine was taken
from DETREAD by Stein Vidar Hagfors Haugan.
Written : William Thompson, GSFC, 26 October 1993.
Modified : Version 1, William Thompson, GSFC, 29 October 1993.
Added check to make sure column is a data window.
Version 2, William Thompson, GSFC, 15 September 1994
Modified to call READCDSCOL.
Use X-Y coordinate system instead of Y-Z.
Added HEADER to the output structure.
Version : Version 2, 15 September 1994
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_LINEFIT_WRAP
Purpose : Wrapper routine for several CDS line fitting procedures.
Explanation : Many different line fitting procedures have been written for
the CDS project. This is an attempt to make a coherent
interface for some of them.
Multiple lines are not yet supported.
Use : CDS_LINEFIT_WRAP,LAMBDA,INTENS,NLINES,LAB_LAMBDA,A,FIT_TYPE
Inputs : (LAMBDA, INTENSITY) The spectrum at hand.
NLINES : The number of lines to fit. Most fitting routines
only fit one line anyhow.
LAB_LAMBDA : The lab wavelength(s) of the line(s) to be
fitted.
A : Array of coefficients, with same interpretation as
GAUSSFIT. For N lines, an A(6,N)-element vector.
If this array is defined on entry, it is taken as
initial guesses (for those fitting routines that
do accept them).
FIT_TYPE : A string indicating the desired fitting procedure.
Options are:
'lstsqr': Fixed background + Gaussian
'curvefit': Fixed background + Gaussian
'amoeba_c': Fixed background + Gaussian
'gaussfit': Gaussian, background + linear + quadratic
'cds_fit_wave': Gaussian(s), background + linear + quadr.
Opt. Inputs : None.
Outputs : A contains the results of the fit.
Opt. Outputs: None.
Keywords : None.
Calls : ***
AMOEBA_C, CDS_FIT_WAVE, CLEANPLOT [1], CLEANPLOT [2], CLEANPLOT [3], CURVEFIT
DEFAULT, GAUSSFIT [1], GAUSSFIT [2], GAUSSFIT [3], GAUSSFIT [4], GAUSSFIT [5]
LSTSQR, PARCHECK, TRIM, TYP
CALLED BY:
CWQ_SPECTR [1], cwq_spectr [2]
Common : None.
Restrictions: Subject to restrictions of the fitting routines.
Side effects: Calls CLEANPLOT after calling cds_fit_wave.
Category : Data_Analysis, Line_fit
Prev. Hist. : None.
Written : Stein Vidar H. Haugan, UiO, 13 June 1996
Modified : Version 2, 10-Dec-1997, William Thompson, GSFC
Use AMOEBA_C instead of AMOEBA, to avoid conflict with
IDL/v5 routine of that name.
Version : 2, 10-Dec-1997
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_MOSAIC
Purpose : Forms a mosaic of CDS images.
Category : Class2, CDS, Image_processing
Explanation : Reads in a series of CDS FITS files, and forms an image which
is a mosaic of the selected data window.
Syntax : CDS_MOSAIC, FILENAMES, WINDOW, MOSAIC, ORIGIN
CALLED BY:
CDS_SNAPSHOT
Examples : CDS_MOSAIC, 's2707r*.fits', 'HE_2_303_78', MOSAIC, ORIGIN
CDS_MOSAIC, 2707, 'HE_2_303_78', MOSAIC, ORIGIN
CDS_MOSAIC, 's3084r00.fits,s3085r00.fits', 1, MOSAIC, ORIGIN
CDS_MOSAIC, [3084, 3085], 1, MOSAIC, ORIGIN
Inputs : FILENAMES = A comma separated list of the names of the FITS
files to use in forming the mosaic. Wildcards are
allowed, but take some time to resolve.
Alternatively, one can pass an integer array
containing the study numbers to process. This is
much faster than using wildcards.
One can also pass in a quicklook data structure.
This option is used for rasters formed with the
90x240 arcsecond slit. The individual exposures
then each form an image, and all the exposures
together form a larger image.
WINDOW = The number of the window to form the mosaic from.
Can be from 0 to N-1.
Opt. Inputs : None.
Outputs : MOSAIC = An array containing the mosaic.
ORIGIN = The origin of the mosaic, i.e. the coordinates of the
lower left pixel. This parameter can be used in
routines such as PLOT_IMAGE, e.g.
PLOT_IMAGE, MOSAIC, ORIGIN=ORIGIN, SCALE=2
Opt. Outputs: None.
Keywords : SCALE = The scale in arcseconds to use in forming the
mosaic. The default is 2.
LABEL = Returns the label of the window used in making the
mosaic.
COUNTDOWN = If set, then a countdown is displayed as the FITS
files are processed.
NOCLEAN = If set, then CDS_CLEAN_IMAGE is not called.
DEBIAS = If set, then VDS_DEBIAS is called.
NOMISSING = Passed to CDS_CLEAN_IMAGE to clean cosmic rays, but
not fill in missing pixels.
PIX1, PIX2 = If present these represent the spectral pixels within
the chosen data window that are to be averaged.
Calls : ***
AVERAGE, CDS_CLEAN_IMAGE, CONGRID [1], CONGRID [2], CONGRID [3], COPY_QLDS
COUNTDOWN, DATATYPE [1], DATATYPE [2], DATATYPE [3], FILL_MISSING, FIND_FILES
GT_WINDATA, GT_WINDESC, LIST_EXPER, READCDSFITS, STR_SEP, UPD_CDS_POINT, VDS_DEBIAS
WAVE2PIX
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, William Thompson, GSFC, 14 June 1996
Version 2, William Thompson, GSFC, 13 November 1996
Added calls to UPD_CDS_POINT
Added keyword DEBIAS
Version 3, William Thompson, GSFC, 3 February 1998
Changed to call GT_WINDATA/GT_WINDESC instead of
DETDATA/DETDESC. This means that windows are specified
from 0 to N-1 instead of 1 to N.
Only read in the window that will be used.
Version 4, C D Pike, RAL, 23-Feb-98. Skip find_files search
if explicit names given
Version 5, William Thompson, GSFC, 24-Aug-1999
Allow study numbers to be passed instead of filenames.
Added keyword NOMISSING
Average together overlaid pixels.
Version 6, 02-Nov-1999, William Thompson, GSFC
Form mosaics out of slit 6 images.
Allow quicklook data structures to be passed.
Version 7, 17-Feb-2000, Willliam Thompson, GSFC
Modify to work with GIS rasters.
Version 8, 21-Mar-2000, CDP, Add PIX1/PIX2 keywords
Version 9, 11-Jul-2003, William Thompson, GSFC
Handle upside-down images.
Contact : WTHOMPSON
[Previous]
[Next]
PROJECT: SOHO - CDS
NAME: CDS_NEW_SPIKE
PURPOSE:
Removes cosmic rays from CDS quicklook data structures
CATEGORY:
Utility
EXPLANATION:
Takes each set of window data from the QLDS and cleans them
with the NEW_SPIKE routine. If the data has not been de-biased
then VDS_DEBIAS is called first. Unless the keyword NOFILL is set,
the cosmic ray pixels are filled in, otherwise they are given the
MISSING value.
For more details on the cleaning process see the header for the
NEW_SPIKE routine.
CALLED BY:
MK_SYNOPTIC, XCDS_COSMIC
EXAMPLES:
CDS_NEW_SPIKE, QLDS
CDS_NEW_SPIKE, QLDS, /NOFILL, /INFO
INPUTS:
QLDS - CDS quicklook data structure.
KEYWORDS:
INFO - Display number of flagged pixels for each window
NO_NEIGHBOURS - Don't flag neighbours of cosmic rays
NOFILL - Change cosmic rays to missing value of QLDS
CALLS: ***
GT_DIMENSION, GT_NUMWIN, GT_WINDATA, GT_WLABEL, NEW_SPIKE, REARRANGE, ST_WINDATA
VDS_DEBIAS
RESTRICTIONS:
The QLDS data should not be calibrated.
HISTORY:
Ver.1, PRY 18-Aug-98
Ver.2, PRY 24-Nov-98, cosmetic changes
Ver.3, PRY 20-Feb-03, caught error when array dimensions are too
small
Ver.4, PRY 15-Aug-03, added ybin= when calling new_spike to allow
for data binned in Y-direction.
WRITTEN:
P.R. Young, Rutherford Appleton Laboratory, p.r.young@rl.ac.uk
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_OUTPLOT
Purpose : To overplot time series data on a plot created by UTPLOT
Explanation : Converts input x-variable to seconds, applies the time offset
stored in common and overplots data on a plot created by
UTPLOT.
Use : IDL> cds_outplot,x,y + normal oplot keywords.
Inputs : x - the time variable. May be either an array of CDS internal
time structures (as produced by the
routine STR2UTC, say) or...
a string array of date/times in a
format translatable by STR2UTC.
y - the data value to be plotted.
Opt. Inputs : Various keywords.
Outputs : None
Opt. Outputs: None
Keywords : dmy - if the x-variable is a list of date/time strings
this keyword must be used if they are in the
format dd-mm(m)-yyyy as opposed to the CDS
'official' format of yyyy-mm-dd
+ other standard oplot keywords
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], STR2UTC [1], STR2UTC [2], STR2UTC [3]
UTC2SEC, VCHECK
CALLED BY:
CDS_PLOT_ERR, PLOT_TEMP_POS, PLOT_VDS_BIAS, VDS_BIAS_GLITCH
Common : cds_utplot_com (for getting time axis offset from cds_utplot)
Restrictions: Any 2-character year specifications are translated as being
between 1950 and 2049 (use 4-characters as necessary).
Side effects: None
Category : Data display, plotting
Prev. Hist. : This is a version of the old OUTPLOT as used on
Yohkoh and developed by Tolbert, Schwartz and Morrison.
Written : This version for CDS by C D Pike, RAL, 20-Apr-94
Modified : Update keyword handling. CDP, 8-Dec-95
Name change. CDP, 2-Oct-96
Version : Version 2, 2-Oct-96
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_PAD_QLDS
Purpose : Make sure all detector data windows have same size.
Explanation : To ensure that all CDS Quick Look routines may safely
assume that all data extraction windows have the same size,
this routine forces them to be. The padding is not done with
the wavelength dimension, though.
This routine is normally only called from readcdsfits, as soon
as the fits file has been read.
Use : CDS_PAD_QLDS,QLDS
Inputs : QLDS : A CDS Quick Look Data Structure
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : ***
GT_WINDATA, ST_WINDATA, TRIM
CALLED BY:
READCDSFITS
Common : None.
Restrictions: None.
Side effects: Modifies the contents of the QLDS, pads all data arrays
to the size of the largest one, filling with MISSING.
Category : Data_handling
Prev. Hist. : None.
Written : Stein Vidar H. Haugan, UiO, 18 August 1996
Modified : Version 2, SVHH, 23 August 1996
No longer padding the wavelength dimension.
Version 3, SVHH, 26 August 1996
Corrected typo sz -> new_sz in calculation of
new ixstop.
Version 4, SVHH, 24 September 1996
Added PADDING information.
Version 5, SVHH, 4 April 1997
Added test for non-selected windows.
Version : 5, 4 April 1997
[Previous]
[Next]
PROJECT:
SOHO - CDS
NAME:
CDS_PLAN_BRIEF
PURPOSE:
Read detail (or other) plans from DB and display them in text widget
CATEGORY:
planning, utility
SYNTAX:
cds_plan_brief, startdis, stopdis [, group=group]
INPUTS:
STARTDIS - Start date/time in any CDS time format
STOPDIS - Stop date/time in any CDS time format
OPTIONAL INPUTS:
DETAILS - Array of detail plan structures. If passed, no DB
read will be conducted; Useful for just displaying
details plans during planning.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
NOBS - Number of detailed plans found in between STARTDIS
and STOPDIS
GROUP - ID of widget who serves as the group leader
TEXT - Just make a text file without popping up a widget
DETECTOR - Set this keyword to include detector list of the
study (this can be slow)
SCI_PLAN - Set this keyword to list SCI plan only
ACRONYM - Set this keyword to show acronym (or obs_prog)
TITLE - Set this keyword to show title (i.e., SCI_SPEC)
INIT - Set this to initialize XTEXT
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], ARR2STR [1], Arr2Str [2], CONCAT_DIR [1]
CONCAT_DIR [2], CONCAT_DIR [3], EXIST, GET_CDS_XY, GET_PLAN_ITIME, GET_STUDY_PAR
LIST_DETAIL, LIST_PLAN, RD_PLAN, SEC2DHMS, STRPAD, TAG_EXIST [1], TAG_EXIST [2], XKILL
XTEXT, concat_dir [4]
CALLED BY:
MK_CDS_PLAN, XCPT, XPORT
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
The calling widget program is put on hold till the pop up
widget is killed.
HISTORY:
Version 1, April 11, 1996, Liyun Wang, GSFC/ARC. Written
Version 2, May 2, 1996, Liyun Wang, GSFC/ARC
Added DETECTOR and SCI_PLAN keywords
Version 3, October 1, 1996, Liyun Wang, NASA/GSFC
Added ACRONYM keyword
Version 4, October 9, 1996, Liyun Wang, NASA/GSFC
Added TITLE keyword
Modified Dec 28, 1999, Zarro (SM&A/GSFC) - added pointing listing
CONTACT:
Liyun Wang, GSFC/ARC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_PLAN_POINT
Purpose : create map structures for planned CDS pointings
Category : planning
Syntax : IDL> cds_plan_point,cmap,tstart,tend
Inputs : TSTART = plot start time [def=current date]
Opt. Inputs : TEND = plot end time [def = 24 hour window]
Outputs : CMAP = CDS plan pointings in MAP structures
Keywords : COUNT = # of pointings found
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4]
GET_CDS_FOV, GET_CDS_STUDY, GET_CDS_XY, MAKE_MAP, MERGE_STRUCT, RD_PLAN, delvarx [5]
get_def_times
CALLED BY:
RD_CDS_POINT
History : Version 1, 20-May-1998, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_PLOT_ERR
Purpose : Plot data with error bars in both X and Y directions
Explanation : Plots data points with accompanying error bars in both the X
and Y directions.
A plot of X versus Y with error bars drawn from X-XERR to
X+XERR and from Y-YERR to Y+YERR is written to the output
device. Optionally, one can give different sizes for the lower
and upper error bars.
If !BCOLOR is not zero, then that color is used for error bars.
Use : CDS_PLOT_ERR, [ X, ] Y [, XERR=XERR] [, YERR=YERR]
Inputs : Y = array of Y values.
Opt. Inputs : X = array of X values. If not passed, then the index of Y is
used instead.
Outputs : None.
Opt. Outputs: None.
Keywords : XERR = Array of errors in X
YERR = array of errors in Y.
The error arrays can take one of two forms:
* Same dimensions as the data arrays, in which case the
error is applied in both the X and Y directions
* An extra initial dimension of 2, in which case the
first value is the size of the lower (or left) error bar,
and the second value is the size of the upper (or right)
error bar.
PSYM = Symbol to use for plotting. Default is 7 (X).
SYMSIZE = Symbol size
COLOR = Color to use for plotting.
BCOLOR = Color to use instead of !BCOLOR for error bars.
LINESTYLE = Line style
THICK = Line thickness
UTPLOT = If set, then the first (X) parameter is considered
to be time in one of the CDS time formats. This is
only allowed if both X and Y are passed. If used,
then XERR is in seconds.
Also, most PLOT keywords are supported.
Calls : ***
CDS_OUTPLOT, CDS_UTPLOT, DATATYPE [1], DATATYPE [2], DATATYPE [3], TAI2UTC, UTC2TAI
CALLED BY:
TILT_NIS1_DEMO, TILT_NIS2_DEMO
Common : None.
Restrictions: Requires that the system parameter !BCOLOR be defined.
Side effects: None.
Category : Utilities, Plotting
Prev. Hist. : Based on an earlier routine called PLOTERR2.
Written : William Thompson, GSFC, 19 April 1995
Modified : Version 1, William Thompson, 19 April 1995
Version 2, William Thompson, GSFC, 20 April 1995
Added keyword UTPLOT.
Made determination of symmetrical/asymmetrical error
bars more robust.
Version 3 CDP, 30-Nov-95
Cut linestyle from plot call so keyword is acted upon
Version 4, A version of PLOT_ERR which uses the CDS version
of UTPLOT. CDP, 7-Oct-96
Version 5, William Thompson, GSFC, 18 December 2002
Changed !COLOR to !P.COLOR
Version : Version 5, 18 December 2002
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_PLOT_FIT
Purpose : To display the results from various line fitting routines for
CDS spectra.
Explanation : Routines like CDS_AUTOFIT can return a set of Gaussian fitted
components and errors and also continuum estimates. This
routine can either simply display the CDS input spectrum with
a simple indication of where the lines fitted are, or if the
KELLY keyword was used, can indicate the closest matches to
known lines (default lambda differences or user defined by
WDIFF keyword), and/or indicate the fitted gaussian profile
and fitted intensity if the FILL keyword is supplied. The
defaults is to display the entire spectrum. However, a WRANGE
keyword can be used to plot a restricted wavelength interval.
Use : IDL> cds_fit_plot, sp, [ results = gfit, /fill, /kelly, $
wdiff = 0.25, wrange = [wave1,wave2], $
/logplot ]
Inputs : sp - a structure containing the input spectrum (wavelengths
and fluxes).
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None
Keywords : RESULTS - a set of gaussian parameters etc. as returned by
eg. CDS_AUTOFIT.
KELLY - indicate full Kelly lines in spectral range within
certain range (default is 1.75 pixels, or user
defined by WDIFF value).
BLUEBOOK - indicate CDS Bluebook lines in plotted range.
FILL - (only valid if RESULTS supplied!) - show fitted gaussians
and continuum and print line intensities.
WDIFF - used with the KELLY keyword to select closest lines
in the Kelly CDS list (i.e. within +/- WDIFF Angstroms).
[Default value is 1.75 wavelength pixels].
WRANGE - a range of wavelengths over which to display results.
eg WRANGE = [ 333., 336., 355., 360. ] would produce
two plots (333-336 and 355-360).
LOGPLOT - use log scaling on the y-axis
ALL - override WDIFF and plot all KELLY or BLUEBOOK lines.
Calls : ***
CDS_SLINE, GET_GAUSS, GFIT_ERROR, POLY
CALLED BY:
CDS_AUTOFIT, CDS_VEL_SLICE [2]
Common : None
Restrictions: None
Side effects: None
Category : Data_Analysis
Prev. Hist. : None
Written : B J Kellett 2/12/95.
Modified :
Version : Version 1.0, 2-Dec-95
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_QUASI_FIT()
Purpose : Quasi-fits line profile to extract image
Category : Class3, CDS, Analysis
Explanation : CDS/NIS spectral line data sit on top of a scattered light
component due to small irregularities in the grating. This
scattered light component is spatially structured, mimicking
the behavior of continuum radiation. In order to extract the
correct spatial behavior of the line being observed, then some
analysis must be applied to the data to remove the background
component.
This routine applies some crude analysis to remove the
scattered light component. It does this by taking the average
of the three leftmost and rightmost pixels in the wavelength
direction. If there appears to be significant data on one side
that isn't on the other side, as recognized by the statistics
in the two average images, then only the other side is used.
Syntax : Result = CDS_QUASI_FIT( QLDS, WINDOW )
Result = CDS_QUASI_FIT( ARRAY, MISSING )
CALLED BY:
CDS_SNAPSHOT, SNAP_MOVIE
Examples : QLDS = READCDSFITS('s3300r00.fits')
IMAGE = CDS_QUASI_FIT(QLDS, 0)
Inputs : QLDS = A CDS quicklook data structure as returned by
READCDSFITS. Alternatively, this could be an array
containing a single data window.
WINDOW = The index number of the desired window, with values
from 0 to N-1. Alternatively, if an array is passed
instead of a QLDS, then this is the missing pixel
flag value.
Opt. Inputs : None.
Outputs : The extracted image is returned as the result of the function.
Opt. Outputs: None.
Keywords : QUIET = If the wavelength coverage is less than nine pixels,
then a straight average is applied. When the /QUIET
keyword is used, the warning messages about this are
turned off.
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors
are encountered, then a null string is returned. In
order to use this feature, ERRMSG must be defined
first, e.g.
ERRMSG = ''
A = CDS_QUASI_FIT( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
AVERAGE, CDS_CLEAN_IMAGE, DATATYPE [1], DATATYPE [2], DATATYPE [3], FILL_MISSING
GT_WINDATA, GT_WINDESC, STDEV
Common : None.
Restrictions: None.
Side effects: Missing pixels are filled in.
Prev. Hist. : None.
History : Version 1, 13-Jan-1997, William Thompson, GSFC
Version 2, 13-Mar-1997, William Thompson, GSFC
Improved handling of missing pixels
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_READ_MISSING
Purpose : Read list of missing pixels and apply to QLDS
Explanation : The procedure CDS_SAVE_MISSING can be used to save a list of
MISSING pixels (cosmic rays etc) in a QLDS to an IDL SAVE
file. This routine reads such a save file and flags those
pixels as MISSING in the supplied QLDS.
Use : CDS_READ_MISSING,QLDS,FILENAME
Inputs : QLDS : Quick Look Data Structure
Opt. Inputs : FILENAME : Name of save-file containing the list of MISSING
pixels. Must have been written by CDS_SAVE_MISSING.
If this parameter is not present, then the STATUS
keyword must contain the missing status (see
CDS_SAVE_MISSING).
Outputs : Alters the QLDS
Opt. Outputs: None.
Keywords : STATUS : The missing status of a QLDS, as ouput from
CDS_SAVE_MISSING.
Calls : ***
GT_WINDATA, PARCHECK, QLMGR, ST_WINDATA, TEST_OPEN, TYP
CALLED BY:
APPLY_CDS_ADEF, XCDS_COSMIC
Common : None.
Restrictions: None.
Side effects: None.
Category : CDS utility
Prev. Hist. : None.
Written : S. V. H. Haugan, UiO/GSFC, 26 November 1996
Modified : Version 2, SVHH, 3 January 1997
Added STATUS keyword.
Version 3, SVHH, 23 March 1998
Corrected spelling of ST_WINDATA (pointed out by
V. Andretta) and added CATCH,/CANCEL.
Version : 3, 23 March 1998
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_REPAIR_TOP
Purpose : "Repair" the tops of saturated lines ( 4095 counts )
Explanation : This routine, as it is, should be applied to NIS data only,
*before* any calibration/debiasing routines have been applied.
CDS_REPAIR_TOP goes through all single spectra in the QLDS and
replaces saturated pixel values with values matching a
Gaussian fit to the surrounding, non-saturated pixels.
The large amount of assumptions necessary to justify such a
procedure should be obvious, so *BE CAREFUL* about analyzing
data after processing them with this program.
Of course, if your data contains anything else than a single
gaussian plus background, this routine may fill the saturated
pixels with stuff that's even more wrong than the saturated
values.
Use : CDS_REPAIR_TOP,QLDS
Inputs : QLDS : Quick Look Data Structure.
Opt. Inputs : K : The number of coefficients included in the fit of the
background level in CDS_GAUSS. Default is 1 (i.e., a
constant background).
Outputs : The data in the QLDS are altered.
Opt. Outputs: None.
Keywords : None.
Calls : ***
CDS_GAUSS, CDS_REPAIR_SINGLETOP, DEFAULT, GT_DIMENSION, GT_WINDATA, QLMGR
ST_WINDATA
Common : None.
Restrictions: See Explanation.
Side effects: None.
Category :
Prev. Hist. : None.
Written : S. V. H. Haugan, UiO/GSFC, 26 November 1996
Modified : Not yet.
Version : 1, 26 November 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_SATURATE
Purpose : Checks NIS data for saturation
Explanation : Records if a file has raw data values = 4095
Use : IDL> cds_saturate, qlds
Inputs : qlds - RAW data structure
Opt. Inputs : None
Outputs : If saturation found, prints results to file named
file.sat
Opt. Outputs: None
Keywords : SYSTEM - writes to official HEADCAT directory, otherwise local
Calls : ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], GT_DATA_UNITS, GT_EXPTIME [2], GT_NUMWIN, GT_WINDATA, GT_WLABEL
PRINT_STR, STRPAD, TRIM, break_file [4], concat_dir [4], gt_exptime [1]
Common : None
Restrictions: None
Side effects: None
Category : Help
Prev. Hist. : None
Written : C D Pike, RAL, 5-Aug-99
Modified :
Version : Version 1, 5-Aug-99
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_SAVE_MISSING
Purpose : Save a list of MISSING pixels to a file
Explanation : To avoid e.g., removing cosmic rays manually more than once,
this routine will save a list of those pixels marked as
MISSING. CDS_READ_MISSING will be able to read that list and
mark the corresponding pixels as missing during another IDL
session.
It is possible to use CDS_SAVE_MISSING/CDS_READ_MISSING
without writing/reading a file, through the keyword STATUS,
e.g.:
CDS_SAVE_MISSING,QLDS,STATUS=NAMED
....
CDS_READ_MISSING,QLDS,STATUS=NAMED
Use : CDS_SAVE_MISSING,QLDS,FILENAME
Inputs : QLDS : Quick Look Data Structure
Opt. Inputs : FILENAME: The name of the file in which the list of MISSING
pixels will be saved.
Outputs : None.
Opt. Outputs: None.
Keywords : STATUS : A named variable to receive the status structure
containing the list of missing pixels.
Calls : ***
GT_WINDATA, PARCHECK, QLMGR, ST_WINDATA, TEST_OPEN, TYP
CALLED BY:
XCDS_COSMIC
Common : None.
Restrictions: None.
Side effects: None.
Category : CDS utility
Prev. Hist. : None.
Written : S. V. H. Haugan, UiO/GSFC, 27 November 1996
Modified : Version 2, SVHH, 3 January 1997
Corrected bug, added STATUS keyword
Version 3, SVHH, 23 March 1998
Corrected spelling of ST_WINDATA (pointed out by
V. Andretta), added catch,/cancel
Version : 3, 23 March 1998
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_SHOW_IMAGE
Purpose : Displays a CDS image read by CDS_IMAGE.
Explanation : This routine displays in a window a CDS image read by the
routine CDS_IMAGE. Axes are drawn around the image to signify
data coordinates in arcseconds from the center of the Sun.
Because CDS images are small, the image is shown three times
the actual size.
This routine was deliberately written to "stand alone" as much
as possible, so that a minimum of CDS library routines will be
needed to support it.
Use : CDS_SHOW_IMAGE, DATA
Inputs : DATA = A structure variable containing the CDS image and
auxilliary data. See CDS_IMAGE for more information.
Opt. Inputs : None.
Outputs : A window is displayed containing the image.
Opt. Outputs: None.
Keywords : WINDOW = The index of the window used to display the image is
returned in this parameter.
Calls : ***
CONGRID [1], CONGRID [2], CONGRID [3]
Common : None.
Restrictions: Requires the current graphics device to be a windowing system.
Side effects: None.
Category : Data Handling, I/O, CDS Specific.
Prev. Hist. : None.
Written : William Thompson, GSFC, 27 October 1993.
Modified : Version 1, William Thompson, GSFC, 29 October 1993.
Fixed bug with Y axis origin.
Added WINDOW keyword.
Version : Version 1, 29 October 1993.
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_SIMPLE_FITS
Purpose : Write out simple 2D FITS files.
Category : Class3, FITS
Explanation : Takes a normal CDS binary table or quicklook structure, and
writes out a series of simple two-dimensional FITS image files.
This allows the data to be given to users who are unable to use
more sophisticated FITS files.
Syntax : CDS_SIMPLE_FITS, FILENAME
CDS_SIMPLE_FITS, DATA
CALLED BY:
MK_CDS_FITS
Examples : CDS_SIMPLE_FITS, 's3042r00.fits'
A = READCDSFITS('s3042r00.fits')
CDS_SIMPLE_FITS, A
Inputs : FILENAME = Name of CDS FITS file to read in.
Opt. Inputs : DATA = A quicklook data structure as returned by
READCDSFITS.
Outputs : The output FITS files are written to the current directory, and
have names like "s3042r00_584.fts".
Opt. Outputs: None.
Keywords : CLEAN = If set, then CDS_CLEAN_IMAGE is called prior to
writing the FITS files.
BYTE_SCALE = If set, then the data is scaled into a byte array.
ERRMSG = If defined and passed, then any error messages
will be returned to the user in this parameter
rather than depending on the MESSAGE routine in
IDL. If no errors are encountered, then a null
string is returned. In order to use this feature,
ERRMSG must be defined first, e.g.
ERRMSG = ''
CDS_SIMPLE_FITS, INPUT, ERRMSG=ERRMSG
IF ERRMSG NE '' THEN ...
Calls : ***
AVERAGE, BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], BSCALE, CDS_CLEAN_IMAGE
DATATYPE [1], DATATYPE [2], DATATYPE [3], DETDATA, DETDESC, FXADDPAR [1]
FXADDPAR [2], FXHCLEAN [1], FXHCLEAN [2], FXHMAKE [1], FXHMAKE [2], FXWRITE [1]
FXWRITE [2], READCDSFITS, SXDELPAR [1], SXDELPAR [2], SXDELPAR [3], TRIM
break_file [4]
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 17-Jun-1996, William Thompson, GSFC
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_SLINE()
Purpose : Select from basic CDS Kelly or BB spectral line list
Explanation : Restores the basic parameters (wavelength and line ID) from
the SAVE file created by cds_sline_data and filters the list
according to user requirements.
eg IDL> list = cds_sline(345,350,elem=['ca','ne'],ion=['v','vi'])
will select all lines in the range 345-350 A originating
from Ca V, Ca VI, Ne V or Ne VI
Use : list = cds_sline([wave_start, wave_end, elem=elem, ion=ion,$
/hard, /see, /cds, /kelly])
Inputs : None
Opt. Inputs : wave_start - start wavelength for search, default = 153 A
wave_end - end wavelength for search, default = 789 A
Outputs : Function returns details of chosen lines in (3,n) array.
Also get listing to screen and optional hard copy.
Opt. Outputs: listing to printer
Keywords : ELEM - the element of interest (2 character std abbreviation)
can be an array.
ION - ionization stage (up to 4 character Roman style)
can be an array.
HARD - if set the listing will be sent to the printer
SEE - if set, listing is output to screen
CDS - use line list from Blue Book
KELLY - use abbreviated Kelly line list (default)
Calls : ***
Bell, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FILEPATH, FIND_COMMON, STRPAD
concat_dir [4]
CALLED BY:
CDS_AUTOFIT, CDS_FIT_WAVE, CDS_PLOT_FIT, CDS_VEL_SLICE [2], MK_RASTER, NDSPSPEC
SEL_LINE_MENU
Common : None
Restrictions: None
Side effects: None
Category : Util, spectrum
Prev. Hist. : None
Written : C D Pike, RAL, 9-Nov-94
Modified : Added output variable. CDP, 24-Nov-94
Changed to a function. CDP, 7-Mar-95
Added CDS BB line list option. CDP, 15-Mar-95
Use CDS_ATOMIC instead of CDS_INFO for save files.
CDP, 2-jun-95
Initialise line variable before restoration. DMZ, 24-Jan-96
Version : Version 6, 24-Jan-96
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_SLINE_DATA
Purpose : Create save file from Kelly or CDS spectral line list.
Explanation : The CDS version of the Kelly line list or the Blue Book CDS
line list is read and the wavelengths and lines
identifications are SAVEd for pickup by cds_sline.
Use : IDL> cds_sline_data [, /kelly, /cds]
Inputs : None
Opt. Inputs : None
Outputs : File is created in CDS_ATOMIC
Opt. Outputs: None
Keywords : kelly - uses Kelly line list (default)
cds - uses CDS Blue Book line list
Calls : ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], REM_MULT_CHAR, STR_SEP
concat_dir [4]
Common : None
Restrictions: Must have write access to CDS_ATOMIC directory.
Side effects: None
Category : Util, spectrum
Prev. Hist. : None
Written : C D Pike, RAL, 9-Nov-94
Modified : To include BB line list. CDP, 15-Mar-95
Add /xdr key for VMS compatibility. CDP, 3-Apr-95
Use CDS_ATOMIC instead of CDS_INFO for save files.
CDP, 2-Jun-95
Version : Version 4, 2-Jun-95
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_SLIT6_BURNIN()
Purpose : Returns the SLIT6 burn-in data for a given date and wavelength
Explanation : This routine returns the burn-in due to SLIT6 for a given date
and wavelength.
Use : Result = CDS_SLIT6_BURNIN( DATE, WAVE )
Inputs : DATE = The observation date, in any CDS time format.
WAVE = The wavelength, in Angstroms.
Opt. Inputs : None.
Outputs : Messages about the burn-in corrections will be printed to the
screen.
Opt. Outputs: None.
Keywords : ANALYSIS_DATE = Date on which the data was analyzed. This
allows comparison between old and new burn-in
calibrations. The default is to use the most
up-to-date calibration.
ERRMSG = If defined and passed, then any error messages will
be returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors
are encountered, then a null string is returned. In
order to use this feature, ERRMSG must be defined
first, e.g.
ERRMSG = ''
CDS_SLIT6_BURNIN, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2TAI, BOOST_ARRAY [1], BOOST_ARRAY [2], BOOST_ARRAY [3], CONCAT_DIR [1]
CONCAT_DIR [2], CONCAT_DIR [3], DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4]
FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3], FXREAD [1], FXREAD [2]
GET_UTC, NIMCP_DEPTH_FUNCT, POLY, STR_SEP, UTC2TAI, WAVE2PIX, concat_dir [4]
delvarx [5]
Common : None.
Restrictions: See GET_NIMCP for more information.
Side effects: The wavelengths displayed will be based on the currently loaded
wavelength calibration. See LOAD_WAVECAL for more information.
Category : Class4, Calibration
Prev. Hist. : None.
Written : William Thompson, GSFC, 13-November-2003
Modified : Version 1, 13-Nov-2003, William Thompson, GSFC
Version 2, 09-Jun-2004, William Thompson, GSFC
Corrected bug for pre-accident data
Allow DATE to be an array.
Version : Version 2, 09-Jun-2004
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_SNAPSHOT
Purpose : Makes a thumbnail sketch of images from a CDS study.
Category : CDS, Class3, Quicklook
Explanation : Displays all the images associated with a CDS observation,
together with a label that shows information about the data.
Syntax : CDS_SNAPSHOT, FILENAME
CDS_SNAPSHOT, DATA
CALLED BY:
MK_CDS_GIF, SNAP_MOVIE, XCDS_SNAPSHOT
Examples : CDS_SNAPSHOT, 's3042r00.fits'
A = READCDSFITS('s3042r00.fits')
CDS_SNAPSHOT, A
Inputs : FILENAME = Name of CDS FITS file to read in.
Opt. Inputs : DATA = A quicklook data structure as returned by
READCDSFITS.
Outputs : None.
Opt. Outputs: None.
Keywords : REVERSE = If set, then plot is done in inverse video. In other
words, white areas on the screen will appear dark,
and visa versa. This saves toner on greyscale
printers.
NOCLEAN = If set, then CDS_CLEAN_IMAGE is not called.
WINDOWS = An array of windows to display. The windows can be
passed as either the NUMBERS of the data windows
(NOTE: numbering from 0...N-1) or as text with the
LABELS of the desired spectral windows. The windows
will be displayed in the order given by the WINDOWS
array, unless the WAVESORT keyword is passed.
WAVESORT = If set, then the windows are displayed in wavelength
order. (Note that second order lines will be
displayed according to their first order
equivalent.)
QUASI_FIT= If set, then the routine CDS_QUASI_FIT is called to
extract the images. See the documentation on that
routine for more information.
SPECTRA = If set, then spectra are shown instead of images.
For some data sets, spectra are shown by default.
MOSAIC = If set, then a mosaic is formed out of the
individual exposures. This option is only used for
rasters made with slit #6, and is otherwise ignored.
LOG = If set, then spectra are plotted logarithmically.
Only used for line plots.
WO_CR = If set, then spectra are calculated using AVG_WO_CR
instead of AVERAGE. Warning, very slow.
FRACTION = Fraction to pass to SIGRANGE function. The default
is 0.99.
CHARSIZE = Character size to use for the window labels.
CHARTHICK= Character thickness.
NOTITLE = If set, then the title information at the bottom of
the page is suppressed.
NOLABEL = If set, then the labels above each data window are
suppressed.
ROTATE = If passed, then is the value of the parameter passed
to the ROTATE function to change the image
orientation. For example, using ROTATE=1 would
rotate the image by +90 degrees, while ROTATE=3
would rotate it by -90 degrees. (See also ROLL).
MIN,MAX = Arrays of the minimum and maximum values to be
applied to each window. Must be in the same order
as the windows are displayed.
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors
are encountered, then a null string is returned. In
order to use this feature, ERRMSG must be defined
first, e.g.
ERRMSG = ''
CDS_SNAPSHOT, INPUT, ERRMSG=ERRMSG
IF ERRMSG NE '' THEN ...
LARGE_TITLE = Make last two lines of titles larger.
ROLL = If set, and the image is from a period when SOHO is
upside-down, then roll the data by 180 degrees.
Ignored if ROTATE keyword is passed.
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], AVERAGE, CDS_CLEAN_IMAGE, CDS_MOSAIC
CDS_QUASI_FIT, CDS_WAVE_LABEL, CONGRID [1], CONGRID [2], CONGRID [3], DATATYPE [1]
DATATYPE [2], DATATYPE [3], EXIST, GOOD_PIXELS, GT_WINDATA, GT_WINDESC, LABEL_IMAGE
PUT, READCDSFITS, SETVIEW [1], SETVIEW [2], SIGRANGE [1], SIGRANGE [2], STRPAD, TRIM
Common : None.
Restrictions: Can only be used for rasters which build up images via mirror
(and slit for GIS) movements. Otherwise, average spectra are
shown.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 10-Jun-1996, William Thompson, GSFC
Version 2, 12-Jun-1996, William Thompson, GSFC
Made more robust, added NOCLEAN keyword.
Version 3, 13-Jun-1996, William Thompson, GSFC
Added call to CDS_WAVE_LABEL.
Modified label thickness for non-PostScript output.
Version 4, 17-Jul-1996, William thompson, GSFC
Adjust label size to space available.
Change way that "invisible" plot is generated, to make
sure it really is invisible.
Version 5, 23-Jul-1996, William Thompson, GSFC
Added keywords WINDOWS, and WAVESORT.
Version 6, 19-Aug-1996, William Thompson, GSFC
Show spectra when can't show images. Added keyword
SPECTRA.
Version 7, 21-Aug-1996, William Thompson, GSFC
Added keyword WO_CR
Version 8, 19-Aug-1996, William Thompson, GSFC
Fixed bug where images appeared in one window and
caption in another, when TVDEVICE was enabled.
Version 9, 28-Oct-1996, William Thompson, GSFC
Added word SOHO to caption.
Added keyword FRACTION.
Version 10, 22-Nov-1996, William Thompson, GSFC
Handle case where only summed NIS spectrum is returned.
Version 11, 20-Dec-1996, William Thompson, GSFC
Take slit size into account in label
Version 12, 14-Jan-1997, Dominic Zarro & William Thompson, GSFC
Added keywords ROTATE, NOLABEL, NOTITLE, CHARSIZE,
CHARTHICK and QUASI_FIT.
Version 13, 20-Mar-1997, William Thompson, GSFC
Changed printed YHEIGHT for GIS when NY=1.
Version 14, 15-May-1997, CDP, RAL
Added LARGE_TITLE keyword
Version 15, 05-Jun-1997, William Thompson, GSFC
Corrected bug when full height of NIS slit is not used.
Version 16, 13-Jun-1997, William Thompson, GSFC
Make sure all images displayed at same size.
Version 17, 15-Oct-1997, William Thompson, GSFC
Filter out those images which weren't read in.
Version 18, 20-Oct-1997, William Thompson, GSFC
Added keyword /NOMISSING to CDS_CLEAN_IMAGE, in case
the missing pixel value was set with SETFLAG.
Version 19, 19-Mar-1999, William Thompson, GSFC
Added keyword /LOG. Made small improvements in
plotting of GIS spectra.
Version 20, 17-Sep-1999, William Thompson, GSFC
Made default character sizes larger on some displays
and more consistent across displays.
Version 21, 02-Nov-1999, William Thompson, GSFC
Added keyword MOSAIC.
Make window numbering from 0,...,N-1
Fixed PostScript bug introduced in version 20.
Version 22, 18-Dec-2000, William Thompson, GSFC
Improved generation of images for GIS data
Version 23, 26-Mar-2002, William Thompson, GSFC
Added keywords MIN, MAX
Version 24, 17-Jul-2003, William Thompson, GSFC
Added keyword ROLL
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_STACK
Purpose : store CDS QL structures in a pointer stack
Category : CDS planning
Syntax : IDL> cds_stack,ql,[/set,/get,file=file,/clear]
Inputs : QL = CDS QL data structure (if /GET)
Outputs : QL = retrieved structure (if /SET and FILE)
Keywords : SET = insert QL in stack
GET = retrieve filename in keyword FILE from stack
CLEAR = empty stack
FILE = string filename to retrieve
STATUS =1/0 if success/failure
MAX_SIZE= maximum size of stack [def=25]
CHECK = check if QL is saved in stack
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], DELETE_QLDS, DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4]
DPRINT, EXIST, FREE_POINTER, FREE_STACK, GET_POINTER, GET_TAG_VALUE, MAKE_POINTER
MERGE_STRUCT, NUM2STR, SET_POINTER, SHOW_STACK, TAG_EXIST [1], TAG_EXIST [2], TRIM
VALID_POINTER, VALID_QL, break_file [4], delvarx [5]
CALLED BY:
XCAT
History : Version 1, 1-Sept-1999, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_THUMBNAIL
Purpose : Makes a thumbnail sketch of images from a CDS study.
Category : CDS, Class3, Quicklook
Explanation : This procedure creates a 128x128 GIF thumbnail image from a CDS
observation. The software first tries to find one of a number
of preferred wavelengths to form the image from. If it can't
find a preferred wavelength, it uses the first window. If it
can't form an image, it makes a simple plot.
Syntax : CDS_THUMBNAIL, FILENAME [, OUTFILE ]
CDS_THUMBNAIL, DATA [, OUTFILE ]
Examples : CDS_THUMBNAIL, 's3042r00.fits'
A = READCDSFITS('s3042r00.fits')
CDS_THUMBNAIL, A
Inputs : FILENAME = Name of CDS FITS file to read in.
Opt. Inputs : DATA = A quicklook data structure as returned by
READCDSFITS.
OUTFILE = The name of the output file. The default extension
is ".gif". If not passed, the name is formed from
the name stored in the FITS header, with "_tn.gif"
appended.
Outputs : The thumbnail is written to a GIF file.
Opt. Outputs: None.
Keywords : OUTPATH = The path to write the GIF file. The default is to
write it in the current directory.
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors
are encountered, then a null string is returned. In
order to use this feature, ERRMSG must be defined
first, e.g.
ERRMSG = ''
CDS_THUMBNAIL, INPUT, ERRMSG=ERRMSG
IF ERRMSG NE '' THEN ...
Calls : ***
AVERAGE, BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CDS_CLEAN_IMAGE
DATATYPE [1], DATATYPE [2], DATATYPE [3], EXPTV, FORM_FILENAME [1]
FORM_FILENAME [2], GT_WINDATA, GT_WINDESC, LOAD_RED, READCDSFITS, SETPLOT [1]
SETPLOT [2], SIGRANGE [1], SIGRANGE [2], SSW_WRITE_GIF, TVREAD [1], TVREAD [2]
TVREAD [3], break_file [4]
Common : None.
Restrictions: Can only be used for rasters which build up images via mirror
(and slit for GIS) movements. Otherwise, average spectra are
shown.
Side effects: None.
Prev. Hist. : Partially based on CDS_SNAPSHOT
History : Version 1, 01-Jul-2005, William Thompson, GSFC
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_TILT_COR
Purpose : Produce tilt corrected CDS wavelength scale
Category : Analysis
Explanation :
Syntax : IDL> wave=cds_tilt_cor(a,window)
CALLED BY:
FIT_CDS_QL
Examples :
Inputs : A = QL structure to read
WINDOW = QL window to select
Opt. Inputs : None
Outputs : WAVE = tilt corrected wavelength
Opt. Outputs: None
Keywords : WINDOW = window to fit (input)
CALIB = set to calibrate spectra before fitting
CALLS: ***
DIMREBIN, EXIST, GET_TILTCAL, GT_CDS_WINDOW, GT_START, GT_WINDATA, PIX2WAVE, POLY
Common : None
Restrictions: None
Side effects: None
History : Version 1, 17-Jan-1998, D M Zarro. Written
Based upon SETUPAN by SVH
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_UTPLOT
Purpose : To plot time series data with sensible time axis labelling.
Explanation : Uses the routine DEF_CDS_UTPLOT to manipulate the IDL plotting
variables to set up sensible time axis labels and intervals.
After the setup the data are plotted with a normal call to
the routine PLOT.
Use : IDL> cds_utplot,x,y,timerange=[], /dmy, /log + normal plot keywords.
Inputs : x - the time variable. May be either an array of CDS internal
time structures (as produced by the
routine STR2UTC, say) or...
a string array of date/times in a
format translatable by STR2UTC.
y - the data value to be plotted.
Opt. Inputs : Various keywords.
Outputs : None
Opt. Outputs: None
Keywords : timerange - a 2-element array each element is either a CDS
internal time structure or a CDS date/time string.
Note that this time range is still adjusted
slightly for actual plotting unless the keyword
xstyle=1 is specified.
dmy - if the x-variable is a list of date/time strings
this keyword must be used if they are in the
format dd-mm(m)-yyyy as opposed to the CDS
'official' format of yyyy-mm-dd
log - make plot log-linear
+ other standard plot keywords
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DEF_CDS_UTPLOT, SEC2UTC, STR2UTC [1]
STR2UTC [2], STR2UTC [3], UTC2SEC, UTC2STR, VCHECK
CALLED BY:
CDS_PLOT_ERR, PLOT_SCI_TLM, PLOT_TEMP_POS, PLOT_VDS_BIAS, VDS_BIAS_GLITCH
Common : cds_utplot_com (for passing of time axis offset to cds_outplot)
Restrictions: The MJD of any dates used must be positive.
Any 2-character year specifications are translated as being
between 1950 and 2049 (use 4-characters as necessary).
The time array passed to CDS_UTPLOT must be in ascending order
of time - sort it if necessary!
Side effects: None
Category : Data display, plotting
Prev. Hist. : This is a severely trimmed version of the old UTPLOT as used on
Yohkoh and developed by Tolbert, Schwartz and Morrison.
I may have trimmed too much, please let me know.
Written : This version for CDS by C D Pike, RAL, 20-Apr-94
Modified : Version 1, C D Pike, RAL, 20-Apr-94
Version 2, William Thompson, GSFC, 14 November 1994
Modified .DAY to .MJD
Version 3, Add /log keyword. CDP, 18-Sep-95
Version 4, Fix bug when specifying <10 days timerange. 7-Dec-95
Version 5, Add xminor keyword. CDP, 25-Mar-96
Version 6, Name change. CDP, 2-Oct-96
Version : Version 6, 2-Oct-96
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_UTSTRING
Purpose : To overprint a string on a UTPLOT graph
Explanation : Converts input x-variable to seconds, applies the time offset
stored in common and overprints data on a plot created by
UTPLOT.
Use : IDL> cds_utstring, x, y, string
Inputs : x - the time location. May be either an array of CDS internal
time structures (as produced by the
routine STR2UTC, say) or...
a string array of date/times in a
format translatable by STR2UTC.
y - the data value location of the text
string - the string to print on the plot
Opt. Inputs : Various keywords.
Outputs : None
Opt. Outputs: None
Keywords : dmy - if the x-variable is a list of date/time strings
this keyword must be used if they are in the
format dd-mm(m)-yyyy as opposed to the CDS
'official' format of yyyy-mm-dd
charsize - usual character size parameter
orientation - usual character orientation parameter
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], STR2UTC [1], STR2UTC [2], STR2UTC [3]
UTC2SEC, VCHECK
CALLED BY:
PLOT_TEMP_POS, VDS_BIAS_GLITCH
Common : cds_utplot_com (for passing of time axis offset to outplot)
Restrictions: Any 2-character year specifications are translated as being
between 1950 and 2049 (use 4-characters as necessary).
Side effects: None
Category : Data display, plotting
Prev. Hist. : None
Written : C D Pike, RAL, 3-Feb-95
Modified : Name change. CDP, 2-Oct-96
Version : Version 2, 2-Oct-96
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_VEL_SLICE
Purpose : To display a single spectrum from a data cube with user
selectable inputs.
Explanation : The procedure takes a data structure (or fits file name) and
lists a summary of the data available in it. It then offers
the user a variety of options in order to specify the exact
details of the spectrum required (eg. band or window, raster,
det-y, and wavelength or pixel range).
Use : IDL> plot_spec,file_str
Inputs : file_str - either:- the name of a CDS FITS file
or:- the name of a CDS data structure
(a data structure is the faster option!)
Opt. Inputs : None
Outputs : None (just plots a spectrum in the default window)
Opt. Outputs: None
Keywords : None
Calls : ***
ANYTIM2CAL, BJ_ERR, CDS_VEL_PLOT, SPLINE, TAI2UTC
Common : None
Restrictions: None
Side effects: None
Category : Data_handling, FITS
Prev. Hist. : None
Written : B J Kellett, 15-Nov-95.
Modified :
Version : Version 1, 15-Nov-95.
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_VEL_SLICE ()
Purpose : To display a single spectrum from a data cube with user
selectable inputs.
Explanation : The procedure takes a data structure (or fits file name) and
lists a summary of the data available in it. It then offers
the user a variety of options in order to specify the exact
details of the spectrum required (eg. band or window, raster,
det-y, and wavelength or pixel range).
Use : IDL> plot_spec,file_str
Inputs : file_str - either:- the name of a CDS FITS file
or:- the name of a CDS data structure
(a data structure is the faster option!)
Opt. Inputs : None
Outputs : None (just plots a spectrum in the default window)
Opt. Outputs: None
Keywords : None
Calls : ***
CDS_FIT_WAVE, CDS_PLOT_FIT, CDS_SLINE, CDS_VEL_PLOT, CONCAT_DIR [1]
CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2], DATATYPE [3], DEV_PS
FILE_EXIST [2], GT_SPECTRUM, GT_WLIMITS, INT2UTC, LOADCT, OUT_PS, QLMGR, READCDSFITS
TAI2UTC, UTC2DOY, UTC2INT [1], UTC2INT [2], UTC2INT [3], YDECODE, concat_dir [4]
file_exist [1], file_exist [3]
Common : None
Restrictions: None
Side effects: None
Category : Data_handling, FITS
Prev. Hist. : None
Written : B J Kellett, 15-Nov-95.
Modified :
Version : Version 1, 15-Nov-95.
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_WAVE_CAT()
Purpose : Find data extraction windows that match a given input.
Explanation : Looks up windows for the given element. If an ionisation
number is specified, it will pick out the matches for both
the given element and ionization number. If a wavelength
is also specified the windows which match all three will be
found along with the general extraction windows (WW_...)
whose wavelengths match the specified wavelength.
If just a wavelength is specified it will find windows that
match solely in wavelength.
Use : IDL> win = cds_wave_cat(elem, ion, wave)
Inputs : elem - The element being searched for. 1 or 2 characters
e.g. 'Fe'
Opt. Inputs : ion - The ionization stage being searched for. An integer.
wave - The wavelength being searched for. Between 300 &
650 Angstroms
Outputs : Function returns Window names which are a match for the
given input data.
Opt. Outputs: None
Keywords : Range - wavelength search range (default +/- 1.5A)
Quiet - if set, no screen output.
Calls : ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], FILE_EXIST [2], PRINT_STR, RD_ASCII [1], RD_ASCII [2], STR2ARR [1]
STR2ARR [2], TRIM, concat_dir [4], file_exist [1], file_exist [3]
Common : None
Restrictions: None
Side effects: None
Category : Catalogues
Prev. Hist. : None
Written : A N Pike, RAL, 21/07/98
Modified : Fix IDL v4 bug, ANP, 3/9/98
Version : Version 2, 3/09/98
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_WAVE_FILES()
Purpose : Find data files which contain named data window(s).
Explanation : Returns the names of datafiles whose line list
contains ALL the input line IDs.
Use : IDL> f = cds_wave_files(line_id)
eg
f= cds_wave_files(['Al_10','Fe','Ca_10_557'])
Inputs : line id - The line(s) being searched for. Can be array
Opt. Inputs : None
Outputs : Function returns the filenames in which the windows
can be found.
Opt. Outputs: None
Keywords : None
Calls : ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FILE_EXIST [2], PRINT_STR, TRIM
concat_dir [4], file_exist [1], file_exist [3]
Common : None
Restrictions: None
Side effects: None
Category : Catalogues
Prev. Hist. : None
Written : A N Pike, RAL, 27/07/98
Modified : Corrected bug 10/08/98
Version : Version 2, 10/08/98
[Previous]
[Next]
Project : SOHO - CDS
Name : CDS_WAVE_LABEL()
Purpose : Converts CDS wavelength labels into a nicer format
Category : CDS, Class4, String
Explanation : Takes CDS labels such as "SI_12_520_69" and converts them into
a nicer format (e.g. "Si XII 520.69 A") for use in plot titles
and the like. Alternate forms supported are "BB_*" (broad
band) and "WW_*" (wavelength).
Syntax : Result = CDS_WAVE_LABEL( LABEL )
CALLED BY:
CDS_SNAPSHOT, MK_CDS_IMAP, MK_CDS_SMAP
Examples : A = READCDSFITS('s2707r00.fits')
AA = REFORM(DETDATA(A,1))
EXPTV, AA
DD = DETDESC(A,1)
LABEL_IMAGE, CDS_WAVE_LABEL(DD.LABEL)
Inputs : LABEL = The window label from the CDS FITS file, stored in a
TTYPEn keyword.
Opt. Inputs : None.
Outputs : The result of the function is the modified label.
Opt. Outputs: None.
Keywords : None.
Calls : ***
ROMAN, STR_SEP
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : Based partially on a routine called cnv_label by Bob Bentley.
History : Version 1, 03-Jul-1996, William Thompson, GSFC
Version 2, 19-Aug-1996, William Thompson, GSFC
Made more robust.
Version 3, 20-Jan-1998, Vincenzo Andretta, NRC/GSFC
Handles case of concatenated labels.
Contact : WTHOMPSON
[Previous]
[Next]
NAME:
CDSCONGRID
PURPOSE:
Shrink/expand the size of an array by an arbitrary amount.
EXPLANATION:
This IDL procedure simulates the action of the VAX/VMS
CONGRID/CONGRIDI function.
This function is similar to "REBIN" in that it can resize a
one, two, or three dimensional array. "REBIN", however,
requires that the new array size must be an integer multiple
of the original size. CDSCONGRID will resize an array to any
arbitrary size (REBIN is somewhat faster, however).
REBIN averages multiple points when shrinking an array,
while CDSCONGRID just resamples the array.
CATEGORY:
Array Manipulation.
CALLING SEQUENCE:
array = CDSCONGRID(array, x, y, z)
INPUTS:
array: A 1, 2, or 3 dimensional array to resize.
Data Type : Any type except string or structure.
x: The new X dimension of the resized array.
Data Type : Int or Long (greater than or equal to 2).
OPTIONAL INPUTS:
y: The new Y dimension of the resized array. If the original
array has only 1 dimension then y is ignored. If the
original array has 2 or 3 dimensions then y MUST be present.
z: The new Z dimension of the resized array. If the original
array has only 1 or 2 dimensions then z is ignored. If the
original array has 3 dimensions then z MUST be present.
KEYWORD PARAMETERS:
INTERP: If set, causes linear interpolation to be used.
Otherwise, the nearest-neighbor method is used.
CUBIC: If set, uses "Cubic convolution" interpolation. A more
accurate, but more time-consuming, form of interpolation.
CUBIC has no effect when used with 3 dimensional arrays.
MINUS_ONE:
If set, will prevent CDSCONGRID from extrapolating one row or
column beyond the bounds of the input array. For example,
If the input array has the dimensions (i, j) and the
output array has the dimensions (x, y), then by
default the array is resampled by a factor of (i/x)
in the X direction and (j/y) in the Y direction.
If MINUS_ONE is present (AND IS NON-ZERO) then the array
will be resampled by the factors (i-1)/(x-1) and (j-1)/(y-1).
OUTPUTS:
The returned array has the same number of dimensions as the original
array and is of the same data type. The returned array will have
the dimensions (x), (x, y), or (x, y, z) depending on how many
dimensions the input array had.
CALLED BY:
CW_PZOOM [1], DSPEXP, PQLZOOM, PTEST, cw_pzoom [2]
PROCEDURE:
IF the input array has three dimensions, or if INTERP is set,
then the IDL interpolate function is used to interpolate the
data values.
If the input array has two dimensions, and INTERP is NOT set,
then the IDL POLY_2D function is used for nearest neighbor sampling.
If the input array has one dimension, and INTERP is NOT set,
then nearest neighbor sampling is used.
CALLS: ***
CDSROUND
EXAMPLE:
; vol is a 3-D array with the dimensions (80, 100, 57)
; Resize vol to be a (90, 90, 80) array
vol = CDSCONGRID(vol, 90, 90, 80)
MODIFICATION HISTORY:
DMS, Sept. 1988.
DMS, Added the MINUS_ONE keyword, Sept. 1992.
Daniel Carr. Re-wrote to handle one and three dimensional arrays
using INTERPOLATE function.
DMS, RSI, Nov, 1993. Added CUBIC keyword.
SVHH, UiO, May 1994. Included in CDS project with name
changed from CONGRID. Also fixed the problem noted that
an interpolated image seemed shifted half a pixel if
interpolation was used.
Modified usage of CUBIC keyword in call to INTERPOLATE,
to enable use on IDL v 3.0
[Previous]
[Next]
Project : SOHO - CDS
Name : CDSFOV
Purpose : Plots given (x,y) in CDS Field Of View
Explanation : Illustrates location of intended (X,Y) pointing location
in current CDS FOV. Any program wishing to know whether
an (X,Y) position is valid should use the GET_OPS_POINT
function.
Use : IDL> cdsfov,solar_x,solar_y [,tit='My Object',range=[-1000,0]]
Inputs : solar_x - X location in arcsecs from Sun centre
solar_y - Y location in arcsecs from Sun centre.
Both inputs can be scalar or arrays.
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : TITLE - set user title to plot. Default = 'CDS Field of View'
RANGE - 2 element array to set X/Y range of plot
(same in both axes)
SYM - set plot symbol number (default 8)
OVER - overplots some new data
Calls : ***
CIRCLE_SYM, OPS_POINT, VALID_CDS_POINT
Common : fov_com - saves database access
Restrictions: None
Side effects: None
Category : Operations
Prev. Hist. : None
Written : C D Pike, RAL, 28-Jun-96
Modified : Shrink plot symbol if gt 9 locations to plot. CDP, 24-Mar-97
Sort 32K limit on loop, add SYM keyword. CDP, 20-Jun-97
Add OVER keyword. CDP, 10-Jul-97
Do not recreate window if already correct size.
CDP, 10-Jul-97
Tidy if sending to PS. CDP, 21-Jan-99
Version : Version 6, 21-Jan-99
[Previous]
[Next]
Project : SOHO - CDS
Name : CDSHEADFITS()
Purpose : Read a FITS file header record
Explanation : Reads a FITS file header record.
Use : Result = headfits( filename ,[ EXTEN = ])
CALLED BY:
CAT_DURATION, MK_HEAD_CAT
Example: Read the FITS header of a file 'test.fits' into a
string variable, h
IDL> h = headfits( 'test.fits')
Inputs : FILE_IN = String containing the name of the FITS file to be
read.
Opt. Inputs : None.
Outputs : Result of function = FITS header, string array
Opt. Outputs: None.
Keywords : EXTEN = integer scalar, specifying which FITS extension to
read. For example, to read the header of the first
extension set EXTEN = 1. Default is to read the
primary FITS header (EXTEN = 0).
Calls : ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3]
OS_FAMILY, RM_FILE, SXPAR [1], SXPAR [2], SXPAR [3], TEST_OPEN, break_file [4]
concat_dir [4]
Common : None.
Restrictions: None.
Side effects: None.
Category : Utilities, FITS.
Prev. Hist. :
adapted by Frank Varosi from READFITS by Jim Wofford, January, 24 1989
Keyword EXTEN added, K.Venkatakrishna, May 1992
Make sure first 8 characters are 'SIMPLE' W. Landsman October 1993
Written : Frank Varosi, GSFC, 24 January 1989
Modified : Version 1, Liyun Wang, GSFC/ARC, September 19, 1994
Incorporated into CDS library
Version 2, William Thompson, GSFC/ARC, 9 January 1995
Incorporated following change:
Check PCOUNT and GCOUNT W. Landsman December 1994
Version 3, CDP, 17-nov-95
Search for file in standard CDS fits directory
or current and stop it crashing if file not found.
Version 4, CDP, 21-Nov-95
Make input file spec a scalar.
Version 5, CDP, allow default extension of ".fits"
Version 6, From HEADFITS, to allow CDS specific. CDP, 1-Aug-96
Version 7, Trap no file to read. CDP, 20-Nov-96
Version 8, Sort the header. CDP, 12-Sep-97
Version 9, Use useful return if error rather than message. CDP, 11-Jun-98
Version 10, To handle compressed FITS files. CDP, 8-Jun-99
Version : Version 10, 8-Jun-99
[Previous]
[Next]
Project : SOHO - CDS
Name : CDSLOG
Purpose : Accumulate messages from other routines, option to save
Explanation : Creates a window in the lower right corner of the
screen with a text area to show lines with
the logged information (intensities etc...)
Normally, the window pops up in front (also from
iconified state) to show the text. This may be
turned off.
Use : CDSLOG,'Text to be logged'
Inputs : The message text
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : BELL: Set to cause a bell after the text is displayed
Calls : ***
Bell, CDSLOG_CLEANUP, CDSLOG_EVENT, DATATYPE [1], DATATYPE [2], DATATYPE [3]
PICKFILE, XMANAGER, XMENU [1], XMENU [2], XREGISTERED
CALLED BY:
DSPEXP, GDSPSPEC, NDSPSPEC, PICK_LINE, dsp_menu
Common : CDSLOG
Restrictions:
Side effects:
Category : CDS,QL,DISPLAY,UTIL
Prev. Hist. : Adapted from CDSNOTIFY
Written : SVHH, February 1994
Modified : SVHH, March 1994
Made it ignore group (leader) - in case
it's invoked first by a sub-application.
SVHH, 12 April 1994
Fixed the procedure to add (append) messages
Version : 1.0
[Previous]
[Next]
Project : SOHO - CDS
Name : CDSLOGO
Purpose : Puts a CDS logo in one corner of a PostScript plot
Category : CDS, Graphics, Class5
Explanation : Puts the CDS logo in one corner of a PostScript plot. The
default is to put it in the lower right corner.
Syntax : CDSLOGO
Examples : A line like the following should be placed near the end of a
plot-producing routine.
IF !D.NAME EQ 'PS' THEN CDSLOGO
Inputs : None.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : LEFT = If set, then the logo is put in the left corner
rather than the right.
TOP = If set, then the logo is put in the top corner rather
than the bottom.
SIZE = Size to use in displaying the image. The default
size is 3.
Calls : ***
FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3], READ_GIF
Common : None.
Restrictions: Should only be used with PostScript output. Requires that the
file cdslogo.png be available somewhere in the IDL path.
Side effects: Changes the color table.
Prev. Hist. : None.
History : Version 1, 25-Mar-1996, William Thompson, GSFC
Version 2, 24-Oct-2000, William Thompson, GSFC
Use PNG file instead of GIF file,
but only for version 5.4 or above.
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : CDSLR2XY()
Purpose : Calculates solar (x,y) values for given OPS position.
Explanation : Wrapper for the OPS_POINT routine.
Use : IDL> print,cdslr2xy(opsl,opsr)
Inputs : opsl - the OPS left leg value
opsr - the OPS right leg value
Both may be either scalar or arrays.
Opt. Inputs : None
Outputs : Function returns solar (x,y) values in an array (n,2) where
n is the number of input positions. If n=1 then a simple
2-element array is returned.
Opt. Outputs: None
Keywords : None
Calls : ***
OPS_POINT
CALLED BY:
LOCATE_FFCAL
Common : None
Restrictions: None
Side effects: None
Category : Operations
Prev. Hist. : None
Written : C D Pike, RAL, 28-Jun-96
Modified :
Version : Version 1, 28-Jun-96
[Previous]
[Next]
Project : SOHO - CDS
Name : CDSNOTIFY
Purpose : Display a message to the user.
Explanation : Creates a window in the upper right corner of the
screen with a text area to show lines with
information to the CDS QuickLook user.
Use : CDSNOTIFY,'Message'
Inputs : The message text
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : BELL: Set to cause a beep.
Calls : ***
Bell, CDSNOTIFY_EVENT, DATATYPE [1], DATATYPE [2], DATATYPE [3], XMANAGER
XREGISTERED
CALLED BY:
DSPEXP, DSPWAV, FIND_SERTSW, GDSPSPEC, NDSPSPEC, PICK_LINE, PQLPROFILE, PQLZOOM
QL_RD_LLIST, TLB_PLACE, dsp_menu
Common : CDSNOTIFY
Restrictions:
Side effects:
Category : CDS, QL, DISPLAY, UTIL
Prev. Hist. : None.
Written : SVHH, January 1994
Modified :
Version : 1.0
[Previous]
[Next]
NAME:
CDSPICKFILE
PURPOSE:
This function allows the user to interactively pick a file.
EXPLANATION:
A file selection tool with a graphical user interface is created.
Files can be selected from the current directory or other directories.
CATEGORY:
Widgets.
CALLING SEQUENCE:
Result = CDSPICKFILE()
KEYWORD PARAMETERS:
FILE: A string value for setting the initial value of the
selection. Useful if there is a default file
GET_PATH: Set to a named variable. Returns the path at the
time of selection.
GROUP: The widget ID of the widget that calls CDSPICKFILE. When this
ID is specified, a death of the caller results in the death of
the CDSPICKFILE widget application.
READ: Set this keyword to make the title of the CDSPICKFILE window
"Select File to Read".
WRITE: Set this keyword to make the title of the CDSPICKFILE window
"Select File to Write".
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.
The user can modify the filter unless the FIX_FILTER keyword
is set. Example filter values might be "*.pro" or "*.dat".
FIX_FILTER: When this keyword is set, only files that satisfy the
filter can be selected. The user has no ability to modify
the filter and the filter is not shown.
TITLE: A scalar string to be used for the window title. If it is
not specified, the default title is "Select File"
NOCONFIRM: Return immediately upon selection of a file. The default
behavior is to display the selection and then return the
file when the user uses the "ok" button.
MUST_EXIST: When set, only files that actually exist can be selected.
OUTPUTS:
CDSPICKFILE returns a string that contains the name of the file selected.
If no file is selected, CDSPICKFILE returns a null string.
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CDSPICKFILE_EV, FIND_FILE, GETDIRS, GETFILES
OS_PICKFILE, VALID_DIR, XDISPLAYFILE [1], XDISPLAYFILE [2], XMANAGER, XREGISTERED
CALLED BY:
DSPWAV, GDSPSPEC, PQLPROFILE, QL_MENU, WPLOT_NONOP, WPLOT_SUBHTR [2]
COMMON BLOCKS:
CDSPICKER: COMMON block that maintains state for the widget.
SIDE EFFECTS:
This function initiates the XMANAGER if it is not already running.
RESTRICTIONS:
This routine is known to work on Suns (OPEN LOOK), MIPS, RS/6000,
DEC Ultrix, HP/700, VAX/VMS and SGI machines.
Only one instance of the CDSPICKFILE widget can be running at one time.
CDSPICKFILE does not recognize symbolic links to other files in UNIX.
PROCEDURE:
Create and register the widget and then exit, returning the filename
that was picked.
EXAMPLE:
Create a CDSPICKFILE widget that lets users select only files with
the extensions 'pro' and 'dat'. Use the 'Select File to Read' title
and store the name of the selected file in the variable F. Enter:
F = CDSPICKFILE(/READ, FILTER = '*.pro *.dat')
MODIFICATION HISTORY:
Written by: Steve Richards, April, 1991
July, 1991 Added a FILTER keyword to allow users
to select files with a given extension or
extensions.
August, 1991 Fixed bugs caused by differences between
spawned ls commands on different machines.
September, 1991 Made Myfindfile so only one pass was
necessary to find files and directories.
3/92 - ACY Corrected initialization of dirsave, change spawn
command to "ls -lL" and added case for links
add NOCONFIRM keyword for auto exiting on selection
8/92 - SMR Rewrote cdspickfile as a compound widget.
10/92 - SMR Fixed a bug where extremely large file namess didn't
show up properly in the file list or as return
values.
12/92 - JWG Add better machine dependency code
1/93 - JWG Added FILE, GET_PATH keywords.
1/93 - TAC Added Windows Common dialog cdspickfile code
2/93 - SMR Fixed the documentation example for multiple extensions
3-MAR-1996 PB Added button to toggle between sorting on time or name
12-Mar-1996 SVHH Added support for *looong* file lists (using
find_file).
17-Jun-1996 DMZ Fixed small bug in VMS findfile branch
[Previous]
[Next]
Project : SOHO - CDS
Name : CDSXY2LR()
Purpose : Calculates CDS OPS values for given solar (X,Y) position.
Explanation : Wrapper for the GET_OPS_POS routine.
Use : IDL> print,cdsxy2lr(xpos,ypos)
Inputs : xpos - solar_X value in arcsecs from sun centre.
ypos - solar_Y value in arcsecs from sun centre.
Both may be either scalar or arrays.
Opt. Inputs : None
Outputs : Function returns OPSL/R values in an array (n,2) where
n is the number of input positions. If n=1 then a simple
2-element array is returned.
Opt. Outputs: None
Keywords : None
Calls : ***
GET_OPS_POS
CALLED BY:
BP_SEEK_POS
Common : None
Restrictions: None
Side effects: None
Category : Operations
Prev. Hist. : None
Written : C D Pike, RAL, 28-Jun-96
Modified :
Version : Version 1, 28-Jun-96
[Previous]
[Next]
NAME:
CENTERTLB
PURPOSE:
This is a utility routine to position a widget program
on the display at an arbitrary location. By default the
widget is centered on the display.
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:
Utilities
CALLING SEQUENCE:
CenterTLB, tlb, [x, y, /NOCENTER]
REQUIRED INPUTS:
tlb: The top-level base identifier of the widget program.
OPTIONAL INPUTS:
x: Set this equal to a normalized position for the center
of the widget as measured from the left-hand side of the screen.
The default value is 0.5 (the center) Setting this equal to 1.0
places the widget at the far right-hand side of the screen.
y: Set this equal to a normalized position for the center
of the widget as measured from the bottom of the screen.
The default value is 0.5 (the center) Setting this equal to 1.0
places the widget at the top of the screen.
KEYWORDS:
NOCENTER: By default, the center of the widget is positioned at the
location specified by the x and y parameters. If NOCENTER is set
to a non-zero value, then the upper left corner of the widget
is postioned at the specifed location.
CALLS: ***
GET_SCREEN_SIZE
CALLED BY:
FSC_WINDOW
PROCEDURE:
The program should be called after all the widgets have
been created, but just before the widget hierarchy is realized.
It uses the top-level base geometry along with the display size
to calculate offsets for the top-level base that will center the
top-level base on the display.
COMMENT:
Regardless of the values set for x, y and NOCENTER, the widget
is not permitted to run off the display.
MODIFICATION HISTORY:
Written by: Dick Jackson, 12 Dec 98.
Modified to use device-independent Get_Screen_Size
function. 31 Jan 2000. DWF.
Added x, y, NOCENTER and run-off protection. 26 Jan 2001. BT.
###########################################################################
LICENSE
This software is OSI Certified Open Source Software.
OSI Certified is a certification mark of the Open Source Initiative.
Copyright © 1998-2000 Fanning Software Consulting
This software is provided "as-is", without any express or
implied warranty. In no event will the authors be held liable
for any damages arising from the use of this software.
Permission is granted to anyone to use this software for any
purpose, including commercial applications, and to alter it and
redistribute it freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must
not claim you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation
would be appreciated, but is not required.
2. Altered source versions must be plainly marked as such, and must
not be misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
For more information on Open Source Software, visit the Open Source
web site: http://www.opensource.org .
###########################################################################
[Previous]
[Next]
NAME:
CENTROIDW
PURPOSE:
Calculate the weighted average of ARRAY
CATEGORY:
CALLING SEQUENCE:
CENTROID,ARRAY,XCEN,YCEN
INPUTS:
ARRAY = Rectangular input array of any type except string
OUTPUTS:
XCEN = weighted average of X values
YCEN = weighted average of Y values
CALLED BY:
H_VS_TIME, SPOTTER, fit_limb, ocenter, ssw_find_transit
COMMON BLOCKS:
NONE.
SIDE EFFECTS:
NONE.
PROCEDURE:
MODIFICATION HISTORY:
VERSION 1.0, Written J. R. Lemen, 11 Feb 1991
[Previous]
[Next]
Project : SOHO - CDS
Name : CF_174LG
Purpose : To relocate ghosts
Explanation : When called by GHOST_BUSTER, relocates ghosted lines
automatically back to parent line.
Use : only works in call from ghost_buster
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
Opt. Inputs : PLOT = Plots the fits.
Outputs : QLDS, corrected for some ghosts.
Opt. Outputs: None.
Keywords :
Calls : ***
CFIT, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DSPLINE, GIS_ARM, GT_WINDATA
HANNING, MGAUSS, PAUSE [1], ST_WINDATA, concat_dir [4], pause [2], restgen [1]
restgen [2]
CALLED BY:
GHOST_BUSTER
Common : None.
Restrictions: None.
Side effects: None.
Still To Do :
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Carl Foley, caf@mssl.ucl.ac.uk August 2003
Modified :
Version : 1.
[Previous]
[Next]
Project : SOHO - CDS
Name : CF_177LG
Purpose : To relocate ghosts
Explanation : When called by GHOST_BUSTER, relocates ghosted lines
automatically back to parent line.
Use : only works in call from ghost_buster
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
Opt. Inputs : PLOT = Plots the fits.
Outputs : QLDS, corrected for some ghosts.
Opt. Outputs: None.
Keywords :
Calls : ***
CFIT, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DSPLINE, GIS_ARM, GT_WINDATA
HANNING, MGAUSS, PAUSE [1], ST_WINDATA, concat_dir [4], pause [2], restgen [1]
restgen [2]
CALLED BY:
GHOST_BUSTER
Common : None.
Restrictions: None.
Side effects: None.
Still To Do :
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Carl Foley, caf@mssl.ucl.ac.uk August 2003
Modified :
Version : 1.
[Previous]
[Next]
Project : SOHO - CDS
Name : CF_180LG
Purpose : To relocate ghosts
Explanation : When called by GHOST_BUSTER, relocates ghosted lines
automatically back to parent line.
Use : only works in call from ghost_buster
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
Opt. Inputs : PLOT = Plots the fits.
Outputs : QLDS, corrected for some ghosts.
Opt. Outputs: None.
Keywords :
Calls : ***
CFIT, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DSPLINE, GIS_ARM, GT_WINDATA
HANNING, MGAUSS, PAUSE [1], ST_WINDATA, concat_dir [4], pause [2], restgen [1]
restgen [2]
CALLED BY:
GHOST_BUSTER
Common : None.
Restrictions: None.
Side effects: None.
Still To Do :
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Carl Foley, caf@mssl.ucl.ac.uk August 2003
Modified :
Version : 1.
[Previous]
[Next]
Project : SOHO - CDS
Name : CF_765LG
Purpose : To relocate ghosts
Explanation : When called by GHOST_BUSTER, relocates ghosted lines
automatically back to parent line.
Use : only works in call from ghost_buster
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
Opt. Inputs : PLOT = Plots the fits.
Outputs : QLDS, corrected for some ghosts.
Opt. Outputs: None.
Keywords :
Calls : ***
CFIT, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DSPLINE, GIS_ARM, GT_WINDATA
HANNING, MGAUSS, PAUSE [1], PIX2WAVE, ST_WINDATA, concat_dir [4], pause [2]
restgen [1], restgen [2]
CALLED BY:
GHOST_BUSTER
Common : None.
Restrictions: None.
Side effects: None.
Still To Do :
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Carl Foley, caf@mssl.ucl.ac.uk August 2003
Modified : Mon Oct 4 12:56:10 BST 2004, caf
Improved the fit.
Version : 1.
[Previous]
[Next]
Project : SOHO - CDS
Name : CF_770LG
Purpose : To relocate ghosts
Explanation : When called by GHOST_BUSTER, relocates ghosted lines
automatically back to parent line.
Use : only works in call from ghost_buster
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
Opt. Inputs : PLOT = Plots the fits.
Outputs : QLDS, corrected for some ghosts.
Opt. Outputs: None.
Keywords :
Calls : ***
CFIT, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DSPLINE, GIS_ARM, GT_WINDATA
HANNING, MGAUSS, PAUSE [1], PIX2WAVE, ST_WINDATA, concat_dir [4], pause [2]
restgen [1], restgen [2]
CALLED BY:
GHOST_BUSTER
Common : None.
Restrictions: None.
Side effects: None.
Still To Do :
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Carl Foley, caf@mssl.ucl.ac.uk August 2003
Modified :
Version : 1.
[Previous]
[Next]
Project : SOHO - CDS
Name : CF_GIS1A
Purpose : To fit a region of the GIS spectra
Explanation : When called by GIS_FIT, automatically fits well known GIS lines
Use : gisfit=cf_gis1a(qlds,/plot)
gisfit=cf_gis1a(gisfit)
gisfit=cf_gis1a(gisfit,/plot)
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
Opt. Inputs : PLOT = Plots the fits.
Outputs : QLDS, corrected for some ghosts.
Opt. Outputs: None.
Keywords :
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CFIT, CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4], FIND_FILE
GIS_ERROR, GT_WINDATA, INT2UTC, LOAD_WAVECAL, PIX2WAVE, TAG_EXIST [1], TAG_EXIST [2]
WRT_ASCII, concat_dir [4], delvarx [5], restgen [1], restgen [2]
CALLED BY:
GIS_FIT
Common : None.
Restrictions: None.
Side effects: None.
Still To Do :
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Carl Foley, caf@mssl.ucl.ac.uk August 2003
Modified : CAF : v1.1, caf, Mon Sep 22 2003
Changed the format of the output structure so that it only
consists of anonymous structures, to avoid conflicts.
Version : 1.1
[Previous]
[Next]
Project : SOHO - CDS
Name : CF_GIS1B
Purpose : To fit a region of the GIS spectra
Explanation : When called by GIS_FIT, automatically fits well known GIS lines
Use : gisfit=cf_gis1b(qlds,/plot)
gisfit=cf_gis1b(gisfit)
gisfit=cf_gis1b(gisfit,/plot)
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
gisfit = Output structure from GIS_UTPLOT or one of the
cf_gis fitting routines.
Opt. Inputs : PLOT = Plots the fits.
Outputs : QLDS, corrected for some ghosts.
Opt. Outputs: None.
Keywords :
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CFIT, CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4], FIND_FILE
GIS_ERROR, GT_WINDATA, INT2UTC, LOAD_WAVECAL, PIX2WAVE, TAG_EXIST [1], TAG_EXIST [2]
WRT_ASCII, concat_dir [4], delvarx [5], restgen [1], restgen [2]
CALLED BY:
GIS_FIT
Common : None.
Restrictions: None.
Side effects: None.
Still To Do :
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Carl Foley, caf@mssl.ucl.ac.uk August 2003
Modified : v1.1, caf, Mon Sep 22 2003
Changed the format of the output structure so that it only
consists of anonymous structures, to avoid conflicts.
Version : 1.1
[Previous]
[Next]
Project : SOHO - CDS
Name : CF_GIS1C
Purpose : To fit a region of the GIS spectra
Explanation : When called by GIS_FIT, automatically fits well known GIS lines
Use : gisfit=cf_gis1c(qlds,/plot)
gisfit=cf_gis1c(gisfit)
gisfit=cf_gis1c(gisfit,/plot)
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
gisfit = Output structure from GIS_UTPLOT or one of the
cf_gis fitting routines.
Opt. Inputs : PLOT = Plots the fits.
Outputs : QLDS, corrected for some ghosts.
Opt. Outputs: None.
Keywords :
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CFIT, CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4], FIND_FILE
GIS_ERROR, GT_WINDATA, INT2UTC, LOAD_WAVECAL, PAUSE [1], PIX2WAVE, TAG_EXIST [1]
TAG_EXIST [2], WRT_ASCII, concat_dir [4], delvarx [5], pause [2], restgen [1]
restgen [2]
CALLED BY:
GIS_FIT
Common : None.
Restrictions: None.
Side effects: None.
Still To Do :
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Carl Foley, caf@mssl.ucl.ac.uk August 2003
Modified : v1.1, caf, Mon Sep 22 2003
Changed the format of the output structure so that it only
consists of anonymous structures, to avoid conflicts.
Version : 1.1
[Previous]
[Next]
Project : SOHO - CDS
Name : CF_GIS2A
Purpose : To fit a region of the GIS spectra
Explanation : When called by GIS_FIT, automatically fits well known GIS lines
Use : gisfit=cf_gis4a(qlds,/plot)
gisfit=cf_gis4a(gisfit)
gisfit=cf_gis4a(gisfit,/plot)
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
gisfit = Output structure from GIS_UTPLOT or one of the
cf_gis fitting routines.
Opt. Inputs : PLOT = Plots the fits.
Outputs : QLDS, corrected for some ghosts.
Opt. Outputs: None.
Keywords :
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CFIT, CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4], FIND_FILE
GIS_ERROR, GT_WINDATA, INT2UTC, LOAD_WAVECAL, PIX2WAVE, TAG_EXIST [1], TAG_EXIST [2]
WRT_ASCII, concat_dir [4], delvarx [5], restgen [1], restgen [2]
CALLED BY:
GIS_FIT
Common : None.
Restrictions: None.
Side effects: None.
Still To Do :
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Carl Foley, caf@mssl.ucl.ac.uk August 2003
Modified : v1.1, caf, Mon Sep 22 2003
Changed the format of the output structure so that it only
consists of anonymous structures, to avoid conflicts.
Version : 1.1
[Previous]
[Next]
Project : SOHO - CDS
Name : CF_GIS2A
Purpose : To fit a region of the GIS spectra
Explanation : When called by GIS_FIT, automatically fits well known GIS lines
Use : gisfit=cf_gis4a(qlds,/plot)
gisfit=cf_gis4a(gisfit)
gisfit=cf_gis4a(gisfit,/plot)
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
gisfit = Output structure from GIS_UTPLOT or one of the
cf_gis fitting routines.
Opt. Inputs : PLOT = Plots the fits.
Outputs : QLDS, corrected for some ghosts.
Opt. Outputs: None.
Keywords :
Calls :
CALLED BY:
GIS_FIT
Common : None.
Restrictions: None.
Side effects: None.
Still To Do :
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Carl Foley, caf@mssl.ucl.ac.uk August 2003
Modified : v1.1, caf, Mon Sep 22 2003
Changed the format of the output structure so that it only
consists of anonymous structures, to avoid conflicts.
Version : 1.1
[Previous]
[Next]
Project : SOHO - CDS
Name : CF_GIS4A
Purpose : To fit a region of the GIS spectra
Explanation : When called by GIS_FIT, automatically fits well known GIS lines
Use : gisfit=cf_gis4a(qlds,/plot)
gisfit=cf_gis4a(gisfit)
gisfit=cf_gis4a(gisfit,/plot)
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
gisfit = Output structure from GIS_UTPLOT or one of the
cf_gis fitting routines.
Opt. Inputs : PLOT = Plots the fits.
Outputs : QLDS, corrected for some ghosts.
Opt. Outputs: None.
Keywords :
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CFIT, CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4], FIND_FILE
GIS_ERROR, GT_WINDATA, INT2UTC, LOAD_WAVECAL, PIX2WAVE, TAG_EXIST [1], TAG_EXIST [2]
WRT_ASCII, concat_dir [4], delvarx [5], restgen [1], restgen [2]
CALLED BY:
GIS_FIT
Common : None.
Restrictions: None.
Side effects: None.
Still To Do :
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Carl Foley, caf@mssl.ucl.ac.uk August 2003
Modified : v1.1, caf, Mon Sep 22 2003
Changed the format of the output structure so that it only
consists of anonymous structures, to avoid conflicts.
Version : 1.1
[Previous]
[Next]
Project : SOHO - CDS
Name : CF_GIS4B
Purpose : To fit a region of the GIS spectra
Explanation : When called by GIS_FIT, automatically fits well known GIS lines
Use : gisfit=cf_gis4b(qlds,/plot)
gisfit=cf_gis4b(gisfit)
gisfit=cf_gis4b(gisfit,/plot)
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
gisfit = Output structure from GIS_UTPLOT or one of the
cf_gis fitting routines.
Opt. Inputs : PLOT = Plots the fits.
Outputs : QLDS, corrected for some ghosts.
Opt. Outputs: None.
Keywords :
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CFIT, CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4], FIND_FILE
GIS_ERROR, GT_WINDATA, INT2UTC, LOAD_WAVECAL, PIX2WAVE, TAG_EXIST [1], TAG_EXIST [2]
WRT_ASCII, concat_dir [4], delvarx [5], restgen [1], restgen [2]
CALLED BY:
GIS_FIT
Common : None.
Restrictions: None.
Side effects: None.
Still To Do :
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Carl Foley, caf@mssl.ucl.ac.uk August 2003
Modified : v1.1, caf, Mon Sep 22 2003
Changed the format of the output structure so that it only
consists of anonymous structures, to avoid conflicts.
Version : 1.1
[Previous]
[Next]
Project : SOHO - CDS
Name : CF_GIS4C
Purpose : To fit a region of the GIS spectra
Explanation : When called by GIS_FIT, automatically fits well known GIS lines
Use : gisfit=cf_gis4c(qlds,/plot)
gisfit=cf_gis4c(gisfit)
gisfit=cf_gis4c(gisfit,/plot)
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
gisfit = Output structure from GIS_UTPLOT or one of the
cf_gis fitting routines.
Opt. Inputs : PLOT = Plots the fits.
Outputs : QLDS, corrected for some ghosts.
Opt. Outputs: None.
Keywords :
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CFIT, CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4], FIND_FILE
GIS_ERROR, GT_WINDATA, INT2UTC, LOAD_WAVECAL, PIX2WAVE, TAG_EXIST [1], TAG_EXIST [2]
WRT_ASCII, concat_dir [4], delvarx [5], restgen [1], restgen [2]
CALLED BY:
GIS_FIT
Common : None.
Restrictions: None.
Side effects: None.
Still To Do :
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Carl Foley, caf@mssl.ucl.ac.uk August 2003
Modified : v1.1, caf, Mon Sep 22 2003
Changed the format of the output structure so that it only
consists of anonymous structures, to avoid conflicts.
Version : 1.1
[Previous]
[Next]
Project : SOHO - CDS
Name : CFITSLIST
Purpose : Create/update the lfitslist.txt file.
Explanation : CDS fits file names don't tell you much about their
content. This program creates/updates a file
called lfitslist.txt in the fits file directory, with
various information on the content of the files.
This file is used by PICKFITS in order to search
the list of files for those files that the user wants.
NOTE! Creating a new and complete listing of all files
may take a *long* time, from half an hour (for ~3000 files)
and up, depending heavily on hardware/network/OS setup.
Use : CFITSLIST [,FITSDIR [,LISTDIR]]
Inputs : None required.
Opt. Inputs : FITSDIR : The directory with the fits files to be in the
list. Default "$CDS_FITS_DATA". Multiple paths are possible
through comma or colon !path-like notation.
LISTDIR : The directory to place the list in. This is also the
directory where the lfitslist.txt file is
created/updated. The default is "$CDS_FITS_DATA_W".
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3]
CFITSLIST_PROP, CFITSLIST_SRNUMBER, CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], DATATYPE [1], DATATYPE [2], DATATYPE [3], DEFAULT, FILE_EXIST [2]
FIND_FILES, FITSLIST_ADD, FITSLIST_ADDTX, FXBCLOSE [1], FXBCLOSE [2], FXBOPEN [1]
FXBOPEN [2], FXBOPEN [3], FXBTDIM [1], FXBTDIM [2], FXPAR [1], FXPAR [2]
INCCFITSLIST, PARCHECK, RD_ASCII [1], RD_ASCII [2], STRPAD, TRIM, TYP, break_file [4]
concat_dir [4], file_exist [1], file_exist [3]
Common : None.
Restrictions: Expects to find fits files in the specified directory.
If there is already a lfitslist.txt file in the destination
directory, it has to have one or more entries.
Side effects: Creates/updates the file "lfitslist.txt" in the
specified directory.
Category : CDS Utility
Prev. Hist. :
Written : Stein Vidar H. Haugan, UiO, 22 March 1996
Modified : Version 2, SVHH, 18 April 1996
Changed format of fitslist.txt -> lfitslist.txt
Generic format.
Version 3, SVHH, 19 April 1996
Added check for errors after FXBOPEN call.
Version 4, SVHH, 22 April 1996
TITLE expanded to 80 chars max
Version 5, SVHH, 23 April 1996
Using find_files for multi-path CDS_FITS_DATA.
Allowing both FITSDIR and LISTDIR to be
specified.
For updates the new list is collected before
it's written -- direct overwrite, no spawns.
Version 6, SVHH, 29 April 1996
Wrote fitslist_add, fitslist_addtx to shorten
cfitslist_prop. These are (should be) identical
in sfitslist (the SUMER version). Added a few
error tests (to catch corrupt fits files etc).
Version : 6, 29 April 1996
[Previous]
[Next]
NAME:
cfl_summary
PURPOSE:
Make MDI control file summaries
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], SSW_FILE_DELETE, anytim2ex [1], anytim2ex [2], anytim2ints [1]
anytim2ints [2], break_file [4], concat_dir [4], ex2fid [1], ex2fid [2]
file_list [1], file_list [2], fmt_tim [1], fmt_tim [2], prstr [1], prstr [2]
rd_tfile [1], rd_tfile [2], str_replace [1], str_replace [2], ut_time [1]
ut_time [2]
HISTORY:
Written 6-Oct-99 by R. Bush
Combines and replaces go_arch_sum and go_arch_sum2
[Previous]
[Next]
NAME:
cfl_summary
PURPOSE:
Make MDI control file summaries
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], SSW_FILE_DELETE, anytim2ex [1], anytim2ex [2], anytim2ints [1]
anytim2ints [2], break_file [4], concat_dir [4], ex2fid [1], ex2fid [2]
file_list [1], file_list [2], fmt_tim [1], fmt_tim [2], prstr [1], prstr [2]
rd_tfile [1], rd_tfile [2], str_replace [1], str_replace [2], ut_time [1]
ut_time [2]
HISTORY:
Written 6-Oct-99 by R. Bush
Combines and replaces go_arch_sum and go_arch_sum2
[Previous]
[Next]
Project : SOHO - LASCO
Name : CHANDLE
Purpose :
Category : DISPLAY
Explanation :
Syntax :
CALLED BY:
WC2P, WLOADC, imcalc, las_exp_norm, mk_minim, mk_stdim, mk_stdim_list, poly_diffim
Examples :
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
CALLS: ***
CONGRID [1], CONGRID [2], CONGRID [3], FXPAR [1], FXPAR [2], GET_SOLAR_RADIUS
LASCO_FITSHDR2STRUCT, MKHDR [1], MKHDR [2], UNDEFINE
Common :
Restrictions:
Side effects: Not known
History : Version 1, 02-Sep-1995, B Podlipnik. Written
Contact : BP, borut@lasco1.mpae.gwdg.de
[Previous]
[Next]
Project : SOHO - CDS
Name : CHECK_ANOMALY
Purpose : check directory location of anomaly database file: anomaly.db
Category : operations
Explanation :
Syntax : IDL> check_anomaly,file_loc,status=status
Inputs : None
Opt. Inputs : None
Outputs : FILE_LOC = directory location of file
Opt. Outputs: None
Keywords : STATUS=1/0 for found/not found
WRITE = test for write access
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CHKLOG [1], CHKLOG [2]
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FIND_WITH_DEF [1]
FIND_WITH_DEF [2], FIND_WITH_DEF [3], IS_DIR, MKLOG, TEST_DIR, TEST_OPEN
break_file [4], concat_dir [4]
CALLED BY:
XREPORT, XREPORT_EDIT
Common : None
Restrictions: environment/logical SOHO_ANOMALY pointing to location
of anomaly.db
Side effects: if not defined, sets above environmental to:
/soho-archive/private/operations/anomalies
History : Version 1, 21-Dec-1995, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : CHECK_CDS_MODES
Purpose : check CDS raster telemetry against DSN submodes
Category : planning
Explanation : the checks are as follows:
if high-rate (submode 3) - permit L, M, & H (and P) rasters
if medium-rate (submode 5,6) - permit L and M (and P) only
if low+ (submode 2) - permit L (and P) only
if low-rate (submode 4 ) - permit L only
Syntax : IDL> flagged=check_cds_modes(plans,dsn)
Inputs : PLANS = detailed plans array
: DSN = DSN schedule
Opt. Inputs : None
Outputs : FLAGGED = boolean array with indicies of plans with
raster telemetries that don't match current DSN submodes.
Opt. Outputs: None
Keywords : ERR = error string
VERBOSE = verbose output
COUNT = # of flagged plans
PROBLEM= description of problem
CALLS: ***
EXIST, GET_PLAN_ITIME, GET_PLAN_TYPE, GET_STUDY_PAR, STR_FORMAT
CALLED BY:
MK_CDS_PLAN
Common : None
Restrictions: None
Side effects: None
History : 28-Nov-1997, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Name:
check_check_time
Purpose:
check to see that msod is within the range
0 to 86400000
Input:
msod
ds79
Output:
msod
ds79
History
Written Fall '91 by M.Morrison
27-Jul-92 (MDM) Modified to make "i" a long word
24-Mar-93 (MDM) - Modified logic - see below
27-May-93 (MDM) - Changed the algorithm to be mathematical
instead of a repeat loop
3-Jan-95 (MDM) - Changed to use DOUBLE instead of FLOAT
because when using a reference time of
1-Jan-79, the resolution/accuracy for dates
in 1994 is less than 20 seconds!!
CALLS:
[Previous]
[Next]
Name: check_compile
Purpose: verify whether input module will compile (syntax checker)
Input Parameters:
module_name - name of idl procedure/function file to check
Keyword Parameters:
log - contents of output log file
Calling Sequence:
status=check_compile(module_name [,log=log])
History:
14-Apr-1994 (SLF) Written (to check submitted software)
5-May-1994 (SLF) Turn off batch monitoring for submitted job
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], FILE_EXIST [2], anytim2ex [1], anytim2ex [2], break_file [4]
check_log [1], check_log [2], concat_dir [4], data_chk [1], data_chk [2]
ex2fid [1], ex2fid [2], file_append [1], file_append [2], file_exist [1]
file_exist [3], rd_tfile [1], rd_tfile [2], str_replace [1], str_replace [2]
tbeep [1], tbeep [2], tbeep [3]
Restrictions:
UNIX only
[Previous]
[Next]
NAME:
check_dumps
PURPOSE:
To check the dumps of IP tables and list pages
SAMPLE CALLING SEQUENCE:
check_dumps, infil, dset, page
check_dumps, '960713_000014', [43,44], 16
infil = '/data13/data_eof/sci160k/960522/960522_003057'
check_dumps, infil, [124,140], 14, /qplot
CALLS: ***
ARR2STR [1], Arr2Str [2], BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3]
CHECK1DUMP, CHECK1FF_DUMP, CHECK_HALF_DUMP, CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], PAUSE [1], RFITS [1], RFITS [2], RFITS [3], SXPAR [1], SXPAR [2]
SXPAR [3], anytim2ex [1], anytim2ex [2], break_file [4], circle_mask
concat_dir [4], data_type [1], data_type [2], ex2fid [1], ex2fid [2], list_tfi
pause [2], prstr [1], prstr [2], read_mdi, set_list_addr
HISTORY:
Written 15-Jul-96 by M.Morrison
16-Jul-96 (MDM) - Added check for page 14
6-Aug-96 (MDM) - REvamped a bunch
- Added page 12 (flat field) checks
16-Aug-96 (MDM) - Added selection code if "dset" is not defined
27-Aug-96 (MDM) - Removed "velocity1" from the check
15-Nov-96 (MDM) - Added checking 6500xxxx dumps.
13-Mar-97 (MDM) - Added checking of page 10 dumps (FF)
7-Apr-97 (MDM) - Commented out page 10 dump checks (errors too often)
- Masked out more of RWBIN memory checks
- Changed length of RWBIN and VWBIN
11-Apr-97 (MDM) - Added /DO10 option to check page 10 dumps
- Fixed up option for page 10 dumps checks
15-Jul-97 (MDM) - Changed to use flat_005 instead of flat_003.fits
20-Oct-98 (CNF) - Changed number of pixels it would list from 10 to
25.
3-dec-98 (CNF) - Modified program to read new vwbin 6007a to fix
bad pixel 400.
1-Oct-99 (RIB) - Modified program to work with IDL 5.2, primarily
correcting dpc hex comparisons
[Previous]
[Next]
NAME:
check_dumps
PURPOSE:
To check the dumps of IP tables and list pages
SAMPLE CALLING SEQUENCE:
check_dumps, infil, dset, page
check_dumps, '960713_000014', [43,44], 16
infil = '/data13/data_eof/sci160k/960522/960522_003057'
check_dumps, infil, [124,140], 14, /qplot
HISTORY:
Written 15-Jul-96 by M.Morrison
16-Jul-96 (MDM) - Added check for page 14
6-Aug-96 (MDM) - REvamped a bunch
- Added page 12 (flat field) checks
16-Aug-96 (MDM) - Added selection code if "dset" is not defined
27-Aug-96 (MDM) - Removed "velocity1" from the check
15-Nov-96 (MDM) - Added checking 6500xxxx dumps.
13-Mar-97 (MDM) - Added checking of page 10 dumps (FF)
7-Apr-97 (MDM) - Commented out page 10 dump checks (errors too often)
- Masked out more of RWBIN memory checks
- Changed length of RWBIN and VWBIN
11-Apr-97 (MDM) - Added /DO10 option to check page 10 dumps
- Fixed up option for page 10 dumps checks
15-Jul-97 (MDM) - Changed to use flat_005 instead of flat_003.fits
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
CHECK_ENOUGH()
PURPOSE:
CATEGORY:
EXPLANATION:
SYNTAX:
Result = check_enough()
CALLED BY:
RAW2BIN
EXAMPLES:
INPUTS:
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, November 11, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
NAME:
CHECK_EXP_FACTOR_DUPS
PURPOSE:
This procedure reads the exposure factor file for a given date
and then writes it back out, eliminating any duplicate entries.
CATEGORY:
EXPFAC
CALLING SEQUENCE:
CHECK_EXP_FACTOR_DUPS,Tel,YYMMDD
INPUTS:
Tel: String indicating the telescope, 'c1','c2','c3'
Date: Date for which the exposure factors are wanted
can be in either YYMMDD, MJD, or CDS time structure
CALLS: ***
GET_UTC, READ_EXP_FACTOR, UTC2YYMMDD, YYMMDD2UTC
COMMON BLOCKS:
EXP_FACTOR_ARRAY: The exposure facotor information for a given
date.
PROCEDURE:
READ_EXP_FACTOR is called to readin the exposure factor file for
the specified date. Then WRITE_EXP_FACTOR is called to write
it back out. Note that READ_EXP_FACTOR eliminates duplicates.
MODIFICATION HISTORY:
Written by: RA Howard, NRL, 22 Feb 1998
@(#)check_exp_factor_dups.pro 1.1 02/22/98 :LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
check_ff_load
PURPOSE:
To check the status of the flat field load
SAMPLE CALLING SEQUENCE:
check_ff_load, infil
check_ff_load, infil, dsets, img2, dattim
check_ff_load, get_last_tfr(), [17,18], img2, dattim, tit='SIM System'
check_ff_load, infil, dsets, img2, dattim, img0, diff, half=1
check_ff_load, infil, -1, img2, dattim, img0, diff
check_ff_load,infil,[129,130],a,b,c,d,start_addr='20000'x ;page 10 backup check
check_ff_load,infil,[130,131],a,b,c,d,imgfil='/mdisw/dbase/cal/files/flat_005.fits'
check_ff_load, get_last_tfr(), /page10, imgfil='/mdisw/dbase/cal/files/flat_005.fits'
INPUTS:
infil - The file to check
dsets - The datasets to read (the dump data sets)
OUTPUTS:
img2 - The assembled image
dattim - The date/time of the dump
img0 - The proper image (read from the database)
diff - The difference image
CALLS: ***
ARR2STR [1], Arr2Str [2], RFITS [1], RFITS [2], RFITS [3], ccd_hdr_info, circle_mask
data_type [1], data_type [2], disp_gen [1], disp_gen [2], list_tfi, read_mdi
OPTIONAL KEYWORD INPUT:
hc - If set, make a hardcopy of the image
tit - Optional description to be displayed as a title
half - =1 means mask out the second half, we only have data for
the first half. Equal 2 means mask out the first half
nmaxdiff- The maximum number of pixels that can be listed before
not bothering to list them (default = 40)
HISTORY:
Written May-96 by M.Morrison
Oct-96 (MDM) - Various modifications
(like allowing it to search for the datasets
to be processed).
4-Nov-96 (MDM) - Added documentation header
12-Nov-96 (MDM) - Added nmaxdiff
11-Dec-96 (MDM) - Added START_ADDR
13-Dec-96 (MDM) - Corrected for bug when there are no bad pixels
16-Apr-97 (MDM) - Added 1/5 checks (assuming they are all there)
19-May-97 (MDM) - Corrected search for 1/5th dumps -- was not
looking at the second half.
10-Jul-97 (MDM) - Added IMGFIL option
- Added /page10 option
15-Jul-97 (MDM) - Made IMGFIL default to flat_005.fits
[Previous]
[Next]
NAME:
check_filename
PURPOSE:
Removes the extension and path from the filename
if present
CALLING SEQUENCE:
check_filename,filename
check_filename,filename,path,extension
INPUTS:
filename = string to be checked (may be a string array)
OUTPUTS:
filename will be returned without extension and path
OPTIONAL OUTPUTS:
path = path name
extension = extension not including decimal point
MODIFICATION HISTORY:
RAH 10/1/89
rah 3/28/91 added array input for filename
ALL 5/15/93 adapted to VMS
SCCS variables for IDL use
@(#)check_filename.pro 1.1 7/6/92 :NRL Solar Physics
[Previous]
[Next]
NAME:
check_filename
PURPOSE:
Removes the extension and path from the filename if present
CALLING SEQUENCE:
check_filename,filename
check_filename,filename,path,extension
INPUTS:
filename = string to be checked (may be a string array)
OUTPUTS:
filename will be returned without extension and path
OPTIONAL OUTPUTS:
path = path name
extension = extension not including decimal point
MODIFICATION HISTORY:
RAH 10/1/89
rah 3/28/91 added array input for filename
SCCS variables for IDL use
@(#)check_filename.pro 1.1 7/6/92 :NRL Solar Physics
[Previous]
[Next]
NAME:
check_imgdir
PURPOSE:
checks !imgdir for a / on the end
CALLING SEQUENCE:
check_imgdir
INPUTS: None
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
CALLED BY:
SYNSCAN
PROCEDURE:
if !imgdir does not end with / then puts one on
MODIFICATION HISTORY: RAH 3/26/91
ALL 5/15/93 adapted to VAX VMS
SCCS variables for IDL use
@(#)check_imgdir.pro 1.1 7/6/92 :NRL Solar Physics
[Previous]
[Next]
NAME:
check_imgdir
PURPOSE:
checks !imgdir for a / on the end
CALLING SEQUENCE:
check_imgdir
INPUTS: None
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
CALLED BY:
SYNSCAN
PROCEDURE:
if !imgdir does not end with / then puts one on
MODIFICATION HISTORY: RAH 3/26/91
SCCS variables for IDL use
@(#)check_imgdir.pro 1.1 7/6/92 :NRL Solar Physics
[Previous]
[Next]
Project : SOHO - CDS
Name : CHECK_INTEG
Purpose : Checks the integrity of the CDS catalog databases
Category : Class4, Operations, Catalog
Explanation : Makes various checks on the integrity of the CDS catalog
databases.
Syntax : CHECK_INTEG [, OUTPUT=OUTPUT ]
Examples :
Inputs : None.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : OUTPUT = Name of an output file to contain the result. If not
passed, then the output is written to the screen.
Calls : ***
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], DB_INFO [1]
DB_INFO [2], DB_INFO [3], FIND_ALL_DIR [1], FIND_ALL_DIR [2], FIND_ALL_DIR [3]
FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3], FXHREAD [1]
FXHREAD [2], FXPAR [1], FXPAR [2], TAI2UTC, TRIM
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 02-Apr-1996, William Thompson, GSFC
Version 2, 12-Apr-1996, William Thompson, GSFC
Added checks for OBT_TIME=0, SCI_OBJ='', OBS_MODE=''
Version 3, 18-Apr-1996, William Thompson, GSFC
Corrected error in one of the checks.
Version 4, 30-Apr-1996, William Thompson, GSFC
Cope with split databases.
Version 5, 29-May-1996, William Thompson, GSFC
Cope with empty experiment* databases, and main_ptr=0.
Version 6, 25-Mar-1997, William Thompson, GSFC
Fixed bug in print statement.
Don't print orphaned entries with SEQ_NUM = -1
Version 7, 24-Apr-1997, William Thompson, GSFC
Corrected test for duplicate PROG_NUM/SEQ_IND
Version 8, William Thompson, GSFC, 1 June 1998
Don't use PRINTF to the screen.
Look for entries in "_year" files
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO-CDS
Name : CHECK_KAP
Purpose : Check validity of campaign numbers in IAP file
Category : planning
Explanation :
Syntax : CHECK_KAP,FILE
CALLED BY:
UPDATE_KAP
Examples :
Inputs : FILE = IAP (or KAP) file to check
Opt. Inputs : None
Outputs : None
Opt. Outputs:
Keywords : ALERT = set to send e-mail to instrument planners about
invalid or missing campaign numbers
MISSING = set to alert planners if they forgot to submit IAP
NOICAL = set to not check for Intercalibrations
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], ARR2STR [1], Arr2Str [2], DATATYPE [1]
DATATYPE [2], DATATYPE [3], DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4]
ESPAWN, EXIST, FIND_CAMPAIGN, GET_CALLER, GET_CAMPAIGN, GET_LATEST_IAP, GET_UTC
IAP2STC, LOC_FILE [1], LOC_FILE [2], LOC_FILE [3], RD_ASCII [1], RD_ASCII [2]
RM_FILE, SEND_MAIL, STRPAD, TAG_EXIST [1], TAG_EXIST [2], TRIM, WHICH_INST
delvarx [5]
Common : None
Restrictions: None
Side effects: None
History : Written 20 November 1996, D. Zarro, ARC/GSFC
Contact : dzarro@solar.stanford.edu
[Previous]
[Next]
Project : SOHO - CDS
Name : CHECK_KAP_ANOMALY
Purpose : check lines in KAP files for anomalous activity keywords
Category : operations, planning
Explanation : Certain KAP files produced by ECS do not appear to conform
to Interface Control Document conventions.
Syntax : IDL> anomalous=check_kap_anomaly(line)
Inputs : LINE = line in KAP file
Opt. Inputs : None
Outputs :
Opt. Outputs: ANOMALOUS = 1 if line contains ACTIVITY keyword and there
is a resource associated with it. The following resources
should not be associated with an activity:
SVM_reserved, PAYLOAD_reserved, TLM_Tape_Dump, MDI_H, MDI_M,
Throughput_RCR, Clock_Adjust, Spacecraft_Maneuver.
Keywords : None
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], STREP [1], STREP [2], STREP [3], STREP [4]
STREP [5], TRIM
CALLED BY:
READ_KAP_ITEM
Common : None
Restrictions: None
Side effects: If present and anomalous, the ACTIVITY keyword is removed from line
History : Version 1, 26-Feb-1995, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Name: check_log
Purpose: check idl batch logfile for abnormal termination
Calling Sequence:
check_log, logfile [user=user]
Input Paramters:
logfile - idl batch log to check
Keyword Paramters:
job - batch job name (optional)
user - user list for e-mail
window - lines preceding error to include in output (def=5, -1 = all)
nomail - switch, if set, inhibit mail on ABNORMAL exit (def=mail)
mailnorm - switch, if set, mail on NORMAL exit (def=nomail)
unixerr - switch, if set, limit checks to UNIX errors
ftperr - switch, if set, limit checks to ftp errors
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], FILE_EXIST [2], PATH_LIB [1], PATH_LIB [2], break_file [4]
concat_dir [4], data_chk [1], data_chk [2], file_exist [1], file_exist [3]
get_logenv [1], get_logenv [2], mail [1], mail [2], rd_tfile [1], rd_tfile [2]
rename [1], rename [2], search [1], search [2], tbeep [1], tbeep [2], tbeep [3]
wc_where [1], wc_where [2]
CALLED BY:
check_compile [1], check_compile [2]
History:
1-Mar-1994 (SLF)
2-Mar-1994 (SLF) - add <no job file> and <compile time error> checks
15-Apr-1994 (SLF) - inhibit message if /quiet is set
21-Apr-1994 (SLF) - add UNIXERR/FTPERR keywords and action, call sear
call search.pro, mail SUBJ: info, other mods...
3-May-1994 (SLF) - call search.pro with /case_ignore set
10-May-1994 (SLF) - allow inhibition of unix and ftp checks via log/env
29-Sep-1994 (SLF) - add REMOVE keyword (succesfully completed jobs&logs)
4-Sep-1994 (SLF) - do a RENAME instead of a delete (seperate option after testing
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
CHECK_MDU()
PURPOSE:
Return the MDU-Flag (Missing Data in Unit)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = check_mdu(header)
EXAMPLES:
INPUTS:
header - SUMER Image Header greater 92 Bytes
OPTIONAL INPUTS:
None.
OUTPUTS:
0 - Image is OK
1 - Image in not OK
-1 - MDU-Flag is not in Header
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
Valid for SUMER binary Image Header
SIDE EFFECTS:
None.
HISTORY:
Version 1, May 6, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (Dietmar Germerott@linmpi.mpg.de)
[Previous]
[Next]
NAME:
CHECK_MONEXP_DUPS
PURPOSE:
Check for duplicate entries in MONEXP data
CATEGORY:
LASCO EXPFAC
CALLING SEQUENCE:
CHECK_MONEXP_DUPS,Tel,Datea
INPUTS:
Datea: String giving the starting date, '980401'
OPTIONAL INPUTS:
Dateb: String giving the ending date, '980401'. If not present, then
the ending date is the starting date.
CALLS: ***
READ_MONEXP_DATA, UTC2YYMMDD, YYMMDD2UTC
CALLED BY:
REDUCE_DAILY
COMMON BLOCKS:
MONEXP_DATA
PROCEDURE:
The MONEXP data file for the specified dates and all telescope are checked
for duplicate entries by checking to see if two entries have the same
time of exposure. If there are any duplicates then the file is rewritten
using the latest MONEXP entry in the data file.
EXAMPLE:
To check a single date:
CHECK_MONEXP_DUPS,'c3','980201'
To check a range of dates:
CHECK_MONEXP_DUPS,'c3','980201','980204'
MODIFICATION HISTORY:
Written by: RA Howard, NRL, 6 June, 1998
Karl Battams 05/10/21 Add /swap_if_little_endian keyword to OPEN calls
@(#)check_monexp_dups.pro 1.2 10/21/05 LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - CDS
Name : CHECK_NIS_WCAL
Purpose : Demonstrates applicability of current NIS wavecal.
Explanation :
Use : IDL> check_nis_wcal
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : ANGSTROMS - residuals plotted as Angstroms instead of pixels
Calls : ***
AVERAGE, CIRCLE_SYM
Common : None
Restrictions: None
Side effects: None
Category : Calibration
Prev. Hist. : None
Written : C D Pike, RAL, 10-Oct-96
Modified :
Version : Version 1, 10-Oct-96
[Previous]
[Next]
NAME:
CHECK_OBESUMERROR
PURPOSE:
Checks for OBE error when doing LEB summing
CATEGORY:
Reduce
CALLING SEQUENCE:
CHECK_OBESUMERROR,A,Hdr
INPUTS:
A: Image to be checked
Hdr: FITS Header
KEYWORD PARAMETERS:
FIXIT: If present, fixes the LEBXSUM and LEBYSUM keywords
CALLS: ***
FXADDPAR [1], FXADDPAR [2], GET_UTC, LASCO_FITSHDR2STRUCT
CALLED BY:
FIX_OBESUMERROR, REDUCE_LEVEL_05
PROCEDURE:
An error was discovered in OBE beginning 6 March 1997.
It started after sending a command to sum difference in EIT images.
The result was that the LEB summing parameter in the header was not
being set to the proper value. It always read 1, even though the
summing was performed.
MODIFICATION HISTORY:
RA Howard, NRL, 24 March 97
@(#)check_obesumerror.pro 1.1 05/14/97 LASCO IDL LIBRARY
[Previous]
[Next]
Name: check_oldprocess
Purpose: check old processes
Calling Sequence:
check_oldprocess
CALLS: ***
ARR2STR [1], Arr2Str [2], BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3]
CHECK_OLDPROC, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], anytim2ints [1]
anytim2ints [2], break_file [4], concat_dir [4], fid2ex [1], fid2ex [2]
file_append [1], file_append [2], file_list [1], file_list [2], file_purge [1]
file_purge [2], get_host [1], get_host [2], get_user [1], get_user [2], mail [1]
mail [2], prstr [1], prstr [2], rd_tfile [1], rd_tfile [2], strjustify, tim2dset [1]
tim2dset [2], timegrid, where_arr [1], where_arr [2]
History:
15-Feb-1995 (SLF)
Method - look at queue of old chk_process logs and flag/remove old
hung jobs (generally called from check_process.pro)
[Previous]
[Next]
Name: check_oldprocess
Purpose: check old processes
Calling Sequence:
check_oldprocess
CALLS: ***
ARR2STR [1], Arr2Str [2], BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3]
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], anytim2ints [1], anytim2ints [2]
break_file [4], concat_dir [4], fid2ex [1], fid2ex [2], file_append [1]
file_append [2], file_list [1], file_list [2], get_user [1], get_user [2]
mail [1], mail [2], prstr [1], prstr [2], rd_tfile [1], rd_tfile [2], strjustify
tim2dset [1], tim2dset [2], timegrid, where_arr [1], where_arr [2]
History:
15-Feb-1995 (SLF)
Method - look at queue of old chk_process logs and flag/remove old
hung jobs (generally called from check_process.pro)
[Previous]
[Next]
NAME:
CHECK_PRO_NAMES
PURPOSE:
This procedure checks for duplicate procedure names in $NRL_LIB
CATEGORY:
LASCO UTIL
CALLING SEQUENCE:
CHECK_PRO_NAMES
INPUTS:
None
KEYWORD PARAMETERS:
LASCO: Set this keyword to only print duplicates if they also occur
underneath the lasco directory.
OUTPUTS:
This procedure writes the results to a file 'duplicate_pros.txt' in
the users home directory.
CALLS: ***
GET_UTC, RSTRPOS, UTC2STR
PROCEDURE:
All files with pro in their name are found using the find commadn
Then only files ending in .pro and which are not in teh SCCS directory
are saved. Duplicate file names are then located using the where
function.
MODIFICATION HISTORY:
Written by: RA Howard, NRL, 7 March 1997
@(#)check_pro_names.pro 1.1 09/26/97 LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
check_process
PURPOSE:
To monitor jobs that have hung up and are eating up CPU
CALLS: ***
CHECK_OLDPROC, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FILE_EXIST [2]
STR2ARR [1], STR2ARR [2], concat_dir [4], ex2fid [1], ex2fid [2], file_append [1]
file_append [2], file_exist [1], file_exist [3], get_host [1], get_host [2]
get_user [1], get_user [2], is_member [1], is_member [2], mail [1], mail [2]
prstr [1], prstr [2], rd_tfile [1], rd_tfile [2], syst2ex [1], syst2ex [2]
syst2ex [3]
HISTORY:
22-Apr-94 (SLF) - Rewrite MDM kill_ftp - parameter/generic PID checks
25-Apr-94 (SLF) - read from file if it exists
29-Apr-94 (SLF) - actually spawn command! (was claiming it spawned)
11-Jul-94 (SLF) - remove ps warning lines from output ('ps:...')
15-Feb-95 (SLF) - Add call to check_oldprocess - added 2 parameters
to the pid_limits data file, create archive logs
27-Feb-95 (slf) - allow BSD syntax (OSF, etc)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
CHECK_QAC()
PURPOSE:
Return the QAC-Flag (Missing Data in Unit)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = check_qac(header)
EXAMPLES:
INPUTS:
header - SUMER Image Header greater 92 Bytes
OPTIONAL INPUTS:
None.
OUTPUTS:
0 - Image is OK
1 - Image in not OK
-1 - QAC-Flag is not in Header
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
Valid for SUMER binary Image Header
SIDE EFFECTS:
None.
HISTORY:
Version 1, May 6, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (Dietmar Germerott@linmpi.mpg.de)
[Previous]
[Next]
NAME:
check_sci5k_trunc
PURPOSE:
To review the SCI5K data and see if any data products were truncated
Mail a message if there were some truncations
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FMT_SCI5K, MASK, UNSIGN
anytim2ex [1], anytim2ex [2], anytim2ints [1], anytim2ints [2], concat_dir [4]
data_type [1], data_type [2], deriv_arr [1], deriv_arr [2], ex2fid [1], ex2fid [2]
fmt_tim [1], fmt_tim [2], gt_day [1], gt_day [2], int2secarr [1], int2secarr [2]
rd_hk [1], rd_hk [2], ut_time [1], ut_time [2]
HISTORY:
Written 13-Jun-96 by M.Morrison
27-Jun-96 (MDM) - Modified to recognize "false" truncate flag setting
30-Jul-96 (MDM) - Modified mail address to be "mdiers", not "mdi"
13-Feb-2001 (RIB) - Modified mail address to be "mdiops"
[Previous]
[Next]
Project : SOHO - CDS
Name : CHECK_TAPE_DRV
Purpose : Associate tape drive numbers with device files. *Unix only*
Explanation : This is an internal routine to the CDS/SERTS Unix tape handling
utilities. It converts tape drive numbers to actual device
names, and checks to make sure that the device file is open.
**Unix only**
Use : CHECK_TAPE_DRV, UNIT, LOGICAL_DRIVE, DRIVE, LUN
Inputs : UNIT = Tape unit number. Tape drives are selected via the UNIX
environment variables "MT1", "MT2", etc. The desired
tape drive is thus specified by numbers, as in VMS.
Must be from 0 to 9.
Opt. Inputs : None.
Outputs : LOGICAL_DRIVE = Name of environment variable pointing to tape
drive device file, e.g. "MT0".
DRIVE = Name of device file, e.g. '/dev/nrst0'.
LUN = Logical unit number used for reads and writes.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
DISMOUNT [1], DISMOUNT [2], REWIND [1], REWIND [2], SKIPF [1], SKIPF [2], TAPRD [1]
TAPRD [2], TAPWRT [1], TAPWRT [2], WEOF [1], WEOF [2]
Common : CHCK_TAPE_DRVS contains array TAPE_LUN, containing logical unit
numbers for each tape device, and TAPE_OPEN, which tells
whether each device is open or not.
Restrictions: The environment variable "MTn", where n corresponds to the
variable UNIT, must be defined. E.g.,
setenv MT0 /dev/nrst0
Requires IDL v3.1 or later.
Side effects: If the device file is not yet open, then the tape is rewound,
and a file unit is opened to it.
Category : Utilities, I/O, Tape.
Prev. Hist. : William Thompson, Apr 1991.
Written : William Thompson, GSFC, April 1991.
Modified : Version 1, William Thompson, GSFC, 21 December 1993.
Added keyword /NOSTDIO to OPEN statement.
Incorporated into CDS library.
Version 2, William Thompson, GSFC, 22 December 1993.
Added spawn to "mt rewind".
Version : Version 2, 22 December 1993.
[Previous]
[Next]
Project : SOHO - CDS
Name : CHECK_WINDOWS
Purpose : Check the line_window structure to ensure completeness.
Explanation : When new lines and/or windows are added to the lists, not
all the parameters need be specified by the user. This
routines checks for missing parameters and adds the current
defaults where necessary. It is only appropriate for use with
the technical planning procedure tp_page1
Use : IDL> check_windows
Inputs : None, done via private common blocks
Opt. Inputs : None
Outputs : None, common variables are updated.
Opt. Outputs: None
Keywords : None
Calls : None
Restrictions: Needs technical planning common blocks
Side effects: None
Category : Technical planning
Prev. Hist. : None
Written : C D Pike, RAL, 28-May-93
Modified : Take account of order for calculation of y_pos, CDP 6/12/93
Change to tplan. CDP, 8-Jul-94
Version : Version 3, 8-Jul-94
[Previous]
[Next]
Project : SOHO - CDS
Name : CHECKCDSFITS()
Purpose : Check FITS file to insure that it meets the CDS standard.
Explanation : This procedure makes sure that the FITS file associated with
the file FILENAME is a CDS FITS level-1 file with a FITS header
that has the proper registered SFDU keywords.
Use : RESULT = CHECKCDSFITS( FILENAME [, MESSG] )
Inputs : FILENAME: The FITS file name(s) to be checked (STRING scalar
or array).
Opt. Inputs : None.
Outputs : RESULT: STRING (scalar or array depending on input) is output:
'valid' if file meets criterion test,
'invalid' if it fails.
Opt. Outputs: MESSG: A detailed message describing why the file check
failed (STRING, 1-D array if 1 filename sent, 2-D array
(NFile, NError) if array of filenames sent.
Keywords : DIR: The directory where the file(s) in FILENAME can be
found. Note that use of this keyword requires all of
the FITS files to be stored in one directory. Also
note that a directory delimiter (i.e., "/" for Unix)
must be passed at the end of the directory name.
VERBOSE: If set, then operational messages will be printed to
the screen.
ERRMSG: If defined and passed, then any error messages will
be returned to the user in this parameter rather than
being handled by the IDL MESSAGE utility. If no
errors are encountered, then a null string is
returned. In order to use this feature, the string
ERRMSG must be defined first, e.g.,
ERRMSG = ''
RES = CHECKCDSFITS( 'data.fits', ERRMSG=ERRMSG)
IF ERRMSG(0) NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], FXBCLOSE [1], FXBCLOSE [2], FXBDIMEN [1]
FXBDIMEN [2], FXBFIND [1], FXBFIND [2], FXBOPEN [1], FXBOPEN [2], FXBOPEN [3]
FXBSTATE [1], FXBSTATE [2], FXBTFORM [1], FXBTFORM [2], VALIDCDSHEAD, VALIDCDSTYPE
Common : None.
Restrictions: None.
Side effects: None.
Category : Data Handling, I/O, FITS, SFDU, CDS, Quicklook
Prev. Hist. : None.
Written : Donald G. Luttermoser, GSFC/ARC, 26 October 1995
Modified : Version 1, Donald G. Luttermoser, GSFC/ARC, 26 October 1995
Initial program.
Version : Version 1, 26 October 1995.
[Previous]
[Next]
PURPOSE : CHECKS TO SEE WHETHER VARIABLE IS DEFINED, IF NOT SET TO DEFAULT
CALLED BY
ADD_SCATTER_DRM, ATMOS, AVERAGE_STEPS, AXIS__DEFINE [2], Ai_bpow [1], Ai_bpow [2]
Ai_thermal [1], Ai_thermal [2], Ai_vth_bpow [1], Ai_vth_bpow [2], Apar_init [1]
Apar_init [2], BATSE_DEADTM, BATSE_FLARES_WEEK, BATSE_MATCH_SEQUENCE, BATSE_ON
BATSE_POINTING, BAT_MERGE, BPOW, BUILD_DRM, BURST_FLARE, CALIBRATE [1]
CALIBRATE [2], CAL_SHER, CH2KVT, CHOOSE_FL, CLEAN_GOES, CLEAN_JOURNAL, CNTRATE
COMPARE_SHUTTERS, CONT_DEF, CONT_EDGES, CONT_READ, CRAB_OCC_STR, CURVFIT [1]
CURVFIT [2], Create a FITS primary Header and Data Unit, DATPLOT, DCFREAD
DEFAULTS_2, DESPIKE_1D, DET_XSEC, DIFF_DRM, DISCP_RESP, DISCSP_BANDS, DISCSP_READ
DO_WRITE_DD, DUMMYPLOTS, EMENU, EVAL_SHERB, EXTRACT_TRIGGERS, Energy_res [2]
Enorm_drm, FAST_RATIO, FCOLOR [1], FDBREAD, FILE_SEARCHER [1], FILE_SEARCHER [2]
FILTER_ATTEN, FIND_GOOD_OCCS, FITS READER CLASS, FITS WRITER CLASS
FITS WRITER CLASS FOR ANY RHESSI DATA TYPES
FITS WRITER CLASS FOR RHESSI IMAGES, FIT_BACKGRND, FLDISPLAY, FLISTOC
FLUORESCENCE, FRAMEWORK ABSTRACT CLASS DEFINITION, FSDEF, FSOC, FS_ARCHIVE_RW
FS_GRAPH, FS_OPEN [1], FS_READ_DD, F_3POW, F_BPOS_NLINE, F_COMPOSITE, F_MTH_EXP_BPOW
F_MTH_POW_BPOW, F_MULTI_SPEC, F_POW, F_VTH_ION, Fits_spectra [1], Fits_spectra [2]
Flux model of a thermal bremsstrahlung plus broken powerlaw
Flux model of thermal bremsstrahlung plus thintarget broken, GAUSS_INTG
GD_TITLE, GETFLARE, GETUT [1], GETUT [2], GET_DAYN, GET_HXRBS_FITS, GET_OCCS
GET_OCC_ONDAY, GET_TRIG, GE_WINDOW [1], GE_WINDOW_SIM, GFITS_R, GOES_DEGLITCH
GOES_MEWE_TEM, GOES__DEFINE, GRS_LIGHTCURVE
HESSI BACK PROJECTION STRATEGY ABSTRACT CLASS
HESSI BINNED EVENTLIST CLASS DEFINITION
HESSI CALIBRATED EVENTLIST CLASS DEFINITION [1]
HESSI CALIBRATED EVENTLIST CLASS DEFINITION [2]
HESSI FRAMEWORK TEMPLATE CLASS [2], HESSI FRAMEWORK TEMPLATE CLASS [3]
HESSI IMAGE FILE CLASS DEFINITION [1]
HESSI IMAGE RAW CLASS DEFINITION [2]
HESSI IMAGE STRATEGY CLASS DEFINITION, HESSI IMAGE [1]
HESSI MODULATION PATTERN CLASS DEFINITION [1]
HESSI MODULATION PATTERN CLASS DEFINITION [5]
HESSI MODULATION PATTERN STRATEGY CLASS DEFINITION
HESSI MONITOR RATE CLASS DEFINITION, HESSI PACKET CLASS DEFINITION
HESSI Packet to EventList, HESSI ROLL_DB CLASS DEFINITION, HESSI_FILTERS
HESSI_FLARE_SPECTRUM, HESSI_MODEL_COUNTS, HESSI_SHUTTERS, HKG_STR
HSI_ANNSEC2XY [1], HSI_ANNSEC2XY [2], HSI_ANNSEC_BPROJ [1]
HSI_ANNSEC_BPROJ [3], HSI_ANNSEC_MAP [1], HSI_ANNSEC_MAP [2]
HSI_ANNSEC_MAP_INFO [1], HSI_ANNSEC_MAP_INFO [2], HSI_ANNSEC_MODUL_PATTERN
HSI_ANNSEC_MPAT [1], HSI_ANNSEC_MPAT [2], HSI_ANNSEC_PROFILE [1]
HSI_ANNSEC_PROFILE [2], HSI_ASPECT_SIM, HSI_BESEL_PSF, HSI_CHK_DUPLICATE
HSI_COUNTS_PER_MODEL, HSI_CSPECTRUM_DIST, HSI_DRM_MOD CLASS
HSI_DRM_MOD_CONTROL__DEFINE, HSI_EVENTLIST_SELECT_BY_ENERGY
HSI_EVENTLIST_TO_SPECTROGRAM [1], HSI_FILL_FASTRATE_PACKET, HSI_FILL_FORWARD
HSI_GET_MOD_PAT, HSI_GRID_PARAMETERS, HSI_HIST_GROUP, HSI_INPUT_MODEL
HSI_LIVETIME_PACKET_BUILD, HSI_LIVETIME_SIM, HSI_MAP_CLEAN [1]
HSI_MEM_SATO [1], HSI_MK_FASTRATE_PACKET, HSI_MK_MODUL_PATRN
HSI_MODULATE_POINT_SOURCE, HSI_MODUL_PATTERN_BPROJ, HSI_MODUL_PATTERN_BUILD
HSI_MODUL_PATTERN_PROFILE, HSI_MODUL_PATTERN_PSF, HSI_MODUL_PATTERN_RD_ONE
HSI_MODUL_PATTERN_READ, HSI_PACKET2FITS, HSI_PIXEL_COORD, HSI_PIXON_ERROR_CALC
HSI_PTR_LISTSORT, HSI_RD_FITS_SPECTRUM, HSI_RD_RASPMT, HSI_RD_WEIGHT_MAP
HSI_SCALE_IMAGE, HSI_SCORE2FILE, HSI_SCORE_BPROJ, HSI_SCTIME_ADD
HSI_SCTIME_DIFF, HSI_SPEC2CDIST, HSI_SPECTROGRAMACCBIN [5]
HSI_SPECTROGRAMCHAN_OVERLAP_FIX, HSI_SPECTROGRAM_DECIM_CORRECT
HSI_SPECTROGRAM_DECIM_TABLE, HSI_SPECTRUM__DEFINE, HSI_SRM__DEFINE
HSI_SUM_MODUL_PATTERN, HSI_TIME_JUMP, HSI_TIME_RESET, HXARCHIVE, HXFITS, HXR2FILE
HXRBS, HXRBS_DEGLITCH, HXT_CAL_DRM [1], HXT_CAL_DRM [2], HXT_CAL_FIX [1]
HXT_CAL_FIX [2], IGAIN, Intervals [1], Intervals [2], JUMPER, JUMPER_SHER, LAD_DRM
LAD_RESP, LINE_COMPLEX, LIST_OP [1], LIST_OP [2], LIVETIME [1], LLD_CHAN
Load_Main [1], Load_Main [2], Load_sher, MAILPLOT, MAP_DISCLA2CONT, MEMORY_INTRVLS
MERGE_BATSE, MERGE_BURSTS, MORE_OCCULTS, MOVIE_MAP, Modify_Merge_list [1]
Modify_Merge_list [2], Modify_sled [2], N511_VS_HVSPEC, NEAR_PC_RESP [1]
NEAR_PC_RESP [2], NEAR_PIN_CAL [1], NEAR_PIN_CAL [2], NEAR_PIN_RESP [1]
NEAR_PIN_RESP [2], NOFILL_ARE, OCC_AVG, OCC_DBASE, OCC_FROM_FITS, OCC_PROFILE
OP_COM [1], OP_COM [2], PAIRXSEC, PARA_LIVETIME, PARSE_COMLINE, PHOTON_MODEL
PICK_POINTING, PLOT_ANGC [1], PLOT_ANGC [2], PLOT_GD, PLOT_GD_CALC
PLOT_HESSI_FILTERS, PLOT_OCCS, PLOT_OCC_ONDAY
POINT SPREAD FUNCTION CLASS DEFINITION, POINT [1], PROFILES2
Packet to fast rate, Pointing_Change, QLARCHIVE, QLDISPLAY, QL_DAY_PLOT
QL_ORBIT_PLOT, QL_PLOTTER, RAWDUMP, RD_TGRS_SPEX [1], RD_TGRS_SPEX [2]
READ_DISCLA, READ_HXRS_4_SPEX [1], READ_HXRS_4_SPEX [2], READ_HXRS_4_SPEX [3]
READ_OCC_DISCSP, READ_RESULTS, READ_RESULTS2, READ_SHERB, RESOLVE_NEW_OBS
RESP_CALC response calculation, RESTORE_OVERFLOW, RESTORE_QLOOK
RHESSI IMAGE SINGLE CLASS DEFINITION, ROUTINE_NAME [4], ROUTINE_NAME [7]
RUN_BATSE, RUN_CURVEFIT [1], RUN_CURVEFIT [2]
Radiospectrogram FITS File reader [1], Read_mat_xcom, SAVE_DCDATA, SC4TREAD
SEARCH_HXRBS_DB, SELECTION MANAGER ABSTRACT CLASS, SETUP_ARRAYS, SETUP_BATSE
SETUP_BATSE_ARRAYS, SETUP_DRM, SETUT [1], SETUT [2], SETUTBASE [1], SETUTBASE [2]
SETUTEND [1], SETUTEND [2], SETUTSTART [1], SETUTSTART [2], SET_GRAPHICS [1]
SET_GRAPHICS [2], SET_UTLABEL, SET_UTPLOT [1], SET_UTPLOT [2], SLED
SPECTROGRAM CLASS DEFINITION, SPECTRUM CLASS DEFINITION, SPEX_BACKGROUND [1]
SPEX_BACKGROUND [2], SPEX_COMMONS [2], SPEX_COMMONS [4], SPEX_FITINT__DEFINE
SPEX_FIT__DEFINE, SPEX_GEN__DEFINE, SPEX_HANDLES [1], SPEX_HANDLES [2]
SPEX_HANDLES_STR [1], SPEX_HANDLES_STR [2], SPEX_PLOT_SAVED [1]
SPEX_PLOT_SAVED [2], SPEX_PROC [1], SPEX_PROC [2], SPEX_RUN_CURVEFIT [1]
SPEX_RUN_CURVEFIT [2], SPEX_SAVE [1], SPEX_SAVE [2], SPEX_SAVE_DATA [1]
SPEX_SAVE_DATA [2], SPEX_THISTORY [1], SPEX_THISTORY [2], SPEX__DEFINE
SSW_CROSSCORR, STRATEGY HOLDER TOOLS ABSTRACT CLASS, STRUCTURE TO VOTABLE
Shers_load [1], Show Image [2], TEK_INIT [1], TEK_INIT [2], TEK_PRINT [1]
TEK_PRINT [2], TEST_CAL, UNFORMAT_INTERVALS, UPDATE_LINE_TEMPLATES, USE_VLTH
UTHELP, UTLABEL [1], UTLABEL [2], UTPLOT [1], UTPLOT [2], UTPLOT [3], UTPLOT [4]
UTPLOT [5], Vlth, WCHECK_SET [1], WRAP_TXT, WRITE_DD, X_EOUT_DRM [1], X_EOUT_DRM [2]
anytim [1], anytim [2], anytim [3], anytim [4], anytim [5], apar_check [1]
apar_check [2], array_insert, avsig_1 [6], axis_get_expanded_range, base_flash
batse_file_search [1], batse_file_search [2], bpow_taper, check_plotlimits
constbacksub [1], constbacksub [2], countsmod_plot [1], countsmod_plot [2]
cw_edroplist, cw_energy_range, cw_range, cw_ut_range, double_click_detect
drm_4_spex [1], drm_4_spex [2], drm_albedo, f_vth_thick, fcolor [2]
fcount_rate [1], fcount_rate [2], file__define, find_contig_ranges, fit_comp_kw
fits2rm, goes_reducer [1], grid_diffraction, help_merge [1], help_merge [2]
hesi_grid_trans, hessi_grid_trans, hsi_as_rdpacket, hsi_chk_obj
hsi_compute_image_axis, hsi_cw_energy_range, hsi_cw_ut_range, hsi_do_plotman
hsi_image__getaxis [2], hsi_image__plot [2], hsi_image_fitsread
hsi_image_plot, hsi_imagefile2png, hsi_imagefile_2_plotman
hsi_imagemisc_widget, hsi_lc_dims, hsi_make_hessi_ct, hsi_obs_summ_fill [1]
hsi_obs_summ_fill [2], hsi_obs_summ_soc__define
hsi_obs_summary_adapter__define, hsi_pixon_residuals, hsi_plot_flux
hsi_pmap2xy, hsi_qlook__define, hsi_shutter_transmission
hsi_spectrogramACCBIN [2], hsi_spectrogram__define [1]
hsi_spectrogram__define [2], hsi_spectrogram__define [3]
hsi_spectrogram__get_obs [1], hsi_spectrogram__livetime [1]
hsi_spectrum__filewrite, hsi_time_bin_auto, hsi_ui_flarecat, hsi_ui_img
hsi_ui_lc, hsi_ui_mon, hsi_ui_obs, hsi_ui_ql, hsi_ui_qlimage, hsi_ui_spec
hxr_cnt2phot, hxrbs_response, hxrs_response [1], hxrs_response [2]
hxrs_response [3], list_sp_files, low_e_spec_eff [1], low_e_spec_eff [2]
mark_intervals, mark_poly, modify_sled [1], mrdfits_spectra, option_changer [1]
option_changer [2], plot_goes_ospex, plotman, point [2], printx [1], printx [2]
pro set_bpow [1], pro set_bpow [2], pro set_vth_bpow [1], pro set_vth_bpow [2]
rd_sxs_pha [1], rd_sxs_pha [2], rd_wbs_pha [1], rd_wbs_pha [2], read_4_spex [1]
read_4_spex [2], read_batse_4_spex [1], read_batse_4_spex [2], read_dd
read_hessi_4_spex [1], read_hessi_4_spex [2], read_hessi_fits_4_spex [1]
read_hessi_fits_4_spex [2], read_hirex_4_spex [1], read_hirex_4_spex [2]
read_smm_4_spex [1], read_smm_4_spex [2], read_yohkoh_4_spex [1]
read_yohkoh_4_spex [2], select_widg, setup_spex [1], setup_spex [2]
soxs_readfile, spec_plot [1], spec_plot [2], spec_plot [3], spec_plot [4]
spectral_ratio [1], spectral_ratio [2], spectro_plot, spectro_plot2
spex_batse_preview [1], spex_batse_preview [2], spex_bk__define
spex_bkgrd t_d rate trange1 trange2 order sigmasigma [1]
spex_bkgrd t_d rate trange1 trange2 order sigmasigma [2]
spex_bkint__define, spex_bksub__define, spex_current [1], spex_current [2]
spex_customplot [1], spex_customplot [2], spex_data__define, spex_delete [1]
spex_delete [2], spex_gen_strategy_holder, spex_hold [1], spex_hold [2]
spex_image__define, spex_intervals [1], spex_intervals [2], spex_merge [1]
spex_merge [2], spex_preview [1], spex_preview [2], spex_source [1]
spex_source [2], spex_spec_plot [1], spex_spec_plot [2], spex_spec_plot [3]
spex_spec_plot [4], stretch_box, stretch_circle, t_utplot [1], t_utplot [2]
wbs_response [1], wbs_response [2], wcheck_set [2], where_are [1], where_are [2]
wrt_photon_list, xdroplist, xsel_list_multi, xzchange, ysinpixpix
[Previous]
[Next]
NAME:
CHI_NORM
PURPOSE:
compute chi^2 between observed and computed data
CALLING SEQUENCE:
chi2=chi_norm(cflux,oflux,eflux,norm=norm)
chi2=chi_norm(cflux,oflux,eflux,back,subs=subs,norm=norm,bnorm=bnorm)
INPUTS:
cflux = computed data
oflux = observed data
eflux = sigma error on oflux
OPTIONAL INPUTS:
back = Background data (assumed to be a vector the same length as oflux, clfux)
OUTPUTS:
chi2 = chi^2 = total [ (oflux-norm*cflux)^2/eflux^2 ]
chi2 = chi^2 = total [ (oflux-norm*cflux-bnorm*back)^2/eflux^2 ]
OPTIONAL OUTPUT KEYWORDS:
norm = normalization to make cflux = oflux
bnorm = normalization for the background
subs = indicies to include in chi^2 calculation
CALLED BY:
bcs_chi_norm
HISTORY:
18-sep-93, J. R. Lemen (LPARL) and D. M. Zarro (ARL), Written.
[Previous]
[Next]
PROJECT:
SOHO - CDS
NAME:
CHK_DATAWIN()
PURPOSE:
Check the existence in CDS database of a given datawin
EXPLANATION:
A valid datawin structure should contain the following tags:
DW_ID = Data window list ID number. Initially, this
is zero. It is updated by this routine to
reflect the ID number in the database.
DETECTOR = Either "G" for GIS or "N" for NIS.
DW_DESC = A short description of the data window list
beyond what is given in the associated line
list description, e.g. "Full slit, 10 pixels
wide". Can be up to 50 characters.
W_WIDTH = Width in pixels used to generate the
windows.
W_HEIGHT = The height in pixels used to generate the
windows. VDS only, for GIS this is set to
unity.
VDS_BACK = Either 0 for off, or 1 for on,
representing whether or not VDS background
windows are being used. For GIS window
lists this must be 0. If VDS_BACK is 1,
then at least one of the window names must
start with the characters "BACK" (case
insensitive).
LL_ID = The line list ID number for the line list
that this window list was derived from. An
appropriate entry must exist in the line
list database. Alternatively, this can be
set to zero to signal that the data window
list is not connected to a line list.
WINS = An array containing the window definitions.
The window definitions themselves are structures, of type
"cds_windows", with the following tags:
WIN_NAME = Window name, derived from the line name in
the line list database. Can be up to 40
characters.
WIN_DEF = The window definition. This is a 4-element
integer array, although GIS window definitions
only use two of them.
WIN_FLAG = Either 1 (true) or 0 (false) if window can generate a
flag.
This routine will check ALL tags of the given datawin, except
DW_ID and DW_DESC, against entries found from the database to see if
value of each tag matches.
This routine does NOT check to see if the given datawin
structure is valid. It should, therefore, be called after such
checkings are made.
CALLING SEQUENCE:
Result = CHK_DATAWIN(datawin [,errmsg=errmsg])
INPUTS:
DATAWIN -- Strcuture containing the data window definition
OPTIONAL INPUTS:
None.
OUTPUTS:
Result -- -1 if the given datawin does not exist in the database;
-2 indication of syntax error or wrong data type;
integer scalar or vector, indicating the datawin IDs
(DW_ID) of the matched datawins.
OPTIONAL OUTPUTS:
None.
KEYWORD PARAMETERS:
ERRMSG -- If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
RESULT = CHK_DATAWIN(datawin, ERRMSG=ERRMSG, ...)
IF ERRMSG NE '' THEN ...
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], NUM2STR
UNIQ [1], UNIQ [2], UNIQ [3]
CALLED BY:
ADD_DATAWIN, TP_WRT_DWIN
COMMON BLOCKS:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
CATEGORY:
Planning, Databases
PREVIOUS HISTORY:
Written September 28, 1994, by Liyun Wang, GSFC/ARC
MODIFICATION HISTORY:
Version 2, Liyun Wang, GSFC/ARC, October 11, 1994
ALL tags of a given datawin structure are checked now.
Cater for empty database. CDP, 3-Nov-94
Version 4, William Thompson, GSFC, 20 June 1995
Add tag WIN_FLAG
Version 5, 16-May-1997, William Thompson, GSFC
Fix bug involving strings starting with blank.
VERSION:
Version 5, 16-May-1997
[Previous]
[Next]
PROJECT:
SOHO - CDS
NAME:
CHK_DIR()
PURPOSE:
Check the validity of a directory name.
EXPLANATION:
CALLING SEQUENCE:
Result = CHK_DIR(dir_name)
INPUTS:
DIR_NAME -- A string specifying the directory name. For VMS system,
a valid directory name can be a logical name, or
any string with a format of '[...]', '[...]aaa.dir',
or 'aaa.dir'
OPTIONAL INPUTS:
None.
OUTPUTS:
RESULT -- 1 if the directory name is valid, 0 otherwise
OPTIONAL OUTPUTS:
OUTPUT -- A string indicating the real directory path
KEYWORD PARAMETERS:
FULLNAME -- if set and OUTPUT is present, OUTPUT will contain the full
path specification for the directory
CALLS: ***
CHKLOG [1], CHKLOG [2], DATATYPE [1], DATATYPE [2], DATATYPE [3], STR_INDEX [1]
STR_INDEX [2]
CALLED BY:
ADD_PATH [1], ADD_PATH [2], CDD, CDS_COMPRESS, CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], DATA_PATHS, DMOVIE [1], DMOVIE [2], FIX_IAP, GET_NOAA
GET_RECENT_EIT, IMAGE_TOOL_EVENT, MK_CDS_GIF, MK_PLAN_FORM, MK_STUDY, PICKFILES
QUERY_ANOMALY, REBIN_FID, RESTORE_ANALYSIS, RESTORE_CDS_ADEF, SAVE_CDS_ADEF
WIMG_INFO3, WIMG_INFO4, WINFO_ACTIV, WLISTER, WLOAD, WLOADC, WLOADINFO1, WRITE_ANOMALY
WSAVE_PS [2], WTIME_HEIGHT, XCDS_COSMIC, XPORT, XSTUDY, concat_dir [4], mk_minim
mk_stdim, mk_stdim_list, w_las_exp_norm, wprint, wsave1, wsave2, xpickfile2
COMMON BLOCKS:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
CATEGORY:
PREVIOUS HISTORY:
Written October 9, 1994, by Liyun Wang, GSFC/ARC
MODIFICATION HISTORY:
Version 2, Liyun Wang, GSFC/ARC, December 16, 1994
Made work for VMS directories
Version 3, Liyun Wang, GSFC/ARC, December 29, 1994
Added keyword FULLNAME
Fixed bug of false reporting if the given string represents
a plain file under Unix OS
VERSION:
Version 3, December 29, 1994
[Previous]
[Next]
PROJECT:
SOHO - CDS
NAME:
CHK_F_RASTER()
PURPOSE:
Check existence in CDS database of a given raster structure
EXPLANATION:
Currently a f_raster structure has the following tags:
RAS_ID = Raster ID number. Initially, this is
zero. It is updated by this routine to
reflect the ID number in the database.
DETECTOR = Either "G" for GIS or "N" for NIS.
RAS_DESC = A short description of the raster, giving
its purpose.
SLIT_NUM = The ID number for the slit to be used.
XSTEP = The step size in the X direction, in arcsec.
YSTEP = The step size in the Y direction, in arcsec.
NX = The number of exposure positions in X.
NY = The number of exposure positions in Y.
This routine will check ALL tags of the given f_raster, except
RAS_ID and RAS_DESC against entries found from the database to
see if value of each tag matches.
This routine does NOT check to see if the given f_raster
structure is valid. It should, therefore, be called after such
checkings are made.
CALLING SEQUENCE:
Result = CHK_F_RASTER(f_raster [,errmsg=errmsg])
INPUTS:
F_RASTER -- A strcuture containing the f_raster definition
OPTIONAL INPUTS:
None.
OUTPUTS:
Result -- -1 if the given f_raster does not exist in the database;
-2 for syntax error or wrong type of input parameter;
Integer scalar or vector indicating the ID number of existed
f_raster if found in the database
OPTIONAL OUTPUTS:
None.
KEYWORD PARAMETERS:
ERRMSG -- If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
RESULT = CHK_F_RASTER(f_raster, ERRMSG=ERRMSG, ...)
IF ERRMSG NE '' THEN ...
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], NUM2STR
UNIQ [1], UNIQ [2], UNIQ [3]
CALLED BY:
ADD_F_RASTER, TP_WRT_FRAST
COMMON BLOCKS:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
CATEGORY:
Planning, Databases
PREVIOUS HISTORY:
Written October 13, 1994, by Liyun Wang, GSFC/ARC
MODIFICATION HISTORY:
Cater for empty database. CDP, 3-Nov-94
VERSION:
Version 2, 3-Nov-94
[Previous]
[Next]
PROJECT:
SOHO - CDS
NAME:
CHK_F_STUDY()
PURPOSE:
Check existence in CDS database of a given fundamental study
EXPLANATION:
Currently a fundamental study structure has 8 tags. They are:
STUDY_ID -- Study ID
OBS_PROG -- Name of the study
TITLE -- Title of the study
CATEGORY -- The study category
VAR_POINT -- Boolean parameter that indicates whether the pointing
of the study is controllable
N_RASTER_DEF-- Number of rasters in the definition.
RASTERS -- Definition of rasters in the study (if
N_RASTER_DEF>0). It itself is a structure that has
the following tags:
RAS_ID -- Raster ID number
POINTING -- How to treat pointing parameters INS_X, INS_Y
INS_X -- X position of the instrument pointing
INS_Y -- Y position of the instrument pointing
This routine will check ALL tags of the given f_study, except
STUDY_ID, OBS_PROG, TITLE and CATEGORY, against entries found from the
database to see if value of each tag matches.
Two fundamental studies are said to be identical only if
values of all tags of the two studies are identical.
This routine does NOT check to see if the given f_study
structure is valid. It should, therefore, be called after such
checkings are made.
CALLING SEQUENCE:
Result = CHK_F_STUDY(f_study [,errmsg=errmsg])
INPUTS:
F_STUDY -- A strcuture containing the study definition
OPTIONAL INPUTS:
None.
OUTPUTS:
Result -- -1 if the given f_study does not exist in the database;
-2 for syntax error or wrong type of input parameter;
Integer scalar or vector indicating the ID number of existed
f_study if found in the database
OPTIONAL OUTPUTS:
None.
KEYWORD PARAMETERS:
ERRMSG -- If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
RESULT = CHK_F_STUDY(f_study, ERRMSG=ERRMSG,..)
IF ERRMSG NE '' THEN ...
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], NUM2STR
UNIQ [1], UNIQ [2], UNIQ [3]
CALLED BY:
ADD_F_STUDY
COMMON BLOCKS:
None.
RESTRICTIONS:
CHK_F_STUDY must not be called if N_RASTER_DEF=0.
SIDE EFFECTS:
None.
CATEGORY:
Planning, Databases
PREVIOUS HISTORY:
Written October 11, 1994, by Liyun Wang, GSFC/ARC
MODIFICATION HISTORY:
Cater for empty database. CDP, 3-Nov-94
Version 3, William Thompson, GSFC, 7 November 1994
Maintain original order of rasters, don't sort.
Version 4, William Thompson, GSFC, 21 November 1994
Removed item N_RASTERS0
Added item N_RASTER_DEF
Version 5, William Thompson, GSFC, 10 February 1995
Changed N_POINTINGS to VAR_POINT.
Removed VAR_RASTERS.
VERSION:
Version 5, 10 February 1995
[Previous]
[Next]
Name: chk_flares
Purpose: verify ok to delete reformatted data sets (post tape making)
checks for goes events (flares) during time range
Method: gets time ranges of reformatted data sets on disk calls
rd_gev to determine goes events >= above parmeter
WARNING - assumes all instruments grouped by fileids
Input Parameters:
path - directory to check (default = current)
Output Parameters:
flare_files - string array of files containg flare data
Optional Keyword Paramters:
copy - if set, will copy files to $DIR_DATA_FLARE
above - if set, string NOAA flare class for minimum cutoff (def=M5)
quiet - if set, informational messages are suppressed
cba - if set, save cba files also, default is PI Inst + ada
delete - if set, deletes old files on target directory
test - if set, display copy and delete cmds but do not spawn them
biggest- if set, gets biggest flare if none exceeds above parameter
Calling Sequence:
chk_flares, path [, flare_files, ,/copy , above='Class' ,/cba , /quiet]
[, /delete ,/test ,/biggest]
Category:
swmaint, system, disk
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CHECK_TIME, Int2Ex [1], Int2Ex [2]
RD_GEV, UNIQ [1], UNIQ [2], UNIQ [3], anytim2ex [1], anytim2ex [2], break_file [4]
curdir [1], curdir [2], fidrange [1], fidrange [2], file_list [1], file_list [2]
filetimes [1], filetimes [2], get_closest, int2secarr [1], int2secarr [2]
launch [1], launch [2], pr_gev, prstr [1], prstr [2], str_replace [1]
str_replace [2], tim2file [1], tim2file [2]
History: slf, 3-August-1992
slf, 22-Aug-1992 added delete and test keywords
slf, 14-Sep-1992 added cba file delete commands
slf, 9-Oct-1992 added biggest keyword parameter
mdm, 5-Oct-1993 Corrected error which occurs when the last
fid does not have an ada file.
slf, 6-Jul-1994 protect sort from scaler, subscript error
if gev only has le 2 events! (solar minimum)
[Previous]
[Next]
Project : SOHO - LASCO
Name :
Purpose :
Category :
Explanation :
Syntax :
CALLED BY:
EXSUNC, WMESSAGE [1], WSAVE_PS [2], las_exp_norm, scan4limb
Examples :
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
CALLS: ***
RSTRPOS
Common :
Restrictions:
Side effects: Not known
History : Version 1, 02-Sep-1995, B Podlipnik. Written
Contact : BP, borut@lasco1.mpae.gwdg.de
[Previous]
[Next]
PROJECT:
SOHO - CDS
NAME:
CHK_LINELIST()
PURPOSE:
Check the existence in CDS database of a given linelist
EXPLANATION:
Currently a linelist structure has 5 tags. They are:
LL_ID -- Line list ID number
DETECTOR -- Either 'G' or 'N'
LL_DESC -- Description of the line list
LINES -- A structure array for all lines in the
list. It has 5 tags for each line:
LINES.LINENAME -- Line name
LINES.WAVELNTH -- Wavelength in Angstroms
LINES.GR_ORDER -- Grating order
LINES.CEN_PIX -- Central detector pixel
LINES.WAVEBAND -- Wavelength band
This routine will check ALL tags of the given linelist, except LL_ID
and LL_DESC, against entries found from the database to see if value of
each tag matches.
Two line lists are said to be identical only if values of all checked
tags of the two line lists are identical.
This routine does NOT check to see if the given linelist
structure is valid. It should, therefore, be called after such
checkings are made.
CALLING SEQUENCE:
Result = CHK_LINELIST(linelist [,errmsg=errmsg])
INPUTS:
LINELIST -- A strcuture containing the line list definition
OPTIONAL INPUTS:
None.
OUTPUTS:
Result -- -1 if the given linelist does not exist in the database;
-2 indication of syntax error or wrong data type;
integer scalar or vector, indicating the linelist IDs
(LL_ID) of the matched linelists.
OPTIONAL OUTPUTS:
None.
KEYWORD PARAMETERS:
ERRMSG -- If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
RESULT = CHK_LINELIST(linelist, ERRMSG=ERRMSG, ...)
IF ERRMSG NE '' THEN ...
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], NUM2STR
UNIQ [1], UNIQ [2], UNIQ [3]
CALLED BY:
ADD_LINELIST, TP_WRT_LLIST
COMMON BLOCKS:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
CATEGORY:
Planning, Databases
PREVIOUS HISTORY:
Written September 28, 1994, by Liyun Wang, GSFC/ARC
MODIFICATION HISTORY:
Version 2, Liyun Wang, GSFC/ARC, October 6, 1994
Now returns ID of the linelist found in the database.
Version 3, Liyun Wang, GSFC/ARC, October 11, 1994
ALL tags of a given linelist structure are checked now.
Version 4 CDP, cater for empty databases. 3-Nov-94
Version 5, CDP, exclude central pixel from uniqueness test.
Version 6, 16-May-1997, William Thompson, GSFC
Fix bug involving strings starting with blank.
Version 7, 05-Oct-1999, William Thompson, GSFC
Fixed bug involving sub-milliAngstrom wavelength differences
Tighten way sorting is done.
VERSION:
Version 7, 05-Oct-1999
[Previous]
[Next]
Project : SOHO - CDS
Name : CHK_T_STUDY()
Purpose : Check existence in CDS database of a given study title
Explanation : This routine will check the STUDY_ID, OBS_PROG, and TITLE tags
against entries found from the database to see if a match is
found. If the EITHER keyword is set, then the STUDY_ID tag is
ignored, and a positive value is returned if either the
OBS_PROG or TITLE tags match.
Use CHK_T_STUDY without /EITHER to see if a given STUDY_ID,
OBS_PROG, TITLE combination already exists in the database or
needs to be added.
Use CHK_T_STUDY with /EITHER to check if the STUDY_ID,
OBS_PROG, TITLE combination can be added.
Use : Result = CHK_T_STUDY(f_study [,errmsg=errmsg])
Inputs : F_STUDY = A structure containing the study definition
Opt. Inputs : None.
OUTPUTS : Result = -1 if the given study does not exist in the database,
-2 for syntax error or wrong type of input parameter,
Integer scalar or vector indicating the ID number of
existing f_study if found in the database
Opt. Outputs: None.
Keywords : EITHER = If set, then the software will ignore the value of
STUDY_ID, and check if either the OBS_PROG or TITLE
tags already exists in the database. When used with
this keyword, a non-negative result does not mean that
both the name and title are the same, but only that
one or the other is the same.
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors
are encountered, then a null string is returned. In
order to use this feature, ERRMSG must be defined
first, e.g.
ERRMSG = ''
Result = CHK_T_STUDY(f_study, ERRMSG=ERRMSG,..)
IF ERRMSG NE '' THEN ...
When used with the EITHER keyword, the value of ERRMSG
will specify whether the name or the title was in
conflict.
Calls : ***