[Previous]
[Next]
NAME:
GAMMASCAL
PURPOSE:
To modify images in order to account
for a certain gamma-factor WITHOUT
changing the IDL color table.
CATEGORY:
PICO
CALLING SEQUENCE:
result=GAMMASCAL(image,gamma)
INPUTS:
image: The image to be scaled
gamma: The gamma exponent to be used
OPTIONAL INPUTS:
None
KEYWORD PARAMETERS:
VERBOSE: Gives time indications about
needed time...
OUTPUTS:
result: The scaled image
OPTIONAL OUTPUTS:
None
EXAMPLE:
TVSCL,GAMMASCAL(image,.3)
The image will be displayed using a gamma
exponent of 0.3 without changing the IDL
color table
COMMON BLOCKS:
None
SIDE EFFECTS:
Unknown
RESTRICTIONS:
None
PROCEDURE:
A lookup table is created and then each
pixel value is replaced by the new one.
By efficient programming the procedure
could perhaps be speeded up slightly.
MODIFICATION HISTORY:
V1.0 Alexander Epple 14-FEB-1996 MPAe Lindau
[Previous]
[Next]
NAME:
GAMMASCAL
PURPOSE:
To modify images in order to account
for a certain gamma-factor WITHOUT
changing the IDL color table.
CATEGORY:
PICO
CALLING SEQUENCE:
result=GAMMASCAL(image,gamma)
INPUTS:
image: The image to be scaled
gamma: The gamma exponent to be used
OPTIONAL INPUTS:
None
KEYWORD PARAMETERS:
VERBOSE: Gives time indications about
needed time...
OUTPUTS:
result: The scaled image
OPTIONAL OUTPUTS:
None
EXAMPLE:
TVSCL,GAMMASCAL(image,.3)
The image will be displayed using a gamma
exponent of 0.3 without changing the IDL
color table
COMMON BLOCKS:
None
SIDE EFFECTS:
Unknown
RESTRICTIONS:
None
PROCEDURE:
A lookup table is created and then each
pixel value is replaced by the new one.
By efficient programming the procedure
could perhaps be speeded up slightly.
MODIFICATION HISTORY:
V1.0 Alexander Epple 14-FEB-1996 MPAe Lindau
[Previous]
[Next]
Project : SOHO - CDS
Name : gauss()
Purpose : Gaussian function
Explanation : Calculates the gaussian of a function
Use : IDL> gauss(x,a,p,w)
Inputs : x-array, max-intensity, shift, width
Opt. Inputs : None
Outputs : Gaussian profile
Opt. Outputs: None
Keywords : None
Calls : ***
CDSGAUSS
Common : None
Restrictions: None
Side effects: None
Category :
Prev. Hist. :
Written : Nils Brynildsen, ITA, UiO 27-May-1993
Modified : Version 1 Nils Brynildsen, ITA, UiO, 27-May-1993
Version : Version 1 27-May-1993
[Previous]
[Next]
Project : SOHO - CDS
Name : gauss_d_a()
Purpose : Calculate the partial derivative of line intensity
Explanation : Partial derivative of the Gaussian intensity
Use : IDL> val = gauss_d_a(x-array,line intensity,
line position (i.e. shift), line width)
Inputs : x-array, intensity, position and width of line
Opt. Inputs : None
Outputs : partial derivative of Gaussian intensity
Opt. Outputs: None
Keywords : None
Calls : None
CALLED BY:
funct_f, functn
Common : None
Restrictions: None
Side effects: None
Category : ?
Prev. Hist. : ?
Written : Nils Brynildsen, ITA, UiO 1-July-1993
Modified : Version 1 Nils Brynildsen, ITA, UiO, 1-July-1993
Version : Version 1 1-July-1993
[Previous]
[Next]
Project : SOHO - CDS
Name : gauss_d_p()
Purpose : Calculate the partial derivative of line position
Explanation : Partial derivative of the Gaussian position
Use : IDL> val = gauss_d_p(x-array,line intensity,
line position (i.e. shift),
line width)
Inputs : x-array, intensity, position and width of line
Opt. Inputs : None
Outputs : partial derivative of Gaussian position
Opt. Outputs: None
Keywords : None
Calls : None
CALLED BY:
funct_f, functn
Common : None
Restrictions: None
Side effects: None
Category : ?
Prev. Hist. : ?
Written : Nils Brynildsen, ITA, UiO 1-July-1993
Modified : Version 1 Nils Brynildsen, ITA, UiO, 1-July-1993
Version : Version 1 1-July-1993
[Previous]
[Next]
Project : SOHO - CDS
Name : gauss_d_w()
Purpose : Calculate the partial derivative of line width
Explanation : Partial derivative of the Gaussian width
Use : IDL> val = gauss_d_w(x-array,line intensity,
line position (i.e. shift), line width)
Inputs : x-array, intensity, position and width of line
Opt. Inputs : None
Outputs : partial derivative of Gaussian width
Opt. Outputs: None
Keywords : None
Calls : None
CALLED BY:
funct_f, functn
Common : None
Restrictions: None
Side effects: None
Category : ?
Prev. Hist. : ?
Written : Nils Brynildsen, ITA, UiO 29-June-1993
Modified : Version 1 Nils Brynildsen, ITA, UiO, 29-June-1993
Version : Version 1 29-June-1993
[Previous]
[Next]
NAME : GAUSS_PROFILE
PURPOSE : Calcultes Gaussian profiles
CALLING SEQUENCE :
Value = GAUSS_PROFILE(W, gauss_par)
INPUTS:
W values at which the function is evaluated
GAUSS_PAR Normal Gaussian parameters
which define a Gaussian profile in the way :
continuum = GAUSS_PAR(0,*,*) in counts
peak = GAUSS_PAR(1,*,*) in counts
center = GAUSS_PAR(2,*,*) in pixels
width = GAUSS_PAR(2,*,*) in pixels
I(W) = continuum+peak*exp(-0.5*((W-center)/width)^2)
RESTRICTION:
GAUSS_PAR should not be a scalar.
The first dimension should be 4.
If GAUSS_PAR is an 1-d array, then W can be any of
scalar, 1-d array, 2-d array etc.
IF GAU_PAR is a 2-d or 3-d array, then W should
be either a scalar or 1-d array.
OUTPUTS:
Value spectral profiles
(1-d, 2-d or 3-d array)
with N0 x N1 X N2 elements
N0 = number of X(*,0,0) elements
N1 x N2 = number of GAUSS_PAR(0,*,*) elements
MODIFICATION HISTORY
April 1997 Jongchul Chae
CALLED BY
SUMER_DISPLAY_W
[Previous]
[Next]
NAME : GAUSS_PROFILE
PURPOSE : Calcultes Gaussian profiles
CALLING SEQUENCE :
Value = GAUSS_PROFILE(W, gauss_par)
INPUTS:
W values at which the function is evaluated
GAUSS_PAR Normal Gaussian parameters
which define a Gaussian profile in the way :
continuum = GAUSS_PAR(0,*,*) in counts
peak = GAUSS_PAR(1,*,*) in counts
center = GAUSS_PAR(2,*,*) in pixels
width = GAUSS_PAR(2,*,*) in pixels
I(W) = continuum+peak*exp(-0.5*((W-center)/width)^2)
RESTRICTION:
GAUSS_PAR should not be a scalar.
The first dimension should be 4.
If GAUSS_PAR is an 1-d array, then W can be any of
scalar, 1-d array, 2-d array etc.
IF GAU_PAR is a 2-d or 3-d array, then W should
be either a scalar or 1-d array.
OUTPUTS:
Value spectral profiles
(1-d, 2-d or 3-d array)
with N0 x N1 X N2 elements
N0 = number of X(*,0,0) elements
N1 x N2 = number of GAUSS_PAR(0,*,*) elements
MODIFICATION HISTORY
April 1997 Jongchul Chae
CALLED BY
SUMER_DISPLAY_W
[Previous]
[Next]
NAME : GAUSSB4_CONV
PURPOSE : Convert the Gauss B4 compression parameters
to normal Gaussian line parameters or vice versa
CALLING SEQUENCE:
Value = GAUSSB4_CONV(data, reverse=reverse)
INPUTS :
DATA Gauss B4 compression parameters
(1-d,2-d, or 3-d integer array)
DATA(0,*,*) : continuum in counts
DATA(1,*,*) : peak in counts
DATA(2,*,*) : 100 times center position in pixels
DATA(3,*,*) : 100 times half of the pixel interal
in which the Gaussian integral
lies between 1/4 and 3/4
OUTPUTS:
Value Normal Gaussian parameters
(1-d, 2-d, or 3-d floating array)
which define a Gaussian profile in the way :
continuum = Value(0,*,*) in counts
peak = Value(1,*,*) in counts
center = Value(2,*,*) in pixels
width = Value(2,*,*) in pixels
I(j) = continuum+peak*exp(-0.5*((j-center)/width)^2)
KEYWORDS :
REVERSE If set, given input are interpreted to be
normal gaussian parameters and Gauss B4 compression
parameters are returned.
MODIFICATION HISTORY
April 1997 Jongchul Chae
CALLED BY
XRASTER [1], XRASTER [2]
[Previous]
[Next]
NAME:
GAUSSFIT
PURPOSE:
Fit the equation 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 = sigma (the width).
A3 = constant term, A4 = linear term, A5 = quadratic term.
The parameters A0, A1, A2, A3 are estimated and then CURVEFIT is
called.
CATEGORY:
?? - fitting
CALLING SEQUENCE:
Result = GAUSSFIT(X, Y [, A])
INPUTS:
X: The independent variable. X must be a vector.
Y: The dependent variable. Y must have the same number of points
as X.
OUTPUTS:
The fitted function is returned.
OPTIONAL OUTPUT PARAMETERS:
A: The coefficients of the fit. A is a six-element vector as
described under PURPOSE.
CALLS: ***
CURVEFIT, GAUSS_FUNCT, ONEG_AFIT, POLY_FIT
CALLED BY:
ADD_SCATTER_DRM, ANAL_BCS_PHA, ANAL_STIMS, AN_NIMCP_1_2, AN_NIMCP_AVG, CAL_SHER
CDS_LINEFIT_WRAP, DECOMPOSE_BATSE_DRM, DSPEXP, Enorm_drm, FE25_BSC_TEMP, Fitting
HISTOGAUSS, HXT_BACK, HXT_CAL_FIX [1], HXT_CAL_FIX [2], H_VS_TIME, STOKESFIT
XSM_PREP, exp_scale min_exp max_exp [1], find_grid, fit_pha
get_linearity sig e_min e_max, ltc, read_ltc file
COMMON BLOCKS:
None.
SIDE EFFECTS:
None.
RESTRICTIONS:
The peak or minimum of the Gaussian must be the largest
or smallest point in the Y vector.
PROCEDURE:
If the (MAX-AVG) of Y is larger than (AVG-MIN) then it is assumed
that the line is an emission line, otherwise it is assumed there
is an absorbtion 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 extrema until
a point is found less than the 1/e value.
MODIFICATION HISTORY:
DMS, RSI, Dec, 1983.
[Previous]
[Next]
NAME:
GAUSSFIT
PURPOSE:
Fit the equation y=f(x) where:
F(x) = A0*EXP(-z^2/2) + A3
and
z=(x-A1)/A2
A0 = height of exp, A1 = center of exp, A2 = sigma (the width).
A3 = constant term
The parameters A0, A1, A2, A3 are estimated and then CURVEFIT is
called.
CATEGORY:
?? - fitting
CALLING SEQUENCE:
Result = GAUSSFIT(X, Y [, A])
INPUTS:
X: The independent variable. X must be a vector.
Y: The dependent variable. Y must have the same number of points
as X.
OUTPUTS:
The fitted function is returned.
OPTIONAL OUTPUT PARAMETERS:
A: The coefficients of the fit. A is a six-element vector as
described under PURPOSE.
CALLS: ***
CURVEFIT, GAUSS_FUNCT, LAS_FIT_GAUSS
CALLED BY:
ADD_SCATTER_DRM, ANAL_BCS_PHA, ANAL_STIMS, AN_NIMCP_1_2, AN_NIMCP_AVG, CAL_SHER
CDS_LINEFIT_WRAP, DECOMPOSE_BATSE_DRM, DSPEXP, Enorm_drm, FE25_BSC_TEMP, Fitting
HISTOGAUSS, HXT_BACK, HXT_CAL_FIX [1], HXT_CAL_FIX [2], H_VS_TIME, STOKESFIT
XSM_PREP, exp_scale min_exp max_exp [1], find_grid, fit_pha
get_linearity sig e_min e_max, ltc, read_ltc file
COMMON BLOCKS:
None.
SIDE EFFECTS:
None.
RESTRICTIONS:
The peak or minimum of the Gaussian must be the largest
or smallest point in the Y vector.
PROCEDURE:
If the (MAX-AVG) of Y is larger than (AVG-MIN) then it is assumed
that the line is an emission line, otherwise it is assumed there
is an absorbtion 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 extrema until
a point is found less than the 1/e value.
MODIFICATION HISTORY:
DMS, RSI, Dec, 1983.
[Previous]
[Next]
NAME:
gbo_paths
PURPOSE:
To return the directory list of where ground based data resides
CALLING SEQUENCE:
dirs = gbo_paths()
CALLS: ***
data_paths2 [1], data_paths2 [2]
CALLED BY:
find_dbo_dir, lastgbo, lastgki, newfiles [1], newfiles [2], newfiles [3]
OPTIONAL KEYWORD INPUT:
gbo_only - If set, only pass back the "standard" gbo directories,
do not pass back things like "DIR_GEN_SYOPTIC"
OUTPUT:
returns a string array of the environment variables where
DIR_GBO is defined
RESTRICTIONS:
Currently only works for workstations
HISTORY:
Written 26-Jun-92 by M.Morrison
11-Sep-92 (MDM) - Added DIR_GEN_SYNOPTIC to the derived list
21-Jan-93 (MDM) - Modified to use DATA_PATHS2 routine
27-Jan-93 (MDM) - Added /GBO_ONLY option
[Previous]
[Next]
PRO GCURSOR,TABLE_NAME,N_POINTS
created by M.BOUT, LAS, 931118
the graphic cursor becomes enable and a group of points taken on the
plot are printed & writed into a given table.
[Previous]
[Next]
Project : SOHO - CDS
Name : GDSPSPEC
Purpose : Displays all spectral windows from specific exposures.
Explanation : The individual spectral windows are deselected
into their corresponding positions on the detector.
Line selection and windows given in Blue Book
can be displayed. Measurements of wavelengths
and positions on the detector is possible
together with line identification.
Use : gdspspec,QLDS
Inputs : QLDS: A CDS QL data structure
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: Should return the displayed data for further analyses
and PostScript file. To be written.
Keywords : GROUP_LEADER:
If this invoked by any other CDS QuickLook
display routine (group leader responsible for
keeping the QLDS), this keyword should have
the widget ID of the top level base of the
calling routine.
NOCHECK :
Set to skip QLMGR parameter check.
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], ASSIGN_NOCOPY, CDSLOG, CDSNOTIFY, CDSPICKFILE
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], GDSPEC_DRAW, GDSPEC_LOG
GDSPSPEC_EVENT, GDSP_REDISPLAY, GMAKE_SPEC, GT_DIMENSION, GT_SPECTRUM, GT_VALID
LOAD_WAVECAL, PCONVERT, PFIND, PICK_LINE, PIX2WAVE, PQLPROFILE, PRESTORE, PS [1], PS [2]
PSCLOSE [1], PSCLOSE [2], PSPLOT [1], PSPLOT [2], PSTORE, PUT_GLINES, PUT_GSPECTRA
QLDS_CHECKIN, QLDS_REPORT, QLMGR, QL_RD_LLIST, SETWINDOW [1], SETWINDOW [2], TRIM
WIDG_HELP, XLOADCT [1], XLOADCT [2], XLOADCT [3], XMANAGER, XPDMENU, concat_dir [4]
CALLED BY:
DSPSPEC
Common : QLSAVE
Restrictions: QLDS must be a valid CDS QL data structure
Requires dummy GIS spectrum $CDS_GDS_MODEL/gis_dummy.dat
Looks for line lists in $CDS_PLAN_TECH and $CDS_INFO,
with names 'llist_*'.
For HELP displays the file $CDS_INFO/gdspspec.hlp
Side effects:
Category : QuickLook, Display, NIS
Prev. Hist. : From the NIS version + Dave Pike's TP_PAGE1
Written : Stein Vidar Hagfors Haugan, March 1994
Modified : SVHH, 16 May 1994
Added call to CONCAT_DIR('$CDS_GDS_MODEL',..)
SVHH, 21 May 1994
Switched GEN_WAV(?) --> pix2wave()
Removed some debris from old NDSPSPEC
SVHH, Version 2, 7 June 1994
Added Line ID, on-screen line list marking,
PostScript file dump, profiling/measuring.
Added some support for calibration files.
PB, July 6, 1994
Added call to help routine QLHELP
PB, August 26, 1994
Changed dety --> detx in nmake_spect.pro
PB, Sept 21 - 94 Added Help using WIDG_HELP
SVHH, Version 3, 25-January-1995
Fixed error in locating band 1 windows.
Version 4, SVHH, 27 February 1996
Improved handling of various dimensionality.
(Sort of preliminary facelift)
Version 5, SVHH, 14 April 1996
Using LOAD_WAVECAL
Version 6, SVHH, 16 April 1996
Plot scaling changed.
Version 7, SVHH, 27 November 1996
Fixed disappearing QLDS when called from prompt.
Version : 7, 27 November 1996
[Previous]
[Next]
NAME: gen_file_id
Purpose: given either a weekly-fileid OR a range of fileids
(which can span n-weeks) generate all valid file ids.
Calling Sequence:
files = gen_file_id(weekids, [range=range, filename=
filename, nocba=nocba, xbd_path=xbd_path]
range input start and stop file id as a two element
vector: e.g. ['920422.0000','920429.1000']
filename if set will return checked list of all possible
file names.
nocda if use with filename will return all files
except cba files.
CALLS: ***
GetRng, PREFIXCK, PTSTR, Rd_TapDir, UNIQ [1], UNIQ [2], UNIQ [3], ck, fid2ex [1]
fid2ex [2], tim2orbit [1], tim2orbit [2], weekid [1], weekid [2], weekid [3]
CALLED BY:
archive_ck [1], archive_ck [2]
History:
written 3-May-94
-------------------------------------------------------------
[Previous]
[Next]
NAME:
gen_fn
PURPOSE:
Given file prefix and/or fileid Generate/Create full
file names.
CALLING SEQUENCE:
fn = gen_fn(hdr, drecs, [wid=wid, wkpre=wkpre,
prefix=prefix, fileids=fileids])
Where:
hdr input header to tape dir. file
drecs input data_recs to tape dir. file
wid optional input Weekid to create hdr and drecs.
wkpre optional input for weekly file prefixes
prefix optional input for reformatted file prefixes
fileids optional input for reformatted fileids
CALLS: ***
PREFIXCK, Rd_TapDir, STR2ARR [1], STR2ARR [2], weekid [1], weekid [2], weekid [3]
CALLED BY:
go_rdtap [1], go_rdtap [2]
Examples:
fn = gen_fn(hdr, drecs, prefix=['spr','sfr'],
fileids=['911205.1207','911206.0424'])
fn = gen_fn(wid='91_49', prefix=['spr'],
fileids=['911206.0424'])
HISTORY:
Written 16-Sept-92, gal
30-Nov, bug fix for null on weeklys, gal
[Previous]
[Next]
NAME: gener_mask.pro
PURPOSE: make a circular mask for photometry's studies
CATEGORY: Processing high level
CALLING SEQUENCE: gener_mask,ima_name,npix,Xc,Yc,R,intval,extval
INPUTS: ima_name Name of mask
npix dimension
OPTIONAL INPUT PARAMETERS: Xc,Yc circle's coords
R radius of mask
intval value inside
extval value outside
KEYWORD PARAMETERS: None
OUTPUTS: ima_name mask's frame
OPTIONAL OUTPUT PARAMETERS: None
CALLS: ***
ALIGN1, visu_cal
CALLED BY:
crevig, lunuleR1R2d, vignettage [1], vignettage [2]
COMMON BLOCKS: None
SIDE EFFECTS: None
RESTRICTIONS: None
PROCEDURE:
MODIFICATION HISTORY: defined by M.B 09/10/93
modified by M.B 02/17/94 : LAS
SCCS variables for IDL use
@(#)gener_mask.pro 1.0 09/10/93 :LAS
[Previous]
[Next]
Project : SOHO - LASCO/EIT
Name : GENERIC_MOVIE
Purpose : Load various data formats into pixmaps and call WRUNMOVIE for animation.
Explanation : This procedure is a generic interface to converting data
(image files or data cubes) into the LASCO MVI format.
The user can then save the movie in MVI format and use
routines such as wrunmovie.pro, combine_mvi.pro, mvi2mpg.pro,
put_mvi.pro etc. for MVI manipulation.
Use : GENERIC_MOVIE, data[, bmin, bmax], /SXT, /MK3, /TRUECOLOR
Inputs : data : can be:
- 3 dimensional byte array (nx,ny,len)
- name of file containing names of images
- strarr of names of images
(images can be of type: .fits, .gif, .pict, .tiff)
Optional Inputs: bmin, bmax : Minimum and maximum DN for BYTSCL.
Outputs : None.
Keywords :
/SXT : Data is YOHKOH/SXT FITS files.
/MK3 : Data is Mauna-Loa Mark3 Coronagraph rpb files.
/PICT : Data are PICT files
PAN=.5 : Resize to half
LABEL Set equal to array of labels to put in lower left corner of frames
/RDIFF : Do running difference movie
TRUECOLOR ; Set if images are true color
/TIMES : Put timestamp on each frame
Calls : ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CONGRID [1], CONGRID [2]
CONGRID [3], DATATYPE [1], DATATYPE [2], DATATYPE [3], DEF_LASCO_HDR, DOY2UTC
FXPAR [1], FXPAR [2], LASCO_READFITS [1], LASCO_READFITS [2], READFITS [1]
READFITS [2], READFITS [3], READLIST, READ_GIF, READ_PICT, TIFF_READ, UTC2STR
WRUNMOVIE [1], WRUNMOVIE [2], break_file [4]
Side effects: Creates multiple pixmaps.
Category : Image Display/Animation.
See Also : WMKMOVIE.PRO is a widget front-end to making LASCO/EIT movies.
- Added /MK3 keyword, .tiff support
05/11/06 @(#)generic_movie.pro 1.18 :LASCO IDL LIBRARY, 1996.
DW 21 Jan 99 - Y2K Fix for Yohkoh date
Modified : SEP 16 Dec 97 - Added /SXT keyword
NBR 1 May 02 - Add RDIFF keyword, NBR 3 Jan 02 - Add LABEL keyword
NBR 3 Sep 02 - Add capability for floating point FITS
NBR 7 Jun 01 - Add PNG support, NBR 9 Apr 99 - Added .jpg support
NBR 11 Apr 05 - Use /last keyword for break_file
NBR 11 May 06 - Revert date-obs and time-obs to LASCO level-0.5 format if time-obs is blank
NBR 14 May 99 - Add PICT keyword, NBR 15 Sep 99 - Add PAN keyword
NBR 17 Mar 05 - Refine criteria for doing REBIN
NBR 19 Aug 05 - Handle generic (hopefully) SSW FITS header; tested with MK4 and BBSO
NRL, Prev. Hist. : None., RAH 16 SEP 04 - Flag for true color
SCCS variables for IDL use, SEP 06 Jan 98 - Added .pict, Version :
Written : Scott Paswaters
[Previous]
[Next]
Name: genx2html
Purpose: convert a 'genx' file to an html file in a 'standard' format
Calling Sequence:
genx2html,genxfile [,outfile=outfile, httpdir=httpdir, thumbfact=N,/thumb]
Input Parameters:
genxfiles - one or more genx files to convert
Keyword Parameters:
outfiles - if set, output filenames (default derived from genx name)
thumbnail - if set, make thumbnail and link
thumbfact - if set, scale factor for thumbnail
maxthumb - if set, scale thumbnail to this size (largest dimension)
addlinks - if set, filename to add a link to this image (uniq)
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], CONGRID [1], CONGRID [2], CONGRID [3], FILE_EXIST [2], WRITE_GIF
break_file [4], concat_dir [4], data_chk [1], data_chk [2], file_append [1]
file_append [2], file_exist [1], file_exist [3], file_size [1], file_size [2]
get_logenv [1], get_logenv [2], rd_tfile [1], rd_tfile [2], restgen [1]
restgen [2], str2html [1], str2html [2], str2html [3], str_replace [1]
str_replace [2], ut_time [1], ut_time [2]
CALLED BY:
mk_pix [1], mk_pix [2]
Restrictions:
must define the parameters (pass keyword in or via environmental)
top_http - top http path known to outside world
path_http - top http local disk name (for writing)
optionally define subdirectories (may be relative)
image_http - path to images (gif) created by this routine
html_http - path to html files created by this routines
optionally, the address written at the end of the html file can
be changed from the default (sxtwww@...) by setting the enviroment
variable "address_http" to the required string.
History:
3-Feb-1995 (SLF) - Written to convert show_pix images to gif/html
6-Feb-1995 (SLF) - Added auto-scaling for thumbnail, ADDLINK keyword
and function (update a linked list)
8-Feb-1995 (SLF) - Add text about full image file size
13-Feb-1995 (SLF) - parameterized (site independent)
29-mar-1995 (SLF) - remove <br>x around text
29-mar-1995 (SLF) - break text formatting into str2html.pro
7-jun-1995 (SLF) - increase min_col to str2html
12-Jul-1995 (RDB) - added address_http changing of "address"
31-aug-1995 (SLF) - add HEADER and TRAILER keywords
[Previous]
[Next]
Name: genx_head
Purpose: define version dependent genx file header structures
Input Parameters:
version - genx file version number
Output:
function returns version dependent gen-file header structure
CALLS: ***
MAKE_STR [1], MAKE_STR [2]
CALLED BY:
WRT_GENX [1], WRT_GENX [2]
History:
?? written
RDB 21-Apr-95 modified version=2 so specific to IDLV3 !version
[Previous]
[Next]
Name: genx_newver
Purpose: create new version of genx file - only updates genx header
and (optionally) text sections - original data is preserved
Input Paramters:
filename - file to convert (assume genx)
newname - name for new file (defaults to filename , ie replace orig)
Keyword Paramters:
newtext - optional string / strarray to append to existing text section
verbose - if set, print some informational information
Calling Sequence:
genx_newver,filename ; replace existing file
genx_newver,filename, newname ; make new file
History - slf, 29-jan-1993 ;
CALLS:
[Previous]
[Next]
NAME: get1doc
PURPOSE: extract subset of idl header info for display/verification
this is a check of a two line purpose
third purpose line
CALLING SEQUENCE: doc=get1doc(infile)
Input Parameters:
infile - file to extract - assume idl .pro file
Optional Keyword Parameters:
keep_key - if set, keywords from file are retained in the
tag value - default is to eliminate since the
tag name contains relavent info.
debug - if set, some programmer info is printed
Output:
function returns structure containing documentation info
all fields are string type - null fields imply a particular
field is missing from the documentation header
CALLED BY:
add_pro [1], add_pro [2], get_doc [1], get_doc [2], get_doc [3]
Restrictions: unix only x
Category: gen, swmaint, unix_only
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], FILE_EXIST [2], MAKE_STR [1], MAKE_STR [2], STR_LASTPOS [1]
break_file [4], concat_dir [4], curdir [1], curdir [2], file_exist [1]
file_exist [3], str_lastpos [2], strposarr [1], strposarr [2]
Common Blocks: get_doc_private, doc_strt
Modification History: slf, 18-July-1992
(derived from sw_head.pro)
slf, 9-Aug-1992 added print option
[Previous]
[Next]
NAME:
get1hk_info
PURPOSE:
To return information from the HK database given a time and
a mnemonic. Should have one call per packet type (MDIHK, SC1, ...).
Use GET_HK_INFO as the front end.
INPUT:
times - A list of the dates/times of interest
mnem - A list of the memonics to return info for
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], FMT_TAG [1], FMT_TAG [2]
MAKE_STR [1], MAKE_STR [2], anytim2ex [1], anytim2ex [2], anytim2ints [1]
anytim2ints [2], break_file [4], convert_hk [1], convert_hk [2], data_type [1]
data_type [2], ex2fid [1], ex2fid [2], int2secarr [1], int2secarr [2], prstr [1]
prstr [2], rd_hk [1], rd_hk [2], sel_filetimes [1], sel_filetimes [2]
where_arr [1], where_arr [2]
OPTIONAL KEYWORD INPUT:
every - Can specify to only return every N values. This is
useful when specifying a long time range
nostring - If set, then do not make the output string type (ie:
do not use lookup table for "mnemonic" -- just send the
raw value). This only applies to digital mnemonics.
cleanup - If set, then check the data for only good data (ie: remove
data which is from when the DEP is off).
OUTPUT:
info - A structure with the following tags:
.time - N element array of times
.day - N element array of days
.value - NxM array of values
.mnem - M array of mnemonic names
.descr - M array of short description
RESTRICTIONS:
* The list of mnemonics must be all from MDI or all from the S/C packet
* Do not mix mnemonic types unless you are using the /RAW_VALUE switch
(since floating point and string type do not mix well)
HISTORY:
Written 23-Jan-95 by M.Morrison taking GET_HK_INFO as starting point
6-Feb-95 (MDM) - Added /NOSTRING option
- Patched up case where CONVERT_HK returns a string
7-Jun-95 (MDM) - Modifications to work on new flight like HK
database
29-Jun-95 (MDM) - Added /CLEANUP keyword
27-Nov-95 (MDM) - Added /EXP_PKT option to handle reading of the
emergency HK packet
4-Dec-95 (MDM) - Added /APPEND option so that the EXP_PKT data can
be merged with the regular packet HK data.
2-Dec-96 (MDM) - Put 4-Dec-95 mod online
- Modified the list option to work when the first
time has no data
25-Apr-97 (SDW) - Added "sc3"
10-Dec-99 (RIB) - Fixed how files are selected (Y2K problem)
[Previous]
[Next]
NAME:
get_afile_size
PURPOSE:
Return a list of file sizes for input files.
CALLING SEQUENCE:
fn_sz = get_afile_size(infn [, wid=wid,
xbd_path=xbd_path])
fn_sz list of returned file sizes in bytes
infn input list of file names. Note: Do not
include path with file names.
wid optional output list of weekid's for the
input files.
Optional Input:
xbd_path path to xbd files if $DIR_GEN_XBD is not
defined or used.
hdr header record to tape dir-file
drecs data records to tape dir-file
(Note: if hdr and drecs are defined the weekly IDs
are not recovered and the "infn" list is check against
the given "drecs".)
CALLS: ***
Rd_TapDir, UNIQ [1], UNIQ [2], UNIQ [3], fid2ex [1], fid2ex [2], tim2orbit [1]
tim2orbit [2], weekid [1], weekid [2], weekid [3], yod_sz [1], yod_sz [2]
CALLED BY:
archive_ck [1], archive_ck [2], dbase2disk, flares2disk, go_rdtap [1]
go_rdtap [2], mo_check, mo_patch, prep_week [1], prep_week [2], yo_arch_size
HISTORY:
written 15-Sep-92, gal
minor update 17-Sept-92
minor update 19&20-July-93, gal
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_ALT
Purpose : Extracts a CDS alternate entry from the database
Explanation : This routine extracts parameters which describe the CDS
alternate science plan status at a particular point in time.
Use : GET_ALT, DATE, STATUS
Inputs : DATE = The date/time value that the user wishes the
alternate plan entry for. This can be in any of the
standard CDS time formats.
Opt. Inputs : None.
Outputs : STATUS = Structure containing the alternate science plan
entry. It contains the following tags:
STRUCT_TYPE= The character string 'CDS-ALT'
PROG_ID = Program ID, linking one or more studies
together
STUDY_ID = Number defining the study
STUDYVAR = Number giving the study variation ID
SCI_OBJ = Science objective from the daily science
meeting
SCI_SPEC = Specific science objective from meeting
CMP_NO = Campaign number
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
START_TIME = Date/time of beginning of alternate plan,
in TAI format
END_TIME = Date/time of end of alternate plan, in
TAI format
ORIG_DUR = Original duration of the observation, in
seconds, before being truncated by
following time-tagged observations.
N_RASTERS1 = Variable number of rasters parameter
TRACKING = True (1) if feature tracking to be used,
or false (0) otherwise
N_POINTINGS= Number of pointings to apply to the study.
N_REPEAT_S = Number of times to repeat study
GSET_ID = GSET ID number
GET_RAW = True if raw data should be collected.
POINTINGS = An array of pointings to use with the
study.
If no entry is found, then a simpler structure is returned with
STUDY_ID set to -1. POINTINGS is itself a structure of type
PLAN_PNT_STRUC with the following tags:
INS_X = Pointing in X relative to commanded pos.
INS_Y = Pointing in Y relative to commanded pos.
ZONE_ID = Pointing zone ID
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 = ''
GET_ALT, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], 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], TRIM, UTC2TAI
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 9 May 1995
Modified : Version 1, William Thompson, GSFC, 9 May 1995
Version 2, William Thompson, GSFC, 22 May 1995
Changed way DBFIND is called, to speed up.
Version 3, William Thompson, GSFC, 28 September 1995
Added tags ORIG_DUR, GSET_ID, GET_RAW
Version : Version 3, 28 September 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_ANOMALY
Purpose : Extracts a SOHO anomaly definition from the database
Explanation :
Syntax : GET_ANOMALY, ANOMALY_ID, DEF
Inputs : ANOMALY_ID = The unique anomaly ID.
Opt. Inputs : None.
Outputs : DEF = Structure containing the anomaly definition.
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 = ''
GET_ANOMALY, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
CALLS: ***
ARR2STR [1], Arr2Str [2], DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1]
DBCLOSE [2], DBCLOSE [3], DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2]
DBOPEN [3], DEF_ANOMALY, TIME
CALLED BY:
ADD_ANOMALY, QUERY_ANOMALY, XREPORT_EDIT
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : Dominic Zarro, ARC/GSFC, 22 January 1996.
Version : Version 1
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_AVGSPEC
Purpose : Loads averaged example NIS spectrum.
Explanation : Loads wavelength and data arrays using Bill Thompson's
averaged NIS spectra
Use : IDL> get_avgspec, wave, data
Inputs : None
Opt. Inputs : None
Outputs : wave - wavelength array
data - spectral data array
Opt. Outputs: None
Keywords : VDS - If set, then returns data calibrated using VDS_CALIB.
CALIB - If set, then returns data calibrated using NIS_CALIB.
The default, if neither /VDS nor /CALIB are used, is to return
raw debiased spectrum
N2 - returns NIS2 spectrum, else NIS1
Calls : ***
AVERAGE, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], PIX2WAVE, READFITS [1]
READFITS [2], READFITS [3], VDS_ROTATE, concat_dir [4]
CALLED BY:
SHOW_SLIT6
Common : None
Restrictions: None
Side effects: None
Category : Spectral, data analysis
Prev. Hist. : None
Written : C D Pike, RAL. 28-Nov-96
Modified : Name update. CDP, 4-Dec-96
Version 3, 5-Mar-1997, William Thompson, GSFC
Added keyword /VDS
Use VDS_ROTATE and only return part within slit area.
Version 4, CDP, 13-May-97
Scale raw data counts to match reality.
Version 5, CDP Tidy first and last few pixels. 30-Oct-97
Version : Version 5, 30-Oct-1997
[Previous]
[Next]
NAME:
GET_BAD_CMDS
PURPOSE:
This procedure extracts the bad commands from the housekeeping stream
and puts them into a sequence:
word
0 obt byte 1
1 obt byte 2
2 obt byte 3
3 obt byte 4
4 obt byte 5
5 obt byte 6
6 good / bad flag (0=good, 1=bad ground TC, 2=bad TCE comm)
7 command counter
8 command code
9 command destination code
10 command sequence number
11 command error code
CATEGORY:
PACKETS
CALLING SEQUENCE:
Result = GET_BAD_CMDS (Hk)
INPUTS:
Hk: A 2D byte array containing all three LASCO housekeepking
packets, as returned by READALLHK.
OUTPUTS:
This function returns a 2D array (12,*) containing the bad commands.
Each row of the array contains the parameters above.
CALLS: ***
TMPOINT, gethkn
PROCEDURE:
The houskeeping packets are searched for the TM points that describe
the bad commands, and then decoded into their component values.
MODIFICATION HISTORY:
Written by: R.A. Howard, NRL, 1995
@(#)get_bad_cmds.pro 1.1 01/23/98 LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - LASCO
Name : GET_CACHE
Purpose : Implements caching of files in /tmp/idlpidxx. This speeds up processes which read
many files from the jukebox by cutting down on CD mounts.
Use : IDL> filename = GET_CACHE(j, list_of_filenames, pid)
Inputs : j INT A subscript of flist
flist STRARR A list of filenames
Outputs : filename STR filename in /tmp corresponding to flist[j]
idlpid STR output of getidlpid.pro
optid STR Optional additional identifier if more than one list
is being used.
Keywords : /ALL Retrieve all files in list
Explanation : Checks to see if file i in flist is in /tmp. If not, copies flist[j:j+25]
(or end of flist) to /tmp, and returns '/tmp/filename.fts' as the filename,
which then is used as input to readfits or whatever.
Calls : ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], FILE_EXIST [2], FILE_STAT [1], FILE_STAT [2], GETIDLPID
break_file [4], file_exist [1], file_exist [3], file_stat [3]
Category : Data_Handling, I_O
Prev. Hist. : None.
Written : Nathan Rich, NRL/Interferometrics, 2002/01/07.
Modified :
02.05.23, nbr - Use IDLPID to create subdir in /tmp; add IDL_SESSION common block
02.05.31, nbr - Add optid
10/02/02, @(#)get_cache.pro 1.4 LASCO IDL LIBRARY
CALLED BY
MK_DAILY_MED
[Previous]
[Next]
NAME:
GET_CAL_DARK
PURPOSE:
This function obtains the dark field calibration structure
applicable to the current date and telescope configuration
CATEGORY:
REDUCTION
CALLING SEQUENCE:
GET_CAL_DARK, Tel_num, Date, Obs_mode, Dark
INPUTS:
Tel_num The telescope number [0=C1,.., 3=EIT]
Date The date of the image (format = DATE-OBS)
Obs_mode The telescope configuration (DBMS parameter)
OUTPUTS:
Dark The dark image calibration data structure
Function result Gives the status of the search:
0 if the calibration file could not be found.
1 if successful
COMMON BLOCKS
DBMS, ludb,lulog
SIDE EFFECTS
An entry is written into a log file if the unit number exists
CALLS: ***
GET_CAL_STRUCT
MODIFICATION HISTORY:
Written RA Howard, NRL, 4 October 1995
@(#)get_cal_dark.pro 1.1 04 Apr 1996 LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
GET_CAL_PHOTOM
PURPOSE:
This function obtains the photometric calibration data structure
applicable to the current date and telescope configuration
CATEGORY:
REDUCTION
CALLING SEQUENCE:
GET_CAL_PHOTOM, Tel_num, Date, Obs_mode, Photo
INPUTS:
Tel_num The telescope number [0=C1,.., 3=EIT]
Date The date of the image (format = DATE-OBS)
Obs_mode The telescope configuration
OUTPUTS:
Photo The photometric calibration data structure
Function Result Gives the status of the search
0 if calibration file not found
1 if file found
CALLS: ***
GET_CAL_STRUCT
COMMON BLOCKS:
DBMS, ludb, lulog
SIDE EFFECTS:
An entry in the processing log is produced if lulog is defined
PROCEDURE:
GET_CAL_STRUCT is called to find the appropriate calibration file,
which is an IDL save set. Then the data is restored and an entry
is made in the processing log.
MODIFICATION HISTORY:
Written RA Howard, NRL, 4 October 1995
@(#)get_cal_photom.pro 1.1 04 Apr 1996 LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
GET_CAL_STRAY
PURPOSE:
This function obtains the stray light data structure applicable to
the current date and telescope configuration
CATEGORY:
REDUCTION
CALLING SEQUENCE:
GET_CAL_STRAY, Tel_num, Date, Obs_mode
INPUTS:
Tel_num Telescope number [0=C1,.., 3=EIT]
Date Date of the image (format = DATE-OBS)
Dbs_mode Telescope configuration
OUTPUTS:
Stray Stray Light calibration structure
Function Result The status of the query is returned as the
function result: 0 if cal file was not found
and 1 if it was found.
CALLS: ***
GET_CAL_STRUCT
COMMON BLOCKS:
DBMS, ludb, lulog
SIDE EFFECTS:
An entry is written to the log file if lulog in the common block is
defined.
PROCEDURE:
GET_CAL_STRUCTURE is called to obtain the name of the appropriate
calibration file. Then the file (an IDL save set) is restored.
MODIFICATION HISTORY:
Written RA Howard, NRL, 4 October 1995
@(#)get_cal_stray.pro 1.1 04 Apr 1996 LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
GET_CAL_STRUCT
PURPOSE:
This function is a general purpose function procedure to first
read the date cal file, find the applicable calibration file, and
then return the calibration structure
CATEGORY:
REDUCTION
CALLING SEQUENCE:
GET_CAL_STRUCT, Type, Tel_num, Date, Obs_mode, Filename
INPUTS:
Type String containing type of calibration file
Tel_num Telescope number (0..3)
Date Date and Time of image to be calibrated (format=UTC/ECS)
Obs_mode Observing Mode number
OUTPUTS:
Filename Filename of calibration file
Function Result the status of the query
0 = Valid
1 = Invalid
CALLS: ***
STR2UTC [1], STR2UTC [2], STR2UTC [3]
CALLED BY:
GET_CAL_DARK, GET_CAL_PHOTOM, GET_CAL_STRAY, GET_CAL_VIGNET
COMMON BLOCKS:
DBMS, ludb, lulog
PROCEDURE:
The file whose file name is built from the calibration type
is opened and read. The file names are
photo_date_config.txt
stray_date_config.txt
dark_date_config.txt
vig_date_config.txt
These files have records in the following format:
telescope_number, date_start,date_end, configuration, filename
where:
Telescope_number is the number from 0 to 3 for C1 to EIT
Date_start is the starting valid date and time
End_start is the ending valid date and time
Filename is the name of the calibration file
MODIFICATION HISTORY:
Written RA Howard, NRL, 4 October 1995
@(#)get_cal_struct.pro 1.1 04 Apr 1996 LASCO IDL LIBRARY
[Previous]
[Next]
NAME: GET_CAL_VIGNET
PURPOSE: Obtains the appropriate vignetting calibration
file for the date and observing mode
CATEGORY: REDUCTION
CALLING SEQUENCE: Result = GET_CAL_VIGNET
(Tel_num,Date,Obs_mode,Vig)
INPUTS: Tel_num = Telescope Number (0..3)
Date = Date of observation (format = UTC/ECS)
Obs_mode = Telescope configuration
OUTPUTS: Vig = Vignetting calibration structure
Result = status of operation
1=success
0=failure
CALLS: ***
GET_CAL_STRUCT
COMMON BLOCKS: DBMS
SIDE EFFECTS: A log entries are written to unit LULOG
PROCEDURE: The routine get_cal_struct is called to find
the file name for the appropriate date and
configuration, and then the cal structure is
restored.
MODIFICATION HISTORY: WRITTEN RA Howard, NRL, 4 October 1995
Version 1 RAH Initial Release
@(#)get_cal_vignet.pro 1.1 04 Apr 1996 LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CAMPAIGN
Purpose : Extracts a SOHO campaign definition from the database
Explanation : This routine extracts parameters which defines a SOHO
multi-observation campaign.
Use : GET_CAMPAIGN, CMP_NO, DEF
Inputs : CMP_NO = The unique campaign ID.
Opt. Inputs : None.
Outputs : DEF = Structure containing the campaign definition. It
contains the following tags:
CMP_NO = Unique identifier number. If no matches
are found, then a simpler structure is
returned with this set to -1.
CMP_NAME = Name of the campaign.
CMP_DESC = Up to five lines of text describing the
campaign.
DATE_OBS = Starting date for the observing campaign
DATE_END = Ending data for the campaign
OBSERVER = Observer in overall charge of the campaign
INSTITUTES = Institutions involved in the campaign.
Optionally, there can also be another tag
COMMENT = A list of comments pertaining to this
campaign.
INSTITUTES is also a structure with the following tags:
INSTITUT = Name of the institute
OBSERVER = Name of the observer at the institute
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 = ''
GET_CAMPAIGN, ... ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], 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], DBSORT [1], DBSORT [2], DBSORT [3], TRIM
TRIM_CAMPAIGN
CALLED BY:
ADD_ALT, ADD_DETAIL, ADD_FLAG, ADD_MAIN, ADD_OTHER_OBS, ADD_PLAN, CHECK_KAP
MK_SOHO_TARGET, MOD_CAMPAIGN, MOD_MAIN, UPDATE_CAMPAIGN, UPD_PLAN, UPD_SOHO_DET
XCAMP
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 26 July 1994
Modified : Version 1, William Thompson, GSFC, 29 July 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 29 December 1994
Fixed bug when inputs are bytes.
Version 4, William Thompson, GSFC, 28 April 1995
Returns an error string when no entry is found.
Version 5, William Thompson, GSFC, 26 September 1995
Fixed bug with DBEXT always returning arrays.
Version 6, William Thompson, GSFC, 10 September 1996
Take care of case where there are no entries in the
institutes catalog.
Version 7, 23-Sep-1996, William Thompson, GSFC
Added campaign type.
Version 8, William Thompson, GSFC, 24 September 1996
Change COMMENTS to COMMENT.
Return CMP_DESC as variable number of elements
Fix bug with OBSERVER
Version 9, Zarro, GSFC, 21 November 1996
Trimmed string fields and moved CMP_NO to first
tag location (consistent with documentation and SUMER)
Version 10, Zarro, GSFC, 21 November 1996
Checked for scalar COMMENT and returned as COMMENT(0)
Version : Version 10, 21 November 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDHS_DEXWIN()
Purpose : Returns the parameters of an internal CDHS dexwin ID.
Explanation : Interrogates the dexwin_id database to get the entry
corresponding to this CDHS ID. If none found it returns
a structure with .ID = -1 else returns structure containing
parameters.
Use : IDL> st = get_cdhs_dexwin( cdhs_id )
Inputs : cdhs_id : Integer giving the CDHS dexwin ID.
Opt. Inputs : None.
Outputs : Structure array containing database information on this CDHS ID.
Tags :
DATE C*20 String containing UTC date entry created
SW_VERSION C*4 String containing software version used to create table
CDHS_ID I*2 Internal CDHS ID number
ID I*2 Database ID number
VERSION I*2 Calibration version number.
Opt. Outputs: None.
Keywords : None.
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]
Common : None.
Restrictions: None.
Side effects: None.
Category : Command preparation.
Prev. Hist. : None.
Written : Version 0.0, Martin Carter, RAL, 19/2/96
Modified : None.
Version : Version 0.0, 19/02/96
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDHS_RASTER()
Purpose : Returns the parameters of an internal CDHS raster ID.
Explanation : Interrogates the raster_id database to get the entry
corresponding to this CDHS ID. If none found it returns
a structure with .ID = -1 else returns structure containing
parameters.
Use : IDL> st = get_cdhs_raster( cdhs_id )
Inputs : cdhs_id : Integer giving the CDHS raster ID.
Opt. Inputs : None.
Outputs : Structure array containing database information on this CDHS ID.
Tags :
DATE C*20 String containing UTC date entry created
SW_VERSION C*4 String containing software version used to create table
CDHS_ID I*2 Internal CDHS ID number
ID I*2 Database ID number
VAR I*2 Database variation number
REPN I*2 Raster repeat number
Opt. Outputs: None.
Keywords : None.
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]
CALLED BY:
SHOW_CDHS
Common : None.
Restrictions: None.
Side effects: None.
Category : Command preparation.
Prev. Hist. : None.
Written : Version 0.0, Martin Carter, RAL, 9/6/95
Modified : Version 2 Minor change to error return values. CDP, 9-Jun-95
Version 3 Changed database naming scheme. MKC 9/11/95
Version 4 MKC, 18/1/96
Put in infinite loop to keep accessing database until successful.
Version : Version 4, 18/01/96
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDHS_SERIES()
Purpose : Returns the parameters of an internal CDHS series ID.
Explanation : Interrogates the series_id database to get the entry
corresponding to this CDHS ID. If none found returns structure
with .ID = -1 else returns structure containing parameters.
Use : < st = get_cdhs_series( cdhs_id, /DTYPE ) >
Inputs : cdhs_id : Integer giving the CDHS series ID.
Opt. Inputs : None.
Outputs : Structure array containing database information on this CDHS ID.
Tags :
DATE C*20 String containing UTC date entry created
SW_VERSION C*4 String containing software version used to create table
CDHS_ID I*2 Internal CDHS ID number
ID I*2 Database ID number
VAR I*2 Database variation number
REUS C*1 Fundamental series
SFT C*1 Solar feature tracking Y/N
SOLARX I*2 Initial solar x coord of study
SOLARY I*2 Initial solar y coord of study
SLITN I*2 Initial slit number of study
GSETID I*2 Initial GSET ID of study
RPT C*1 Repeat study indefinitely
REPN I*2 No. of times to repeat last raster and IEF flags
Opt. Outputs: None.
Keywords : DTYPE : Indicates should use the dseries_id database.
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]
CALLED BY:
SHOW_CDHS, WHAT_CDHS_STUDY
Common : None.
Restrictions: None.
Side effects: None.
Category : Command preparation.
Prev. Hist. : None.
Written : Version 0.0, Martin Carter, RAL, 9/6/95
Modified : Version 2. Minor change to error return. CDP, 9-Jun-95
Version 3 Changed database naming scheme added new tags
MKC 9/11/95
Version 4 MKC 15/12/95
Renamed fund reus
Version 5 Put in test for rseries db available. CDP, 17-Jan-96
Version 6 MKC, 18/1/96
Put in infinite loop to keep accessing database until successful.
Version 7 MKC, 3/10/96
Added DTYPE keyword.
Version : Debug version ONLY
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDHS_VDSWIN()
Purpose : Returns the parameters of an internal CDHS vdswin ID.
Explanation : Interrogates the vdswin_id database to get the entry
corresponding to this CDHS ID. If none found it returns
a structure with .ID = -1 else returns structure containing
parameters.
Use : IDL> st = get_cdhs_vdswin( cdhs_id )
Inputs : cdhs_id : Integer giving the CDHS vdswin ID.
Opt. Inputs : None.
Outputs : Structure array containing database information on this CDHS ID.
Tags :
DATE C*20 String containing UTC date entry created
SW_VERSION C*4 String containing software version used to create table
CDHS_ID I*2 Internal CDHS ID number
ID I*2 Database ID number
VERSION I*2 Calibration version number
IEFID I*2 ID of flag master IEF scheme
Opt. Outputs: None.
Keywords : None.
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]
Common : None.
Restrictions: None.
Side effects: None.
Category : Command preparation.
Prev. Hist. : None.
Written : Version 0.0, Martin Carter, RAL, 21/11/95
Modified : Version 1 MKC, 18/1/96
Put in infinite loop to keep accessing database until successful.
Version 2 MKC 19/2/96
Changed some of the parameters in the database.
Version : Version 2, 19/02/96
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDS_ASRUN
Purpose : return ASRUN raster parameters from CDS Main catalog entry
Category : planning
Syntax : IDL> get_cds_asrun,obs,rasters
Inputs : OBS = main entry from LIST_MAIN (must be scalar)
Outputs : RASTERS = raster parameters (can be array)
;
Keywords : ERR = error string
CALLS: ***
CONCAT_STRUCT, DATATYPE [1], DATATYPE [2], DATATYPE [3], GET_CDS_RASTER, HAVE_TAG
JOIN_STRUCT [1], JOIN_STRUCT [2], LIST_EXPER, PR_SYNTAX
History : Writte, 30-Nov-1999, D.M. Zarro (SM&A/GSFC)
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDS_DELAY
Purpose : get delay (secs) due to pointing and slit changes between
two successive CDS studies
Category : planning
Explanation : computes delay when changing pointing and slit from
one plan entry to another
Syntax : IDL> delay=get_cds_delay(last_plan,next_plan)
Inputs : LAST_PLAN = last plan structure
: NEXT_PLAN = next plan structure
Opt. Inputs : None
Outputs : seconds delay between two successive CDS plan entries
Opt. Outputs: None
Keywords : ERR = error string
CALLS: ***
DPRINT, EXIST, GET_CDS_HOME, GET_CDS_XY, GET_OPS_POS, GET_STUDY_PAR, HAVE_PROC
Common : None
Restrictions: None
Side effects: None
History : Version 1, 1-Sep-1995, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDS_DUR
Purpose : compute study duration based on CDS plan details
Explanation : computes delays caused by OPS and slit movements
Use : DUR=GET_CDS_DUR(PLAN)
Inputs : PLAN = CDS detailed plan entry
Opt. Inputs : None
Outputs : DUR = duration of study + extra from variable rasters
Opt. Outputs: None.
Keywords : POINT = set to compute delay for repointing
ERR = error string
Calls : ***
DPRINT, GET_CDS_XY, GET_OPS_POS, GET_PLAN_ITIME, GET_PLAN_TYPE, GET_STUDY_PAR
HAVE_PROC, TAG_EXIST [1], TAG_EXIST [2]
CALLED BY:
MK_CDS_PLAN, ROT_CDS_XY
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning
Prev. Hist. : None.
Written : Dominic Zarro (ARC)
Version : Version 1.0, 9 January 1995.
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDS_FOV
Purpose : get CDS FOV size (width, height) for CDS rasters in a plan
Category : planning
Explanation :
Syntax : IDL> get_cds_fov,plan,width,height
Inputs : PLAN = plan structure
Opt. Inputs : None
Outputs : X, Y = vector of width and heights in arcsecs
Opt. Outputs: None
Keywords : FIRST = set to just return fov of first raster in plan
LAST = set to just return fov of last raster in plan
STUDY = study structure associated with PLAN (optional)
STRING_FORM = output FOV as strings
ONE_DIM = force output vectors to be 1-d
ERR = error string
CALLS: ***
ARR2STR [1], Arr2Str [2], DATATYPE [1], DATATYPE [2], DATATYPE [3], GET_CDS_RASTER
GET_CDS_STUDY, GET_PLAN_TYPE, PR_SYNTAX, RASTER_SIZE, STR_FORMAT, TAG_EXIST [1]
TAG_EXIST [2], TRIM
CALLED BY:
CDS_PLAN_POINT, UPD_SCI_PLAN, WRITE_IAP
Common : None
Restrictions:
Side effects: None
History : Version 1, 29-Aug-1997, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDS_GIS
Purpose : get CDS GIS detectors
Category : planning, database
Explanation :
Syntax : IDL> dets=get_cds_gis(study)
Inputs : STUDY = CDS study structure
Opt. Inputs : None
Outputs : DETS = array of detector nos. (e.g. [0,2,3], or [1,2])
(returns -1 if no GIS detectors used)
Opt. Outputs: None
Keywords : ERR = any errors
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], GET_CDS_RASTER, GET_DATAWIN
TAG_EXIST [1], TAG_EXIST [2], TRIM, UNIQ [1], UNIQ [2], UNIQ [3]
CALLED BY:
MK_CDS_PLAN
Common : None
Restrictions: None
Side effects: None
History : Version 1, 1-Jul-1996, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDS_HOME
Purpose : get CDS home position
Category : planning
Explanation : calls GET_HOME_POS and saves result in COMMON for later
speed reading.
Syntax : IDL> home=get_cds_home()
Inputs : None
Opt. Inputs : None
Outputs : Home position structure with pointing, slit, gset_id etc
Opt. Outputs: None
Keywords : None
CALLS: ***
EXIST, HAVE_PROC
CALLED BY:
GET_CDS_DELAY, GET_CDS_XY, GET_STUDY_PAR
Common : GET_CDS_HOME - last HOME position
Restrictions: None
Side effects: None
History : Version 1, 27-Jan-1996, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDS_OH
Purpose : computes time after a set of un-tagged
CDS plans before a time-tagged plan can start.
Category : planning
Explanation : 5% overhead is often necessary to allow for uncertainties
in study durations causing a series of consecutive studies
to run overtime.
Syntax : IDL>oh_time=get_cds_oh(time,plans,status=status)
Inputs : TIME = planned start time of plan entry
(can also be a plan structure, in which case
PLAN.DATE_OBS is used)
: PLANS = current set of plans
Opt. Inputs : None
Outputs : OH_TIME= computed start time of time-tagged study (with OH added)
Opt. Outputs: None
Keywords : STATUS = 1 if input time is greater than OH time
= 0 if input time is less than OH time
CALLS: ***
ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2], DATATYPE [1], DATATYPE [2]
DATATYPE [3], DPRINT, EXIST, GET_PLAN_ITIME, GET_PLAN_TYPE, MK_PLAN_WHERE
STR_FORMAT
CALLED BY:
MK_CDS_PLAN
Common : None
Restrictions: None
Side effects: None
History : Version 1, 14-Feb-1997, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDS_PLAN
Purpose : Get nearest CDS detailed plan given a TIME, STUDY_ID,
STUDYVAR and (optional) PROG_NUM.
Category : planning
Explanation :
Syntax : IDL>plan=get_cds_plan(time,study_id,studvar,prog_num=prog_num)
Inputs : TIME = plan start time
STUDY_ID, STUDYVAR = usual suspects
Opt. Inputs : None
Outputs : PLAN = sought after plan
ERR = error string
Opt. Outputs: None
Keywords : PROG_NUM = program number. If given, will search on this first
SEARCH_WINDOW= search window in seconds [def = 2hr]
CALLS: ***
ANYTIM2TAI, EXIST, GET_CDS_STUDY, LIST_DETAIL, TAG_EXIST [1], TAG_EXIST [2]
Common : None
Restrictions: None
Side effects: None
History : Version 1, 4-Aug-1997, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDS_PNTCAL
Purpose : Gets a pointing calibration curve from database
Category : CDS, Calibration, Class3
Explanation : Looks up the correct calibration curve for the pointing as a
function of OPS position. First, the software finds the
largest effective date which is on or earlier than the
observation date. If there are multiple entries with the same
effective date, then the one with the latest entry date is
used.
The pointing calibration database allows for a variety of
mathematical models of the OPS. Currently, the only pointing
calibration equations which are recognized are the following.
1. COEFF = (L0, R0, Rho, KX, KY)
DL=L-L0, DR=R-R0, DP=DL+DR, DM=DL-DR
X = -KX * (DM + DM*DP / Rho)
Y = -KY * (DP - (DM^2 + DP^2)/(2*Rho))
2. COEFF = (L0, R0, Rho, KX, KY, Alpha)
Same as 1, except DR = Alpha*(R-R0)
Syntax : GET_CDS_PNTCAL, DATE_OBS, OPS_L, OPS_R, X, Y
CALLED BY:
OPS_POINT, UPD_CDS_POINT
Examples : GET_CDS_PNTCAL, '1996/09/16', 2048, 2048, X, Y
Inputs : DATE_OBS = The date the observation was made.
OPS_L = The Offset Pointing System mechanism position for
the left leg. Floating point values and arrays are
allowed.
OPS_R = The OPS position for the right leg.
Opt. Inputs : None.
Outputs : X, Y = The calculated solar pointing in arcseconds, not
counting any corrections for the spacecraft
pointing.
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 = ''
GET_CDS_PNTCAL, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2], 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], DBSORT [1], DBSORT [2], DBSORT [3], TRIM
Common : None
Restrictions: OPS_L and OPS_R must be values, not unpacked telemetry words.
See OPS_DECODE for more information.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 16-Sep-1996, William Thompson, GSFC
Version 2, 8-Oct-2001, Zarro (EITI/GSFC) - propagated
error check for missing db item
Contact : WTHOMPSON
[Previous]
[Next]
PROJECT:
SOHO - CDS
NAME:
GET_CDS_POINT
PURPOSE:
Create structure from given CDS plan for use in IMAGE_TOOL
EXPLANATION:
In order for IMAGE_TOOL to handle the pointing(s) of a study,
the following information must be provided to IMAGE_TOOL:
Number of pointings needs to be done; for each pointing, width
and height of the pointing area (e.g., a raster). If there are
several rasters in the same pointing, the relation of the
rest of raster with respect to the first one (in CDS case,
determined by the POINTING value in study definition) has to
be given (can be, in CDS case, 0: fixed alreay, 1: same as the
first raster, or -1: offset from the first one). This routine
is to extract such information and put it into a structure to
be passed into IMAGE_TOOL.
CALLING SEQUENCE:
result = get_cds_point(cds_detail)
INPUTS:
CDS_DETAIL - CDS plan structure containing the detailed science plan
record. It contains the following tags:
STRUCT_TYPE - The character string 'CDS-DETAIL'
PROG_ID - Program ID, linking one or more studies together
STUDY_ID - Number defining the study
STUDYVAR - Number giving the study variation ID
SCI_OBJ - Science objective from the daily science meeting
SCI_SPEC - Specific science objective from meeting
CMP_NO - Campaign number
OBJECT - Code for object planned to be observed
OBJ_ID - Object identification
DATE_OBS - Date/time of beginning of observation, in TAI format
DATE_END - Date/time of end of observation, in TAI format
N_RASTERS1 - Variable number of rasters parameter
TIME_TAGGED - True (1) if the start of the study is to be a
time-tagged event. Otherwise, the study will begin
immediately after the previous study.
TRACKING - True (1) if feature tracking to be used, or false (0)
otherwise
N_POINTINGS - Number of pointings to apply to the study.
N_REPEAT_S - Number of times to repeat study.
POINTINGS - An array (with N_POINTINGS elements) of pointings
to use with the study. POINTINGS is itself a
structure of type PLAN_PNT_STRUC with the
following tags:
INS_X - Pointing in X relative to sun center
INS_Y - Pointing in Y relative to sun center
OPTIONAL INPUTS:
None.
OUTPUTS:
RESULT - A pointing structure that can be used by IMAGE_TOOL.
It has the following tags:
MESSENGER - ID of widget in the caller that triggers a
timer event in the planning tool to signal the
completion of pointing; must be a widget that
does not usually generate any event
INSTRUME - Code specifying the instrument; e.g., 'C' for CDS
SCI_SPEC - Science specification
STD_ID - Study ID
G_LABEL - Generic label for the pointing; e.g., 'RASTER'
X_LABEL - Label for X coordinate of pointing; e.g., 'INS_X'
Y_LABEL - Label for Y coordinate of pointing; e.g., 'INS_Y'
DATE_OBS - Date/time of beginning of observation, in TAI format
DO_POINTING- An integer of value 0 or 1 indicating whether pointing
should be handled at the planning level (i.e., by
IMAGE_TOOL)
N_POINTINGS- Number of pointings to be performed by IMAGE_TOOL
POINTINGS - A structure array (with N_POINTINGS elements) of type
"DETAIL_POINT" to be handled by IMAGE_TOOL. It has
the following tags:
POINT_ID - A string scalar for pointing ID
INS_X - X coordinate of pointing area center in arcs
INS_Y - Y coordinate of pointing area center in arcs
WIDTH - Area width (E/W extent) in arcsec
HEIGHT - Area height (N/S extent) in arcsec
ZONE - Description of the zone for pointing
OFF_LIMB - An interger with value 1 or 0 indicating
whether or not the pointing area should
be off limb
N_RASTERS - Number of rasters for each pointing (this is
irrelevant to the SUMER)
RASTERS - A structure array (N_RASTERS-element) of type
"RASTER_POINT" that contains raster size and pointing
information (this is irrelevant to the SUMER). It has
the following tags:
POINTING - Pointing handling code; valis
values are: 1, 0, and -1
INS_X - Together with INS_Y, the pointing to use
when user-supplied values are not
allowed. Only valid when POINTING=0
(absolute) or POINTING=-1 (relative to
1st raster).
INS_Y - ...
WIDTH - Width (E/W extent) of the raster, in arcs
HEIGHT - Height (N/S extent) of the raster, in arcs
CALLED BY:
WRITE_IAP
Note: For CDS case, pointings.width, pointings.height,
pointings.x_coord, and pointings.y_coord should match the first
raster's rasters.width, rasters.height, rasters.ins_x, and
rasters.ins_y, respectively.
OPTIONAL OUTPUTS:
None.
KEYWORD PARAMETERS:
ERR = error string
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DHELP, DPRINT, GET_CDS_RASTER
GET_CDS_STUDY, GET_PLAN_ITIME, MK_POINT_STC, RASTER_SIZE, ZONE_DEF_LABEL
COMMON BLOCKS:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
CATEGORY:
PREVIOUS HISTORY:
Written March 24, 1995, Liyun Wang, NASA/GSFC
MODIFICATION HISTORY:
Version 1, created, Liyun Wang, NASA/GSFC, March 24, 1995
Version 2, Liyun Wang, NASA/GSFC, April 5, 1995
Implemented ZONE ID and ZONE
Version 2.1, Zarro, August 31, 1995 -- allowed for FLAG pointing
Version 2.2, February 5, 1996, Liyun Wang, NASA/GSFC
Fixed a bug that caused problem for engineering studies
Version 3, 13-Feb-97, Zarro, GSFC, added ERR keyword
Version 4, February 18, 1997, Liyun Wang, NASA/GSFC
Modified to cope with the change in POINT_STC (two new tags,
namely SCI_SPEC and STD_ID, were added)
VERSION:
Version 4, February 18, 1997
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDS_RASTER
Purpose : get a CDS raster from database
Explanation : speeds up GET_RASTER by saving each raster in common
Use : RASTER=GET_CDS_RASTER(RAS_ID,RAS_VAR)
Inputs : RAS_ID = raster id
: RAS_VAR = raster variation
Opt. Inputs : None.
Outputs : RASTER = raster definition
Opt. Outputs: None.
Keywords : INIT = initialize commons and return
Calls : ***
CONCAT_STRUCT, DATATYPE [1], DATATYPE [2], DATATYPE [3], DELVARX [1], DELVARX [2]
DELVARX [3], DELVARX [4], EXIST, GET_RASTER, delvarx [5]
CALLED BY:
GET_CDS_ASRUN, GET_CDS_FOV, GET_CDS_GIS, GET_CDS_POINT, GET_RASTER_PAR
MK_CDS_PLAN, MK_STUDY, XSTUDY
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Database.
Prev. Hist. : None.
Written : Dominic Zarro (ARC)
Version : Version 1.0, 28 March 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDS_STATE
Purpose : determine CDS state just prior to input time
Category : Planning
Explanation :
Syntax : IDL> state=get_cds_state(time,look=look)
CALLED BY:
XCPT
Examples :
Inputs : TIME = input time to check prior to
Opt. Inputs : None
Outputs : STATE ={state_structure,$
mode:'X',solarx:0,solary:0,slitn:0,gsetid:0}
Opt. Outputs: None
Keywords : LOOK = seconds to look back prior to TIME [def= 1 day]
CALLS: ***
ANYTIM2TAI, EXIST, GET_CDS_XY, GET_DETAIL, GET_PLAN_ITIME, GET_STUDY_PAR
LIST_DETAIL, MK_PLAN_WHERE, NINT [1], NINT [2]
Common : None
Restrictions: None
Side effects: None
History : Version 1, 29-July-1996, D M Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDS_STUDY
Purpose : get a CDS study from database
Explanation : speeds up GET_STUDY by saving each study in common
Use : STUDY=GET_CDS_STUDY(STUDY_ID,STUDYVAR)
Inputs : STUDY_ID = study id
Opt. Inputs : STUDYVAR = study variation
Outputs : STUDY = study definition
(only fundamental part is returned if STUDYVAR not entered)
Opt. Outputs: None.
Keywords : USE_TITLE = set to search on TITLE_ID in place of STUDY_ID
ERR = error string
INIT = initialize commons and return
ADD_VAR = add STUDYVAR tag (if not present)
FUND_ONLY = return fundamental part only
VERBOSE = verbose output
Calls : ***
ADD_TAG [1], ADD_TAG [2], CONCAT_STRUCT, DATATYPE [1], DATATYPE [2], DATATYPE [3]
DEF_CDS_STUDY, DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4], DPRINT, EXIST
FREE_POINTER, GET_F_STUDY, GET_POINTER, GET_STUDY, MAKE_POINTER, RESET_CDS_STUDY
SET_POINTER, TAG_EXIST [1], TAG_EXIST [2], TRIM, delvarx [5]
CALLED BY:
CDS_ASRUN_POINT, CDS_PLAN_POINT, GET_CDS_FOV, GET_CDS_PLAN, GET_CDS_POINT
GET_CDS_XY, GET_PLAN_PROG, GET_STUDY_PAR, MK_CDS_PLAN, WRITE_IAP, XCDS_BOOK, XSTUDY
Common : GET_CDS_STUDY_COM
Restrictions: None.
Side effects: None.
Category : Planning, Database.
Prev. Hist. : None.
Written : Dominic Zarro (ARC)
Version : Version 1.0, 28 March 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDS_TEMPS()
Purpose : Get the CDS 5-minute average temperature date.
Category : Class3, CDS, Engineering
Explanation : Reads CDS 5-minute average temperature data.
Syntax : Result = GET_CDS_TEMPS( DATE )
Examples :
Inputs : DATE = The date/time value to get the temperatures for.
Can be in any CDS time format.
Opt. Inputs : None.
Outputs : The result of the function is an array containing the 32 CDS
temperatures. If unable to find this information, zeroes are
returned instead.
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 = ''
Result = GET_CDS_TEMPS( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2CAL, ANYTIM2TAI, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
FXBCLOSE [1], FXBCLOSE [2], FXBISOPEN [1], FXBISOPEN [2], FXBOPEN [1], FXBOPEN [2]
FXBOPEN [3], FXBREAD [1], FXBREAD [2], FXBREAD [3], UTC2TAI, concat_dir [4]
Common : Private common block GET_CDS_TEMPS is used to store data from
the last temperature file read. Speeds up subsequent reads
when the same day is referenced.
Restrictions: The temperatures entries are interpolated from the 5-minute
averages to the requested time.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 24-Nov-2004, William Thompson, GSFC
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_CDS_XY
Purpose : get central (X,Y) coordinates CDS rasters in a plan
Category : planning
Explanation :
Syntax : IDL> get_cds_xy,plan,x,y
Inputs : PLAN = plan structure
Opt. Inputs : None
Outputs : X, Y = vector of X and Y positions in arcsecs
Opt. Outputs: None
Keywords : FIRST = set to just return pointing of first raster in plan
LAST = set to just return pointing of last raster in plan
STUDY = study structure associated with PLAN (optional)
STRING_FORM = output pointings as strings
ONE_DIM = force output vectors to be 1-d
ERR = error string
FIXED = vector of 1/0 if fixed/deferred pointing
CALLS: ***
ARR2STR [1], Arr2Str [2], DATATYPE [1], DATATYPE [2], DATATYPE [3], DEF_CDS_DETAIL
EXIST, GET_CDS_HOME, GET_CDS_STUDY, GET_PLAN_TYPE, PR_SYNTAX, STR_FORMAT
TAG_EXIST [1], TAG_EXIST [2], TRIM
CALLED BY:
CDS_PLAN_BRIEF, CDS_PLAN_POINT, GET_CDS_DELAY, GET_CDS_DUR, GET_CDS_STATE
MK_CDS_PLAN, ROT_CDS_XY, UPD_SCI_PLAN, WRITE_IAP
Common : None
Restrictions:
Side effects: None
History : Version 1, 29-Dec-1995, D.M. Zarro. Written
Version 2, 2-Jun-1998, Zarro, added FIXED keyword
Version 3, 12-Dec-1998, Zarro (SM&A), added check for null plan
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
extracts the commands from the housekeeping stream
into a sequence:
hk is an array containing all of the housekeeping packets
word
0 obt byte 1
1 obt byte 2
2 obt byte 3
3 obt byte 4
4 obt byte 5
5 obt byte 6
6 good / bad flag (0=good, 1=bad)
7 command counter
8 command code
9 command destination code
10 command sequence number
11 command error code
modified for hk in bytes or words 20 mar 1996, RAH
@(#)get_cmds.pro 1.1 01/23/98 :LASCO IDL LIBRARY
CALLS:
[Previous]
[Next]
NAME:
GET_CME_SUMMARY
PURPOSE:
This function defines the cme_summary data structure
CATEGORY:
CME
CALLING SEQUENCE:
GET_CME_SUMMARY
OUTPUTS:
This function returns an empty CME structure.
COMMON BLOCKS:
com_xplot_ht
SIDE EFFECTS:
Initiates the XMANAGER if it is not already running.
RESTRICTIONS:
MODIFICATION HISTORY:
Written by: RA Howard, NRL 12 May 1997
@(#)get_cme_summary.pro 1.1 05/14/97 :NRL Solar Physics
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
GET_COMPILED_TKI
PURPOSE:
Restore the compiled Routines of TKI if accessible
CATEGORY:
SUMER Simulator
EXPLANATION:
This procedure tests if the routines of TKI are still
in Memeory then it returns, if not it restores the
Routine save file if available
SYNTAX:
get_compiled_tki
CALLED BY:
ST_SUMER, TKI_CALL, XTKI
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], TEST_OPEN, concat_dir [4]
COMMON:
tki_comp_tst
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 31, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 2, October 10, 1998, Dietmar Germerott, MPAE Lindau
added look for different IDL-Versions in RST-Filename
Version 3, February 10, 1999, Dietmar Germerott, MPAE Lindau
modified messaging in case of no file found
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linsu1.mpae.gwdg.de)
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_COMPRESS
Purpose : Extracts a SOHO compression description from the database
Explanation : This routine extracts parameters which describes a SOHO
compression method.
Use : GET_COMPRESS, COMP_ID, DESC
Inputs : COMP_ID = The unique compression ID.
Opt. Inputs : None.
Outputs : DESC = Structure containing the compression description. It
contains the following tags:
COMP_ID = Compression ID number. If a match is
not found, then a simpler structure is
returned with this set to 0.
COMPDESC = A short description of the compression
method.
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 = ''
GET_COMPRESS, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], 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], TRIM
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 25 July 1994
Modified : Version 1, William Thompson, GSFC, 27 July 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 29 December 1994
Fixed bug when inputs are bytes.
Version 4, William Thompson, GSFC, 28 April 1995
Returns an error string when no entry is found.
Version : Version 4, 28 April 1995
[Previous]
[Next]
Project : SOHO - LASCO/EIT
Name : GET_CROTA
Purpose : Returns Nominal Roll Attitude of SOHO ( degrees )
Use : IDL> result = GET_CROTA( DATE )
Inputs : DATE in format 2003/07/21 23:30:05.469
Optional Inputs:
Outputs : Roll Attitude
Keywords :
Comments :
# Nominal roll attitude of SOHO (degrees)
#
1995-12-02 03:08:00 0.00
2003-07-08 13:00:00 180.00
IDL[hercules]>print, GET_CROTA('2003-07-08 12:59:59')
0.00000
IDL[hercules]>print, GET_CROTA('2003-07-08 13:00:00')
180.000
CALLS: ***
STR2UTC [1], STR2UTC [2], STR2UTC [3], STR_SEP, UTC2TAI
CALLED BY:
REDUCE_LEVEL_05, REDUCE_REFCOORD
Side effects:
Category :
Written : Jake Wendt, NRL, July 10, 2003
Version : 030722 jake changed location of nominal_roll_attitude.dat
030804, nbr - Add ANCIL_DATA, check only uncommented lines of file
Karl Battams 2 Nov 2005 - Add swap_if_little_endian keyword for opening binary data files
11/02/05 @(#)get_crota.pro 1.8
[Previous]
[Next]
Name: get_daily
Purpose: read image from daily_forecast area
Optional Keyword Parameters:
testing - if set, look at test directory (default standard daily direct)
display - if set, display image and header to window
file - explicit file name (default pops up a menu for selection)
select - if set, user menu (default is most recent if file undefined)
Output Paramters
image - daily forecast image (bytarr(512,512))
text - text string (info_array format)
Calling Sequence:
get_daily [image, text, /display , /testing, file=FILENAME]
Calling Examples:
get_daily ; display most receent composite image
get_daily, image, text, /display ; same, but return image and text
get_daily ,/select ; select from menu + display
get_daily, image, text, /testing ; look at test directory instead
get_daily, image, text. file=FILENAME ; user specified file to read
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FILE_EXIST [2], concat_dir [4]
file_exist [1], file_exist [3], file_list [1], file_list [2], get_logenv [1]
get_logenv [2], stepper_title [1], stepper_title [2], wmenu_sel [1]
wmenu_sel [2]
History:
23-Jun-1994 (SLF)
26-Jun-1994 (SLF) minor - allow environmental DIR_SITE_FORECAST
28-Jun-1994 (SLF) SELECT kywrd, display if called with no positional
parameters, default is most recent composite
29-Jun-1994 (SLF) modifiy examples to match yesterdays modifications
[Previous]
[Next]
FUNCTION: get_daily_list, cam, dte, QL=ql, FILTER=filter
Purpose: Returns list of files for given tel fitting standard parameters
Input:
dte: '970502'
cam: 'c2' or 'c3' or 'eit_195' or 'eit_284' or 'eit_171' or 'eit_304'
KEYWORDS:
QL: Use quicklook and save in $MVIS/daily/;
otherwise use LZ and save in $MVIS/daily/yyyy_mm/
FILTER: Set = to unusual filter: so far, 'orange'
Written by N. Rich, NRL, 2002/11/20
@(#)get_daily_list.pro 1.1 11/22/02 : NRL LASCO Library
CALLS:
[Previous]
[Next]
Project : SOHO - LASCO
Name :
Purpose :
Category :
Explanation :
Syntax :
CALLED BY:
WSAVE_PS [2]
Examples :
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Common :
Restrictions:
Side effects: Not known
History : Version 1, 06-May-1996, B Podlipnik. Written
Contact : BP, borut@lasco1.mpae.gwdg.de
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_DATAWIN
Purpose : Extracts a data window list definition from the database
Explanation : This routine extracts a complete data extraction window list
definition from the database for a requested data window list.
Use : GET_DATAWIN, DW_ID, DEF
Inputs : DW_ID = Data extraction window list ID number
Opt. Inputs : None.
Outputs : DEF = Structure containing the linelist definition. It
contains the following tags:
DW_ID = Data window list ID number. If the
requested data window list is not found,
then a simpler structure is returned, with
this set to -1.
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".
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 is 0.
N_FLAGS = The number of flag windows.
LL_ID = The line list ID number for the line list
that this window list was derived from, or
zero to signal that the data window list is
not connected to a line list.
LL_DESC = A description of the line list, e.g.
"Temperature sensitive line pairs".
N_LINES = The number of lines in the 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 four
numbers, although GIS window definitions
only use two of them.
WIN_FLAG = Whether or not the window can be used to
generate a flag. Either 0 (false) or 1
(true).
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 = ''
GET_DATAWIN, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], 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], TRIM
CALLED BY:
ADD_EXPER, CALC_RAS_DUR, EXPORT_STUDY, GET_CDS_GIS, LOAD_TP_STRUCT, MK_HEAD_CAT
MOD_EXPER, RASTER_DUR, SHOW_DATAWIN, TP_DISP_LLIST, TP_DISP_RAST, TP_WRT_DWIN
WRITE_CIF, XSTUDY
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 1 April 1994
Modified : Version 1, William Thompson, GSFC, 1 August 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 29 December 1994
Fixed bug when inputs are bytes.
Version 4, William Thompson, GSFC, 15 March 1995
Removed LL_TITLE
Version 5, William Thompson, GSFC, 28 April 1995
Returns an error string when no entry is found.
Version 6, William Thompson, GSFC, 20 June 1995
Added tags N_FLAGS and WIN_FLAG
Version : Version 6, 20 June 1995
[Previous]
[Next]
Project : SOHO - LASCO/EIT
Name : GET_DB_STRUCT
Purpose : To retrieve a structure appropriate for a given database and table.
Explanation : This routine searches through all structures of database table
definitions and returns the one matching the input parameters.
Use : IDL> s = GET_DB_STRUCT('db_name', 'table_name')
ex. IDL> img_hdr = GET_DB_STRUCT('lasco', 'img_leb_hdr')
Inputs : db_name ;** Name of Sybase database containing table.
tab_name ;** Name of DB table you wish to get the struct of.
Outputs : A structure containing tags of the appropriate type for all fields
in the table or -1 if none found.
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], INIT_DB_STRUCT
CALLED BY:
READ_IP_DAT, REDUCE_IMAGE, REDUCE_LEVEL_05, REDUCE_LEVEL_1, REDUCE_TRANSFER
Common : COMMON DB_STRUCT_COMMON, all_db_struct ;* Defined in INIT_DB_STRUCT
Restrictions: None.
Side effects: None.
Category : Database Administration
Prev. Hist. : None.
Written : Scott Paswaters, NRL, November 1995.
Modified :
Version :
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_DETAIL
Purpose : Extracts a CDS detailed science plan observation
Explanation : This routine extracts parameters which describe the CDS
detailed science plan at a particular point in time.
Use : GET_DETAIL, DATE, OBS
Inputs : DATE = The date/time value that the user wishes the detailed
science plan record for. This can be in any of the
standard CDS time formats.
Opt. Inputs : None.
Outputs : OBS = Structure containing the detailed science plan
record. It contains the following tags:
STRUCT_TYPE= The character string 'CDS-DETAIL'
PROG_ID = Program ID, linking one or more studies
together
STUDY_ID = Number defining the study
STUDYVAR = Number giving the study variation ID
SCI_OBJ = Science objective from the daily science
meeting
SCI_SPEC = Specific science objective from meeting
CMP_NO = Campaign number
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
DATE_OBS = Date/time of beginning of observation,
in TAI format
DATE_END = Date/time of end of observation, in TAI
format
ORIG_DUR = Original duration of the observation, in
seconds, before being truncated by
following time-tagged observations.
N_RASTERS1 = Variable number of rasters parameter
TIME_TAGGED= True (1) if the start of the study is to
be a time-tagged event. Otherwise, the
study will begin immediately after the
previous study.
TRACKING = True (1) if feature tracking to be used,
or false (0) otherwise
N_POINTINGS= Number of pointings to apply to the study.
N_REPEAT_S = Number of times to repeat study.
FLAG_MASTER= Nonzero if flag master
GSET_ID = GSET ID number
GET_RAW = True if raw data should be collected.
PROG_NUM = Study counter number (negative is
predicted)
POINTINGS = An array of pointings to use with the
study.
If no entry is found, then a simpler structure is returned with
STUDY_ID set to -1. POINTINGS is itself a structure of type
PLAN_PNT_STRUC with the following tags:
INS_X = Pointing in X relative to sun center
INS_Y = Pointing in Y relative to sun center
ZONE_ID = Pointing zone ID
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 = ''
GET_DETAIL, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
KEEP_OPEN = set to inhibit calling DBCLOSE
(useful when calling GET_DETAIL in a loop, but
caller must remember to NOT set this keyword on
the last call in the loop)
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DATATYPE [1], DATATYPE [2], DATATYPE [3]
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], DPRINT
FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3], TRIM, UTC2TAI
CALLED BY:
EXPORT_PLAN, GET_CDS_STATE, SHOW_PLAN, WRITE_IAP
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 26 July 1994
Modified : Version 1, William Thompson, GSFC, 3 August 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 17 November 1994
Fixed so that if time is on boundary, then the plan
which starts then is picked.
Version 4, William Thompson, GSFC, 21 November 1994
Added item N_REPEAT_S
Version 5, William Thompson, GSFC, 26 January 1995
Added tag STRUCT_TYPE
Version 6, William Thompson, GSFC, 13 February 1995
Changed way pointing is handled.
Version 7, William Thompson, GSFC, 28 March 1995
Added ZONE_ID to pointing structure.
Version 8, William Thompson, GSFC, 28 April 1995
Returns an error string when no entry is found.
Version 9, William Thompson, GSFC, 8 May 1995
Modified to pay attention to DELETED field in database
Version 10, William Thompson, GSFC, 22 May 1995
Changed way DBFIND is called, to speed up.
Version 11, William Thompson, GSFC, 20 June 1995
Added tag FLAG_MASTER
Version 12, William Thompson, GSFC, 28 September 1995
Added tags ORIG_DUR, GSET_ID, GET_RAW
Version 13, William Thompson, GSFC, 4 June 1997
Added tag PROG_NUM
Version 14, Dominic Zarro, GSFC, 15 July 1997
Added keyword KEEP_OPEN
Version 15, William Thompson, GSFC, 26 May 1998
Look for entries in "_year" files
Version : Version 15, 26 May 1998
[Previous]
[Next]
Project : SOHO - CDS
Name :
GET_DFONT()
Purpose :
Return widget font with size compatible with current device
Explanation :
Useful for selecting fonts to fit into widgets
Use :
Result = GET_DFONT(UFONT)
Inputs :
UFONT = user's optional input fonts (string array)
Opt. Inputs :
None.
Outputs :
DFONT = returned fonts (string array)
Opt. Outputs:
None.
Keywords :
None.
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3]
CALLED BY:
CHIANTI_NE, CHIANTI_TE, EIT_CATRD [1], EIT_DISPLAY, General_Menu [1]
HESSI PARAMETER SELECTION TOOL [1], HESSI Spectrum [2], HESSI Spectrum [4]
IMAGE_TOOL, ITOOL_PKFILE_BS, ITOOL_PTOOL, MDisp, MK_DFONT, MK_POINT_BASE, MK_RASTER
MK_SOHO, MK_SOHO_CUSTOM, MK_SOHO_EDP, MK_SOHO_SBASE [1], MK_SOHO_SBASE [2]
Move_Image, PICKFITS, POPUP_MSG, ROUTINE_NAME [4], ROUTINE_NAME [7]
Radio Astronomy Group View RAG View [1]
Radio Astronomy Group View RAG View [2], SCANPATH, SET_CURSOR_SHAPE
SUMER_SEARCH, SUMER_TOOL, WIDG_HELP, XGET_SYNOPTIC, XGET_UTC, XMATRIX, XMESSAGE
XTEXTEDIT, ch_ss, emiss_select, get_font
Common :
None.
Restrictions:
None.
Side effects:
None.
Category :
Online_help.
Prev. Hist. :
Written Elaine Einfalt (HSTX) May 1992.
Modified :
Version 1, Dominic Zarro, GSFC, 1 August 1994.
Corrected some bugs
Version :
Version 1, 1 August 1994.
[Previous]
[Next]
Name: get_doc
Purpose: retrieve a subset of idl header info. in a standard structure
Input Parameters:
modules - string or string array of idl module names
Output Paramters:
function returns a vector of documentation structures
Optional Keyword Parameters:
quiet - if set, no output (just return documentation structures)
summ - if set, brief output (fmt_doc(doc_str)) - default
full - if set, full header is printed
Method:
calls get1doc for each element of modules
Calling Sequence: docstrs=get_doc(modules)
CALLS:
[Previous]
[Next]
NAME:
get_dpc_info
PURPOSE:
To read a database file and return information on the data product
SAMPLE CALLING SEQUENCE:
get_dpc_info, dpc, nx, ny, npix, sum, err, mnemonic
get_dpc_info, dpc_struct, /struct
INPUT:
dpc - The data product to return the info for
OUTPUT:
nx - The number of "X" pixels (columns)
ny - The number of "Y" pixels (lines)
npix - The total number of pixels
err - Error (0=no error, 1=error)
mnemonic- The mnemonic that is associated with that data product
OPTIONAL KEYWORD INPUTS:
qforce_rd - If set, force the database file to be read again
qprint - If set, print a summary of the data products to the screen
struct - If set, return the structure which holds all of the DPC info
infil - The input file to read. The default is
$MDI_CAL_INFO/dpc_table.txt
CALLS: ***
rd_dpc_table
CALLED BY:
disp_sci160k [1], disp_sci160k [2], disp_sci5k, dpc_summary, mdi_display
mdifocus2, mk_dpc_image, new_disp_sci5k [1], new_disp_sci5k [2], rdtfr
xdisp_sci5k
HISTORY:
Written 18-Apr-94 by M.MOrrison
21-Sep-94 (MDM) - Added IMIN/IMAX values to the structure
28-Sep-95 (MDM) - Allowed MNEM to be defined always
Ver2.0 12-Oct-95 (MDM) - Modified to use the Stanford format DPC table file
- Added .IP_LIST and .PIXMAP2 keywords and read the
DPC_FORMAT files to get those values.
Ver2.1 7-Nov-95 (MDM) - Modified to read the RDB format of the format files
(not the keyword format)
25-Jul-96 (MDM) - Modified to make NX,NY longs for unknown DPC
29-Aug-96 (MDM) - Scrapped reading code and called RD_DPC_TABLE
3-Oct-96 (MDM) - Added 'infil=infil' to the RD_DPC_TABLE call
[Previous]
[Next]
NAME: get_drk_name.pro
PURPOSE: founds de associate dark frame for
a image and gets their name
CATEGORY: Preprocessing high level
CALLING SEQUENCE: get_drk_name, ima_name, drk_name
INPUTS: ima_name Name of image
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: ass_name Name of associate dark frame
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: CATA, db_dark, ndarks, drk_name
SIDE EFFECTS: 1) defines de found dark as the active dark
2) fullfills the dark catalog common if it
don't exists
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)get_drk_name.pro 1.0 25/6/93 :LAS
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_EFF_AREA
Purpose : Gets an overall effective area curve from database
Category : CDS, Calibration, Class3
Explanation : Looks up the correct calibration curve for the effective area
as a function of mirror position of one of the CDS spectral
ranges. First, the software finds the largest effect date
which is on or earlier than the observation date. If there are
multiple entries with the same effective date, then the one
with the latest entry date is used.
Syntax : GET_EFF_AREA, DATE_OBS, SPECTRUM, EFF_AREA
CALLED BY:
GIS_CALIB_AREA, NIS_CALIB
Examples : GET_EFF_AREA, '1996/09/16', 'N1', EFF_AREA
Inputs : DATE_OBS = The date the observation was made.
SPECTRUM = A character string representing the spectrum,
e.g. "N1" or "NIS1".
Opt. Inputs : None.
Outputs : EFF_AREA = The effective area curve, as a function of mirror
position.
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 = ''
GET_EFF_AREA, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2], 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], DBSORT [1], DBSORT [2], DBSORT [3], TRIM
Common : None
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 16-Sep-1996, William Thompson, GSFC
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_EFFICIENCY
Purpose : Gets an overall efficiency value from database
Category : CDS, Calibration, Class3
Explanation : Looks up the correct calibration value for the overall
efficiency of one of the CDS spectral ranges. First, the
software finds the largest effect date which is on or earlier
than the observation date. If there are multiple entries with
the same effective date, then the one with the latest entry
date is used.
Note that the actual efficiency is the product of the
efficiency returned by this routine, times the wavelength
dependence returned by GET_WAVE_EFF. The latter is a
polynomial which will pass through unity at some reference
wavelength. The entire calibration curve would be derived with
the following statements:
WAVE1 = PIX2WAVE('N1', INDGEN(1024))
GET_EFFICIENCY, date_obs, 'N1', EFF1
GET_WAVE_EFF, date_obs, 'N1', COEFF1
EFF1 = EFF1 * POLY(WAVE1, COEFF1)
Syntax : GET_EFFICIENCY, DATE_OBS, SPECTRUM, EFFICIENCY
CALLED BY:
GIS_CALIB_AREA, NIS_CALIB, QCALIB
Examples : GET_EFFICIENCY, '1996/09/16', 'N1', EFFICIENCY
Inputs : DATE_OBS = The date the observation was made.
SPECTRUM = A character string representing the spectrum,
e.g. "N1" or "NIS1".
Opt. Inputs : None.
Outputs : EFFICIENCY = The overall efficiency value.
Opt. Outputs: None.
Keywords : WAVELENGTH = If a wavelength is passed, then the routine
GET_WAVE_EFF will also be called to determine the
efficiency at a specific wavelength. This can
also be an array of wavelengths.
DATE_USED = If a date is passed in through this keyword, then
the most recent efficiency as of this date will be
returned. This is useful for comparing what the
routine would have returned on a given date against
what it currently returns. For example,
GET_EFFICIENCY, '1-Mar-1997', 'N1', OLD_EFF, $
DATE_USED='10-Apr-1997'
GET_EFFICIENCY, '1-Mar-1997', 'N1', NEW_EFF
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 = ''
GET_EFFICIENCY, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2], 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], DBSORT [1], DBSORT [2], DBSORT [3], GET_WAVE_EFF
POLY, TRIM
Common : None
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 16-Sep-1996, William Thompson, GSFC
Version 2, 28-Oct-1997, William Thompson, GSFC
Make sure returned value is scalar
Version 3, 02-Jun-1998, William Thompson, GSFC
Added keyword DATE_USED
Version 4, 21-May-2002, William Thompson, GSFC
Allow N4 for NIS-2 second order.
Contact : WTHOMPSON
[Previous]
[Next]
NAME:
get_eit_data
PURPOSE:
This procedure copies all full field images from specified
date to either local directory or FTP's to remote machine.
CALLING SEQUENCE:
get_eit_data,date,['remote-machine'],['remote-login'],['remote_dir',]
[,/local]
INPUTS:
date specified day of interest, will use LZ data if available
rem_machine remote machine name for FTP
rem_name remote login name for FTP
rem_dir remote directory name for FTP
local set if only want to copy files to local directory
KEYWORD PARAMETERS: None
OUTPUTS:
Copies files to either local directory or remote machine
EXAMPLES:
Copy all EIT full field images from Jan 3, 1997 to my subdirectory
data:
get_eit_data,'3-jan-97','eitv2.nascom.nasa.gov','newmark','data'
COMMON BLOCKS: none.
SIDE EFFECTS:
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], EIT_CATRD [1], EIT_CATRD [2], eit_catrd [3]
eit_file2path, str_replace [1], str_replace [2]
MODIFICATION HISTORY:
Written by: J. Newmark Date. Jan 1997
[Previous]
[Next]
Name: get_eit_info
Purpose: provide 'standard' 1-line summaries of EIT index/fits file headers
Input Parameters:
inrecs - EIT structures (via read_eit) or fits file names
Keyword Parameters:
short - if set, provide a "shorter" summary
fmt_time - output TIME format (default=ECS) - (see anytim OUT_STYLE)
out_style - synonym for FMT_TIME (see anytim OUT_STYLE)
CALLS: ***
ARR2STR [1], Arr2Str [2], STR2ARR [1], STR2ARR [2], data_chk [1], data_chk [2]
get_infox, read_eit
CALLED BY:
eit_fulldisk, eit_mirror, mk_lasteit_movie
History:
15-mar-1997 S.L.Freeland
18-mar-1997 S.L.Freeland - allow user FMT_TIME&OUT_STYLE,
set default time output to -> ECS
Method:
just setup can call <get_infox> for some EIT "standards"
[Previous]
[Next]
NAME:
GET_EXP_FACTOR
PURPOSE:
This function returns the exposure factor and bias for the
given image.
CATEGORY:
EXPFAC
CALLING SEQUENCE:
Result = GET_EXP_FACTOR (Hdr,Exp_factor,Exp_bias)
INPUTS:
Header: Image header for which the factor and bias are wanted.
OUTPUTS:
Result: 0 for success,
-1 for file not found,
-2 for time not found.
Exp_factor: The exposure correction factor. It should be
multiplied with the exposure time to get the
correct time.
Exp_bias: The offset bias that should be subtracted from the
image.
OPTIONAL OUTPUTS:
Nreg: Number of regions that particpated in the calculation.
Exp_sig: The standard deviation in the fit.
KEYWORDS:
FITS_HDR STRARR = a FITS header, returned modified if set
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], FXADDPAR [1], FXADDPAR [2], GET_UTC, LASCO_FITSHDR2STRUCT
OFFSET_BIAS, READ_EXP_FACTOR, TRIM, UTC2YYMMDD, break_file [4]
CALLED BY:
C2_CALIBRATE, C3_CALIBRATE, CORRSUBIMAGE, EXP_CORR, GET_PT, MKMOVIE
MKMOVIE0 obsolete version of mkmoviepro, MK_IMG
COMMON BLOCKS:
EXP_FACTOR_ARRAY: The exposure facotor information for a given
date.
PROCEDURE:
The date in the image header is tested to see if the exposure factor
data in the common block are for that date. If not, the data are
then read in to the common block using READ_EXP_FACTOR. The data
are searched for the time of the exposure. If no time matches
the exposure, then the factor is set to 1 and the standard bias from
OFFSET_BIAS is used.
MODIFICATION HISTORY:
Written by: RA Howard, NRL, 21 September 1997
6 Oct 1997 RAH, Split away from READ_EXP_FACTOR
20 Feb 1998 RAH, Added the fits names to common
19 Jul 2000 NBR - Allow FITS header input, and add HISTORY to FITS header
1 Aug 2000 NBR - Add FITS_HDR keyword
7 Aug 2000 NBR - Remove FITS_HDR keyword
17 Sep 2002 NBR - Only use OFFSET_BIAS.pro if no expfactor; add filedate
to common block and FITS header
19 Sep 2002 NBR - Properly account for no expfac file found (2nd time through)
9 Jan 2003 NBR - Use fn instead of filenamenopath in header
07 Oct 2006 F Auchère - Added the silent keyword
EXAMPLE:
To obtain the exposure factor and bias information and then
convert the image counts to DN/sec:
success = GET_EXP_FACTOR(hdr,expfac,bias)
IF (success NE 0) THEN BEGIN
PRINT,'Exposure factor not found for image ',hdr.filename
PRINT,'Exposure factor is assumed to be 1.0'
ENDIF
img = (img-bias)/(hdr.exptime*expfac)
ver= '@(#)get_exp_factor.pro 1.16 10/10/06' ;LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
GET_EXP_FACTOR
PURPOSE:
This function returns the exposure factor and bias for the
given image.
CATEGORY:
EXPFAC
CALLING SEQUENCE:
Result = GET_EXP_FACTOR (Hdr,Exp_factor,Exp_bias)
INPUTS:
Header: Image header for which the factor and bias are wanted.
OUTPUTS:
Result: 0 for success,
-1 for file not found,
-2 for time not found.
Exp_factor: The exposure correction factor. It should be
multiplied with the exposure time to get the
correct time.
Exp_bias: The offset bias that should be subtracted from the
image.
OPTIONAL OUTPUTS:
Nreg: Number of regions that particpated in the calculation.
Exp_sig: The standard deviation in the fit.
KEYWORDS:
FITS_HDR STRARR = a FITS header, returned modified if set
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], FXADDPAR [1], FXADDPAR [2], GET_UTC, LASCO_FITSHDR2STRUCT
OFFSET_BIAS, READ_EXP_FACTOR, TRIM, UTC2YYMMDD, break_file [4]
CALLED BY:
C2_CALIBRATE, C3_CALIBRATE, CORRSUBIMAGE, EXP_CORR, GET_PT, MKMOVIE
MKMOVIE0 obsolete version of mkmoviepro, MK_IMG
COMMON BLOCKS:
EXP_FACTOR_ARRAY: The exposure facotor information for a given
date.
PROCEDURE:
The date in the image header is tested to see if the exposure factor
data in the common block are for that date. If not, the data are
then read in to the common block using READ_EXP_FACTOR. The data
are searched for the time of the exposure. If no time matches
the exposure, then the factor is set to 1 and the standard bias from
OFFSET_BIAS is used.
MODIFICATION HISTORY:
Written by: RA Howard, NRL, 21 September 1997
6 Oct 1997 RAH, Split away from READ_EXP_FACTOR
20 Feb 1998 RAH, Added the fits names to common
19 Jul 2000 NBR - Allow FITS header input, and add HISTORY to FITS header
1 Aug 2000 NBR - Add FITS_HDR keyword
7 Aug 2000 NBR - Remove FITS_HDR keyword
17 Sep 2002 NBR - Only use OFFSET_BIAS.pro if no expfactor; add filedate
to common block and FITS header
19 Sep 2002 NBR - Properly account for no expfac file found (2nd time through)
9 Jan 2003 NBR - Use fn instead of filenamenopath in header
EXAMPLE:
To obtain the exposure factor and bias information and then
convert the image counts to DN/sec:
success = GET_EXP_FACTOR(hdr,expfac,bias)
IF (success NE 0) THEN BEGIN
PRINT,'Exposure factor not found for image ',hdr.filename
PRINT,'Exposure factor is assumed to be 1.0'
ENDIF
img = (img-bias)/(hdr.exptime*expfac)
ver= '%W% %H%' ;LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_EXPER
Purpose : Extracts a CDS raster entry from the as-run database
Explanation : This routine extracts parameters which describe the CDS as-run
database at the raster (experiment) level for a given SEQ_NUM
value. Optionally, one can pass PROG_NUM and SEQ_IND instead.
Use : GET_EXPER, SEQ_NUM, OBS
GET_EXPER, PROG_NUM, SEQ_IND, OBS
Inputs : SEQ_NUM = The sequence number which serves as the primary
index into the EXPERIMENT database.
PROG_NUM = The program number (study counter).
SEQ_IND = The raster index within the study.
Opt. Inputs : None.
Outputs : OBS = Structure containing the detailed science plan
record. It contains the following tags:
STRUCT_TYPE= The character string 'CDS-EXPERIMENT'
PROG_NUM = Study counter number. This forms the
primary key for this database.
PROG_ID = Program ID, linking one or more studies
together
PROG_IND = An index, reflecting one's position within
a repeated sequence of studies via the
N_REPEAT_S mechanism.
STUDY_ID = Number defining the study
STUDYVAR = Number giving the study variation ID
SCI_OBJ = Science objective from the daily science
meeting
SCI_SPEC = Specific science objective from meeting
CMP_NO = Campaign number
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
SEQ_NUM = Unique sequence number. This serves as
the primary key to the database.
OBS_SEQ = A character string derived from the raster
number and the variation number,
e.g. "R4V3".
COUNT = The number of repeated observations making
up this experiment. Normally 1.
SEQ_IND = The raster counter
RAS_ID = The raster ID number
RAS_VAR = The raster variation index
EXPTIME = The exposure time, in seconds
OBS_MODE = The observing mode.
DW_ID = The data window ID number
DATE_OBS = Date/time of beginning of observation,
in TAI format
DATE_END = Date/time of end of observation, in TAI
format
OBT_TIME = Onboard date/time of beginning of
observation, in TAI format
OBT_END = Onboard date/time of end of observation,
in TAI format
XCEN = Center of instrument field-of-view in
solar X
YCEN = Center of instrument field-of-view in
solar Y
ANGLE = Angle of instrument relative to solar
north
IXWIDTH = Width of field-of-view in instrument X
IYWIDTH = Width of field-of-view in instrument Y
INS_X0 = The instrument origin pointing in X
INS_Y0 = The instrument origin pointing in Y
INS_ROLL = The instrument roll angle
SC_X0 = The spacecraft pointing in X
SC_Y0 = The spacecraft pointing in Y
SC_ROLL = The spacecraft roll
WAVEMIN = The minimum wavelength of observation, in
Angstroms.
WAVEMAX = The maximum wavelength, in Angstroms
TRACKING = True if tracking is on
SER_ID = The series ID number
OPSLBITS = The OPS-L status bits at the start of the
observation.
OPSRBITS = The OPS-R status bits at the start of the
observation.
SLIT_POS = The slit position at the start of the
observation.
MIR_POS = The mirror position at the start of the
observation.
EV_ENAB = True if event recognition enabled
COMP_ERR = True if a compression error was
encountered.
VDS_PMCP = The VDS MCP programmable voltage setting
VDS_MODE = The VDS readout mode.
VDS_ORI = True if the VDS telemetry data is oriented
by columns
VDS_ACC = True if VDS is operated in accumulate mode
GSET_ID = GIS Setup ID
DETECTOR = Either N or G for NIS/GIS.
ZONE_ID = Pointing zone ID
SLIT_NUM = Slit number
FILENAME = FITS file name
SEQVALID = True for valid science data
DATASRC = Data source, either Q(uicklook) or F(inal
distribution).
COMMENTS = Either Y or N
DATE_MOD = Date and time when catalog record was last
modified.
If no entry is found, then a simpler structure is returned with
SEQ_NUM and STUDY_ID both set to -1.
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 = ''
GET_EXPER, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], 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], FIND_WITH_DEF [1], FIND_WITH_DEF [2]
FIND_WITH_DEF [3], GET_MAIN, TRIM
CALLED BY:
ADD_EXPER, ADD_EXP_COMM, FIX_OBS_SEQ, MOD_CATALOG, MOD_EXPER, WRITE_CIF
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 30 June 1995
Modified : Version 1, William Thompson, GSFC, 30 June 1995
Version 2, William Thompson, GSFC, 23 February 1996
Modified for version 2 of the experiment databases.
Version 3, William Thompson, GSFC, 2 April 1996
Added parameters DATASRC and OBS_PROG
Version 4, William Thompson, GSFC, 12 April 1996
Look in both experiment* and fexperiment*
Version 5, William Thompson, GSFC, 25 April 1996
Fixed bug in version 6 related to environment name
Version 6, William Thompson, GSFC, 1 June 1998
Look for entries in "_year" files
Version : Version 6, 1 June 1998
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_F_RASTER
Purpose : Extracts a fundamental raster definition from the database
Explanation : This routine extracts the fundamental parameters of a raster
from the database for the requested raster ID number.
Use : GET_F_RASTER, RAS_ID, DEF
Inputs : RAS_ID = Raster ID number
Opt. Inputs : None.
Outputs : DEF = Structure of type "cds_f_raster" containing the
fundamental parameters of a raster definition. It
contains the following tags:
RAS_ID = Raster ID number. If the requested raster
is not found, then a simpler structure is
returned, with this set to -1.
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.
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 = ''
GET_F_RASTER, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], 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], TRIM
CALLED BY:
ADD_ALT, ADD_DETAIL, ADD_FLAG, TP_DISP_RAST
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 4 April 1994
Modified : Version 1, William Thompson, GSFC, 28 July 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 29 December 1994
Fixed bug when inputs are bytes.
Version 4, William Thompson, GSFC, 28 April 1995
Returns an error string when no entry is found.
Version : Version 4, 28 April 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_F_STUDY
Purpose : Extracts a fundamental study definition from the database
Explanation : This routine extracts the fundamental parameters of a study
from the database for the requested study ID number.
Use : GET_F_STUDY, STUDY_ID, DEF
GET_F_STUDY, TITLE_ID, DEF, /USE_TITLE
GET_F_STUDY, OBS_PROG, DEF
Inputs : STUDY_ID = Study ID number, or
TITLE_ID = Title ID number, or
OBS_PROG = Name of the study
Opt. Inputs : None.
Outputs : DEF = Anonymous structure variable containing the fundamental
parameters of a study definition. It contains the
following tags:
STUDY_ID = Study ID number. If the requested study
is not found, a simpler structure is
returned with this set to -1.
TITLE_ID = Title ID number.
OBS_PROG = Name of the study
TITLE = A descriptive title for the study
CATEGORY = The study category, either "T"est,
"S"cience or "C"alibration.
VAR_POINT = Either "Y" or "N" representing whether or
not the pointing can be controlled by the
user. If "Y" then the pointing is
defined in the plan. If "N" then the
pointing is embedded within the study.
N_RASTER_DEF= Number of rasters in the definition.
RASTERS = A array listing the rasters to be used
during the study.
The raster descriptions themselves are structures, of
type "cds_f_st_ras", with the following tags:
RAS_ID = Raster ID number, pointing to the
definition of the raster.
POINTING = How to handle the pointing. Valid
entries are:
1 = No pointing, supply in plan
0 = Absolute pointing
-1 = Offset value from first raster
INS_X = Together with INS_Y, the pointing to use
when user-supplied values are not
allowed. Only valid when POINTING=0
(absolute) or POINTING=-1 (relative to
1st raster).
INS_Y = ...
Opt. Outputs: None.
Keywords :
USE_TITLE = If set, then the input parameter is the title ID rather
than the study ID. Not required if OBS_PROG is passed.
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 = ''
GET_F_STUDY, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], 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], TRIM
CALLED BY:
CHK_V_STUDY, GET_CDS_STUDY, UPDATE_STUDY_DUR
Common : None.
Restrictions: None.
Side effects: If the input parameter is the STUDY_ID, then the TITLE_ID,
OBS_PROG, TITLE, and CATEGORY fields will be for one and only
one of the entries in the study_title database that matches
that STUDY_ID.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 28 April 1994
Modified : Version 1, William Thompson, GSFC, 26 July 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 21 November 1994
Removed item N_RASTERS0
Added item N_RASTER_DEF
Version 4, William Thompson, GSFC, 29 December 1994
Fixed bug when inputs are bytes.
Version 5, William Thompson, GSFC, 10 February 1995
Changed N_POINTINGS to VAR_POINT.
Removed VAR_RASTERS.
Version 6, William Thompson, GSFC, 28 April 1995
Returns an error string when no entry is found.
Version 7, William Thompson, GSFC, 12 May 1995
Modified to split off separate study_title database
Version 8, William Thompson, GSFC, 17-Mar-1997
Fixed bug involving finding multiple entries if only
study ID was passed.
Version : Version 8, 17-Mar-1997
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_FLAG
Purpose : Extracts a CDS flag receiver status from the database
Explanation : This routine extracts parameters which describe the CDS flag
receiver science plan status at a particular point in time.
Use : GET_FLAG, DATE, STATUS
Inputs : DATE = The date/time value that the user wishes the flag
receiver status for. This can be in any of the
standard CDS time formats.
Opt. Inputs : None.
Outputs : STATUS = Structure containing the flag receiver status. It
contains the following tags:
STRUCT_TYPE= The character string 'CDS-FLAG'
PROG_ID = Program ID, linking one or more studies
together
STUDY_ID = Number defining the study
STUDYVAR = Number giving the study variation ID
SCI_OBJ = Science objective from the daily science
meeting
SCI_SPEC = Specific science objective from meeting
CMP_NO = Campaign number
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
RCVR_START = Date/time of beginning of receiver status,
in TAI format
RCVR_STOP = Date/time of end of receiver status, in
TAI format
ORIG_DUR = Original duration of the observation, in
seconds, before being truncated by
following time-tagged observations.
N_RASTERS1 = Variable number of rasters parameter
TRACKING = True (1) if feature tracking to be used,
or false (0) otherwise
N_POINTINGS= Number of pointings to apply to the study.
Can be either 0 or 1.
REPOINT = Either 1 to allow repoints or 0 to
disallow.
GSET_ID = GSET ID number
POINTINGS = An array of pointings to use with the
study.
If no entry is found, then a simpler structure is returned with
STUDY_ID set to -1. POINTINGS is itself a structure of type
PLAN_PNT_STRUC with the following tags:
INS_X = Pointing in X relative to flag position
INS_Y = Pointing in Y relative to flag position
ZONE_ID = Pointing zone ID
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 = ''
GET_FLAG, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], 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], TRIM, UTC2TAI
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 25 July 1994
Modified : Version 1, William Thompson, GSFC, 25 July 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 17 November 1994
Fixed so that if time is on boundary, then the plan
which starts then is picked.
Version 4, William Thompson, GSFC, 26 January 1995
Added tag STRUCT_TYPE
Version 5, William Thompson, GSFC, 13 February 1995
Changed the way that pointing is treated.
Version 6, William Thompson, GSFC, 28 April 1995
Returns an error string when no entry is found.
Version 7, William Thompson, GSFC, 8 May 1995
Modified to pay attention to DELETED field in database
Version 8, William Thompson, GSFC, 22 May 1995
Changed way DBFIND is called, to speed up.
Version 9, William Thompson, GSFC, 5 July 1995
Added tag REPOINT.
Version 10, William Thompson, GSFC, 6 October 1995
Added tags ORIG_DUR, GSET_ID
Removed tag N_REPEAT_S
Version : Version 10, 6 October 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_GIS_DELAY
Purpose : to get CDS GIS LUT delay
Category : database, planning
Explanation :
Syntax : IDL> delay=get_gis_delay(gset_id)
Inputs : GSET_ID = gset_id id
Opt. Inputs : None.
Outputs : See keywords.
Opt. Outputs: None.
Keywords : ERR = error string
CALLS: ***
EXIST, GET_GSET, HAVE_PROC
Common : GET_GIS_DELAY - misc state DB stuff
Restrictions: None
Side effects: None
History : Version 1, 1-Jan-1996, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_GIS_DET
Purpose : get CDS GIS detectors used by a particular GSET
Category : planning, database
Explanation :
Syntax : IDL> dets=get_gis_det(gset_id)
Inputs : GSET_ID = GSET ID number
Opt. Inputs : None
Outputs : DETS = array of detector nos. (e.g. [0,2,3], or [1,2])
(returns -1 if no GIS detectors used)
Opt. Outputs: None
Keywords : ERR = any errors
CALLS: ***
EXIST, GET_GSET
CALLED BY:
MK_CDS_PLAN
Common : None
Restrictions: None
Side effects: None
History : Version 1, 1-Jul-1996, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_GSET
Purpose : Extracts a GIS raw data file entry from the database
Explanation : This routine extracts a GIS raw data file entry from the
database for a requested raw data file ID number.
Use : GET_GSET, GSET_ID, DEF
Inputs : GSET_ID = GIS setup ID number
Opt. Inputs : None.
Outputs : DEF = Structure containing the GIS setup entry. It
contains the following tags:
GSET_ID = GIS setup ID number. If the requested
GIS setup entry is not found, then a
simpler structure is returned, with this
set to -1.
HVOLT = High voltages (4)
LLD = Low level discriminators (4)
LUT_CHKSUM = LUT checksum in hexidecimal notation (4)
LUT_PAR = LUT parameters (4,11)
RAW_ID = RAW GIS science data file ID (4)
SLIT_NUM = Slit number
ZONE_ID = Zone ID number
FIL_ID = Filament ID number, or 0 for science data
FFB = Front face bias, either -1 or +1
DET_USED = Whether or not detector is used, either 0
or 1 (4)
GSET_DESC = Free format descriptions (4)
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 = ''
GET_GSET, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], 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], TRIM
CALLED BY:
ADD_ALT, ADD_DETAIL, ADD_FLAG, ADD_WAVECAL, GET_GIS_DELAY, GET_GIS_DET, GIS_ARM
GIS_GHOSTING, VIEW_RAW, mk_gset
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 7 September 1995
Modified : Version 1, William Thompson, GSFC, 7 September 1995
Version 2, William Thompson, GSFC, 14 September 1995
Replace FIL_CUR with FFB
Version 3, William Thompson, GSFC, 28 September 1995
Make LUT_CHKSUM an array.
Version 4, William Thompson, GSFC, 4 October 1995
Modified to reflect change in way LUT_PAR, LUT_CHKSUM,
and GSET_DESC are stored.
Version 5, William Thompson, GSFC, 25 January 1996
Modified definition of LUT_PAR and added DET_USED.
Version : Version 5, 25 January 1996
[Previous]
[Next]
FUNCTION: get_hk, mnemonic, filename, time_arr, data_arr
This fuction obtains the data for the item specified by mnemonic from the
file "filename". It returns two array. A time array containing the time of
each data point relative to the first point and a data array containing the
data requested.
The result of the function is the number of data points returned.
CALLS:
[Previous]
[Next]
FUNCTION: get_hk, mnemonic, filename, time_arr, data_arr
This fuction obtains the data for the item specified by mnemonic from the
file "filename". It returns two array. A time array containing the time of
each data point relative to the first point and a data array containing the
data requested.
The result of the function is the number of data points returned.
[Previous]
[Next]
FUNCTION: get_hk, mnemonic, filename, time_arr, data_arr
This fuction obtains the data for the item specified by mnemonic from the
file "filename". It returns two array. A time array containing the time of
each data point relative to the first point and a data array containing the
data requested.
The result of the function is the number of data points returned.
[Previous]
[Next]
NAME:
get_hk_info
PURPOSE:
To return information from the HK database given a time and
a mnemonic.
SAMPLE CALLING SEQUENCE:
info = get_hk_info(times, mnem, /list)
info = get_hk_info('16-mar-94 09:00', 'mtopts5')
info = get_hk_info(['16-mar-94 5:00', '16-mar-94 14:00'], 'mtopts5')
info = get_hk_info(['16-dec-94', '18-dec-94'], ['qtopts1n', 'qtopts2n'])
info = get_hk_info(['7-jun-95', '7-jun-95 23:00'], 'mksqref'+strtrim(indgen(6),2),/qdebug, /raw)
INPUT:
times - A list of the dates/times of interest
mnem - A list of the memonics to return info for
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], FILE_EXIST [2], MAKE_STR [1], MAKE_STR [2], STR2ARR [1]
STR2ARR [2], UNIQ [1], UNIQ [2], UNIQ [3], anytim2ex [1], anytim2ex [2]
anytim2ints [1], anytim2ints [2], break_file [4], concat_dir [4], convert_hk [1]
convert_hk [2], ex2fid [1], ex2fid [2], fid2ex [1], fid2ex [2], file_exist [1]
file_exist [3], file_list [1], file_list [2], prstr [1], prstr [2]
str_replace [1], str_replace [2]
CALLED BY:
MDI_SUMMARY_SUB1, cal_fig_mich, cam_run_sum, iperr_sea, plot_door_open
plot_img_cadence, plot_pzt_corr, plot_shutter_perf, pr_maxmin_hk
pr_mdihk_trans [1], pr_mdihk_trans [2], pr_uniq_hk, quick_hkplot [1]
quick_hkplot [2], seq_frame_info, seq_run_sum [1], seq_run_sum [2]
wrt_fits_bin_exten [2], xhkplot
OPTIONAL KEYWORD INPUT:
list - If set, then the "times" input are a list of times
to find the discrete values for. Default is a starting
and ending time.
every - Can specify to only return every N values. This is
useful when specifying a long time range. It must be
less than 1000.
nostring - If set, then do not make the output string type (ie:
do not use lookup table for "mnemonic" -- just send the
raw value). This only applies to digital mnemonics.
cleanup - If set, then check the data for only good data (ie: remove
data which is from when the DEP is off).
OUTPUT:
info - A floating point array of dimensions
NxM where N is the number of different times requested
and M is the number of mnemoics.
RESTRICTIONS:
* Do not mix mnemonic types unless you are using the /RAW_VALUE switch
(since floating point and string type do not mix well)
HISTORY:
Written 23-May-94 by M.Morrison
24-May-94 (MDM) - Continued to develop
25-May-94 (MDM) - Continued to develop
24-Aug-94 (MDM) - Corrected for error when no valid input files
available for requested time
12-Jan-95 (MDM) - Added EVERY option
- Added access to SC1, SC2, and SC4 database files
16-Jan-95 (MDM) - Continued to add access to SC1, SC2 and SC4
- Changed to do 1000 records at a time
23-Jan-95 (MDM) - Broke into two routines: GET_HK_INFO and
GET1HK_INFO. Made GET_HK_INFO derive which packet
the mnemonic comes from and derive the file names.
24-Jan-95 (MDM) - Corrected error in how MAP2PACK was being derived
6-Feb-95 (MDM) - Added /NOSTRING option
7-Jun-95 (MDM) - Added MDI_MDIHK_LOG_DIR to the list of directories
to check for HK database files.
28-Jun-95 (MDM) - Patched a bug which was causing the schk database
common variable to get clobbered.
29-Jun-95 (MDM) - Added /CLEANUP keyword
27-Jul-95 (MDM) - Finished the 28-Jun-95 patch (added correction for
case where there is no data file)
1-Aug-95 (MDM) - Added /NOMORE to debug PRSTR call
16-Nov-95 (MDM) - Modified to allow a workaround where the expected
extensions were .schk1,2,3,4 and they were implemented
as sc1,2,3,4
21-Nov-95 (MDM) - Modified to handle the fact that the SC HK data is
in a different directory on the EOF system.
27-Nov-95 (MDM) - Added /EXP_PKT option to read the emergency experiment
packet
25-Apr-97 (SDW) - Added "sc3"
8-May-97 (MDM) - Corrected 25-Apr-97 patch (ipack needs to go to 5 now)
17-Sep-98 (CED) - Fixed ".mdihk"-specific bug in file location code.
Added lots of comments.
9-Oct-98 (MDM) - Reverted back to 25-Apr-97 copy because CED did not
backup 8-May copy.
Removed all of 17-Sep-98 CED changes. They were
not necessary -- use the /EXP_PKT option.
See the following file on diapason for 17-Sep-98 mods
/mdisw/save_copy/get_hk_info.pro981009.144946
Reapplied 8-May-97 patch
12-Oct-98 (CED) - Reverted to fixed copy as of 17-Sep-98. Repaired
bug in ".*" -> '.mdihk' code; added directory
replacement for TM subdirs.
2-Dec-98 (MDM) - Reverted back to 9-Oct-98 version and made two line
patch to handle the case where there are no .mdihk
files (it lost track of the directory location, not
because it needed a wildcard fix)
[Previous]
[Next]
NAME:
get_hk_mnem
PURPOSE:
Allow selection of mnemonics from the full list of
mnemonics or from a group list file.
SAMPLE CALLING SEQUENCE:
mnem = get_hk_mnem(1)
mnem = get_hk_mnem(0, sea='volt')
INPUT:
qgroup - 0 for full list, 1 for group list
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], XMENU_SEL [1], XMENU_SEL [2]
concat_dir [4], mapx [1], mapx [2], rd_tfile [1], rd_tfile [2], wc_where [1]
wc_where [2]
CALLED BY:
quick_hkplot [1], quick_hkplot [2]
OPTIONAL KEYWORD INPUT:
sea - If set, then reduce the list of mnemonics to
the ones that have that string in somewhere
group - Optionally the widget ID of the parent
HISTORY:
Written 22-Jan-97 by M.Morrison (stripped out of XHKPLOT)
28-May-97 (MDM) - Added /case_ignore to wc_where call
for mnemonic search
18-Aug-97 (MDM) - Modified to allow 10 char mnem (up from 8)
[Previous]
[Next]
NAME:
get_host
PURPOSE:
Find out the name of the ultrix system as defined in the system
variable "hostname"
INPUT PARAMETERS:
short - If set, then only return the node name, not the full
address (ie sxt2 instead of sxt2.space.lockheed.com)
OUTPUT PARAMETERS:
Returned value is the interpretted `hostname` value.
PROCEEDURE:
Spawn a child process and pipe the result back.
CALLS: ***
STR2ARR [1], STR2ARR [2]
CALLED BY:
ACOPY [1], ACOPY_TEST, CANCEL_PRELIM, LZPLOT, NET_DIR_DIFF, WRITE_IAP
check_oldprocess [1], check_oldprocess [3], check_process [1]
check_process [2], color_copy, dbase2disk, def_tapd [1], def_tapd [2]
def_tapd [3], disk_hog [1], disk_hog [2], diskbench, flares2disk, ftp_copy [1]
ftp_copy [2], get_tf_rec fname filnum recnum [1], getm1ans, go_batch [1]
go_batch [2], html_doc, idl_server_command, idl_server_control, is_bestnode [1]
is_bestnode [2], laser_init, list_tfi, make_mirror, mdifocus2, mk_cd [1], mk_cd [2]
mk_mdi_iap, mk_rasm_files, mk_tfi, mk_vcr, mk_ydbtab, mk_ydbtape [1], mk_ydbtape [2]
mo_check, mo_init [1], mo_init [2], mo_job0, mo_job1, mo_patch, momount, mostrip
nimg_in_tfr fnam [1], pprint OBSOLETE See SPRINTPRO [1], pprint [1]
pr_status [1], pr_status [2], rdtfr, rsh, soon_search [1], soon_search [3]
ssw_install [2], ssw_start_rpcserver, ssw_strfind, synop_link, tfr_decom, timeline
topsdb [1], topsdb [2], tr_hsm_fix, video_menu, web_seq, wrttcplog
wwwidl_server_check, wwwidl_watchdog [1], wwwidl_watchdog [2], xset_chain [1]
xset_chain [2], xsw2tree, xsw2tree_event, xswlist [2], xsxt_prep, ycopy
ydb_install [1], ydb_install [2], ydump
HISTORY:
Written, 30-sep-91, JRL
12-Mar-92 (MDM) - Changed to work for VMS as well as Unix.
24-mar-92 (JRL) - Updated for IRIX operating system
26-mar-92 (SLF) - Got it working for SUNs (again)
30-mar-92 (SLF) - Put vms in the case where it belongs
26-Jul-94 (MDM) - Added /SHORT keyword
4-oct-94 (SLF) - spawn 'hostname' (avoid shell), protect agains .cshrc
minor change in 'short' generation
Noted that there are more modifications to this
program then lines of code...
28-Mar-95 (MDM) - Modified 'irix' to use /usr/bsd/hostname with /noshell
to make it much faster
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
GET_HOSTNAME()
PURPOSE:
Get host or node name of the current machine
CATEGORY:
Utility
SYNTAX:
Result = get_hostname()
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
FULL - Set this keyword to get full host name
UPCASE - Set this keyword to return hostname in uppercase
CALLS: ***
OS_FAMILY
CALLED BY:
SQL_QUERY
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, May 21, 1997, Liyun Wang, NASA/GSFC. Written
CONTACT:
Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
FUNCTION: get_image_param, dpc, nx, ny, npix
Returns image dimensions and number of pixels from the data product code
[Previous]
[Next]
FUNCTION: get_image_param, dpc, nx, ny, npix
Returns image dimensions and number of pixels from the data product code
HISTORY:
Written by D. Mathur
18-Apr-94 (MDM) - Stripped out the code and called GET_DPC_INFO
which uses a database file to get the information
needed.
[Previous]
[Next]
NAME:
GET_IMG_CENTER
PURPOSE:
This function returns the center of the image relative to the
sun center in arc seconds.
CATEGORY:
LASCO_ANALYSIS
CALLING SEQUENCE:
Result = GET_IMG_CENTER (Hdr)
INPUTS:
Hdr: A LASCO header structure for the image that the center is desired
OPTIONAL INPUTS:
Pixel: If set the values are returned in pixels rather than arc seconds
OUTPUTS:
This function returns the image center as a two element array
in which the first element is the azimuthal distance from sun
center in arc seconds and the second element is the elevation
distance from sun center.
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], GET_SUN_CENTER [1], GET_SUN_CENTER [2]
GET_SUN_CENTER [3], LASCO_FITSHDR2STRUCT, SUBTENSE
RESTRICTIONS:
Returns the center for the readout port "C"
PROCEDURE:
Returns values that have been determined by other means and put
into a table here.
MODIFICATION HISTORY:LASCO_FITSHDR2STRUCT(hdr)
Written by: R.A. Howard, NRL, 11 Feb 1997
Updated:
@(#)get_img_center.pro 1.2 07/11/97 LASCO IDL LIBRARY
[Previous]
[Next]
Name: get_info
Purpose: decode Yohkoh index or roadmap information into string info_array
Input Paramters:
index - Yohkoh index or roadmap (scaler or vector)
Optional Input Keywords:
noninteractive = If set, does not prompt user, but only returns
the array. If infil is specified, the summary
is written to an output file.
longform = If set, also put out the percentage of the image
which is available, and the heliocentric coord.
itemnumber = If set, will compute the relative item number
from this starting value. If a vector is passed,
CALLS: ***
GET_INFO2, fmt_tim [1], fmt_tim [2], gt_dp_mode [1], gt_dp_mode [2]
gt_dp_rate [1], gt_dp_rate [2], str_is [1], str_is [2], where_arr [1]
where_arr [2]
CALLED BY:
CHECK_FOR_30S, FAXABLE_SFD, PATROL_ORDER, SDC_VERIFY, SFD_TEK, STEPPER [1]
STEPPER [2], STEPPER [5], STEPPER2 [1], STEPPER2 [2], THICK_FFI, XMOVIE_SFM
chk_pointing, cur_teemcursor Te and EM, fl_summary [1], fl_summary [2]
fl_summary [3], fl_suntoday [1], fl_suntoday [2], fl_suntoday [3], get_sfm
lastspd, mk_sfd [1], mk_sfd [2], mk_sfd [3], mk_sfd [4], mk_ssc [1], mk_ssc [2]
pr_teem, search_obs, sel_leak_image [1], sel_leak_image [3], sel_leak_image [4]
sfc_prep [1], sfc_prep [2], show_pix_event [1], show_pix_event [2]
show_pix_event [3], sun_today [1], sun_today [2], sun_today [3]
sxt_get_grill [1], sxt_get_grill [2], sxt_prep [1], sxt_prep [2], sxt_prep [3]
sxt_ssc2sss, sxt_ssn2fits [1], sxt_xsaa, tim2tfss, xsearch_obs, xso_search, xspr [1]
xspr [2], xsxt_prep_event
Restrictions:
just time and DP mode for non-SXT index input currently
Method:
driver (allow more intuitive get_info call to replace get_info2 call)
for sda, just calls get_info2
History: (SLF) 18-May-1993 (people were calling get_info, not get_info2)
16-Oct-93 (MDM) - Modified to recognized non-SXT roadmaps
9-Dec-93 (MDM) - Added /LONGFORM option (to be passed to GET_INFO2)
9-Sep-94 (GAL) - Added itemnumber option (passed to get_info2) and
documented all the optional inputs.
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
GET_INST_COLOR()
PURPOSE:
Get color code for the given SOHO instrument
CATEGORY:
Utility, planning
EXPLANATION:
SYNTAX:
Result = get_inst_color('C', color_stc)
Result = get_inst_color(/stc)
INPUTS:
INSTRUME - String scalar, instrument name in short format
COLOR_STC - Color structure that has instrument names as part
of its tags. If not passed in or passed in as an
invalid color structure, color #2 will be returned.
OPTIONAL INPUTS:
None.
OUTPUTS:
RESULT - Index of color, or complete color structure if
keyword STC is set
OPTIONAL OUTPUTS:
None.
KEYWORDS:
DEF_COLOR - Default index of color if something goes wrong;
default is set to 2
STC - Set this keyword to return complete color structure
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], GET_SOHO_INST
CALLED BY:
MK_CDS_PLAN, MK_PLAN_FORM, MK_PLAN_PLOT, MK_SOHO, PLOT_SPLAN
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, August 31, 1995, Liyun Wang, GSFC/ARC. Written
Version 2, January 16, 1996, Liyun Wang, GSFC/ARC
Added STC keyword to return color structure
Version 3, January, 1997, Zarro, SAC/GSFC - added TRACE
CONTACT:
Liyun Wang, GSFC/ARC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_INSTRUMENT
Purpose : Extracts a SOHO instrument name and code from the database
Explanation : This routine extracts parameters which associates a SOHO
instrument name with a code value.
Use : GET_INSTRUMENT, INSTRUMENT, DESC
Inputs : INSTRUMENT = Either the instrument name, or the one letter code
value.
Opt. Inputs : None.
Outputs : DESC = Structure containing the instrumention description. It
contains the following tags:
CODE = Single letter instrument code.
NAME = The name of the instrument.
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 = ''
GET_INSTRUMENT, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3]
DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBOPEN [1], DBOPEN [2], DBOPEN [3]
DB_INFO [1], DB_INFO [2], DB_INFO [3]
CALLED BY:
ADD_INST_DLYD, ADD_NRT_RES, ADD_PLAN, DEF_INST_PLAN, DEF_STUDY, DEL_PLAN
DEL_SOHO_DET, GET_PLAN, GET_SOHO_DET, LIST_INST_DLYD, LIST_NRT_RES, LIST_PLAN
LIST_SOHO_DET, MK_PLAN_CLONE, MK_PLAN_CONV, MK_PLAN_EXIST, RD_PLAN, READ_KAP
READ_KAP_ITEM, READ_MSP_FILE, READ_MSP_ITEM, UPD_PLAN, UPD_SOHO_DET, WRITE_CAP
Common : Common block GET_INSTRUMENT contains all the instruments found
the first time this routine is called. Subsequent calls go to
this common block rather than directly to the file.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 26 July 1994
Modified : Version 1.0, William Thompson, GSFC, 3 August 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 28 April 1995
Returns an error string when no entry is found.
Version 4, William Thompson, GSFC, 22 May 1995
Made output a named structure.
Version 5, William Thompson, GSFC, 14 August 1995
Added common block GET_INSTRUMENT
Version : Version 5, 14 August 1995
[Previous]
[Next]
NAME:
get_last_tfr
PURPOSE:
To return the last TFR file (or "n_ago" files) based on creation date/time
SAMPLE CALLING SEQUENCE:
file = get_last_tfr()
file = get_last_tfr(3)
file = get_last_tfr(10, diapason=6)
OPTIONAL INPUT:
n_ago - If you don't want the last file, but want N files ago, use
this argument
CALLS: ***
file_list [1], file_list [2], str_replace [1], str_replace [2], tbeep [1]
tbeep [2], tbeep [3]
CALLED BY:
disp_sci160k [1], disp_sci160k [2], monitor_center [1]
OPTIONAL KEYWORD INPUT:
indir - The input file to check. Default is $MDI_SCI160K_LOG_DIR
reset_tfrx - If set, then delete the .tfrx file so it is recreated
(done if READ_MDI was called before the .tfr file was
finished being written to)
diapason - If set, then look in /data14/data_eof/sci160k directories
diapason can be set to the number of directories to search
OPTIONAL KEYWORD OUTPUT:
nfiles - The total number of *_01.tfr files in the directory
list - The list of the *_01.tfr files in the directory
file - The file name of the file selected (without the directory)
HISTORY:
Written 7-Sep-95 by M.Morrison
6-Aug-96 (MDM) - Added /diapason option
4-Nov-96 (MDM) - Modified how /diapason option worked (look
at multiple directories)
[Previous]
[Next]
Project : SOHO-CDS
Name : GET_LATEST_IAP
Purpose : get latest IAP files from SOC
Category : planning
Explanation :
Syntax : get_latest_iap,date,files=files
CALLED BY:
CHECK_KAP, UPDATE_IAP
Examples :
Inputs : None
Opt. Inputs : DATE = date to retrieve
Outputs : None
Opt. Outputs:
Keywords : FILES = retrieved files
COUNT = # of files found
VERBOSE = print IAP files found
ERR = error string
OUT_DIR = output directory for IAP files
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
DATATYPE [1], DATATYPE [2], DATATYPE [3], DATE_CODE, DELVARX [1], DELVARX [2]
DELVARX [3], DELVARX [4], ESPAWN, EXIST, GET_SOHO_INST, GET_UTC, LOC_FILE [1]
LOC_FILE [2], LOC_FILE [3], OS_FAMILY, RM_FILE, TEST_OPEN, WHERE_VECTOR
concat_dir [4], delvarx [5]
Common : None
Restrictions: Unix only (with FTP access to SOC)
Side effects: None
History : Written 9 January 1997, D. Zarro, ARC/GSFC
Contact : dzarro@solar.stanford.edu
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_LATEST_KAP
Purpose : find most recently created KAP file for a given date
Category : operations, planning
Explanation :
Syntax : IDL> latest_kap_file=get_latest_kap_file(cur_date)
Inputs : CUR_DATE = date to search for
Opt. Inputs : None
Outputs : LATEST_KAP_FILE = most recently created KAP file
Opt. Outputs:
Keywords : CREATE = creation date of file
PATH = path to search [def = SOHO_EAP]
PREFIX = file prefix to search [def = ECS]
SUFFIX = file suffix to search [def = KAP]
STATUS = 1/0 if success/failure
ERR = error messages (blank if none)
YFORMAT = CUR_DATE in YMD format
CALLS: ***
ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], DATATYPE [1], DATATYPE [2], DATATYPE [3], DATE_CODE, DPRINT
LOC_FILE [1], LOC_FILE [2], LOC_FILE [3], OS_FAMILY, TRIM, concat_dir [4]
CALLED BY:
FIX_IAP, MK_SOHO, PURGE_KAPS, UPDATE_KAP
Common : None
Restrictions: None
Side effects: None
History : Version 1, 26-June-1996, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
FUNCTION: get_linearity, sig, e_min, e_max
Returns the % linearity curve(s).
CALLS:
[Previous]
[Next]
FUNCTION: get_linearity, sig
Returns the % linearity curve(s).
CALLS:
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_LINELIST
Purpose : Extracts a line list definition from the database
Explanation : This routine extracts a complete line list definition from the
database for the requested line list.
Use : GET_LINELIST, LL_ID, DEF
Inputs : LL_ID = Line list ID number
Opt. Inputs : None.
Outputs : DEF = Structure containing the line list definition. It
contains the following tags:
LL_ID = Line list ID number. If the requested line
list is not found, then a simpler structure
is returned, with this set to -1.
DETECTOR = Either "G" for GIS or "N" for NIS.
LL_DESC = A description of the line list, e.g.
"Temperature sensitive line pairs".
LINES = An array containing the line definitions.
The line definitions themselves are structures, of type
"cds_lines", with the following tags:
LINENAME = Line name, e.g. "He II 304". Can be up to
12 characters.
WAVELNTH = The wavelength of the line, in Angstroms.
GR_ORDER = The grating order.
CEN_PIX = The central detector pixel.
WAVEBAND = The wavelength band, 1 or 2 for NIS, 1-4 for
GIS.
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 = ''
GET_LINELIST, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], 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], TRIM
CALLED BY:
ADD_DATAWIN, EXPORT_STUDY, FIX_LINELIST, GT_CDS_WINDOW, LOAD_TP_STRUCT
MOD_LINELIST, SHOW_LINELIST, TP_DISP_LLIST, TP_DISP_RAST, TP_WRT_LLIST, UPDATE_DEX
XSTUDY
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 31 March 1994
Modified : Version 1, William Thompson, GSFC, 26 July 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 29 December 1994
Fixed bug when inputs are bytes.
Version 4, William Thompson, GSFC, 15 March 1995
Removed LL_TITLE
Version 5, William Thompson, GSFC, 28 April 1995
Returns an error string when no entry is found.
Version : Version 5, 28 April 1995
[Previous]
[Next]
NAME:
GET_LIST
PURPOSE:
This procedure will return a list of images for selected day(s) from
LASCO/EIT image tree (QL_IMG or LZ_IMG), create reduce image header
catalog, query images on selected keywords and sort images on time.
CATEGORY:
LASCO DATA ANALYSIS
CALLING SEQUENCE:
GET_LIST
INPUTS:
KEYWORD PARAMETERS:
INST: A string for instrument: 'C1' is default.
DAY: A string array: day = ['960703','960704']
ROWS: An integer value for # of rows
COLS: An integer value for # of cols
FILTER: A string for the filter: filter = 'Fe XIV'
POLAR: A string for the polarizer
WAVE: A float array for the wavelength: wave = [5309.2]
QL_IMG: Location of QuickLook images
LZ_IMG: Location of LZ images
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DATATYPE [1], DATATYPE [2], DATATYPE [3]
GET_ARRAY, HEADFITSL, HEAD_INFO, PATH_FILE, QUERYCAT, SXPAR [1], SXPAR [2], SXPAR [3]
UTC2TAI, YYMMDD
SIDE EFFECTS:
PROCEDURE:
EXAMPLE:
list = GET_LIST(day='960704')
list = GET_LIST(day=['960703','960704'],inst='C1',filter='Fe XIV',/wave)
MODIFICATION HISTORY:
Written by: B Podlipnik, 13 March 1997
@(#)get_list.pro 1.1 11/02/01 LASCO IDL LIBRARY
[Previous]
[Next]
Name: get_logenv
Purpose: provide system independent front end to get_env and trn_log
Input Parameters:
logenvs - string or string array of vms logicals or unix environments
(may contain wild cards)
Output Parameters:
function returns equivilence string/string array
Optional Keyword Parameters:
outenv - actual environmentals (output) - may differ from logenvs
if wild cards were used (null if associated env not defined)
Calling Sequence:
envs=get_logenv(logenvs [,count=count, outenv=outenv,
Calling Examples:
sfddirs=get_logenv('DIR_SFD*') ; sfd directories
gendirs=get_logenv('dir_gen*',/case_ignor) ; all DIR_GENxxxxx
home =get_logenv(/home) ; home directory
curdir =get_logenv(/curdirq) ; current [same as curdir()]
ysenvs =get_logenv('ys_*',/environ) ; environmentals form ys_...
ysflags=get_logenv('ys_*') ; same, only translated value
Optional Keyword Parameters
count (output) - number of non-null elements returned
status (output) - boolean success vector (1:match, 0:nomatch)
outenv (output) - string array - actual environmentals found
environ(input) - switch - return logical/environ, not translation
(could be useful if logenvs contains wild card)
home (input) - switch, if set, return home directory translation
curdir (input) - if set, return current directory
case_ignore (input) if set, case INsensitive (only functional in unix)
CALLED BY:
ANAL_BCS_PHA, ANAL_STIMS, ANDRIL_SXT, AUTOCAL, CHECK_DIST, DSK_LOCG, EIT_CATRD [1]
EIT_MKMOVIE, EIT_PREP, FIRST_LIGHT [1], FIRST_LIGHT [2], FLAGOOL, HESSI
HSI_ASPECT_MODEL, HSI_CHK_DUPLICATE, Hsi_contact2fits [1]
Hsi_contact2fits [2], JSMOVIE, QUICKDARK [2], SPEX_COMMONS [2], SPEX_COMMONS [4]
SPEX_PROC [1], SPEX_PROC [2], STEPPER [3], STEPPER [4], STEPPER2_s1 [1]
STEPPER2_s1 [2], UPDATE_LINE_TEMPLATES, ace_files, bcs_path, cdrom_files [2]
check_log [1], check_log [2], chk_batse_env [1], chk_batse_env [2]
configure_http, daily_forecast [2], data_compress [1], data_compress [2]
data_compress [3], dbase2disk, disk_hog [1], disk_hog [2], disk_monitor [1]
disk_monitor [2], drm_4_spex [1], drm_4_spex [2], eit_file2path, eit_files
eit_fulldiskdb, eit_genx_cat, eit_mirror, eit_proton_summary, event_movie [1]
extract_val, file_path [1], file_path [2], file_purge_sizes, files_since [1]
files_since [2], fitstap2tap [1], fitstap2tap [2], fl_goesplot [1]
fl_goesplot [2], fl_goesplot [3], fl_mktext, fl_suntoday [1], fl_suntoday [2]
fl_suntoday [3], fl_sxtobsnar [1], fl_sxtobsnar [2], ftp_copy [1], ftp_copy [2]
ftp_copy2sites, ftp_defprompt, genx2html [1], genx2html [2], get_daily [1]
get_daily [2], get_epoch_sfcs [1], get_epoch_sfcs [2], get_mk3 [1], get_mk3 [2]
get_selsis, get_sirius [1], get_sirius [2], get_solar_indices
go_lasdisk golaserdisk, go_lasdisk2 golaserdisk, go_yo_prod_batch
goes3sec_copy, goes_plot [1], goes_plot [2], goes_plot [3], goes_plot [4]
goes_plot [5], hardcopy [1], hardcopy [2], hessi_version, hsi_1orbit_allpak
hsi_clk_delta_calc, hsi_mult_filedb_inp filedb_dir filedb_dir
hsi_params_write_pro, html_basics, html_doc, http_names, image2movie
is_bestnode [1], is_bestnode [2], lapalma_cat, lapalma_files, leak_sub [1]
leak_sub [2], leak_sub [3], les_archive_info, mail [1], mail [2], make_ssw_mirror
map_env2dir, mdi_cat, mdi_files, mdi_write_genxcat, mk_gsn_obs, mk_lasteit_movie
mk_pix [1], mk_pix [2], mk_pubydb, mk_sdcs, mk_sfc [1], mk_sfc [2], mk_ssc [1]
mk_ssc [2], mk_ssc_batch [1], mk_ssc_batch [2], mk_sxh, mk_syn_sfc [1]
mk_syn_sfc [2], mk_synsfc_coeff [1], mk_synsfc_coeff [2], mk_ydb_list, mk_ydbtab
mk_ydbtape [1], mk_ydbtape [2], mo_filelist, mo_patch, monitor_scratch [1]
monitor_scratch [2], mreadfits_sxig12, msok_copy_jpg, msok_poi_copy [1]
msok_poi_copy [2], multi_hda2hxi, newsfd, nobeyama_update
ospex_params_write_pro, pprint OBSOLETE See SPRINTPRO [1], pprint [1]
pr_logenv, pref_super, rapp_get_spectrogram, rd_fdss, rd_goesp_ascii
rd_goesx_ascii, rd_sxg, rd_ydbtap, read_genxcat, read_lapalma, read_msok_jpg
rep_logenv, restenv [1], restenv [2], save_idl_routines, saveenv [1], saveenv [2]
search_obs, secchi_time2files, selsis_copy [1], selsis_copy [2], set_logwindows
setssw_windows, setup_spex [1], setup_spex [2], sfc_check, sft2sfc, show_contacts
show_pix [1], show_pix [2], show_pix_event [1], show_pix_event [2]
show_pix_event [3], show_pixf, soon_search_www, sooncat_cadence
spex_preview [1], spex_preview [2], ssc_files [1], ssc_files [2], ssc_files [3]
ssw_addmm_gen, ssw_bin, ssw_check_contrib, ssw_colors, ssw_conflicts
ssw_contrib_monitor, ssw_ct2rgb, ssw_findstuff2html, ssw_fov_context
ssw_getapplet, ssw_install [1], ssw_install [2], ssw_instr_info, ssw_instruments
ssw_packages, ssw_path, ssw_required_path, ssw_set_chianti, ssw_set_instr
ssw_setsswdb_gen, ssw_setup_windows, ssw_start_rpcserver, ssw_upgrade [1]
ssw_upgrade [2], ssw_upgrade_backup, sswdb_info, sswdb_install, sswdb_upgrade
sswloc, struct_where, sun_today [1], sun_today [2], sun_today [3], sxt2file
sxt2mpeg, sxt_cen [1], sxt_cen [2], sxt_deleak [1], sxt_deleak [2], sxt_files
sxt_html, sxt_patch_att, sxt_prep [1], sxt_prep [2], sxt_prep [3], sxt_ssc2sss
sxt_uvf_info [1], sxt_uvf_info [3], sxt_where, term_times, tim2dbase, tim2tfss
trace_cat, trace_decode_idl PLEASE USE trace_jpeg_decomp
trace_do_data_requests, trace_dph2struct [1], trace_file2path, trace_files
trace_get1www_image, trace_jpeg_decomp, trace_last_movie [1]
trace_last_movie [2], trace_last_movie [3], trace_last_movie_queue
trace_make_tma, trace_make_tmr [1], trace_make_tmr [2], trace_movie_context
trace_movie_index [1], trace_movie_index [2], trace_movies_prioritize [1]
trace_movies_prioritize [2], trace_special_movie [1]
trace_special_movie [2], trace_special_movie [3], trace_special_movie2
trace_submit_request, trace_success_file, trace_where, trace_write_genxcat
ucon_path, url_decode, write_trace, wwwidl_watchdog [1], wwwidl_watchdog [2]
xcheckip, xso_search, ycopy, ydb_install [1], ydb_install [2], ydb_pre2dir [1]
ydb_pre2dir [2], ydump, yo_index2path, yo_mkos1_dbase, yo_xda2legacy, yohkoh_files
yohkoh_legacy_files [1], yohkoh_legacy_files [2]
History:
slf - 5-apr-1993
SLF - 13-Jan-1993 (use /noshell on printenv for speed)
SLF - 16-Jan-1993 (work around for multiple line envs)
SLF - 30-Mar-1994 fix VMS bug
DMZ - 20-May-1994 added check for '$' in first character
SLF - 21-May-1994 added a semicolon to comment (4 man-months effort)
SLF - 2-Jun-1994 fix (define allenv if wild cards used)
CALLS: ***
wc_where [1], wc_where [2]
Restrictions:
if logenvs is an array with one or more elements containg a wild
card AND more than one env/log satisfies the wildcard, then only
one match is returned (maintains 1 to 1 correspond between
input <logenvs> and <output>
Does not yet handle multiple line environmentals (1st line returned)
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_MAIN
Purpose : Extracts a CDS main entry from the as-run database
Explanation : This routine extracts parameters which describe the CDS as-run
database at the study level for a given PROG_NUM (study
counter) value.
Use : GET_MAIN, PROG_NUM, OBS
Inputs : PROG_NUM = The program number (study counter) which serves as
the primary index into the MAIN database.
Opt. Inputs : None.
Outputs : OBS = Structure containing the detailed science plan
record. It contains the following tags:
STRUCT_TYPE= The character string 'CDS-MAIN'
PROG_NUM = Study counter number. This forms the
primary key for this database.
PROG_ID = Program ID, linking one or more studies
together
PROG_IND = An index, reflecting one's position within
a repeated sequence of studies via the
N_REPEAT_S mechanism.
STUDY_ID = Number defining the study
STUDYVAR = Number giving the study variation ID
OBS_PROG = Name of the study
DETECTOR = Detector, "N", "G", or "B"(oth).
SCI_OBJ = Science objective from the daily science
meeting
SCI_SPEC = Specific science objective from meeting
CMP_NO = Campaign number
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
DATE_OBS = Date/time of beginning of observation,
in TAI format
DATE_END = Date/time of end of observation, in TAI
format
OBT_TIME = Onboard date/time of beginning of
observation, in TAI format
OBT_END = Onboard date/time of end of observation,
in TAI format
XCEN = Center of instrument field-of-view in
solar X
YCEN = Center of instrument field-of-view in
solar Y
ANGLE = Angle of instrument relative to solar
north
IXWIDTH = Width of field-of-view in instrument X
IYWIDTH = Width of field-of-view in instrument Y
SEQ_FROM = Start of range of observing sequence
numbers.
SEQ_TO = End of range of observing sequence
numbers.
COMMENTS = Either Y or N
DATE_MOD = Date and time when catalog record was last
modified.
If no entry is found, then a simpler structure is returned with
PROG_NUM and STUDY_ID both set to -1.
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 = ''
GET_MAIN, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], 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], TRIM
CALLED BY:
ADD_MAIN, FIX_MAIN_TIMES, GET_EXPER, MOD_CATALOG, MOD_MAIN
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 30 June 1995
Modified : Version 1, William Thompson, GSFC, 30 June 1995
Version 2, William Thompson, GSFC, 2 April 1996
Modified for version 3 of the catalog.
Version 3, William Thompson, GSFC, 6 March 1998
Fixed bug where PROG_NUM converted to 1-element array
Version : Version 3, 6 March 1998
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_MIRSHIFT
Purpose : Get the NIS mirror shift calibration for a given date.
Category : Calibration, NIS, Coordinates
Explanation : Looks up the NIS mirror shift calibration in the database for a
given spectrum and date combination. First, the software finds
the largest effective date which is on or earlier than the
observation date. If there are multiple entries with the same
effective date, then the one with the latest entry date is
used.
Syntax : GET_MIRSHIFT, SPECTRUM, REQ_DATE, COEFF
CALLED BY:
GT_LAMBDA, MK_CDS_ANALYSIS, NIS_ROTATE
Examples : GET_MIRSHIFT, 1, DATE, MIRSHIFT
IF MIRSHIFT.DATE NE '' THEN ...
Inputs : SPECTRUM = Either 1 or 2
REQ_DATE = The date to use in searching for a wavelength
calibration.
Opt. Inputs : None.
Outputs : COEFF = The NIS mirror shift calibration coefficients. The
polynomial
SHIFT = POLY(MIR_POS - 128, COEFF)
returns the tilt as a function of mirror position.
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 = ''
GET_MIRSHIFT, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2], 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], DBSORT [1], DBSORT [2], DBSORT [3], TRIM
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 22-Jan-1999, William Thompson, GSFC
Contact : WTHOMPSON
[Previous]
[Next]
PROJET:
SOHO - LASCO
NAME:
GET_MISS_BLOCKS
PURPOSE:
Finds all the missing blocks on an image
CALLED BY:
FUZZY_IMAGE
PROCEDURE:
Finds all the missing blocks on an image, and designs the corresponding
"missing zones"; returns a map of the missing blocks where each
missing block is then given the number of the missing zone it belongs
A missing zone is defined as the smallest rectangle that surrounds a
cluster of missing blocks (likely to be neighbor missing blocks) but
has no missing blocks on its border (its outermost rows and columns)
Call this routine before using a chain of correction, otherwise the
location of all missing blocks would be lost after the 1st correction
CATEGORY:
Detection, Missing Blocks
CALLING SEQUENCE:
get_miss_blocks, image, map_miss_blocks
[ , list_miss_blocks, n_miss_blocks ]
INPUTS:
image the image to make the map of
OUTPUTS:
map_miss_blocks the map of the missing blocks, a 32x32 array
Assume there are nz missing zones, then each
element (i,j) on the map represents the state
of the block at column i and row j :
_ (-1) means it's a correct block
_ A integer z (from 0 to nz-1) means this is a
missing block belonging to the "z"th zone
OPTIONAL OUTPUT:
list_miss_blocks the total list of missing blocks, a 2 columns
array, where each row (i,j) represents the
location of a missing block
n_miss_blocks the total number of missing blocks
KEYWORD INPUT:
detector : C2 or C3 to get the non transmitted block mask (default:C2)
rebindex : 0: 1024 * 1024, 1: 512 * 512, 2:256 * 256
ALL: Do not get block mask
CALLS: ***
WHERE2D, get_tmask
EXAMPLE:
Given a image "image1" with missing blocks, get its map:
get_miss_blocks, image1, map_b
Print the list and the number of missing blocks :
print, where2d(map_b ge 0, n_b) & print, n_b
Get the number of missing zones, then for each missing zone print the
blocks it contains :
n_z = max(map_b)+1
for z=0, n_z - 1 $
print, where2d(map_b eq z)
MODIFICATION HISTORY:
Written by J.MORE, September 1996
Modif 13/01/2000 A.T. add of detector and rebindex keyword
1/24/01, nbr - extend zone to two blocks in each direction instead of one
12/31/01, nbr - Add ALL keyword
4/10/03, nbr - Modify map_miss_blocks criteria
[Previous]
[Next]
NAME:
GET_MISSING_PCKTS
PURPOSE:
Searches index of REL/QKL files between times tai0 and tai1 (exclusive).
If there are any packets in this interval, return them in
'result'. Otherwise return 0.
CATEGORY:
LASCO PACKETS
INPUTS:
tai0 LONG Tai time (seconds) of last packet before gap
tai1 LONG Tai time of first packet after gap
Keywords:
USE_CTR If set, use packet counter instead of time to fill gap
(necessary when LOBT clock is reset backwards). Set equal to
[lastctr,ctr] (counter before and after gap)
OUTPUTS:
Result: BYTARR(packet length, number of packets)
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], FIND_CLOSEST, GETENV_SLASH, OBT2TAI
READLIST, READ_TM_PACKET
CALLED BY:
FIX_TIME_JUMP
SIDE EFFECTS:
PROCEDURE:
MODIFICATION HISTORY:
Written by: N.B. Rich, Jan. 2000
NBRich Apr 2000 - Account for case where files(ind0-1) includes files(ind0);
Add USE_CTR keyword
jake - changed /net/gorgon/gg3/ql/ to GETENV('QL_IMG')
03.10.08, nbr - Changed input index.txt name/location
12/14/05 @(#)get_missing_pckts.pro 1.7 LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
GET_MONEXP_DATA
PURPOSE:
This function returns the monitor data of datatype = type
from the common block.
CATEGORY:
LASCO data analysis
CALLING SEQUENCE:
Result = GET_MONEXP_DATA(Type)
INPUTS:
Type: The data type to be returned
OUTPUTS:
This function returns an array of the image statistics generated
for the exposure time evaluation for the datatype specified as
the input parameter.
CALLED BY:
COMPUTE_MONEXP_FACTORS, CORR_ALLSUBS, PLOT_MONEXP_STD
COMMON BLOCKS:
MONEXP_DATA: Contains the monexp data
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
Written by: RA Howard, 2 June 1997
@(#)get_monexp_data.pro 1.6 11/20/97 LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
get_most_comm
PURPOSE:
Find out which value is use the most and return the subscript
of that value
SAMPLE CALLING SEQUENCE:
sub = get_most_comm( vals )
sub = get_most_comm( gt_res(r) + gt_filta(r)*4 + gt_filtb(r)*32
INPUT:
vals - An array of values. It is expected that there are
many repeats of certain values, and the function
returns the subscript of the value which shows up the
most number of times.
OUTPUT:
sub - Returns the subscript of the value repeated the most
times
OPTIONAL OUTPUT:
uvals - An array of the unique values
h - The number of occurances of each of the "uvals" values
CALLS: ***
UNIQ [1], UNIQ [2], UNIQ [3]
CALLED BY:
obs_summary
HISTORY:
Written 1-Oct-93 by M.Morrison
[Previous]
[Next]
NAME: GET_NEW_FILE_NUMBER
PURPOSE: Finds the last file number for the given
telescope and source and increments it.
CATEGORY: REDUCTION
CALLING SEQUENCE: Result = GET_NEW_FILE_NUMBER(Tel, Source)
INPUTS: Tel = Telescope number (0..3)
Source = 0 for GSFC R/T
1 for NRL R/T
2 for NRL Playback
7 for test
OUTPUTS: Result = Number to be used for file name
CALLED BY:
REDUCE_LEVEL_05
COMMON BLOCKS: DBMS
PROCEDURE: An entry is recorded in the processing log
when the file number is found.
MODIFICATION HISTORY: Written RA Howard, NRL
Version 1 Initial Release 31 Oct 1995
Version 2 17 Jan 96 Added testing source
Version 3 11 Feb 97 SEP Changed num to type LONG
29 Aug 2000, nbr - Use $LAST_IMG instead of $IMAGES
11 Oct 2000, nbr - Use $IMAGES if source=0
@(#)get_new_file_number.pro 1.3 01/12/01 ; NRL LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_NIMCP
Purpose : Gets the relevant NIMCP data for a given date
Explanation : This routine reads in the NIMCP data for a given date,
characterizing lines which have been partially burned into the
detector.
Use : GET_NIMCP, DATE, OUTPUT
Inputs : DATE = The observation date, in any CDS time format.
Opt. Inputs : None.
Outputs : OUTPUT = An array of structures containing the following tags.
DETECTOR = Either "N1" or "N2".
DEPTH = The amount of burn-in, e.g. -0.1.
CENTER = The center pixel of the burn-in.
WIDTH = The gaussian width of the burn-in.
SHAPE = A shape parameter, denoting a departure from
Gaussian profiles.
POST = Set to 1 or 2 if burn-in is post-accident.
The value 2 represents data with broadened
Gaussian shapes.
Note that some lines will appear multiple times--the total
burn-in will be the sum of all the depths for that line.
Opt. Outputs: None.
Keywords : CALIBRATION = The number of the calibration to use. Must be 2
or greater. (With /POST, it must be 1 or
greater.) The default is to use the most
up-to-date calibration.
POST = When used with the CALIBRATION keyword, specifies
that the post-recovery databases be searched instead
of the pre-accident databases. The post-recovery
databases have a completely separate list of version
numbers, starting with 1.
PRE_ONLY = If set, and the observation data is post-recovery,
then only the residual burn-in from pre-accident
lines are returned.
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 = ''
GET_NIMCP, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2TAI, FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3]
NIMCP_DEPTH_FUNCT, NTRIM, POLY, READ_NIMCP_CAL, UTC2TAI
CALLED BY:
DISPLAY_CDS_BURNIN, DISPLAY_NIMCP, VDS_BURNIN_NEW, VDS_BURNIN_ORIG
Common : None.
Restrictions: Requires the file nimcp_cal2.dat in the directory given by the
environment variable CDS_VDS_CAL_INT. There may also be higher
versions, e.g. nimcp_cal3.dat, nimcp_cal4.dat, etc.
Between the dates 1-Apr-1996 and 12-May-1996, the depths are
linearly interpolated so that all are 0 on 1-Apr-1996.
Side effects: None.
Category : Class4, Calibration
Prev. Hist. : None.
Written : William Thompson, GSFC, 10 September 1996
Modified : Version 1, William Thompson, GSFC, 10 September 1996
Version 2, William Thompson, GSFC, 23 September 1996
Corrected bug where file was left open.
Version 3, William Thompson, GSFC, 25 February 1997
Modified to use new nimcp_cal2.dat file.
Version 4, William Thompson, GSFC, 11 August 1997
Modified to use newest nimcp_cal#.dat file.
Added CALIBRATION keyword
Version 5, William Thompson, GSFC, 2 June 1998
Optionally read shape parameter from data file.
Version 6, William Thompson, GSFC, 11 June 1998
Split off reading of file to READ_NIMCP_CAL
Version 7, William Thompson, GSFC, 17 November 1998
As temporary fix, don't extrapolate burn-in past loss
of contact on 24-Jun-1998.
Version 8, William Thompson, GSFC, 14 January 1999
As a temporary fix, reduce all burn-ins by 81% for
post-recovery data.
Version 9, William Thompson, GSFC, 25 February 1999
Fix typo disabling use of CALIBRATION keyword.
Version 10, William Thompson, GSFC, 6 August 1999
Added keywords POST and PRE_ONLY.
Version 11, 30-Sep-1999, William Thompson, GSFC
Added POST to the output structure.
Version 12, 12-Jan-2000, William Thompson, GSFC
Differentiate between ".dat" and "a.dat" files for
post-recovery data (POST=1 or 2).
Version : Version 12, 12-Jan-2000
[Previous]
[Next]
Project : SOHO-CDS
Name : GET_NOAA
Purpose : get latest NOAA NEUTRAL-line GIF from EIT MAC
Category : planning
Explanation :
Syntax : get_noaa,file,date
CALLED BY:
MK_SOHO_TARGET
Examples :
Inputs : None
Opt. Inputs : DATE = date to retrieve
Outputs :
Opt. Outputs: FILE = found filename
Keywords : OUT_DIR = output directory for file [def = current]
ERR = error string
COUNT = no fo files found
BACK= no of days back to look
GDATE = actual date of found GIF file
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CHECK_FTP, CHK_DIR [1], CHK_DIR [2]
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], DATE_CODE, ESPAWN, EXIST, EXIST_JOB, GET_UTC, KILL_JOB, LOC_FILE [1]
LOC_FILE [2], LOC_FILE [3], OS_FAMILY, RM_FILE, SEND_MAIL, TEST_DIR, TRIM, VALID_GIF
concat_dir [4]
Common : None
Restrictions: Unix only (with FTP access to MAC)
Side effects: None
History : Written 18 August 1997, D. Zarro, ARC/GSFC
Contact : dzarro@solar.stanford.edu
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_OBJECT
Purpose : Extracts a SOHO object description from the database
Explanation : This routine extracts parameters which describes a SOHO
object name abbreviation.
Use : GET_OBJECT, OBJECT, DESC
Inputs : OBJECT = Either the unique object code, or the unique object
description.
Opt. Inputs : None.
Outputs : DESC = Structure containing the object description. It
contains the following tags:
OBJECT = Three-letter object code. If a match is
not found, then this set to the null
string.
OBJECT_DESC = Expanded-out name of the object.
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 = ''
GET_OBJECT, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], GETTOK [1], GETTOK [2], GETTOK [3]
GETTOK [4], LIST_OBJECT
CALLED BY:
ADD_ALT, ADD_DETAIL, ADD_FLAG, ADD_MAIN, ADD_OTHER_OBS, ADD_PLAN, MK_SOHO_TARGET
MOD_MAIN, READ_KAP_ITEM, SOHO_ITEMS_HTML, UPD_PLAN, UPD_SOHO_DET
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 25 July 1994
Modified : Version 1, William Thompson, GSFC, 27 July 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 8 November 1994
Changed so that a blank but non-null result is returned
if OBJECT is a blank string.
Version 4, William Thompson, GSFC, 17 February 1995
Changed so that one can either search on the code value
or the description. Fixed bug when two-letter
abbreviations are used.
Version 5, William Thompson, GSFC, 28 April 1995
Returns an error string when no entry is found.
Version 6, William Thompson, GSFC, 22 May 1995
Made output variable a named structure.
Version 7, William Thompson, GSFC, 14 August 1995
Modified to call LIST_OBJECT. Together with changes to
that routine, this routine is speeded up.
Allow format where abbreviation is followed by the
description, e.g. "LMB Solar limb"
Make not found error message more descriptive.
Version : Version 7, 14 August 1995.
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_ORBIT()
Purpose : Get the SOHO orbit information.
Category : Class3, Orbit
Explanation : Reads orbit information from either the definitive or
predictive orbit file, whichever it can find first.
Syntax : Result = GET_ORBIT( DATE [, TYPE ] )
CALLED BY:
CALC_LOI_ROLL, GET_TIME_DELAY, MK_SOHO_MAP_EARTH, TRACE_MDI_ALIGN
Examples :
Inputs : DATE = The date/time value to get the orbit information for.
Can be in any CDS time format.
Opt. Inputs : None.
Outputs : The result of the function is a structure containing the
spacecraft orbit information. It contains the following tags.
If unable to find this information, zeroes are returned
instead.
Opt. Outputs: TYPE = Returns whether predictive or definitive data was
used to calculate the result. Returned as either
"Definitive" or "Predictive". If the routine fails
to return an answer, then the null string is
returned.
Keywords : RETAIN = No longer used. Kept for backwards compatibility.
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 = GET_ORBIT( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
OLD = If set, then files are read in from the subdirectory
"old_samples". This is used to test the software
until real data files are available.
Calls : ***
ANYTIM2CAL, ANYTIM2UTC [1], ANYTIM2UTC [2], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], FXBCLOSE [1], FXBCLOSE [2], FXBISOPEN [1], FXBISOPEN [2]
FXBOPEN [1], FXBOPEN [2], FXBOPEN [3], FXBREAD [1], FXBREAD [2], FXBREAD [3]
OS_FAMILY, REVERSE, TRIM, concat_dir [4]
Common : Private common block GET_ORBIT is used to store data from the
last orbit file read. Speeds up subsequent reads when the same
day is referenced.
Restrictions: The orbit entries for the time closest to that requested is
used to calculate the orbit parameters. Since the orbit data
is calculated every 10 minutes, this should be correct within
+/-5 minutes. No attempt is made to interpolate to closer
accuracy than that.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 04-Dec-1995, William Thompson, GSFC
Version 2, 03-Sep-1996, William Thompson, GSFC
Also look for filename with a dollar sign
prepended--this is how VMS treats uppercase filenames.
Version 3, 11-Oct-1996, William Thompson, GSFC
Only prepend $ in VMS. Use in both places where
needed.
Version 4, 22-Nov-1996, William Thompson, GSFC
Fixed bug introduced in version 3, where only
predictive data was being returned in Unix.
Version 5, 22-Jan-1997, William Thompson, GSFC
Modified to reflect reorganization of orbit files.
Version 6, 30-Jan-1997, William Thompson, GSFC
Fixed VMS bug introduced in version 5
Version 7, 28-Mar-2002, William Thompson, GSFC
Replaced RETAIN keyword with reading in entire file,
and storing in common block.
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - LASCO
Name : GET_ORBIT_CDF()
Purpose : Get the SOHO orbit information.
Category : Class3, Orbit
Explanation : Reads orbit information from either the definitive or
predictive orbit file, whichever it can find first.
Syntax : Result = GET_ORBIT_CDF( DATE [, TYPE ] )
CALLED BY:
POINTING3
Examples :
Inputs : DATE = The date/time value to get the orbit information for.
Can be in any SOHO/CDS time format.
Opt. Inputs : None.
Outputs : The result of the function is a structure containing the
spacecraft orbit information. It contains the following tags.
If unable to find this information, zeroes are returned
instead.
Opt. Outputs: TYPE = Returns whether predictive or definitive data was
used to calculate the result. Returned as either
"Definitive" or "Predictive". If the routine fails
to return an answer, then the null string is
returned.
Keywords : RETAIN = If set, then the orbit cdf file will be left open.
This speeds up subsequent reads.
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 = GET_ORBIT( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2CAL, ANYTIM2UTC [1], ANYTIM2UTC [2], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], REVERSE, STR2UTC [1], STR2UTC [2], STR2UTC [3], concat_dir [4]
Common : Private common block GET_ORBIT_CDF is used to keep
track of the orbit file opened when the RETAIN keyword
is used.
Side effects: None.
Prev. Hist. : Adapted from William Thompson's GET_ORBIT to read CDF
files rather than FITS.
History : Written by Simon Plunkett, 27 March 1996.
RAH, NRL, 18 Feb 97, mods to account for changes in CDF variables
DW, NRL, 26 Aug 98, mod for change in predictive CDF filenames
NBR, NRL, 29 Oct 01 - Rename soho_orbit structure definition to be
compatible with SSW
@(#)get_orbit_cdf.pro 1.3 10/29/01 LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - LASCO
Name : GET_ORBIT_CDF2()
Purpose : Get the SOHO orbit information.
Category : Class3, Orbit
Explanation : Reads orbit information from either the definitive or
predictive orbit file, whichever it can find first.
Syntax : Result = GET_ORBIT_CDF2( DATE [, TYPE ] )
CALLED BY:
DIST2SUN, GET_SOLAR_RADIUS, STARFIELD, get_soho_ephem
Examples :
Inputs : DATE = The date/time value to get the orbit information for.
Can be in any SOHO/CDS time format.
Opt. Inputs : None.
Outputs : The result of the function is a structure containing the
spacecraft orbit information. It contains the following tags:
GCI_POS: Geocentric Inertial X,Y,Z (KM)
GCI_VEL: " (KM/S)
GSE_POS: Geocentric Solar Ecliptic X,Y,Z (KM)
GSE_VEL: " (KM/S)
GSM_POS: Geocentric Solar Magnetospheric X,Y,Z (KM)
GSM_VEL: " (KM/S)
SUN_VECTOR: GCI Sun Vector X,Y,Z (KM)
HEC_POS: Heliocentric Ecliptic X,Y,Z (KM)
HEC_VEL: " (KM/S)
CRN: CARRINGTON ROTATION from EARTH
LONG_EARTH: HELIOGRAPHIC LONG. EARTH (radians)
LAT_EARTH: HELIOGRAPHIC LAT. EARTH (radians)
LONG_SPACE: HELIOGRAPHIC LONG. SOHO (radians)
LAT_SPACE: HELIOGRAPHIC LAT. SOHO (radians)
For more info see http://sohowww.nascom.nasa.gov/data/ancillary/index.html
If unable to find this information, zeroes are returned
instead.
Opt. Outputs: TYPE = Returns whether predictive or definitive data was
used to calculate the result. Returned as either
"Definitive" or "Predictive". If the routine fails
to return an answer, then the null string is
returned.
Keywords : RETAIN = If set, then the orbit cdf file will be left open.
This speeds up subsequent reads.
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 = GET_ORBIT( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2CAL, ANYTIM2UTC [1], ANYTIM2UTC [2], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], FILE_EXIST [2], REVERSE, UTC2TAI, concat_dir [4], file_exist [1]
file_exist [3]
Common : Private common block GET_ORBIT_CDF is used to keep
track of the orbit file opened when the RETAIN keyword
is used.
Side effects: None.
Prev. Hist. : Adapted from William Thompson's GET_ORBIT to read CDF
files rather than FITS.
History : Written by Simon Plunkett, 27 March 1996.
Adapted to read new CDF files (CRN_EARTH and CRN_SPACE
tags replaced by single CRN tag). SPP, 7 August 1996.
Mods to deal with: 1) differing file names on CDs and
in GSFC archive and 2) to take account of changes in
CRN definition in CDF files. 14 March 1997 (SPP).
16 Nov 2000, nbr - Fix problems with using the RETAIN keyword
and epoch array
29 Oct 2001, nbr - Rename soho_orbit structure to make compatible
with SSW
10/29/01 @(#)get_orbit_cdf2.pro 1.4 LASCO NRL IDL LIBRARY
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_ORBIT_FITS()
Purpose : Get the SOHO orbit information.
Category : Class3, Orbit
Explanation : Reads orbit information from either the definitive or
predictive orbit file, whichever it can find first.
Syntax : Result = GET_ORBIT_FITS( DATE [, TYPE ] )
CALLED BY:
STARFIELD
Examples :
Inputs : DATE = The date/time value to get the orbit information for.
Can be in any CDS time format.
Opt. Inputs : None.
Outputs : The result of the function is a structure containing the
spacecraft orbit information. It contains the following tags.
If unable to find this information, zeroes are returned
instead.
Opt. Outputs: TYPE = Returns whether predictive or definitive data was
used to calculate the result. Returned as either
"Definitive" or "Predictive". If the routine fails
to return an answer, then the null string is
returned.
Keywords : RETAIN = If set, then the orbit FITS file will be left open.
This speeds up subsequent reads.
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 = GET_ORBIT_FITS( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
OLD = If set, then files are read in from the subdirectory
"old_samples". This is used to test the software
until real data files are available.
Calls : ***
ANYTIM2CAL, ANYTIM2UTC [1], ANYTIM2UTC [2], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], FXBCLOSE [1], FXBCLOSE [2], FXBISOPEN [1], FXBISOPEN [2]
FXBOPEN [1], FXBOPEN [2], FXBOPEN [3], FXBREAD [1], FXBREAD [2], FXBREAD [3]
REVERSE, concat_dir [4]
Common : Private common block GET_ORBIT is used to keep track of the
orbit file opened when the RETAIN keyword is used.
Restrictions: The orbit entries for the time closest to that requested is
used to calculate the orbit parameters. Since the orbit data
is calculated every 10 minutes, this should be correct within
+/-5 minutes. No attempt is made to interpolate to closer
accuracy than that.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 04-Dec-1995, William Thompson, GSFC
Adapted from Bill Thompson's GET_ORBIT.
Removed /DIR keyword from calls to CONCAT_DIR,
7 August 1996 (SPP).
Changed structure definition to SOHO_ORBIT_FITS to
avoid clashes with structures from CDF files, 14 March
1997 (SPP).
011101, nbr - Add SCCS date /version stamp
Contact : WTHOMPSON
11/01/01 @(#)get_orbit_fits.pro 1.3 ; LASCO NRL IDL Library
[Previous]
[Next]
NAME:
GET_PACKET_FNAMES
PURPOSE:
This function returns all of the packet file names for the specified date(s).
CATEGORY:
LASCO PACKETS
CALLING SEQUENCE:
Result = GET_PACKET_FNAMES ( Date )
INPUTS:
Date: A string or array of strings specifying the date in the format YYMMDD
OUTPUTS:
This function returns a string array of file names for the specified dates.
CALLED BY:
READALLSV1, READALLSV2, READALLSV4
COMMON BLOCKS:
None
RESTRICTIONS:
If the environment variable, TMPCKTS, is not defined then the current
working directory must be the directory where the files are located.
PROCEDURE:
The file names have a basic root structure for a given date and then have
the hour at the end. For example the SVM HK 1 packets for 1998/03/06 would
have the structure:
SVMHK1980306_00 for hour 0
SVMHK1980306_01 for hour 1
SVMHK1980306_02 for hour 2
and so on.
This routine simply searches for all of the files of type SVMHK1980306*
EXAMPLE:
hk = GET_PACKET_FNAMES ('SVMHK1960306')
MODIFICATION HISTORY:
Written by: R.A. Howard, 1998
Sep, 1998 Extracted from the versionof READALLSV1
@(#)get_packet_fnames.pro 1.1 09/24/98 :LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_PLAN
Purpose : Extracts a SoHO science plan observation
Explanation : This routine extracts parameters which describe the SoHO
science plan at a particular point in time.
Use : GET_PLAN, DATE, OBS
Inputs : INSTRUMENT = The name or code value for the instrument to
retrieve the plan entry for.
DATE = The date/time value that the user wishes the
science plan record for. This can be in any of
the standard CDS time formats.
Opt. Inputs : None.
Outputs : OBS = Structure containing the science plan record. It
contains the following tags:
STRUCT_TYPE = The character string 'SOHO-PLAN'.
INSTRUME = Single letter code specifying the
instrument.
SCI_OBJ = Science objective from the daily science
meeting
SCI_SPEC = Specific science objective from meeting
NOTES = Further notes about the observation
START_TIME = Date/time of beginning of observation,
in TAI format
END_TIME = Date/time of end of observation, in TAI
format
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
PROG_ID = Program ID, linking one or more studies
together
CMP_NO = Campaign number
XCEN = Center(s) of instrument FOV along X
axis, given as a character string.
YCEN = Center(s) of instrument FOV along Y
axis, given as a character string.
DISTURBANCES = Description of any disturbances
If no entry is found, then a simpler structure is returned with
INSTRUME set to the null string.
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 = ''
GET_PLAN, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DATATYPE [1], DATATYPE [2], DATATYPE [3]
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]
FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3], GET_INSTRUMENT, TRIM
UTC2TAI
CALLED BY:
GET_PLAN_SCI
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 26 July 1994
Modified : Version 1, William Thompson, GSFC, 3 August 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 24 October 1994
Fixed bug with INSTRUME vs. INSTRUMENT.
Version 4, William Thompson, GSFC, 17 November 1994
Fixed so that if time is on boundary, then the plan
which starts then is picked.
Version 5, William Thompson, GSFC, 26 January 1995
Added tag STRUCT_TYPE
Version 6, William Thompson, GSFC, 28 April 1995
Returns an error string when no entry is found.
Version 7, William Thompson, GSFC, 8 May 1995
Modified to pay attention to DELETED field in database
Version 8, William Thompson, GSFC, 18 August 1995
Added tags XCEN, YCEN
Version 9, William Thompson, GSFC, 26 May 1998
Look for entries in "_year" files
Version : Version 9, 26 May 1998
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_PLAN_DEF
Purpose : Get definition of plan type
Use : DEF=GET_PLAN_DEF(TYPE)
Inputs : TYPE = 0/1/2/3/4 for DETAILS/FLAG/SCIENCE/ALT/SCIENCE_DETAILS
Opt. Inputs : None.
Outputs : DEF = DETAILS/FLAG/SCIENCE/ALT/SCIENCE_DETAILS
= '' if invalid
Opt. Outputs: None.
Keywords : None
Explanation : None.
Calls : None.
CALLED BY:
MK_CDS_PLAN, MK_PLAN_CLONE, MK_PLAN_PLOT, RD_PLAN
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning
Prev. Hist. : None.
Written : Version 1, Zarro (ARC/GSFC) 29 January 1995.
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_PLAN_FUNCT
Purpose : Get DEL, ADD, LIST function for a given plan structure
Use : FUNCT=GET_PLAN_FUNCT(PLAN)
Inputs : PLAN = plan structure definition
OR
TYPE = 0,1,2,3 for DETAIL/FLAG/SCIENCE/ALT
Opt. Inputs : None.
Outputs : FUNCT= function name
Opt. Outputs: None.
Keywords : DELETE for delete function (e.g. del_plan)
ADD for add function
LIST for list function
GET for get function
PRG for purge function
ERR = error message
Explanation : None.
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], EXIST, GET_PLAN_TYPE, MATCH [1], MATCH [2]
MATCH [3]
CALLED BY:
LIST_TO_DETAIL, MK_CDS_PLAN, MK_PLAN_CLONE, MK_PLAN_WRITE, RD_PLAN
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning
Prev. Hist. : None.
Written : Version 1, Zarro (ARC/GSFC) 12 May 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_PLAN_ITIME()
Purpose : Get index of time field in plan structure
Category : Planning
Explanation :
Syntax : INDEX = GET_PLAN_ITIME( PLAN )
or
TYPE = 0,1,2,3,4
CALLED BY:
CDS_PLAN_BRIEF, CHECK_CDS_MODES, DEF_INST_PLAN, GET_CDS_DUR, GET_CDS_OH
GET_CDS_POINT, GET_CDS_STATE, GET_PLAN_SCI, GET_PLAN_TIME, GET_PLAN_TT, HTML_SPLAN
LIST_TO_DETAIL, MK_CDS_PLAN, MK_PLAN_ADD, MK_PLAN_CAMP, MK_PLAN_CHANGE
MK_PLAN_CLONE, MK_PLAN_COMP, MK_PLAN_CONV, MK_PLAN_COPY, MK_PLAN_EXIST
MK_PLAN_FIND [1], MK_PLAN_FIND [2], MK_PLAN_HTML, MK_PLAN_POINT, MK_PLAN_PRIV
MK_PLAN_RECAL, MK_PLAN_SORT, MK_PLAN_TAIL, MK_PLAN_WHERE, MK_PLAN_WRITE, MK_SOHO
MK_SOHO_EDP, MK_SOHO_TARGET, OPLOT_SPLAN, PLOT_SPLAN, RD_PLAN, RD_RESOURCE, READ_KAP
ROT_CDS_XY, SOHO_ITEMS_HTML
Examples :
Inputs : PLAN = Plan structure definition
Opt. Inputs : TYPE = Type code which represents the plan structure type. If
passed, then the PLAN structure is not passed. In other
words, only one of PLAN or TYPE is passed.
Outputs : The returned value is the index of the time field in the
planning structure.
Opt. Outputs: None.
Keywords : None.
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DEF_INST_PLAN, EXIST, WHICH_INST
Common : None.
Restrictions: None.
Side effects: If an error occurs, then -1 is returned.
Prev. Hist. : None.
History : Version 1, Zarro (ARC/GSFC) 29 January 1995.
Version 2, William Thompson, GSFC, 18 January 1996
Made more robust. Does not depend on exact structure
type.
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_PLAN_PROG
Purpose : return program names for set of plans
Category : planning
Syntax : IDL> progs=get_plan_prog(details)
Inputs : DETAILS = detailed plan entries
Outputs : PROGS = string array of program names
Keywords : ERR = error string
CALLS: ***
EXIST, GET_CDS_STUDY, GET_PLAN_TYPE, HAVE_TAG, STRUP
CALLED BY:
UPD_SCI_PLAN
History : Written, 14-May-2001, Zarro (EITI/GSFC)
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_PLAN_SCI
Purpose : replace blank plan fields with SCI_PLAN values
Explanation :
Use : OPLAN=GET_PLAN_SCI(PLAN)
Inputs : PLAN = plan structure (scalar)
Opt. Inputs : None.
Outputs : OPLAN = modified plan structure with blank fields
replaced by corresponding SCI_PLAN fields
Opt. Outputs: None.
Keywords : None.
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], EXIST, GET_PLAN, GET_PLAN_ITIME
GET_PLAN_TYPE
CALLED BY:
MK_CDS_PLAN, MK_SOHO
Common : None.
Restrictions: None.
Side effects: None
Category : Planning, Database.
Prev. Hist. : None.
Written : Dominic Zarro (ARC), 18 March 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : get_plan_spec
Purpose : construct SCI_SPEC title for PLAN
Category : Planning
Explanation : If SCI_SPEC is blank then construct it by
concatanating the STUDY TITLE and STUDY VAR fields.
Syntax : IDL> sci_spec=get_plan_spec(plan)
CALLED BY:
MK_CDS_PLAN, RD_PLAN
Examples :
Inputs : PLANS - plans structure array
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None.
CALLS: ***
GET_PLAN_TYPE, TAG_EXIST [1], TAG_EXIST [2]
Common : None.
Restrictions: Not used for SCIENCE plans (obviously)
Side effects: None.
History : Version 1, 1-July-1995, D M Zarro. Written
Contact : DMZARRO
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_PLAN_TIME()
Purpose : Get plan times
Category : Planning
;
Syntax : TSTART = GET_PLAN_TIME( PLAN, TEND=TEND )
Inputs : PLAN = Plan structure definition
Outputs : TSTART = plan start time
Keywords : TEND = plan end time
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DATATYPE [1], DATATYPE [2], DATATYPE [3]
GET_PLAN_ITIME
History : Written, Zarro (SM&A/GSFC) 2 Dec 1999
Contact : zarro@smmdac.nascom.nasa.gov
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_PLAN_TT
Purpose : Find start time of next time-tagged study in a series of plans
Explanation : Useful for speeding up editing in MK_PLAN
Use : TNEXT=GET_PLAN_TT(TIME,PLANS)
Inputs :
TIME = input time
PLANS = structure array of plan entries to search
Opt. Inputs : None.
Outputs : TNEXT = index of next time-tagged study
Opt. Outputs: None.
Keywords : GSET = if > -1 then find first time-tagged study after
GIS study with this GSET
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DPRINT, EXIST, GET_PLAN_ITIME, GET_PLAN_TYPE
STR_FORMAT, TAG_EXIST [1], TAG_EXIST [2], UTC2TAI
CALLED BY:
MK_CDS_PLAN
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning
Prev. Hist. : None.
Written : Dominic Zarro (ARC)
Modified : April 25 1997, Zarro, added check for undefined plans input
Version : 2
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_PLAN_TYPE
Purpose : Get type of plan structure
Use : TYPE=GET_PLAN_TYPE(PLAN)
Inputs : PLAN = plan structure definition
OR
string definition
Opt. Inputs : None.
Outputs : TYPE = 0/1/2/3/4/5 for
DETAILS/FLAG/SCIENCE/ALT/SOHO_DETAILS/RESOURCES
= -1 if invalid
Opt. Outputs: None.
Keywords : INST = instrument type ('C', 'S', for CDS, SUMER, etc)
Explanation : None.
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], EXIST, TAG_EXIST [1], TAG_EXIST [2]
CALLED BY:
CHECK_CDS_MODES, DEF_INST_PLAN, GET_CDS_DUR, GET_CDS_FOV, GET_CDS_OH, GET_CDS_XY
GET_PLAN_FUNCT, GET_PLAN_PROG, GET_PLAN_SCI, GET_PLAN_TT, LIST_TO_DETAIL
MK_CDS_PLAN, MK_PLAN_ADD, MK_PLAN_CAMP, MK_PLAN_CHANGE, MK_PLAN_COMP, MK_PLAN_CONV
MK_PLAN_ORDER, MK_PLAN_POINT, MK_PLAN_RECAL, MK_PLAN_WHERE, MK_PLAN_WRITE
MK_PLAN_XY, RD_PLAN, ROT_CDS_XY, UPD_SCI_PLAN, get_plan_spec
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning
Prev. Hist. : None.
Written : Version 1, Zarro (ARC/GSFC) 29 January 1995.
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_PROGRAM
Purpose : Extracts a CDS program definition from the database
Explanation : This routine extracts parameters which defines a CDS
multi-observation program.
Use : GET_PROGRAM, PROG_ID, DEF
Inputs : PROG_ID = The unique program ID.
Opt. Inputs : None.
Outputs : DEF = Structure containing the program definition. It
contains the following tags:
PROGNAME = Name of the program.
PROG_ID = Unique identifier number.
PROGDESC = Up to five lines of text describing the
program.
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 = ''
GET_PROGRAM, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], 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], TRIM
CALLED BY:
ADD_ALT, ADD_DETAIL, ADD_FLAG, ADD_MAIN, ADD_PLAN, MOD_MAIN, XPROGRAM_ADD
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 21 July 1994
Modified : Version 1, William Thompson, GSFC, 27 July 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 29 December 1994
Fixed bug when inputs are bytes.
Version 4, William Thompson, GSFC, 28 April 1995
Returns an error string when no entry is found.
Version : Version 4, 28 April 1995
[Previous]
[Next]
NAME:
GET_PT
PURPOSE:
Digitize a point on a previously plotted curve, and return
the corresponding array element.
CALLING SEQUENCE:
Result = GET_PT(XAXIS,YAXIS,XPOINT,YPOINT)
INPUTS:
XAXIS - the x axis vector which was used to make the plot.
YAXIS - the y axis vector which was used to make the plot.
KEYWORD PARAMETERS:
NOHIGHLIGHT - set to inhibit putting a red mark on the curve
at the digitized point.
MESSAGE - a string to print as the message to the user.
Default = 'Digitize a point: '
NOINIT - set to inhibit placing the cursor in the center of
the plot window.
OUTPUTS:
Result - The array subscript of the digitized point.
OPTIONAL OUTPUT PARAMETERS:
XPOINT, YPOINT - the digitized points.
CALLS: ***
C2_CALIBRATE, C3_CALFACTOR [1], C3_CALFACTOR [2], C3_CALIBRATE, C3_VIG
CALIBRATE_IMG, CW_BSELECTOR, CW_FIELD, DATATYPE [1], DATATYPE [2], DATATYPE [3]
GET_CAL_NAME, GET_EXP_FACTOR [1], GET_EXP_FACTOR [2], GET_OPPOSITE_PT
GET_PROFILE, GET_PTS, GET_RING, GET_SEC_PIXEL, GET_SOLAR_RADIUS
GET_SUN_CENTER [1], GET_SUN_CENTER [2], GET_SUN_CENTER [3], HIST_EQUAL
IMAGE_PROFILES, IMG_SELECT_EVENT, IMG_SUM_2X2, LASCO_FITSHDR2STRUCT
READFITS [1], READFITS [2], READFITS [3], SNORTH_ANG, TRIM, USE_BOX_AVG
XDISPLAYFILE [1], XDISPLAYFILE [2], XLOADCT [1], XLOADCT [2], XLOADCT [3]
XMANAGER, ZOOM_PLOT, get_peak
SIDE EFFECTS:
A mark is drawn on the plot at the digitized point.
PROCEDURE:
The user is asked to digitize a point on the curve using the
mouse. The VALUE_TO_INDEX function is used to find the
closest array element.
MODIFICATION HISTORY:
D. L. Windt, Bell Laboratories, November 1989
Feb. 1991, Removed call to TEK_COLOR
Mar. 1997, replaced index search code with call to
VALUE_TO_INDEX function.
windt@bell-labs.com
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_QLDS()
Purpose : Returns the QLDS that the display routine is working on.
Explanation : In order to avoid multiple storage of the data
structures operated upon by the display routines,
the _FIRST_ display routine invoked interactively
by the user has the responsibility to keep the
QLDS as the UVALUE of its top level base.
The window generated in this way is called the MASTER
window. All display routines called by the MASTER
window's event handling routine should be passed
the widget ID of the MASTER window in the keyword
GROUP_LEADER, and this should be stored in the
UVALUE of the invoked, (SLAVE) TOP_LEVEL_BASE.
If a SLAVE window event handling routine invokes another
display routine, (a sub-SLAVE), it passes the widget ID
of its own TOP_LEVEL_BASE so that GET_QLDS can follow the
trace of widget IDs up to the MASTER, to retrieve the
QLDS. SET_QLDS can (SHOULD!) then also be used to
"put back" the QLDS.
Use : QLDS = GET_QLDS(EV.TOP)
Inputs : EV.TOP -- the widget ID of the TOP_LEVEL_BASE of
a window generated by a CDS QL display routine.
Opt. Inputs : None.
Outputs : Returns the QLDS
Opt. Outputs: None.
Keywords : None.
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3]
Common : None.
Restrictions: See 'Explanation'
Side effects: The use of this scheme reserves the user value (UVALUE)
of the TOP_LEVEL_BASE of any display window.
Category : CDS, QuickLook
Prev. Hist. : None.
Written : Stein Vidar Hagfors Haugan, 10 October, 1993
Modified : CDP, 25 October 1993 -- cut /no_copy keyword
SVHH, 21 November 1993 - Documentation added.
Version : 1.0
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_RASTER
Purpose : Extracts a complete raster definition from the database
Explanation : This routine extracts all the parameters of a raster from the
database for the requested raster ID number and variation
index.
Use : GET_RASTER, RAS_ID, RAS_VAR, DEF
Inputs : RAS_ID = Raster ID number
RAS_VAR = Raster variation index
Opt. Inputs : None.
Outputs : DEF = Structure of type "cds_raster" containing the
complete raster definition. It contains the
following tags:
RAS_ID = Raster ID number. If the requested raster
is not found, then a simpler structure is
returned, with this set to -1.
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.
RAS_VAR = Raster variation index.
RV_DESC = A short description of the raster
variation beyond what is given in the
associated fundamental raster description.
EXPTIME = Exposure time in seconds, to millisecond
accuracy.
LL_ID = Line list ID. Alternatively, this can be
zero to signal that the raster is not
connected to a line list.
LL_DESC = A description of the line list, e.g.
"Temperature sensitive line pairs".
N_LINES = The number of lines.
COMP_ID = Compression method ID.
COMP_OPT = Compression option parameter.
DW_ID = Data extraction window list ID.
IEF_ID = Inter-instrument event flag ID.
VDS_ORIENT = VDS orientation, either 0 (row) or 1
(column).
VDS_MAP = VDS mapping mode: 2=Normal, 3=Accumulate.
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".
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 is 0.
N_WINDOWS = The number of windows.
N_FLAGS = The number of flag windows.
TEL_RATE = Estimated required telemetry rate, as a
character representing Low/Medium/High
DURATION = Estimated duration of the raster, in
seconds.
USABLE = Either "Y" or "N" to signal whether or not
the raster is usable. Normally "Y".
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 = ''
GET_RASTER, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], 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], TRIM
CALLED BY:
ADD_EXPER, CALC_RAS_DUR, CAT_DURATION, EXPORT_STUDY, FREEZE_RAS_DUR
GET_CDS_RASTER, LIST_DURATION, LOAD_TP_STRUCT, MOD_EXPER, PLAN_XCAT_SUMM
RASTER_DUR, SHOW_RASTER, SHOW_STUDY, TP_DISP_LLIST, TP_DISP_RAST, UPDATE_RAS_DUR
WRITE_CIF
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 5 April 1994
Modified : Version 1, William Thompson, GSFC, 1 August 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 29 December 1994
Fixed bug when inputs are bytes.
Version 4, William Thompson, GSFC, 15 March 1995
Removed LL_TITLE
Version 5, William Thompson, GSFC, 28 April 1995
Returns an error string when no entry is found.
Version 6, William Thompson, GSFC, 20 June 1995
Added tag N_FLAGS.
Version 5, William Thompson, GSFC, 27 October 1995
Added item IEF_ID.
Version : Version 5, 27 October 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_RASTER_PAR
Purpose : to get CDS raster parameter information
Category : database, planning
Explanation :
Syntax : IDL> get_raster_par,raster
Inputs : rasters = CDS raster structure
Opt. Inputs : None.
Outputs : See keywords.
Opt. Outputs: None.
Keywords :
ERR = any error string
RDUR = duration (secs) of individual rasters composing study
REPS = # of repeats per raster
DETS = detectors per raster (e.g. ['N','G','N'....])
SLITS = slit number per raster
SDUR = total duration of study from summing rasters
(not taking account of slit and OPS motions)
OH = % overhead to add to duration
TEL = telemetry rate of each raster (L/M/H)
VERBOSE = verbose output
CALLS: ***
EXIST, GET_CDS_RASTER, NUM2STR, TRIM
CALLED BY:
GET_STUDY_PAR, MK_CDS_PLAN, MK_CDS_STUDY, MK_STUDY, UPDATE_STUDY_DUR
Common : None
Restrictions: None
Side effects: None
History : Version 1, 1-Jan-1996, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_RAW
Purpose : Extracts a GIS raw data file entry from the database
Explanation : This routine extracts a GIS raw data file entry from the
database for a requested raw data file ID number.
Use : GET_RAW, RAW_ID, DEF
Inputs : RAW_ID = GIS raw data file ID number
Opt. Inputs : None.
Outputs : DEF = Structure containing the raw data file entry. It
contains the following tags:
RAW_ID = Raw data file ID number. If the requested
raw data file entry is not found, then a
simpler structure is returned, with this
set to -1.
RAW_DESC = Free format description.
START_TIME = Start time of data taking, in TAI format.
DET_NUM = GIS detector number: 1-4
SLIT_NUM = Slit number
HVOLT = High voltage value
LLD = Low level discriminator value
CNT_RATE = Count rate range (min, max)
RAW_FILE = Raw data file name
FFB = Front face bias
FIL_ID = Filament ID number
FIL_CUR = Filament current
ZONE_ID = Zone ID number
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 = ''
GET_RAW, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], 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], TRIM
CALLED BY:
VIEW_RAW
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 7 September 1995
Modified : Version 1, William Thompson, GSFC, 7 September 1995
Version 2, William Thompson, GSFC, 14 September 1995
Added RAW_DESC, rename FF_BIAS to FFB to match GSET
database.
Version 3, William Thompson, GSFC, 1 March 1996
Fixed bug
Version : Version 3, 1 March 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_RAW_FIL
Purpose : Extracts GIS raw filament data file entry from database
Explanation : This routine extracts a GIS raw data file entry from the
database for a requested detector number, filament ID number,
and target time. The entry in the database with a start time
closest to the target time is returned.
Use : GET_RAW_FIL, DET_NUM, FIL_ID, DATE, DEF
Inputs : DET_NUM = GIS raw data file ID number
FIL_ID = Filament ID number.
DATE = Target date. Can be in any standard CDS time format.
Opt. Inputs : None.
Outputs : DEF = Structure containing the raw data file entry. It
contains the following tags:
RAW_ID = Raw data file ID number. If the requested
raw data file entry is not found, then a
simpler structure is returned, with this
set to -1.
RAW_DESC = Free format description
START_TIME = Start time of data taking, in TAI format.
DET_NUM = GIS detector number: 1-4
SLIT_NUM = Slit number
HVOLT = High voltage value
LLD = Low level discriminator value
CNT_RATE = Count rate range (min, max)
RAW_FILE = Raw data file name
FFB = Front face bias
FIL_ID = Filament ID number
FIL_CUR = Filament current
ZONE_ID = Zone ID number
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 = ''
GET_RAW_FIL, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], 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], UTC2TAI
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 7 September 1995
Modified : Version 1, William Thompson, GSFC, 7 September 1995
Version 2, William Thompson, GSFC, 14 September 1995
Added RAW_DESC, rename FF_BIAS to FFB to match GSET
database.
Version : Version 2, 14 September 1995
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
GET_RAWDATA
PURPOSE:
Collect SUMER Raw Telemetry and convert to IDL Restore files
CATEGORY:
Telemetry Conversion
EXPLANATION:
SYNTAX:
get_rawdata
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
rawpath_ - where to find Raw Tlemetry (def -> SUMER_RAW)
out_path - Root Directory, where to put Restore files
once_ - Run collection only once and stop then otherwise endless
loop until 'Q' is hit on keyboard
lastagain_- process also the last processed file again to get in SYNC
nohkhall - switch of Science HK saving
nointer - do not read keyboard because run from batch
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], RAW2BIN, concat_dir [4]
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, April 7, 2002, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
NAME:
get_rb0p
PURPOSE:
Determine the solar radius, b0 angle, and p angle for a set of times
CALLING SEQUENCE:
rb0p = get_rb0p(time)
r = get_rb0p(index, /radius)
b0angle = get_rb0p(roadmap, /b0angle, /deg)
pangle = get_rb0p('1-jun-93', /pangle)
INPUT:
item - A structure or scalar. It can be an array.
CALLS: ***
GET_SUN [1], GET_SUN [2], anytim2ints [1], anytim2ints [2]
CALLED BY:
ALIGN1BIGGRAM, ARC2LEN, BUILD_SSX, CONV_A2H [1], CONV_A2H [2], CONV_H2A [1]
CONV_H2A [2], EARTH, EARTH_CURSOR, GBO_HEL, GET_LATLON, GET_POINT_STR, GET_SSX_SLICE
GET_TRACUBE, GRID_CURSOR, G_H, HELIOCENTRIC, HELIO_FOOT, HXA2HXAXY [1]
HXA2HXAXY [2], HXASCAN2HXAXY, HXA_SUNCENTER, LAY1GKM, LIMB2DISK, LONLAT2XY
LOUGHHEAD, MAP_CARRINGTON, MK_SOHO_MAP_EARTH, MK_SSX, NEAR_CONJ, NORH_BEAM [1]
NORH_BEAM [2], NORH_GRID [1], NORH_GRID [2], NORH_P2H [1], NORH_P2H [2]
NOV93_ECLIPSE, NOV_ECLIPSE, PLOT_CLON, PLOT_HSI, PLOT_HXT, POLAR_GRID, PP_MWLT2SXT
PP_SXT2ANY, PP_SXT2VLA, PROM_ON_DISK, Ruler, SXT_ECLIPSE, SXT_EXPOSURE_MAP
SXT_GRID [1], SXT_GRID [2], SXT_GRID [3], SXT_RPAXY, TANGENT_HEIGHT, TERM_QUICK
THERMAL_KEV, TRACE_CUBE_POINTING, TRACE_MDI_ALIGN, TRACE_SSWHERE [1], TV_SSX
TV_SYNOP, WITH_INT, agl2cut, atr2hxa_dbase, azimuth_teem [1], azimuth_teem [2]
conv_a2ap, conv_a2p [1], conv_a2p [2], conv_p2a [1], conv_p2a [2], fit_limb
fl_suntoday [1], fl_suntoday [2], fl_suntoday [3], foreshort, gbo_obs_coord
gbo_pfi, get_gbo_pfi, gt_pix_size, hxt_images2ps, mk_gsn_obs_s1, mk_mdi_fits
mk_strip_file, mk_sun_mosaic, mk_sxh, mk_sxl, mplot_nar, plot_ar_pfi, plot_fov [1]
plot_nar [1], plot_nar [2], plot_ssw_fov, rot_pix2, rt_nkr, scale_gbo, sda2fits
show_hxafid, sleazy_rot, sol_rot [2], sun_grid, sun_today [1], sun_today [2]
sun_today [3], sxi_arcs2pix, sxi_hel2arcs, sxi_parv2pix, sxi_pix2arcs, sxi_pix2hel
sxipng_arcs2pix, sxipng_hel2arcs, sxipng_parv2pix, sxipng_pix2helstr
sxt_deleak [1], sxt_deleak [2], sxt_plot_fov, sxt_xsaa, trace_sswhere [2]
trace_sswhere [3], trace_sswhere [4], xy2lonlat, xy_lwa
OPTIONAL KEYWORD INPUT:
radius - If set, just return the radius
b0angle - If set, just return the b0 angle
pangle - If set, just return the p angle
pb0r - If set, return a 3xN array of [p, b0, r]
This option is available so that the old routine PB0R can
be replaced.
deg - If set, then return angles in degrees (default is radians)
OUTPUT:
rb0p - Returns a 3xN vector containing the following parameters
when /RADIUS, /B0ANGLE, or /PANGLE are not set:
P = Position angle of the northern extremity of the axis
of the sun's rotation, measured eastward from the
geographic north point of the solar disk.
B0 = Heliographic latitude of the central point of the
solar disk
R = Solar radius measured outside earth's atmosphere in
arcseconds
HISTORY:
Written 22-Nov-91 by G. Slater using Morrison style parameters
18-Jul-93 (MDM) - Added /RADIUS, /B0ANGLE, and /PANGLE
- Deleted "header" option (was not implemented)
- Changed the time conversion code somewhat
- Added /PB0R option
18-Jan-94 (GLS) - Made GET_RB0P front end to GET_SUN, which
calculates a variety of solar ephemeris data,
and was derived from SUN, a Johns Hopkins U.
routine
15-Feb-94 (GLS) - Checked for 1 element OUT
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_RES_NAME
Purpose : return a valid resource name
Category : Planning
Explanation :
Syntax : IDL> res_name=get_res_name(res)
CALLED BY:
LIST_OTHER_RES, LIST_RESOURCE, RD_RESOURCE
Examples :
Inputs : RES - string name to check
Opt. Inputs : None
Outputs : RES_NAME - actual resource name if valid, null otherwise
Opt. Outputs: None
Keywords : ERR = string error message
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], GREP, LIST_RES_TYPE
Common : None
Restrictions: Only one resource name can be checked at a time
Side effects: None
History : Version 1, 2-Aug-1995, D M Zarro. Written
Contact : DMZARRO
[Previous]
[Next]
NAME:
GET_ROLL_OR_XY
Version :
05/02/06 @(#)get_roll_or_xy.pro 1.4 :NRL Solar Physics
PURPOSE:
This function returns the roll angle of solar north in radians
or the sun center position as a 2 element array
{sun_center,xcen:xcen,ycen:ycen} (pixels).
It uses C2 and C3 center and roll files created by star routines
after adjusting header times using EIT/LASCO time-offsets. It should
only be used with ql or lz level_05 data. For other telescopes, the
roll, and center are set to but if a roll is requested and it is zero,
the SOHO roll is returned instead - as was the case in old version of
get_roll_or_xy.
CATEGORY:
LASCO_ANALYSIS
CALLING SEQUENCE:
Result = GET_ROLL_OR_XY (Hdr, Roll_xy)
INPUTS:
Hdr: A LASCO header structure
Roll_xy: 'ROLL' : return the roll angle
'CENTER': return the sun center
OUTPUTS:
Roll angle in radians OR sun center {xcen,ycen} in pixels.
OPTIONAL OUTPUTS:
ROLL_OUT=named_var Named_var contains value of roll angle
CENTER_OUT=named_var Named_var contains sun center structure
OPTIONAL KEYWORD INPUTS:
MEDIAN: Not used - kept for compatability with previous version.
STAR: Not used - kept for compatability with previous version.
AVG: Not used - kept for compatability with previous version.
SILENT: Stop printing of warning and informational messages
DEGREES: Return roll angle in degrees not radians
OPTIONAL IO:
source: On output, returns
'Data generated from SunDec files using EIT/LASCO adjusted time-offsets.'
CALLS: ***
ADJUST_ALL_DATE_OBS, ANYTIM2UTC [1], ANYTIM2UTC [2], DATATYPE [1], DATATYPE [2]
DATATYPE [3], FILEPATH, FXPAR [1], FXPAR [2], GET_SC_POINT, LASCO_FITSHDR2STRUCT
LINEAR_INTERP, MLO_FITSHDR2STRUCT, TAI2UTC, UTC2TAI
CALLED BY:
GETBKGIMG, GET_SOLAR_ROLL, GET_SUN_CENTER [1], REDUCE_LEVEL_1, WRUNMOVIEM
WRUNMOVIEM3, carrmapmaker2
History:
2005 January 05 - Ed Esfandiari First version - based on adjust_hdr_tcr.
2005 January 05 - Ed Esfandiari Changed call to linterp to linear_interp.
2005 April 12 - Karl Battams - Fixed problem with incompatible date formats
2006 April 25 - Nathan Rich - Add ROLL_OUT and CENTER_OUT keywords
[Previous]
[Next]
Name: get_saved
Purpose: return data saved in saved_data widgets
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_SC_ATT()
Purpose : Get the SOHO spacecraft attitude.
Category : Class3, Orbit
Explanation : Read the definitive attitude file to get the spacecraft
pointing and roll information. If no definitive file is found,
then all parameters are returned as zero, and the type is
returned as "Predictive".
Syntax : Result = GET_SC_ATT( DATE [, TYPE ] )
CALLED BY:
GET_SC_POINT
Examples :
Inputs : DATE = The date/time value to get the attitude information
for. Can be in any CDS time format.
Opt. Inputs : None.
Outputs : The result of the function is a structure containing the
spacecraft attitude information. It contains the following
tags:
SC_AVG_PITCH_ECLIP
SC_AVG_ROLL_ECLIP
SC_AVG_YAW_ECLIP
SC_AVG_PITCH
SC_AVG_ROLL
SC_AVG_YAW
GCI_AVG_PITCH
GCI_AVG_ROLL
GCI_AVG_YAW
GSE_AVG_PITCH
GSE_AVG_ROLL
GSE_AVG_YAW
GSM_AVG_PITCH
GSM_AVG_ROLL
GSM_AVG_YAW
SC_STD_DEV_PITCH
SC_STD_DEV_ROLL
SC_STD_DEV_YAW
SC_MIN_PITCH
SC_MIN_ROLL
SC_MIN_YAW
SC_MAX_PITCH
SC_MAX_ROLL
SC_MAX_YAW
All parameters are in radians.
Opt. Outputs: TYPE = Returns whether predictive or definitive data was
used to calculate the result. Returned as either
"Definitive" or "Predictive".
Keywords : RETAIN = If set, then the FITS attitude file will be left
open. This speeds up subsequent reads.
FIND_CLOSEST = If set, then the closest attitude file to the
date requested is found.
SUB_DATE= If data from a date other than was called is used,
this keyword returns the date used. Otherwise returns
''.
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 = GET_SC_ATT( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2CAL, ANYTIM2UTC [1], ANYTIM2UTC [2], BREAK_FILE [1], BREAK_FILE [2]
BREAK_FILE [3], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FXBCLOSE [1]
FXBCLOSE [2], FXBISOPEN [1], FXBISOPEN [2], FXBOPEN [1], FXBOPEN [2], FXBOPEN [3]
FXBREAD [1], FXBREAD [2], FXBREAD [3], OS_FAMILY, REVERSE, TAI2UTC, TRIM, UTC2STR
UTC2TAI, break_file [4], concat_dir [4]
Common : Private common block GET_SC_ATT is used to keep track of the
attitude file opened when the RETAIN keyword is used.
Restrictions: The attitude entries for the time closest to that requested is
used to calculate the parameters. Since the attitude data
is calculated every 10 minutes, this should be correct within
+/-5 minutes. No attempt is made to interpolate to closer
accuracy than that.
Side effects: Any data with too much variation (max-min) in the attitude data
are rejected. The limits are one arcminute in pitch and yaw,
and one degree in roll.
Prev. Hist. : None.
History : Version 1, 04-Dec-1995, William Thompson, GSFC
Version 2, 07-Dec-1995, William Thompson, GSFC
Returns full attitude file--renamed version 1 to
GET_SC_POINT.
Added keyword RETAIN
Version 3, 12-Dec-1995, William Thompson, GSFC
Fixed bug with LAST_FILE not being initialized.
Version 4, 24-Jan-1996, William Thompson, GSFC
Filter out bad attitude data
Version 5, 08-Mar-1996, William Thompson, GSFC
Include ecliptic attitude as well as that relative to
solar north.
Removed keyword OLD.
Version 6, 03-Sep-1996, William Thompson, GSFC
Also look for filename with a dollar sign
prepended--this is how VMS treats uppercase filenames.
Version 7, 11-Oct-1996, William Thompson, GSFC
Only prepend $ in VMS.
Version 8, 22-Jan-1997, William Thompson, GSFC
Modified to reflect reorganization of attitude files.
Version 9, 30-Jan-1997, William Thompson, GSFC
Fixed VMS bug introduced in version 8
Version 10, Apr-2000, N Rich, NRL
Search first by month for speed; Add SUB_DATE keyword;
Use year if month not found
Version 11, 14-Apr-2000, William Thompson, GSFC
Added keyword FIND_CLOSEST
Version 12, 15-May-2002, N Rich, NRL
Fix FIND_CLOSEST bug by moving operation into
'IF COUNT EQ 0 ...' statement
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_SC_ATT()
Purpose : Get the SOHO spacecraft attitude.
Category : Class3, Orbit
Explanation : Read the definitive attitude file to get the spacecraft
pointing and roll information. If no definitive file is found,
then the nominal values are returned as "Predictive".
Syntax : Result = GET_SC_ATT( DATE [, TYPE ] )
CALLED BY:
GET_SC_POINT
Examples :
Inputs : DATE = The date/time value to get the attitude information
for. Can be in any CDS time format.
Opt. Inputs : None.
Outputs : The result of the function is a structure containing the
spacecraft attitude information. It contains the following
tags:
SC_AVG_PITCH_ECLIP
SC_AVG_ROLL_ECLIP
SC_AVG_YAW_ECLIP
SC_AVG_PITCH
SC_AVG_ROLL
SC_AVG_YAW
GCI_AVG_PITCH
GCI_AVG_ROLL
GCI_AVG_YAW
GSE_AVG_PITCH
GSE_AVG_ROLL
GSE_AVG_YAW
GSM_AVG_PITCH
GSM_AVG_ROLL
GSM_AVG_YAW
SC_STD_DEV_PITCH
SC_STD_DEV_ROLL
SC_STD_DEV_YAW
SC_MIN_PITCH
SC_MIN_ROLL
SC_MIN_YAW
SC_MAX_PITCH
SC_MAX_ROLL
SC_MAX_YAW
All parameters are in radians.
Opt. Outputs: TYPE = Returns whether predictive or definitive data was
used to calculate the result. Returned as either
"Definitive" or "Predictive".
Keywords : RETAIN = If set, then the FITS attitude file will be left
open. This speeds up subsequent reads.
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 = GET_SC_ATT( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2CAL, ANYTIM2UTC [1], ANYTIM2UTC [2], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], FXBCLOSE [1], FXBCLOSE [2], FXBISOPEN [1], FXBISOPEN [2]
FXBOPEN [1], FXBOPEN [2], FXBOPEN [3], FXBREAD [1], FXBREAD [2], FXBREAD [3]
GET_ATT_FITS, REVERSE, concat_dir [4]
Common : Private common block GET_SC_ATT is used to keep track of the
attitude file opened when the RETAIN keyword is used.
Restrictions: The attitude entries for the time closest to that requested is
used to calculate the parameters. Since the attitude data
is calculated every 10 minutes, this should be correct within
+/-5 minutes. No attempt is made to interpolate to closer
accuracy than that.
Side effects: Any data with too much variation (max-min) in the attitude data
are rejected. The limits are one arcminute in pitch and yaw,
and one degree in roll.
Prev. Hist. : None.
History : Version 1, 3-Jan-1997, RA Howard, NRL Adapted from
Version 7 of GET_SC_ATT, written by W.Thompson
Removed /DIR from calls to concat_dir
Changed call to OS_VERSION() to use system variable !version
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_SC_POINT()
Purpose : Get the SOHO spacecraft pointing.
Category : Class3, Orbit
Explanation : Read the definitive attitude file to get the spacecraft
pointing and roll information. If no definitive file is found,
then the nominal values are returned as "Predictive".
Note that the difference between GET_SC_ATT and GET_SC_POINT is
that GET_SC_POINT converts the information in the attitude file
into a format suitable for use in the FITS headers.
Syntax : Result = GET_SC_POINT( DATE [, TYPE ] )
CALLED BY:
GET_ROLL_OR_XY, MK_DAILY_MED, MK_MONTHLY_MIN
rt_carrmapmaker yymmdd num_r rad limb wlimb hdr disp saveset nextrot
Examples : PNT = GET_SC_POINT(DATE_OBS)
FXADDPAR, HEADER, 'SC_X0', PNT.SC_X0
FXADDPAR, HEADER, 'SC_Y0', PNT.SC_Y0
FXADDPAR, HEADER, 'SC_ROLL', PNT.SC_ROLL
Inputs : DATE = The date/time value to get the pointing information
for. Can be in any CDS time format.
Opt. Inputs : None.
Outputs : The result of the function is a structure containing the
spacecraft pointing information. It contains the following
tags:
SC_X0 = Spacecraft pointing in the solar X direction,
in arcseconds from the center of the sun.
SC_Y0 = Spacecraft pointing in the solar Y direction
SC_ROLL = Spacecraft roll in degrees counter-clockwise.
Opt. Outputs: TYPE = Returns whether predictive or definitive data was
used to calculate the result. Returned as either
"Definitive" or "Predictive".
Keywords : RETAIN = If set, then the FITS attitude file will be left
open. This speeds up subsequent reads.
NOCORRECT = If set, then the correction for the repointing of
16-Apr-1996 is not applied. This allows one to
check the uncorrected values against the corrected
ones.
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 = GET_SC_POINT( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
FIND_CLOSEST = If set, then the closest attitude file to the
date requested is found.
SUB_DATE= If data from a date other than was called is used,
this keyword returns the date used. Otherwise
returns ''.
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], 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], GET_SC_ATT [1], GET_SC_ATT [2], GET_UTC, SOCK_LIST
concat_dir [4], delvarx [5]
Common : GET_SC_POINT is an internal common block.
Restrictions: The attitude entries for the time closest to that requested is
used to calculate the parameters. Since the attitude data
is calculated every 10 minutes, this should be correct within
+/-5 minutes. No attempt is made to interpolate to closer
accuracy than that.
Side effects: Currently, predictive data is always 0 for all angles. This is
the nominal pointing for SOHO.
Prev. Hist. : None.
History : Version 1, 04-Dec-1995, William Thompson, GSFC
Version 2, 06-Dec-1995, William Thompson, GSFC
Corrected calculation of output parameters.
Renamed to GET_SC_POINT
Use GET_SC_ATT to read file.
Added keyword RETAIN
Version 3, 24-Jan-1996, William Thompson, GSFC
Temporary fix to return only predictive data until the
problems with the attitude files are resolved.
Version 4, 08-Mar-1996, William Thompson, GSFC
Removed temporary fix, and corrected sign of roll.
Version 5, 04-Apr-1996, William Thompson, GSFC
Corrected sign of pitch.
Version 6, 08-Jul-1996, William Thompson, GSFC
Corrected for repointing of spacecraft 16-Apr-1996
Version 7, 01-Oct-2001, Nathan Rich, NRL
Add SUB_DATE, FIND_CLOSEST keywords
Version 8, 01-Jul-2003, William Thompson, GSFC
Read nominal_roll_attitude.dat
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_SCREEN
Purpose :
return screen scaling parameters for controlling widget
sizing
Explanation :
Use : GET_SCREEN, space,xpad,ypad,scx,scy
Inputs : None.
Opt. Inputs : None.
Outputs :
space = pixel spacing between children bases
xpad,ypad = horizontal and vertical pixel spacing being children
bases and edges of parent base.
scx,scy = pixel scale factors to rescale screen size in
X- and Y-directions
Opt. Outputs: None.
Keywords : None.
Procedure :
The returned values were derived empirically by
experimenting with sizing widgets on a 1280 x 1024 pixel screen.
They can be used as keywords in WIDGET_CONTROL to produce
"nice fitting" widgets. IDL can (and will likely) ignore them.
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category :
Prev. Hist. : None.
Written : DMZ (ARC) Oct 1993
Modified :
Version :
[Previous]
[Next]
NAME:
GET_SEC_PIXEL
PURPOSE:
This function returns plate scale in arc seconds per pixel.
CATEGORY:
LASCO_ANALYSIS
CALLING SEQUENCE:
Result = GET_SEC_PIXEL (Hdr)
INPUTS:
Hdr: A LASCO header structure
OPTIONAL INPUTS:
FULL=FULL: If the image has been placed in a square field. Ex:
Result = GET_SEC_PIXEL (Hdr, FULL=1024)
Result = SEC_PIXEL (Hdr, FULL=512)
OUTPUTS:
arc seconds per pixel
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], FXPAR [1], FXPAR [2]
LASCO_FITSHDR2STRUCT, MLO_FITSHDR2STRUCT, SOLAR_EPHEM, SUBTENSE
CALLED BY:
C2_WARP, C3_WARP, COMBINE_IMG, GET_PT, GET_SOLAR_RADIUS, MAKE_DAILY_IMAGE, MKMOVIE
MKMOVIE0 obsolete version of mkmoviepro, MK_IMG, REDUCE_LEVEL_1
REDUCE_REFCOORD, RTMOVIE, TELESCOPE_POINTING, WRUNMOVIEM, WRUNMOVIEM3
plot_thetas im xc yc th HDRhdr INTRVALintrval RANGErange SDIRsdir ROOTroot SAVEsave PIXELSpixels OCCocc RSUNrsun OVERPLOToverplot YTITLEytitle XRANGExrange YRANGEyrange THICKNESSthickness
polariz_display
PROCEDURE:
Returns values that have been determined by other means and put
into a table here.
MODIFICATION HISTORY:
Written by: S.E. Paswaters, 30 August 1996
Updated:
96/10/04 SEP Changed FULL to allow different sizes.
98/08/28 RAH Mods for MLO/MK3
99/08/05 NBR Fixed FULL keyword to compute floating point factor
00/01/14 DAB Mods for MLO/MK4
01/02/12 NBR Mods for MK4 and elimination of sec_pix as array
08/19/05 @(#)get_sec_pixel.pro 1.12 : LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - CDS/SUMER
Name : GET_SECTION_NO
Purpose : Get a set of section numbers from a string.
Explanation : This function searches a string for a section number. A
section number is a regular expression with the following
format:
((DIGIT)+[D1 | D2 | .. | DN])*(DIGIT)+
Where:
+ Repeat the character or expression one
or more times.
* Repeat the character or expression any
number of times. (including 0 times -
(..)+ => (..)(..)* )
[d1 | d2 | .. | dn] Choose either d1 or d2 or d3 up to dn.
DIGIT Any numberical character (0 - 9).
D1, D2, .. , DN The set of characters that can be used
delimit a section number from a sub
section number.
If it finds a substring in this format, then it converts each
of the section numbers to an integer and returns them as
an array.
Use : RESULT = GET_SECTION_NO (STR, DELIMITER=DELIM, ERRMSG=ERRMSG)
STRING = 'Section 3.22.14 Recursive Searches'
SECNO = GET_SECTION_NO (STRING, DELIMITER = '.')
PRINT, SECNO
IDL> 15 3 22 14
Inputs : STR = The character string to retrieve the section
number from.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : DELIMITER = A string of characters, any one of which may be
used to delimit a portion of a section number.
Delimiter characters are used demarcate the
the strings of digits which should be treated as
a single number when converting the section number
string to an integer array.
If no delimiter is specified, then the function
default to using the '.' character as the
delimeter.
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 = ''
SECNO = GET_SECIONT_NO (STR, ERRMSG=ERRMSG)
IF ERRMSG NE '' THEN ...
Result : An integer array containing the section number. Each part
of the section number string (up to the delimiter character)
is stored in a seperate element of the array. If a string
contains more then one section number, only the first one
in the string will be processed. Element 0 of the array will
contain the position of the first character after the section
number.
Calls : ***
IS_DIGIT, VAR_TYPE
CALLED BY:
READ_MSP_ITEM
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, science
Prev. Hist. : None.
Written : Ron Yurow, 7 November 1995
Modified : Version 1, Ron Yurow, 7 November 1995
Version : Version 1, 7 November 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_SERTSW
Purpose : Return a descriptor for the current SERTS IMAGE window
Explanation :
Use : SERTSW = GET_SERTSW()
Inputs : None.
Opt. Inputs : None.
Outputs : Return value.
Opt. Outputs: None.
Keywords : None.
Calls : None.
Common : IMAGE_AREA, from Bill Thompsons image routines
Restrictions: Should only be used when Bill routines are always used.
Side effects: None.
Category : QuickLook
Prev. Hist. : None.
Written : Stein V Hagfors Haugan, December -93
Modified :
Version : 1.0
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_SOHO_DET
Purpose : Extracts a SoHO detailed science plan observation
Explanation : This routine extracts parameters which describe the SoHO
detailed science plan at a particular point in time for a given
instrument.
Use : GET_SOHO_DET, DATE, OBS
Inputs : INSTRUMENT = The name or code value for the instrument to
retrieve the plan entry for.
DATE = The date/time value that the user wishes the
science plan record for. This can be in any of
the standard CDS time formats.
Opt. Inputs : None.
Outputs : OBS = Structure containing the science plan record. It
contains the following tags:
STRUCT_TYPE = The character string 'SOHO-DET-PLAN'.
INSTRUME = Single letter code specifying the
instrument.
DATE_OBS = Date/time of beginning of observation,
in TAI format
DATE_END = Date/time of end of observation, in TAI
format
SCI_OBJ = Science objective
SCI_SPEC = Specific science objective
OBS_PROG = Observing program that will be run
PROG_ID = Program ID, linking one or more studies
together
CMP_NO = Campaign number
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
XCEN = Center(s) of instrument field-of-view
along X axis
YCEN = Center(s) of instrument field-of-view
along Y axis
ANGLE = Rotation angle(s) of field-of-view
relative to solar north
IXWIDTH = Width(s) of field-of-view in instrument
X direction
IYWIDTH = Width(s) of field-of-view in instrument
Y direction
DISTURBANCES = Description of any disturbances
JITTER_LIMIT = Jitter limit in 1/10 arcsec units
If no entry is found, then a simpler structure is returned with
INSTRUME set to the null string.
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 = ''
GET_SOHO_DET, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], 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], GET_INSTRUMENT, TRIM, UTC2TAI
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 12 April 1995
Modified : Version 1, William Thompson, GSFC, 12 April 1995
Version 2, William Thompson, GSFC, 28 April 1995
Returns an error string when no entry is found.
Version 3, William Thompson, GSFC, 22 May 1995
Changed way DBFIND is called, to speed up.
Modified to take into accounted DELETED field.
Version : Version 3, 22 May 1995
[Previous]
[Next]
Returns SOHO solar ephemeris info in SUNEPHEM structure:
LONG STRUCT -> COORDINATE Array[1]
LAT STRUCT -> COORDINATE Array[1]
ORIENT STRUCT -> ORIENT Array[1]
L0 DOUBLE 3.5500000
B0 DOUBLE -5.7100000
ROTATION LONG 1934
CRSTART DOUBLE 2450892.5
DIAMETER STRUCT -> SUNDIAMETER Array[1]
and planetary ephemeris info for 5 planets in PLANETEPHEM structures:
NAME STRING 'Mars'
LONG STRUCT -> COORDINATE Array[1]
LAT STRUCT -> COORDINATE Array[1]
PHASE DOUBLE 4.8000000
ILLUM DOUBLE 0.99823315
DIAMETER STRUCT -> PLANDIAMETER Array[1]
Uses predictive orbital CDF files from SOHO.
INPUTS:
t STRING date_obs+' '+time_obs
OUTPUTS:
sunephem SUNEPHEM structure
planephem PLANETEPHEM structure (array of 5)
By Nathan Rich/NRL/Interferometrics, Nov 2000
011219, NR - Use (new) sohoephem.pro
%H%, %W% ; LASCO NRL IDL Library
CALLS:
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
GET_SOHO_INST()
PURPOSE:
Return one or more SOHO instrument names
CATEGORY:
Utility, planning
SYNTAX:
Result = get_soho_inst([name])
CALLED BY:
ADD_ANOMALY, GET_INST_COLOR, GET_LATEST_IAP, GET_SOHO_MAP, GET_SYNOPTIC
HTML_SPLAN, MK_CDS_PLAN, MK_PLAN_CLONE, MK_PLAN_CUSTOM, MK_PLAN_EXIST
MK_PLAN_FORM, MK_PLAN_HTML, MK_PLAN_PLOT, MK_PLAN_READ, MK_SOHO, MK_SOHO_CUSTOM
MK_SOHO_EDP, MK_SOHO_EXTPLAN, MK_SOHO_TARGET, PLOT_SPLAN, RD_PLAN, READ_KAP
READ_KAP_ITEM, UPDATE_KAP, XCLONE_PLAN, XREPORT, XREPORT_EDIT
EXAMPLES:
PRINT, get_soho_inst() ; print all SOHO instruments in long form
PRINT, get_soho_inst(/short) ; print all inst. in short form
print, get_soho_inst('SWAN') ; print 'W'
PRINT, get_soho_inst('W') ; print 'SWAN'
print, get_soho_inst('W',/short) ; print 'W'
INPUTS:
None required.
OPTIONAL INPUTS:
NAME - String scalar or array, instrument name in either short
or long form.
If NAME is in short form, output will be in long form
(unless keyword SHORT is set); if NAME is in long form,
output will be in short form. If NAME is missing, all
instrument names (except those listed in EXCLUDE
keyword) will be returned
OUTPUTS:
RESULT - Returned instrument name in full form (default) or
short name (if SHORT keyword is set)
OPTIONAL OUTPUTS:
None.
KEYWORDS:
ALL - Set this keyword to return names of all SOHO instruments
SHORT - Set this keyword to return inst name in short format
(1 character)
EXCLUDE - List of instrument names to be excluded from the
returned list. If keyword SHORT is set, EXCLUDE
should also in short form, otherwise it should be in
full form
SORTING - Set this keyword to sort instrument list (in long form)
alphabetically
ERROR - String scaler containing any returned error
message. If no error occurs, it's a null string.
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], GREP
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, January 15, 1996, Liyun Wang, GSFC/ARC. Written
Version 2, January 16, 1996, Liyun Wang, GSFC/ARC
Added SORTING keyword
Keyword SHORT will force returned name to be short now
Version 3, April 26, 1996, Liyun Wang, GSFC/ARC
Modified so that NAME can be a string array as well
Version 4, January, 1997, Zarro, SAC/GSFC - added TRACE
CONTACT:
Liyun Wang, GSFC/ARC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_SOHO_MAP
Purpose : return SOHO SCI_PLAN instrument that is being used for ACTIVITY
Category : operations, planning
Explanation :
Syntax : IDL> inst=get_soho_map(activity)
Inputs : ACTIVITY = activity (e.g., 'jop')
Opt. Inputs : None
Outputs : OUT = instrument letter associated with activity
Opt. Outputs: None
Keywords : None
CALLS: ***
GET_SOHO_INST, GREP
CALLED BY:
WRITE_CAP
Common : None
Restrictions: None
Side effects: None
History : Version 1, 26-Apr-1995, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO
Name : GET_SOHO_ROLL
Purpose : retrieve current SOHO roll state
Category : planning
Syntax : IDL> roll=get_soho_roll(date)
Inputs : DATE = required date of roll [def = current UT]
Outputs : ROLL = roll degrees clockwise from N
Keywords : VERBOSE = set for output
FORCE = set to force reading (otherwise cache is used)
REMOTE = force reading via socket (mainly for testing)
CALLS: ***
ALLOW_SOCKETS, ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2], DELVARX [1]
DELVARX [2], DELVARX [3], DELVARX [4], EXIST, GET_UTC, IS_BLANK, IS_STRING, LOCAL_NAME
LOC_FILE [1], LOC_FILE [2], LOC_FILE [3], PARSE_SOHO_ROLL, RD_ASCII [1]
RD_ASCII [2], SOCK_LIST, STR2ARR [1], STR2ARR [2], SYNOP_SERVER, VALID_TIME
delvarx [5]
CALLED BY:
DO_EIT_MAP, IMAGE_TOOL, ITOOL_RD_FITS, PLOT_SPLAN, XCOR_CDS, XCPT
Restrictions: None yet
History : Written 3 July 2003, D. Zarro (EER/GSFC)
Modified 1 October 2003, Zarro (GSI/GSFC) - removed "break" for
backwards IDL compatibility.
Modified 16 March 2004, Zarro (L-3Com/GSFC) - added sort
to roll_data.
Modified 26 Dec 2005, Zarro (L-3Com/GSFC) - removed depecrated
/NO_PROTOCOL keyword
Contact : dzarro@solar.stanford.edu
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_SOHO_SUBMODE
Purpose : return DSN subformat definitions for SOHO instruments
Category : planning
Explanation : Single point maintenance
Syntax : IDL>def=get_soho_submode(submode)
Inputs : SUBMODE= 1,2,3,4, or 6
Opt. Inputs : None
Outputs : DEF = corresponding definition
Opt. Outputs: None
Keywords : None
CALLS: ***
EXIST
CALLED BY:
MK_SOHO_TARGET, SHOW_RES_STC
Common : None
Restrictions: None
Side effects: None
History : Version 1, 18-Jan-1998, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
NAME:
GET_SOLAR_RADIUS
PURPOSE:
This function returns the radius of the sun in arc seconds.
CATEGORY:
LASCO_ANALYSIS
CALLING SEQUENCE:
Result = GET_SOLAR_RADIUS (Hdr)
INPUTS:
Hdr: A LASCO header structure
KEYWORDS:
PIXEL Output result in pixels
DISTANCE Set equal to variable which will contain distance
to sun in km
OUTPUTS:
solar radius in arc seconds
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CDS2JD, DATATYPE [1], DATATYPE [2], DATATYPE [3]
GET_ORBIT_CDF2, GET_SEC_PIXEL, LASCO_FITSHDR2STRUCT, ORBIT_FILE_TYPE
SOLAR_EPHEM, TAI2UTC, UTC2TAI, UTC2YYMMDD, sohoephem
CALLED BY:
C3_CME, C3_CME_FRONT, CHANDLE, CME_MASS, CME_MASSIMG2TOTAL, COMBINE_IMG, COMBINE_MVI
GET_PT, LAYOUT, MAKE_DAILY_IMAGE, MKMOVIE
MKMOVIE0 obsolete version of mkmoviepro, MK_IMAGE, PB_INVERTER, POLARIZ_CALC
REDUCE_LEVEL_1, ROI_SECTOR, RTMOVIE, TELESCOPE_POINTING, WRUNMOVIEM, WRUNMOVIEM3
PROCEDURE:
Determines the solar radius from the position of SOHO as
defined in the *.cdf format files.
MODIFICATION HISTORY:
Written by: D.A. Biesecker, 12 September 1996
General routine taken from POINTING3.PRO written by S.P. Plunkett
Modified 30 Sept. 1996 by DAB: return default values of the solar
radius if calls to read the SOHO orbit files fail.
RA Howard 5/20/97 Added keyword PIXEL to return solar radius in pixels
NB Rich 8/25/98 Use detector instead of telescop to allow MVIHDR
NB Rich 12/16/98 Use get_orbit_cdf2 instead of get_orbit_cdf
NB Rich 11/13/01 Use solar_ephem instead of sohoephem if linux is OS
NB Rich 07/15/03 Ditto for darwin (MaxOSX)
NB Rich 04.03.29 Fix /pixel for linux case
NB Rich, 05.08.19 - Try to make general for any (FITS) header
08/19/05 @(#)get_solar_radius.pro 1.13 - LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
GET_SOLAR_ROLL
PURPOSE:
This function returns the roll angle of solar north in radians.
1. If /STAR keword is set, it returns the roll angle computed from
the stars from the daily time files.
2. If /MEDIAN keyword is set, it returns the running median
roll angle from the daily time files.
3. If /AVG keyword is set (or if no /STAR, /MEDIAN, or /AVG
keyword is set), it returns the median average roll angle from
an average file.
4. IF /STAR or /MEDIAN keyword is used but the daily time files
do not contian the needed information, the average files will
be used instead.
CATEGORY:
LASCO_ANALYSIS
CALLING SEQUENCE:
Result = GET_SOLAR_ROLL (Hdr)
INPUTS:
Hdr: A LASCO header structure
OPTIONAL KEYWORD INPUTS:
MEDIAN: Return the running median roll angle from the daily time files.
Result = GET_SOLAR_ROLL (Hdr, /MEDIAN)
STAR: Return the roll angle computed from the stars from the daily
time files.
Result = GET_SOLAR_ROLL (Hdr, /STAR)
AVG: Return the average roll angle for a period to which the image
belongs from an average file. This is used as default if no
MEDIAN, STAR, or AVG keyword is used.
Result = GET_SOLAR_ROLL (Hdr, /AVG) or
Result = GET_SOLAR_ROLL (Hdr)
OUTPUTS:
roll angle in radians
CALLED PROGRAMS:
GET_ROLL_OR_XY
CALLS: ***
GET_ROLL_OR_XY
CALLED BY:
MK_MONTHLY_MIN, TELESCOPE_POINTING, polariz_display
PROCEDURE:
Determines the solar north roll angle from the time files or the
average files.
MODIFICATION HISTORY:
Written by:
Updated: 98/10/06 AEE Changed to use the c?_rollxy_yymmdd.dat
files instead of returning 0.0 (it still
returns zero if the file is not found
or if found it does not contain info for
the image) by calling get_roll_or_xy pro.
98/10/28 AEE Added AVG keyword and made it default.
98/12/11 AEE now returns the source used (STAR,MEDIAN,
AVG,NONE) as a parameter.
@(#)get_solar_roll.pro 1.1 05/14/97 LASCO IDL LIBRARY
[Previous]
[Next]
Name: get_string
Purpose: read and return file generated by sav_string
used for Yohkoh !path, documentation, filemaps
Input Parameters:
file - filename of file (written by save_idlpath)
if any keyword is set
Optional Keyword Parameters:
Output:
function returns contents of file
Method:
special files contain a single string (but the string may be long)
in XDR format for transporability among systems
Calling Sequence: string=get_string(file)
Categories:
swmaint, file i/o, gen, util
Notes:
The pair of routines [sav_string/get_string] were developed to allow
saving and restoring of several yohkoh parameters (ex: !path) to help
manage the Yohkoh idl environment but they are generic in nature and
other uses may be considered. They can be used in conjunction with
arr2str and str2arr to allow storing of string 'arrays'
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], concat_dir [4]
History: slf, 30-July-92
slf, 22-Jul-93 (use SITE instead of GEN)
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_STUDY
Purpose : Extracts a complete study definition from the database
Explanation : This routine extracts all the parameters of a study from the
database for the requested study ID number and variation index.
Use : GET_STUDY, STUDY_ID, STUDYVAR, DEF
GET_STUDY, TITLE_ID, STUDYVAR, DEF, /USE_TITLE
Inputs : STUDY_ID = Study ID number
STUDYVAR = Study variation index
Opt. Inputs : TITLE_ID = Study title ID number. This can be passed
instead of the study ID, but this must be
signalled by passing the /USE_TITLE flag.
Outputs : DEF = Anonymous structure containing the complete study
definition. It contains the following tags:
STRUCT_TYPE = The character string 'CDS-STUDY'
STUDY_ID = Study ID number. If the requested study
is not found, then a simpler structure is
returned, with this set to -1.
TITLE_ID = Study title ID number.
OBS_PROG = Name of the study
TITLE = A descriptive title for the study
CATEGORY = The study category, either "T"est,
"S"cience or "C"alibration.
N_RASTERS0 = Fixed part of the number of rasters in
the study.
VAR_POINT = Either "Y" or "N" representing whether or
not the pointing can be controlled by the
user. If "Y" then the pointing is
defined in the plan. If "N" then the
pointing is embedded within the study.
N_RASTER_DEF= Number of rasters in the definition.
STUDYVAR = Study variation index. Initially, this
is zero. It is updated by this routine
to reflect the index in the database.
SV_DESC = A short description of the study
variation beyond what is given in the
associated fundamental study description.
DURATION0 = Fixed part of the study duration, in
seconds.
DURATION1 = Number of seconds/raster for the variable
part of the study duration.
ZONE_ID = Pointing zone ID
USABLE = Either "Y" or "N" to signal whether or
not the study is usable. Normally "Y".
RASTERS = A array listing the rasters to be used
during the study.
The raster descriptions themselves are structures, of
type "cds_study_ras", with the following tags:
RAS_ID = Raster ID number, pointing to the
definition of the raster.
RAS_VAR = Raster variation index.
POINTING = How to handle the pointing. Valid
entries are:
1 = No pointing, supply in plan
0 = Absolute pointing
-1 = Offset value from first raster
INS_X = Together with INS_Y, the pointing to use
when user-supplied values are not
allowed. Only valid when POINTING=0
(absolute) or POINTING=-1 (relative to
1st raster).
INS_Y = ...
N_REPEAT_R = Number of times to repeat raster.
Opt. Outputs: None.
Keywords :
USE_TITLE = If set, then the input parameter is the title ID rather
than the study ID. Not required if OBS_PROG is passed.
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 = ''
GET_STUDY, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], 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], TRIM
CALLED BY:
ADD_ALT, ADD_DETAIL, ADD_FLAG, ADD_MAIN, EXPORT_STUDY, GET_CDS_STUDY, IMPORT_PLAN
IMPORT_STUDY, MOD_MAIN, PLAN_XCAT_SUMM, SHOW_PLAN, SHOW_STUDY, UPDATE_STUDY_DUR
WHAT_CDHS_STUDY, WRITE_CIF
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 29 April 1994
Modified : Version 1, William Thompson, GSFC, 2 August 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 21 November 1994
Added items N_REPEAT_R and N_RASTER_DEF
Version 4, William Thompson, GSFC, 29 December 1994
Fixed bug when inputs are bytes.
Version 5, William Thompson, GSFC, 26 January 1995
Added tag STRUCT_TYPE
Version 6, William Thompson, GSFC, 10 February 1995
Changed N_POINTINGS to VAR_POINT.
Removed VAR_RASTERS.
Version 7, William Thompson, GSFC, 29 March 1995
Added tag ZONE_ID
Version 8, William Thompson, GSFC, 28 April 1995
Returns an error string when no study is found.
Version 9, William Thompson, GSFC, 12 May 1995
Modified to split off separate study_title database
Version 10, William Thompson, GSFC, 20 June 1995
Added tag FLAGABLE.
Version 11, William Thompson, GSFC, 27 October 1995.
Removed tag flagable. Any study can produce a flag if
given an IEF_ID.
Version 12, William Thompson, GSFC, 1 December 1995
Allow case where N_RASTER_DEF=0.
Version : Version 12, 1 December 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_STUDY_PAR
Purpose : to get CDS study parameter information
Category : database, planning
Explanation :
Syntax : IDL> get_study_par,study_id,studyvar
Inputs : STUDY_ID = study id
: STUDYVAR = study variation
Opt. Inputs : None.
Outputs : See keywords.
Opt. Outputs: None.
Keywords :
STUDY = study definition (optional input)
PLAN = plan structure (optional input)
RASTERS = raster definition (optional output)
COUNT = no of rasters found (zero for engineering)
ERR = any error string
RDUR = duration (secs) of individual rasters composing study
REPS = # of repeats per raster
DETS = detectors per raster (e.g. ['N','G','N'....])
SLITS = slit number per raster
SDUR = total duration of study from summing rasters
(not taking account of slit and OPS motions)
ENG =1/0 if engineering/science study
GIS =1/0 if study uses GIS
TELEM = raster telemetry modes
VERBOSE = verbose output
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], EXIST, GET_CDS_HOME, GET_CDS_STUDY
GET_RASTER_PAR, TAG_EXIST [1], TAG_EXIST [2], TRIM
CALLED BY:
CDS_PLAN_BRIEF, CHECK_CDS_MODES, EIS_CAT [1], EIS_CAT [2], FIND_CDS_STUDY
GET_CDS_DELAY, GET_CDS_DUR, GET_CDS_STATE, MK_CDS_PLAN, ROT_CDS_XY, XCAT
Common : None
Restrictions: Input study must be valid. Cannot enter PLAN and STUDY
keywords simultaneously
Side effects: None
History : Version 1, 1-Jan-1996, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
NAME:
get_subdirs
PURPOSE:
To return a list of the subdirectories under a given location
CALLING SEQUENCE:
sdir = get_subdirs('/2p/morrison')
sdir = get_subdirs('/ys')
sdir = get_subdirs('ys:[sxt]')
INPUT:
indir - The input directory to find all subdirectories under
CALLS: ***
str_replace [1], str_replace [2]
CALLED BY:
DATA_PATHS, PLOT_RESULTS [2], file_path [1], file_path [2], get_dirtree, his_dirs
show_pix [1], show_pix [2], sxt2file, timeline, topsdb [1], topsdb [2], web_seq
xdisp_fits
RESTRICTIONS:
For VMS system, there has to be a "]" in the input specification
HISTORY:
Written 19-Oct-92 by M.Morrison
5-Jul-94 (MDM) - Modified to add the root directory to the list
of subdirectories found
[Previous]
[Next]
Project:
SOHO - SUMER
Name:
get_sum_column
Purpose:
Interactively select a particular column from a sumer index structure.
Explanation
This program is analygous to get_cds_window.
Catagory:
util
Use:
column= get_sum_column(index)
Inputs
index - The index structure returned from rd_sumer.
Output
Column - selected column index for data and index structure.
Input Keywords:
None
Calls: ***
SGT_BTE, sgt_refval
CALLED BY:
mk_sumer_map [1], mk_sumer_map [2], mk_sumer_map [3]
Common:
None
Written:
Terry Kucera, Oct 23, 1996.
Contact:
tkucera@solar.stanford.edu
[Previous]
[Next]
Project : SOHO-SUMER
Name : GET_SUMER_FILES
Purpose : find SUMER fits files
Category : data analysis
Explanation :
Syntax : files=get_sumer_files(tstart,tend)
Inputs : TSTART,TEND = tstart/tend to search OR FILE = filename
If TEND is not entered, then all files on TSTART day will
be returned.
Outputs : FILES = full filenames found
Keywords : ERR = error string
COUNT = number of files found
INDEX = user-supplied index file
FLAT = get flat field files only
NEAREST = find file closest in time to TSTART
VERBOSE = print some messages
ALL = return all files
CHECK = check that files really exist
FITS or FTS for fits or .fts files (def=all)
CALLS: ***
ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2], APPEND_ARR, BREAK_FILE [1]
BREAK_FILE [2], BREAK_FILE [3], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
DATATYPE [1], DATATYPE [2], DATATYPE [3], DELVARX [1], DELVARX [2], DELVARX [3]
DELVARX [4], EXIST, GET_UTC, GREP, LOC_FILE [1], LOC_FILE [2], LOC_FILE [3], NUM2STR
PR_SYNTAX, TRIM, UNIQ [1], UNIQ [2], UNIQ [3], break_file [4], concat_dir [4]
delvarx [5], restgen [1], restgen [2], str_replace [1], str_replace [2]
CALLED BY:
SUMER_CALIB
History : Written: 20 November 1998, D. Zarro (SM&A)
Modified: 6-May-2002, Zarro (L-3Com/GSFC) - added
$SUMER_FLATFIELD to search path
Contact : dzarro@solar.stanford.edu
[Previous]
[Next]
Project : SOHO - SUMER
Name : GET_SUMER_FLAT
Purpose : Find nearest SUMER flatfield file to input file
Category : analysis,planning
Syntax : IDL> flat=get_sumer_flat(file)
Inputs : FILE = SUMER FITS filename or INDEX from RD_SUMER
Outputs : FLAT = name of nearest flatfield file
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], FIND_COMPRESSED, PR_SYNTAX, STR_SEP
anytim2dd79, rd_sumer [1], rd_sumer [2], sgt_detector, sgt_time, str_replace [1]
str_replace [2], sumer_ffdb
History : Version 1, 5-Feb-1999, D.M. Zarro (SM&A), Written
Based on MK_FFDB by H. Warren.
Modified: 6-May-2002, Zarro (L-3Com/GSFC) - added
$SUMER_FLATFIELD to search path
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
NAME:
GET_SUN
PURPOSE:
Provides geocentric physical ephemeris of the sun.
Front end to routine SUN to provide 'Yohkoh-style' time interface
CATEGORY:
CALLING SEQUENCE:
OUT = GET_SUN(ITEM)
INPUTS:
ITEM - Reference time for ephemeris data. Interpreted as
an ephemeris time (ET). The difference between ephemeris
time and universal time (Delta T = ET - UT) is not
completely predictable but is about 1 minute now. This
difference is noticable slightly. The form can be:
(1) structure with a .time and .day field,
(2) standard 7-element external representation, or
(3) a string of the format "hh:mm dd-mmm-yy".
If no date is entered, the current date is used.
The year is not required, but if entered should be
of the form "dd-mmm" style. The date should be entered
in string style with date first.
KEYWORD INPUTS:
/LIST : Displays values on screen.
OUTPUTS:
DATA = Vector of solar ephemeris data:
DATA( 0) = Distance (AU).
DATA( 1) = Semidiameter of disk (sec).
DATA( 2) = True longitude (deg).
DATA( 3) = True latitude (0 always).
DATA( 4) = Apparent longitude (deg).
DATA( 5) = Apparent latitude (0 always).
DATA( 6) = True RA (hours).
DATA( 7) = True Dec (deg).
DATA( 8) = Apparent RA (hours).
DATA( 9) = Apparent Dec (deg).
DATA(10) = Longitude at center of disk (deg).
DATA(11) = Latitude at center of disk (deg).
DATA(12) = Position angle of rotation axis (deg).
DATA(13) = decimal carrington rotation number.
KEYWORD OUTPUTS
DIST = Distance in AU.
SD = Semidiameter of disk in arc seconds.
TRUE_LONG = True longitude (deg).
TRUE_LAT = 0 always.
APP_LONG = Apparent longitude (deg).
APP_LAT = 0 always.
TRUE_RA = True RA (hours).
TRUE_DEC = True Dec (deg).
APP_RA = Apparent RA (hours).
APP_DEC = Apparent Dec (deg).
HE_LON = Longitude at center of disk (deg).
HE_LAT = Latitude at center of disk (deg).
PA = Position angle of rotation axis (deg).
CARR = decimal carrington rotation number.
CALLS: ***
RECPOL [1], RECPOL [2], RECPOL [3], TIM2JD [1], TIM2JD [2], fmt_tim [1], fmt_tim [2]
CALLED BY:
CARR2EX, COORD_ADDINDEX, COORD_CART_HELIO [1], COORD_CART_HELIO [2]
COORD_HELIO_SPHERE, STEREO_SIMUL, TIM2CARR, ea_view_angle [2], get_rb0p [1]
get_rb0p [2], mk_strip_file, mk_syn_sfc [1], mk_syn_sfc [2], mk_synsfc_coeff [1]
mk_synsfc_coeff [2], read_soon
return a solar disk mask using SSW standard keywords
return solar disk mask constrained by XY limits using SSW standards
yopos [1], yopos [2]
COMMON BLOCKS:
NOTES:
Notes: based on the book Astronomical Formulae
for Calculators, by Jean Meeus.
If no arguments given will prompt and list values.
MODIFICATION HISTORY:
Feb, 1994 - GLS - Written to provide 'Yohkoh style' time
interface to routine SUN.PRO by R. Sterner, 19 Feb, 1991
Copyright (C) 1991, Johns Hopkins University/Applied Physics Laboratory
This software may be used, copied, or redistributed as long as it is not
sold and this copyright notice is reproduced on each copy made. This
routine is provided as is without any express or implied warranties
whatsoever. Other limitations apply as described in the file disclaimer.txt.
[Previous]
[Next]
NAME:
GET_SUN_CENTER
PURPOSE:
This function returns a 2 element array of the column and row
numbers as the sun center.
1. If /STAR keword is set, it returns the center computed from
the stars from the daily time files.
2. If /MEDIAN keyword is set, it returns the running median
center from the daily time files.
3. If /AVG keyword is set (or if no /STAR, /MEDIAN, or /AVG
keyword is set), it returns the median average center from
an average file.
4. IF /STAR or /MEDIAN keyword is used but the daily time files
do not contian the needed information, the average files will
be used instead.
5. If no time or average file contains the required sun center (get_
roll_or_xy returns {0.0,0.0}), then the center of the occulting
disk is used instead.
The number, in time files, average files, and occulting disk starts
at 0. The definition in the FITS header starts from 1.
CATEGORY:
LASCO_ANALYSIS
CALLING SEQUENCE:
Result = GET_SUN_CENTER (Hdr)
INPUTS:
Hdr: A LASCO header structure for the image that the center is desired
OPTIONAL INPUTS:
MEDIAN: Return the running median sun center from the daily time files.
Result = GET_SUN_CENTER (Hdr, /MEDIAN)
STAR: Return the sun center computed from the stars from the daily
time files.
Result = GET_SUN_CENTER (Hdr, /STAR)
AVG: Return the average sun center for a period to which the image
belongs from an average file. This is used as default if no
MEDIAN, STAR, or AVG keyword is used.
Result = GET_SUN_CENTER (Hdr, /AVG) or
Result = GET_SUN_CENTER (Hdr)
FULL=FULL: If the image has been placed in a square field. Ex:
Result = GET_SUN_CENTER (Hdr, FULL=1024)
Result = GET_SUN_CENTER (Hdr, FULL=512)
RAW: If set, no corrections are applied
DOCHECK: If set, corrected header is read in
NOCHECK: If set, input header is used
DEGREES: Value returned in ROLL keyword is in degrees, else is radians.
OUTPUTS:
This function returns the sun center as a two element array in which
the first element is the column center and the second element is the
row center.
OPTIONAL OUTPUT:
ROLL=named_var Named_var will contain roll value
OPTIONAL IO:
source: On output, returns one of the following sources used to
get the sun center: STAR, AVG, MEDIAN, OCC.
CALLED PROGRAMS:
GET_ROLL_OR_XY
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], FXPAR [1], FXPAR [2], GET_ROLL_OR_XY
HEADFITS [1], HEADFITS [2], HEADFITS [3], LASCO_FITSHDR2STRUCT, LZ_FROM_QL
LZ_GETLASCODIR, MLO_FITSHDR2STRUCT, OCCLTR_CNTR, QL_GETLASCODIR, STR2UTC [1]
STR2UTC [2], STR2UTC [3], UTC2TAI
CALLED BY:
C3_CME_FRONT, CME_MASSIMG2TOTAL, COMBINE_IMG, GET_IMG_CENTER, GET_PT
MAKE_DAILY_IMAGE, MKMOVIE, MKMOVIE0 obsolete version of mkmoviepro, MK_IMG
PB_INVERTER, POLARIZ_CALC, REDUCE_LEVEL_1, REDUCE_REFCOORD, REDUCE_STD_SIZE
ROI_SECTOR, RTMOVIE, TELESCOPE_POINTING, WRUNMOVIEM, WRUNMOVIEM3, WSUNPROFILE
plot_thetas im xc yc th HDRhdr INTRVALintrval RANGErange SDIRsdir ROOTroot SAVEsave PIXELSpixels OCCocc RSUNrsun OVERPLOToverplot YTITLEytitle XRANGExrange YRANGEyrange THICKNESSthickness
RESTRICTIONS:
Returns the center for the readout port "C"
PROCEDURE:
Returns values that have been determined by other means and put
into a table here.
MODIFICATION HISTORY:
Written by: S.E. Paswaters, 30 August 1996
Updated:
96/10/04 SEP Changed FULL to allow different sizes.
97/01/08 SHH Added correction for cropped images.
97/02/11 RAH Added keyword to return raw center
97/12/16 SEP updated check for EIT date_obs
98/08/24 RAH added capability to handle MLO/MK3 images
98/08/26 DW fixed problem
98/10/06 AEE Added code to use time files for getting
the sun center, first. A returned center
of {0.0,0.0} from get_roll_or_xy means
center info for the image was not in a
time file and, so, occ_cen_arr is used,
as before.
98/10/26 AEE Added AVG keyword and made it default.
It still uses occ_cen_arr if zero is
returned by get_roll_or_xy.
98/11/05 AEE Corrected nocheck and added docheck
98/11/12 RAH Changed MLO/MK3 cam to be MK3
98/11/13 AEE Corrected docheck. Assign all of complete
hdr to shdr.
98/12/01 AEE changed call to read_occ_dat to
occltr_cntr.
98/12/11 AEE now returns the source used for sun
center (STAR,MEDIAN,AVG,OCC) as an
optional parameter.
99/05/14 NBR Change name of sun_cen stucture for MK3
99/06/22 NBR Make factor floating point for /FULL
00/01/14 DAB Added MK4 telescope
01/01/08 NBR Do not correct for subfield if keyword FULL is set
04.04.01, nbr - add COMMON reduce_history
06.04.25, nbr - Add ROLL and DEGREES keywords
version= '@(#)get_sun_center.pro 1.27, 05/02/06' ; LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
GET_SUN_CENTER
PURPOSE:
This function returns the center of the occulting disk as a 2
element array of the column and row numbers. The number starts
at 0. The definition in the FITS header is starting from 1.
CATEGORY:
LASCO_ANALYSIS
CALLING SEQUENCE:
Result = GET_SUN_CENTER (Hdr)
INPUTS:
Hdr: A LASCO header structure for the image that the center is desired
OPTIONAL INPUTS:
FULL=FULL: If the image has been placed in a square field. Ex:
Result = GET_SUN_CENTER (Hdr, FULL=1024)
Result = GET_SUN_CENTER (Hdr, FULL=512)
RAW: If set, no corrections are applied
OUTPUTS:
This function returns the occulter center as a two element array
in which the first element is the column center and the second
element is the row center.
CALLS: ***
CNVRT_FILTER, DATATYPE [1], DATATYPE [2], DATATYPE [3], GET_SUN_CEN
LASCO_FITSHDR2STRUCT, READ_OCC_DAT
CALLED BY:
C3_CME_FRONT, CME_MASSIMG2TOTAL, COMBINE_IMG, GET_IMG_CENTER, GET_PT
MAKE_DAILY_IMAGE, MKMOVIE, MKMOVIE0 obsolete version of mkmoviepro, MK_IMG
PB_INVERTER, POLARIZ_CALC, REDUCE_LEVEL_1, REDUCE_REFCOORD, REDUCE_STD_SIZE
ROI_SECTOR, RTMOVIE, TELESCOPE_POINTING, WRUNMOVIEM, WRUNMOVIEM3, WSUNPROFILE
plot_thetas im xc yc th HDRhdr INTRVALintrval RANGErange SDIRsdir ROOTroot SAVEsave PIXELSpixels OCCocc RSUNrsun OVERPLOToverplot YTITLEytitle XRANGExrange YRANGEyrange THICKNESSthickness
RESTRICTIONS:
Returns the center for the readout port "C"
PROCEDURE:
Returns values that have been determined by other means and put
into a table here.
MODIFICATION HISTORY:
Written by: S.E. Paswaters, 30 August 1996
Updated:
96/10/04 SEP Changed FULL to allow different sizes.
97/01/08 SHH Added correction for cropped images.
97/02/11 RAH Added keyword to return raw center
@(#)get_sun_cen.pro 1.1 11/02/01 LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
GET_SUN_CENTER
PURPOSE:
This function returns the center of the occulting disk as a 2
element array of the column and row numbers. The number starts
at 0. The definition in the FITS header is starting from 1.
CATEGORY:
LASCO_ANALYSIS
CALLING SEQUENCE:
Result = GET_SUN_CENTER (Hdr)
INPUTS:
Hdr: A LASCO header structure for the image that the center is desired
OPTIONAL INPUTS:
FULL=FULL: If the image has been placed in a square field. Ex:
Result = GET_SUN_CENTER (Hdr, FULL=1024)
Result = GET_SUN_CENTER (Hdr, FULL=512)
RAW: If set, no corrections are applied
OUTPUTS:
This function returns the occulter center as a two element array
in which the first element is the column center and the second
element is the row center.
CALLS: ***
CNVRT_FILTER, DATATYPE [1], DATATYPE [2], DATATYPE [3], GETSUNCEN
LASCO_FITSHDR2STRUCT, READ_OCC_DAT
CALLED BY:
C3_CME_FRONT, CME_MASSIMG2TOTAL, COMBINE_IMG, GET_IMG_CENTER, GET_PT
MAKE_DAILY_IMAGE, MKMOVIE, MKMOVIE0 obsolete version of mkmoviepro, MK_IMG
PB_INVERTER, POLARIZ_CALC, REDUCE_LEVEL_1, REDUCE_REFCOORD, REDUCE_STD_SIZE
ROI_SECTOR, RTMOVIE, TELESCOPE_POINTING, WRUNMOVIEM, WRUNMOVIEM3, WSUNPROFILE
plot_thetas im xc yc th HDRhdr INTRVALintrval RANGErange SDIRsdir ROOTroot SAVEsave PIXELSpixels OCCocc RSUNrsun OVERPLOToverplot YTITLEytitle XRANGExrange YRANGEyrange THICKNESSthickness
RESTRICTIONS:
Returns the center for the readout port "C"
PROCEDURE:
Returns values that have been determined by other means and put
into a table here.
MODIFICATION HISTORY:
Written by: S.E. Paswaters, 30 August 1996
Updated:
96/10/04 SEP Changed FULL to allow different sizes.
97/01/08 SHH Added correction for cropped images.
97/02/11 RAH Added keyword to return raw center
@(#)getsuncen.pro 1.1 11/02/01 LASCO IDL LIBRARY
[Previous]
[Next]
hk is an array containing all of the housekeeping packets
Extracts TCE communication errors as reported in the HK stream
into a sequence. These errors are in words 45-54 of packet #3.
CALLS: ***
gethkn
Note: since there is no sequence # associated with these errors
there may actually be more errors than reported. For example
only the last 5 errors are reported. So if there were more
than 5 errors in between pckt 3 acquisitions we would only see
the last 5. Or if all 5 reported errors are the same, when
we get a 6th of the same, we wouldn't be able to tell.
OUTPUT:
word
0 obt byte 1
1 obt byte 2
2 obt byte 3
3 obt byte 4
4 obt byte 5
5 obt byte 6
6 good / bad flag (0=good, 1=bad soho 2 = bad tce)
7 command counter
8 command code
9 command destination code
10 detected by
11 command error code
there are five slots for putting bad commands into
if more than five bad commands are received with the same id
then they cannot be distinguished from the first five.
all 5 locations are cleared when good TC count rolls over 255
@(#)get_tce_comm_errs.pro 1.1 01/23/98 :LASCO IDL LIBRARY
[Previous]
[Next]
NAME: GET_TEL_CONFIG
PURPOSE: Computes the telescope configuration number,
given the telescope, the telescope mechanism
configuration, and the camera configuration in
the header
CATEGORY: REDUCTION
CALLING SEQUENCE: Result = GET_TEL_CONFIG(Tel_num,Fits_hdr)
INPUTS: Tel_num = Telescope number (0..3)
Fits_hdr = String containing the FITS header
OUTPUTS: Result = Configuration number
CALLS: ***
FXPAR [1], FXPAR [2]
MODIFICATION HISTORY: WRITTEN RA Howard NRL
Version 1 RAH 20 Oct 1995 Initial Release
Version 2 RAH 6 Nov 1995 compute number
rather than use DBMS
@(#)get_tel_config.pro 1.1 04 Apr 1996 LASCO IDL LIBRARY
[Previous]
[Next]
FUNCTION: get_tf_rec, fname, filnum, recnum
Purpose: To return the a record from a ".tfr" file.
Arguments:
1. fname - Name of the tfr file, not including the file number of the
extension. (INPUT)
2. filnum - File Number
3. recnum - record number in file.
This procedure can be used to read a set of tfr files as though they were a
a single file. The procedure procedure updates filnum and recnum after
reading the specified record, opening the next file in the series if
necessary.
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], GET_TF_REC, break_file [4]
file_list [1], file_list [2], get_host [1], get_host [2]
HISTORY:
Written 1994 by D.Mathur
25-Apr-95 (MDM) - Added capability to get around FINDFILE
limitations which were causing a false failure
19-Feb-96 (MDM) - Put a patch in for the case where there are more than
100 extensions
8-Aug-96 (MDM) - Added code to handle reading Stanford sci160k files
[Previous]
[Next]
FUNCTION: get_tf_rec, fname, filnum, recnum
Purpose: To return the a record from a ".tfr" file.
Arguments:
1. fname - Name of the tfr file, not including the file number of the
extension. (INPUT)
2. filnum - File Number
3. recnum - record number in file.
This procedure can be used to read a set of tfr files as though they were a
a single file. The procedure procedure updates filnum and recnum after
reading the specified record, opening the next file in the series if
necessary.
[Previous]
[Next]
FUNCTION: get_tf_rec, fname, filnum, recnum
Purpose: To return the a record from a ".tfr" file.
Arguments:
1. fname - Name of the tfr file, not including the file number of the
extension. (INPUT)
2. filnum - File Number
3. recnum - record number in file.
This procedure can be used to read a set of tfr files as though they were a
a single file. The procedure procedure updates filnum and recnum after
reading the specified record, opening the next file in the series if
necessary.
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_TILTCAL
Purpose : Get the NIS tilt calibration for a given date.
Category : Calibration, NIS, Coordinates
Explanation : Looks up the NIS tilt calibration in the database for a given
spectrum and date combination. First, the software finds the
largest effective date which is on or earlier than the
observation date. If there are multiple entries with the same
effective date, then the one with the latest entry date is
used.
Syntax : GET_TILTCAL, SPECTRUM, REQ_DATE, COEFF
CALLED BY:
CDS_TILT_COR, GT_LAMBDA, MK_CDS_ANALYSIS, NIS_ROTATE, QTILT, VDS_BURNIN_NEW
VDS_BURNIN_ORIG
Examples : GET_TILTCAL, 1, DATE, TILTCAL
IF TILTCAL.DATE NE '' THEN ...
Inputs : SPECTRUM = Either 1 or 2
REQ_DATE = The date to use in searching for a wavelength
calibration.
Opt. Inputs : None.
Outputs : COEFF = The NIS tilt calibration coefficients. The
polynomial
TILT = POLY(PIXEL, COEFF)
returns the tilt as a function of pixel position.
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 = ''
GET_TILTCAL, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2], 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], DBSORT [1], DBSORT [2], DBSORT [3], TRIM
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 13-Jan-1998, William Thompson, GSFC
Modified, 26-Nov-2004, Zarro (L-3Com/GSFC) -
- added DBCLOSE on error handling
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_TIME_DELAY()
Purpose : Get the time delay between SOHO and the Earth
Category : Class3, Orbit, Time
Explanation : Calculate the distance between the Earth and the Sun, and the
SOHO spacecraft and the sun. Convert this into a time delay to
be used in converting onboard time into Earth-based time.
Reads orbit information from either the definitive or
predictive orbit file, whichever it can find first.
Syntax : Result = GET_TIME_DELAY( DATE [, TYPE ] )
CALLED BY:
MAKE_DAILY_IMAGE, WRITE_SUMMARIES [1]
Examples : In the following example, OBT_TIME is the onboard time, and
DATE_OBS is the time the same solar event would be observed at
the earth. Note that the delay is not implemented if it can't
be calculated.
DELAY = GET_TIME_DELAY(OBT_TIME)
DATE_OBS = OBT_TIME
IF DELAY GT 0 THEN DATE_OBS = DATE_OBS + DELAY
Inputs : DATE = The date/time value to get the time delay for. Can
be in any CDS time format.
Opt. Inputs : None.
Outputs : The result of the function is the time delay in seconds. If
unable to calculate, then -1 is returned instead.
Opt. Outputs: TYPE = Returns whether predictive or definitive data was
used to calculate the result. Returned as either
"Definitive" or "Predictive". If the routine fails
to return an answer, then the null string is
returned.
Keywords : RETAIN = If set, then the orbit FITS file will be left open.
This speeds up subsequent reads.
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 = GET_TIME_DELAY( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
OLD = If set, then files are read in from the subdirectory
"old_samples". This is used to test the software
until real data files are available.
Calls : ***
GET_ORBIT [1], GET_ORBIT [2]
Common : None.
Restrictions: The orbit entries for the time closest to that requested is
used to calculate the orbit parameters. Since the orbit data
is calculated every 10 minutes, this should be correct within
+/-5 minutes. No attempt is made to interpolate to closer
accuracy than that.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 04-Dec-1995, William Thompson, GSFC
Version 2, 07-Dec-1995, William Thompson, GSFC
Rewrote to use GET_ORBIT.
Added keyword RETAIN
Version 3, 11-Dec-1995, William Thompson, GSFC
Simplified calculation
Contact : WTHOMPSON
[Previous]
[Next]
searches sciences packets for the next occurrence of an image
sc = 2D array containing the science packets
the array should contain only data packets when the OBE
is running. ie no packets when the instrument is off,
and 'ffff'xl are being transmitted.
pktno = packet number to start the search
on exit, it will contain the packet number of the header
hdr = image header returned
img = image returned
npckt = number of packets in image
the function return is =0 if no image is found
=1 if an image is found
@(#)get_tm_img.pro 1.1 01/23/98 :LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
GET_TM_MONITOR
PURPOSE:
This function returns an array of TM values, associated with a
specified lasco monitor.
CATEGORY:
PACKETS
CALLING SEQUENCE:
Result = GET_TM_MONITOR (Hk,Name)
INPUTS:
Hk: A 2D byte array containing all three LASCO HK TM packets
Name: A string containing the name of the monitor point
KEYWORD PARAMETERS:
CONVERT: If set the raw TM values will be converted to
engineering units.
OUTPUTS:
This function returns a 1D array containing the TM values.
COMMON BLOCKS:
TM_MON_DB Contains the TM Monitor data base
mon_name Monitor Name
mon_offset Monitor Packet offset #1
mon_mask1 Monitor Mask #1
mon_offset2 Monitor Packet offset #2
mon_mask2 Monitor Mask #2
mon_title Monitor Title
mon_packet Monitor Packet Name
SIDE EFFECTS:
If the monitor DB has not been defined, the data base is read from disk
PROCEDURE:
This routine is not operational yet.
EXAMPLE:
MODIFICATION HISTORY:
Written by: R.A. Howard, NRL, 1995
@(#)get_tm_monitor.pro 1.1 01/23/98 LASCO IDL LIBRARY
[Previous]
[Next]
PROJET
SOHO - LASCO
NAME:
get_tmask
PURPOSE:
Classify blocks of image level 0.5
CATEGORY:
Masking, Missing Blocks
CALLING SEQUENCE
get_tmask,camera,rebin_index,imsk
INPUTS
camera string 'C1','C2','C3'
rebin_index 0=1024x1024, 1=512x512, 2,256x256
KEYWORD INPUTS:
none
OUTPUTS:
imsk intarray of 32x32, multivalued image mask of
-2 non useful blocks (NUB) on the corner
-1 non useful blocks (NUB) on center
1 useful blocks
2 fringe blocs
3 NS center fringe blocs
4 EW center fringe blocs
CALLED BY:
FIND_MISS_BLOCKS, FUZZY_IMAGE, GET_MISS_BLOCKS
note: 0 is reserved for non transmitted useful blocks
PROCEDURE:
HISTORY:
written by A.LL. May 1996
[Previous]
[Next]
NAME:
get_tty_type
PURPOSE:
Return the terminal type by comparing the environment variable
DISPLAY to a lookup list in $GSE_BASE_DIR/.MDI_HOSTS
SAMPLE CALLING SEQUENCE:
ttype = get_tty_type()
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FILE_EXIST [2], concat_dir [4]
file_exist [1], file_exist [3], rd_tfile [1], rd_tfile [2]
CALLED BY:
mdi_idl_startup
HISTORY:
Written 4-May-94 by M.Morrison
30-Nov-95 (MDM) - Modified to use .XTERMS file instead of .MDI_HOSTS
4-Nov-96 (MDM) - Added protection if the .XTERMS file does not
exist.
5-Nov-97 (DMZ) - added check for GSE_BASE_DIR
[Previous]
[Next]
NAME:
get_tty_type
PURPOSE:
Return the terminal type by comparing the environment variable
DISPLAY to a lookup list in $GSE_BASE_DIR/.MDI_HOSTS
SAMPLE CALLING SEQUENCE:
ttype = get_tty_type()
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FILE_EXIST [2], concat_dir [4]
file_exist [1], file_exist [3], rd_tfile [1], rd_tfile [2]
CALLED BY:
mdi_idl_startup
HISTORY:
Written 4-May-94 by M.Morrison
30-Nov-95 (MDM) - Modified to use .XTERMS file instead of .MDI_HOSTS
4-Nov-96 (MDM) - Added protection if the .XTERMS file does not
exist.
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
GET_UDP_HEAD()
PURPOSE:
Parse the SCL code and return document as a structure
CATEGORY:
ST_SUMER
SYNTAX:
Result = get_udp_head(scl_file)
INPUTS:
SCL_FILE - Full name of SCL file
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
ERROR - Named variable containing error message. If no error
occurs, the null string is returned
SEP_CHAR - Character used to differentiate keyword headers.
The default SEP_CHAR is '!'
CALLS: ***
ADD_TAG [1], ADD_TAG [2], DATATYPE [1], DATATYPE [2], DATATYPE [3], REPCHAR
TEST_OPEN
CALLED BY:
ST_SUMER, TKI_CALL, XTKI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 28, 1996, Liyun Wang, NASA/GSFC. Written
CONTACT:
Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
NAME:
get_user
PURPOSE:
Find out the name of the user as defined by the environment
variable USER
INPUT PARAMETERS:
None.
OUTPUT PARAMETERS:
Returned value is the interpretted USER value.
PROCEEDURE:
Spawn a child process and pipe the result back.
CALLED BY:
NET_DIR_DIFF, SET_PS, check_oldprocess [1], check_oldprocess [2]
check_oldprocess [3], check_oldprocess [4], check_process [1]
check_process [2], color_copy, diskbench, evt_demo, ftp_copy [1], ftp_copy [2]
go_batch [1], go_batch [2], go_yo_prod_batch, html_basics, html_doc
idl_server_control, killold [1], killold [2], laststat [1], laststat [2]
make_mirror, mk_mdi_iap, mk_sfc [1], mk_sfc [2], mk_ssc_batch [1]
mk_ssc_batch [2], mo_check, mo_patch, mobad_summ, modvolume_inf [1]
modvolume_inf [2], pr_status [1], pr_status [2], ref_term [2], save_idl_routines
search_obs, soon_search [1], soon_search [3], ssw_conflicts, ssw_install [2]
ssw_start_rpcserver, ssw_upgrade [1], ssw_upgrade [2], ssw_upgrade_backup
sswdb_upgrade, sxt_html, trace_special_movie [2], trace_special_movie [3]
write_access [1], write_access [2], xset_chain [1], xset_chain [2], xso_search
xsw2tree, xsw2tree_event, xswlist [2], xsxt_prep, ydb_install [1], ydb_install [2]
HISTORY:
Written, 14-jan-92, JRL
4-oct-94, SLF - spawn 'whoami' first, then try the old
printenv if USER not defined
(protect against loud .cshrc files)
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_VDS_BIAS
Purpose : Determines CCD bias levels in the VDS.
Category : Calibration, VDS, Intensity
Explanation : Determines the CCD bias levels to be used with VDS_DEBIAS
routine. The bias levels are determined in one of three ways:
1. There are four windows labeled "BACKGROUND".
2. The last four windows are near the edges of the
CCD.
3. The full CCD was read out.
This routine is called from DETSELECT.
Syntax : GET_VDS_BIAS, UNIT, HEADER, NAMES, DET_COLNO, BACKGROUND
CALLED BY:
DETSELECT
Examples :
Inputs : UNIT = The logical unit number of the opened FITS file.
HEADER = The binary table header.
NAMES = The names of the windows containing detector data.
DET_COLNO = The column numbers of the columns containing
detector data.
Opt. Inputs : None.
Outputs : BACKGROUND = A structure containing the background information,
with the following tags:
AVERAGE = The average bias value in each quadrant.
STDEV = The standard deviation in the bias in each
quadrant.
MINVAL = The minimum value in each background window.
MAXVAL = The maximum value in each background window.
Each tag will have the dimensions of (N_EXP,4) where N_EXP is
the number of exposures.
Opt. Outputs: None.
Keywords : None.
Calls : ***
BASELINE, FILL_MISSING, FXBFIND [1], FXBFIND [2], FXBTDIM [1], FXBTDIM [2]
FXPAR [1], FXPAR [2], READCDSCOL, TRIM
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : Part of this routine was extracted from an earlier version of
DETSELECT by SVH Haugan.
History : Version 1, 13-Feb-1996, William Thompson, GSFC
Version 2, 21-Mar-1996, William Thompson, GSFC
Corrected behavior when SUMLINE or SUMWIN compression
mode used.
Version 3, 26-Mar-1996, William Thompson, GSFC
Fill in missing values via interpolation
Version 4, 29-Mar-1996, William Thompson, GSFC
Don't call FILL_MISSING if only one element.
Version 5, 01-Sep-1999, William Thompson, GSFC
Filter out background values that have large errors.
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_VDS_SLITPOS
Purpose : Gets VDS state database information.
Explanation : This returns a structure containing information about various
quasi-static VDS parameters.
Use : GET_VDS_SLITPOS, DATE, DESC, ERRMSG=ERRMSG
Inputs : DATE = The date/time value that the user wishes the state
for. This can be in any of the standard CDS time
formats.
Opt. Inputs : None.
Outputs : DESC = Structure containing the state description. It
contains the following tags:
DATE = Start date and time for the period for
which the parameters in this record are
valid. The period ends at the start
date/time of the next record. This is a
double precision TAI value. If no entries
are found, then a simplified structure is
returned with this set to zero.
N1_CEN_S = Center slit position for NIS1 at the short
wavelength end.
N1_CEN_L = Center slit position for NIS1 at the long
wavelength end.
N2_CEN_S = Center slit position for NIS2 at the short
wavelength end.
N2_CEN_L = Center slit position for NIS2 at the long
wavelength end.
NIS_HT = NIS slit height.
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 = ''
GET_STATE, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CP_GET_HISTORY, DATATYPE [1], DATATYPE [2]
DATATYPE [3], UTC2TAI
CALLED BY:
GT_DETY, GT_SOLARY, GT_SOLAR_XY, LOAD_TP_STRUCT, NIS_CALIB, VDS_BURNIN_NEW
VDS_BURNIN_ORIG, VDS_ROTATE
Common : None.
Restrictions: None.
Side effects: None.
Category : Command preparation.
Prev. Hist. : Adapted from CP_GET_STATE by Martin Carter.
Written : William Thompson, GSFC, 22 February 1996
Modified : Version 1, William Thompson, GSFC, 22 February 1996
Adapted from CP_GET_STATE. Only returns readout mode
and MCP voltage.
Version 2, William Thompson, GSFC, 29 February 1996
Added NIS_HT to output structure.
Version : Version 2, 29 February 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_VDS_STATE
Purpose : Gets VDS state database information.
Explanation : This returns a structure containing information about various
quasi-static VDS parameters.
Use : GET_VDS_STATE, DATE, DESC, ERRMSG=ERRMSG
Inputs : DATE = The date/time value that the user wishes the state
for. This can be in any of the standard CDS time
formats.
Opt. Inputs : None.
Outputs : DESC = Structure containing the state description. It
contains the following tags:
DATE = Start date and time for the period for
which the parameters in this record are
valid. The period ends at the start
date/time of the next record. This is a
double precision TAI value. If no entries
are found, then a simplified structure is
returned with this set to zero.
VDS_READ = Code value (1-7) giving the VDS readout
mode.
VDS_PMCP = Programmable voltage (0--255) controlling
the voltage across the VDS microchannel
plate.
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 = ''
GET_STATE, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CP_GET_HISTORY, DATATYPE [1], DATATYPE [2]
DATATYPE [3], UTC2TAI
CALLED BY:
CALC_RAS_DUR, LOAD_TP_STRUCT, MK_RASTER, RASTER_DUR
Common : None.
Restrictions: None.
Side effects: None.
Category : Command preparation.
Prev. Hist. : Adapted from CP_GET_STATE by Martin Carter.
Written : William Thompson, GSFC, 22 February 1996
Modified : Version 1, William Thompson, GSFC, 22 February 1996
Adapted from CP_GET_STATE. Only returns readout mode
and MCP voltage.
Version : Version 1, 22 February 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_VDS_WIN()
Purpose : Calculate VDS windows from data windows
Explanation : This procedure takes a desired data extraction window list, and
calculates the corresponding VDS window list. The VDS window
list will depend on the VDS readout mode. In the standard
readout mode, all VDS windows are in the first quadrant, and
are reflected into all other quadrants.
Any overlapping data windows are merged together in the
resulting VDS window list. Also, no matter how may data
windows are passed, a maximum of 10 VDS windows will be
returned.
Use : VDSWIN = GET_VDS_WIN( DEW, MODE )
Inputs : DEW = Integer array of dimensions (N,4) where N is the
number of data extraction windows, and the second
dimension has the meaning:
(Xstart, Ystart, Xlength, Ylength)
MODE = VDS readout mode, i.e.
1 Full quadrature readout (A,B,C,D)
2 Readout through quadrants A,D only
3 Readout through quadrants B,C only
4 Readout through quadrant A only
5 Readout through quadrant B only
6 Readout through quadrant C only
7 Readout through quadrant D only
Opt. Inputs : None.
Outputs : The result of the function is an array of dimensions (M,4)
where M is the number of calculated VDS windows, and the second
dimension has the same meaning as in the input array.
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 = ''
Result = GET_VDS_WIN(DEW,MODE,ERRMSG=ERRMSG)
IF ERRMSG NE '' THEN ...
Calls : None.
CALLED BY:
CALC_RAS_DUR, RASTER_DUR, TP_VWIN_LOGIC
Common : None.
Restrictions: This routine assumes that all data extraction windows are
valid, although some may have zero widths.
Side effects: None.
Category : Planning, Technical.
Prev. Hist. : None. However, influenced by TP_FIRST_QUAD by C. D. Pike.
Written : William Thompson, GSFC, 3 January 1995
Modified : Version 1, William Thompson, GSFC, 3 January 1995
Version 2, William Thompson, GSFC, 17 May 1996
Force windows to go across entire CCD
Version : Version 2, 17 May 1996
[Previous]
[Next]
Project : SOHO - CDS
Name :
GET_VIEWPORT
Purpose :
Gets current viewport values, in device coordinates.
Explanation :
Gets the current values of the viewport, in the form of the
old-fashioned variables !SC1, !SC2, !SC3, and !SC4. This supports
those routines that were originally developed for IDL version 1.
The routine calculates the system variables by generating a dummy plot
without actually drawing to the screen.
Use :
GET_VIEWPORT, SC1, SC2, SC3, SC4
Inputs :
None.
Opt. Inputs :
None.
Outputs :
SC1, SC2, SC3, SC4 are the device coordinates of the viewport.
Opt. Outputs:
None.
Keywords :
None.
Calls :
None.
CALLED BY:
SETIMAGE, SETSCALE [1], SETSCALE [2], SET_SERTSW
Common :
None.
Restrictions:
In general, the SERTS graphics devices routines use the special system
variables !BCOLOR and !ASPECT. These system variables are defined in
the procedure DEVICELIB. It is suggested that the command DEVICELIB be
placed in the user's IDL_STARTUP file.
Side effects:
None.
Category :
Utilities, Devices.
Prev. Hist. :
William Thompson, November 1992.
William Thompson, November 1992, modified to get parameters by
generating a dummy plot rather than calculating directly, so as
to be compatible with !P.MULTI.
William Thompson, December 1992, corrected bug where certain system
variables were being changed by this routine.
Written :
William Thompson, GSFC, November 1992.
Modified :
Version 1, William Thompson, GSFC, 27 April 1993.
Incorporated into CDS library.
Version 2, William Thompson, GSFC, 12 January 1994.
Modified to avoid problems that may arise when !X.STYLE or
!Y.STYLE is not zero.
Version :
Version 2, 12 January 1994.
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_WAVE_EFF
Purpose : Gets an efficiency versus wavelength curve from database
Category : CDS, Calibration, Class3
Explanation : Looks up the correct calibration curve for the efficiency as a
function of wavelength. First, the software finds the largest
effect date which is on or earlier than the observation date.
If there are multiple entries with the same effective date,
then the one with the latest entry date is used.
Note that the actual efficiency is the product of the
efficiency returned by this routine, times the wavelength
dependence returned by GET_WAVE_EFF. The latter is a
polynomial which will pass through unity at some reference
wavelength. The entire calibration curve would be derived with
the following statements:
WAVE1 = PIX2WAVE('N1', INDGEN(1024))
GET_EFFICIENCY, date_obs, 'N1', EFF1
GET_WAVE_EFF, date_obs, 'N1', COEFF1
EFF1 = EFF1 * POLY(WAVE1, COEFF1)
Syntax : GET_WAVE_EFF, DATE_OBS, SPECTRUM, COEFF
CALLED BY:
GET_EFFICIENCY, NIS_AVG_SPECT_DEMO, NIS_CALIB, QCALIB
Examples : GET_WAVE_EFF, '1996/09/16', 'N1', COEFF
Inputs : DATE_OBS = The date the observation was made.
SPECTRUM = A character string representing the spectrum,
e.g. "N1" or "NIS1".
Opt. Inputs : None.
Outputs : COEFF = The polynomial efficients representing the relative
efficiency curve, expressed as a function of
wavelength.
Opt. Outputs: None.
Keywords : DATE_USED = If a date is passed in through this keyword, then
the most recent efficiency as of this date will be
returned. This is useful for comparing what the
routine would have returned on a given date against
what it currently returns. For example,
GET_WAVE_EFF, '1-Mar-1997', 'N1', OLD_EFF, $
DATE_USED='10-Apr-1997'
GET_WAVE_EFF, '1-Mar-1997', 'N1', NEW_EFF
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 = ''
GET_WAVE_EFF, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2], 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], DBSORT [1], DBSORT [2], DBSORT [3], TRIM
Common : None
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 16-Sep-1996, William Thompson, GSFC
Version 2, 02-Jun-1998, William Thompson, GSFC
Added keyword DATE_USED
Version 3, 21-May-2002, William Thompson, GSFC
Allow N4 for NIS-2 second order.
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_WAVECAL
Purpose : Get the wavelength calibration for a given date.
Category : Calibration, GIS, NIS, Wavelength
Explanation : Looks up the wavelength calibration in the database for a given
detector, date, and GSET_ID combination. First, the software
finds the largest effective date which is on or earlier than
the observation date. If there are multiple entries with the
same effective date, then the one with the latest entry date is
used.
Syntax : GET_WAVECAL, DETECTOR, REQ_DATE, WAVECAL [, GSET_ID=GSET_ID ]
CALLED BY:
LOAD_WAVECAL, MK_WAVECAL, READCDSFITS, mk_gset
Examples : GET_WAVECAL, 'N', DATE, WAVECAL
IF WAVECAL.DATE NE '' THEN ...
Inputs : DETECTOR = Either "NIS" or "GIS" (can be abbreviated).
REQ_DATE = The date to use in searching for a wavelength
calibration.
Opt. Inputs : None.
Outputs : WAVECAL = A structure containing the information about the
wavelength calibration. It contains the following
tags:
DATE = The registration date for the calibration,
in truncated CCSDS format. If unsuccessful,
then a simpler structure is returned with
DATE set to the null string.
GSET_ID = GIS Setup ID number. Not included for NIS
data.
FILENAME = The name of the file that the calibration is
based on.
COEFF = The wavelength calibration coefficients.
The dimensions depend on the spectrometer
used.
For the NIS spectrometer, the dimensions are
(2,2,2) with the following meanings:
Dim1 = NIS1 (0) or NIS2 (1)
Dim2 = Linear or quadratic coefficients
Dim3 = Coeff. are for wave->pix (0) or
for pix->wave (1)
For the GIS spectrometer, the dimensions are
(4,3,2) with the following meanings:
Dim1 = Detector number (0-3)
Dim2 = Quadratic coefficients
Dim3 = Coeff. are for wave->pix (0) or
for pix->wave (1)
Opt. Outputs: None.
Keywords : GSET_ID = The GIS Setup ID that the wavelength calibration
refers to. This is a required keyword for
retrieving GIS wavelength calibrations.
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 = ''
GET_WAVECAL, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], Bell, DATATYPE [1], DATATYPE [2], DATATYPE [3]
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], DBSORT [1]
DBSORT [2], DBSORT [3], GET_UTC, NTRIM, TRIM, UTC2TAI
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 05-Mar-1996, William Thompson, GSFC
Version 2, 12-Mar-1996, William Thompson, GSFC
Add /ATTENTION to call to CDS_MESSAGE
Return named structures.
Version 3, 19-Mar-1996, William Thompson, GSFC
Removed call to CDS_MESSAGE
Version 4, 05-Jul-1996, William Thompson, GSFC
Change NIS coefficients to second order.
Version 5, 18-Apr-1997, William Thompson, GSFC
Use DATE_EFF in database.
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : GET_WIDTH_CORR()
Purpose : Get adjustments for selected NIS line widths.
Category : Class3, Calibration
Explanation : The narrow-slit burn-in correction applied to the CDS/NIS data
does not entirely restore the spectral line shapes to their
unburned-in condition. As a result, the average widths of some
lines slowly change over time, as does the integrated
brightness over the line. These changes can be tracked with
the weekly NISAT_S study. Only some lines show significant
width variations with time, and the behavior of each spectral
line is unique.
This routine reads in data files storing adjustment factors for
the various spectral lines which show significant line width
variation, so that the width can be adjusted to a consistent
value. These adjustments can be applied to the fitted
intensity, to account for the brightness changes caused by the
width changes.
Although the result of this function is a correction factor for
the line width, it is not necessarily true that the adjusted
width will be the true width of the line. The widths are also
not necessarily correct for dates extrapolated past the
creation date of the data file.
The line width corrections are critically dependent on the
narrow-slit burn-in correction. Thus, each time the burn-in
calibration is changed, the line width calibration also needs
to be changed.
Syntax : Result = GET_WIDTH_CORR( DATE, WAVELENGTH [, IDENTITY ] )
Examples : Result = GET_WIDTH_CORR('1998-Jan-3', 584.3, 'He I')
Inputs : DATE = The observation date. Can also be an array of
dates.
WAVELENGTH = The wavelength of the line. Second-order lines
can be specified by either their first- or
second-order wavelengths. For example, the He II
line at 303.8 A can be specified as either 303.7
or 607.6.
It's important to specify the wavelength as
precisely as possible, to avoid confusion with
nearby lines. For example, trying to specify the
He II line with a wavelength of 608 (or 304)
causes confusion with the O IV line at 608.3 A.
Similar confusion is possible between the He II
line and the Si IX line at 303.3 A. Since two
lines can be right next to each other, and have
completely different width variations, getting two
nearby lines confused will give the wrong
correction factor.
Even where there is no chance of ambiguity, the
wavelength must be specified to within +/- 0.25 A
to find the correct line.
Opt. Inputs : IDENTITY = Entering in an identity for a spectral line
removes the ambiguity in line identification, and
allows more leeway (+/- 1 A) in entering in the
wavelength. For example,
Result = GET_WIDTH_CORR(Date, 304)
is likely to give an incorrect result, while
Result = GET_WIDTH_CORR(Date, 304, 'He II')
will give the correct result.
Outputs : The result of the function is the amount to multiply the line
width (or integrated intensity) by to correct for the slowly
varying width.
Opt. Outputs: None.
Keywords : CALIBRATION = The number of the line width calibration to use.
The default is to use the most up-to-date
calibration.
Calls : ***
ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2], DATATYPE [1], DATATYPE [2]
DATATYPE [3], DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4]
FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3], NTRIM, POLY, STR_SEP
delvarx [5]
Common : None.
Restrictions: The data files line_widths_pre*a.dat and _post*a.dat must be in
the directory $CDS_VDS_CAL_INT.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 18-May-2001, William Thompson
Version 2, 27-Jun-2001, William Thompson
Allow DATE to be an array.
Contact : WTHOMPSON
[Previous]
[Next]
Name: get_xfont
Purpose: return font (front end filter to device,get_font=)
Input Parameters:
pattern - font pattern to match
Keyword Parameters:
only_one - return one match as a scaler string
fixed - if set, only fixed sized fonts (example: for table output)
closest - if set, font size (select closest size to this if mulitple)
CALLS: ***
str2number [1], str2number [2], str_replace [1], str_replace [2], strsplit
CALLED BY:
CHOOSE_FL, disp_gen [1], disp_gen [2], favviewer, set_font, show_pix [1]
show_pix [2], verify_gui, xanal_emi, xcheckip, xdate [1], xdate [2], xdisp_fits
xdisp_sci5k, xdisp_tfr, xdisp_trace [1], xdisp_trace2, xdisp_trace3, xgen_widget
xhkplot, xread_hist, xsearch_obs, xset_chain [1], xset_chain [2], xspr [1], xspr [2]
xwrite_hist
History:
25-mar-95 (SLF)
10-Apr-95 (MDM) - Fixed a typo "xfont" versus "xfonts"
2-May-95 (SLF) - font format protections (call str2number)
[Previous]
[Next]
Name: get_ydbhelp
Purpose: return one line descriptions about each input prefix
Calling Sequence:
help=get_ydbhelp(prefixs)
Calling Examples:
more,get_ydbhelp(['nar','fem','att'])
CALLS: ***
RD_PREFIX_DOC, data_chk [1], data_chk [2], str_replace [1], str_replace [2]
CALLED BY:
mk_ydbtab, rd_ydbtap
History:
15-Jun-1994 (SLF) - provide help for rd_ydbtap
[Previous]
[Next]
NAME:
get_yo_dates
PURPOSE:
Return significant Yohkoh dates.
CALLING SEQUENCE:
Launch = get_yo_dates(/launch) ; Return launch date
SXT_ent= get_yo_dates(/entrance) ; Date SXT entrance filter failed
SXT_ent= get_yo_dates(/entr,/verbos); Provide additional information
SXT_ent= get_yo_dates(/entr,/ver,/head); Provide additional information with header
SXT_ent= get_yo_dates(/entr,/value) ; Provide values of entrance filter
SC_pnt = get_yo_dates(/pointing) ; Dates of S/C pointing changes
SC_pnt = get_yo_dates(/poi,verbose) ; Provide additional information
SC_pnt = get_yo_dates(/poi,/val) ; Return the values
moon = get_yo_dates(moon=1) ; Get first eclipse date
mercury= get_yo_dates(/mercury) ; Get the mercury date
SC_pnt = get_yo_dates(index,/point) ; Return nominal pointing time of index
OPTIONAL INPUTS:
index = Standard Yohkoh index or time in any Yohkoh format
OPTIONAL INPUT KEYWORDS:
launch = Set to return launch date
entrance = Set to return dates when SXT entrance filter transmission changed
Value returned the fractional open area
pointing = Set to return dates of Yohkoh spacecraft pointing
verbose = Set to return additional information as a string vector
value = Set to return the associated value (rather than the date)
header = If verbose is set, return a header as first element of output
string vector
CALLED BY:
SXT_BAKEOUT_IN, SXT_TEEM2 [1], SXT_TEEM2 [2], SXT_TEEM2 [3], choose_sfc
get_epoch_sfcs [1], get_epoch_sfcs [2], go_lasdisk golaserdisk
go_lasdisk2 golaserdisk, mk_sdcs, mk_sfc [1], mk_sfc [2], mk_sff_pair [1]
mk_sff_pair [2], mk_sft [1], mk_sft [2], mk_ssc [1], mk_ssc [2], mk_syn_sfc [1]
mk_syn_sfc [2], mk_synsfc_coeff [1], mk_synsfc_coeff [2], mk_ydbtab, search_obs
sel_leak_image [1], sel_leak_image [3], sel_leak_image [4], sfc_prep [1]
sfc_prep [2], ssc_files [1], ssc_files [2], ssc_files [3], sxt_chk_era
sxt_eff_area, sxt_etemp, sxt_flux [1], sxt_flux [2], sxt_flux [3]
sxt_get_grill [1], sxt_get_grill [2], sxt_mornint, sxt_mwave, sxt_prep [1]
sxt_prep [2], sxt_prep [3], sxt_uvf_info [1], sxt_uvf_info [3], xdate [1]
xdate [2], xsearch_obs, yo_mkos1_dbase
RESTRICTIONS:
The keywords launch, entrance and pointing are mutually exclusive.
MODIFICATION HISTORY:
25-jan-93, J. R. Lemen LPARL, Written
22-aug-95, S. L. Freeland - second entrance filter failure
[Previous]
[Next]
Project : SOHO - LASCO/EIT
Name : GETBKGIMG
Purpose : Get background image for given telescope
Explanation : This routine returns a model image (stray light and/or
f-corona) for a given telescope, date, image size.
Use : bkgimg = GETBKGIMG(hdr, model_hdr)
Inputs : None.
Opt. Inputs : ops Start time of display in TAI.
Outputs : None.
Opt. Outputs: None.
Keywords : use /FFV to return full field of view model (1024x1024 image)
use /ALL to return yearly minimum otherwise closest monthly minimum images
are interpolated for given date
use /ANY_YEAR to return monthly minimum over multiple years.
ROLLED Look in $MONTHLY_IMAGES/rolled
Calls : ***
ABBRV_FILPOL, BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], DATATYPE [1]
DATATYPE [2], DATATYPE [3], FILEPATH, FILE_EXIST [2], FIND_CLOSEST, GET_ROLL_OR_XY
LASCO_FITSHDR2STRUCT, LASCO_READFITS [1], LASCO_READFITS [2], ROLL_TIMES
STR2UTC [1], STR2UTC [2], STR2UTC [3], TRIM, UTC2DOY, UTC2STR, UTC2TAI, UTC2YYMMDD
YYMMDD2UTC, break_file [4], file_exist [1], file_exist [3]
CALLED BY:
DIFBKGND, MAKE_DAILY_IMAGE, MKMOVIE, MKMOVIE0 obsolete version of mkmoviepro
MKMOVIEWLC, MK_IMG, REMOVE_CR, RTMOVIE
Common : SOHO_DATA Contains start and end times of SOHO roll periods.
Restrictions: None.
Side effects: None.
Category : Data analysis
Prev. Hist. : None.
Written : Scott Paswaters, NRL
Modified : 06 Oct 1997 SEP - Added year independent option /ANY_YEAR
28 Jul 1998 NBR - added time to tai computation; comment out
STRPUT lines in interpolation section
23 Sep 1998 NBR - finish repair to year difference problem in interpolation
29 Sep 1998 NBR - for /FFV, rebin result to size of input image
5 Oct 1998 NBR - add call for level_1 images
13 Nov 1998 NBR - Fix year difference repair
25 Mar 1999 NBR - Do not interpolate if DATE_OBSs are equal
6 Apr 1999 NBR - Use congrid to resize if necessary
9 Apr 1999 NBR - Set year2 = year1 for ANY_YEAR
Dec 1999 NBR - Fix Y2K glitch for finding ind
Jan 2000 NBR - Tinker with resize of imgm; ReFix y2k bug for finding ind
Feb 2000 NBR - Rebin both imgm and imgm2 before interpolating
Jun 2000 NBR - Add ROLL keyword for rolled images
3/23/01, NBR - Check if bkgimg should be rolled in this procedure, making ROLL keyword
unnecessary
3/30/01, NBR - Redo year problem for any-year
11/20/01, NBR - Use ROLL_TIMES.pro and change ROLL to ROLLED to be consistent with other pros
12/17/01, NBR - Fix ANY_YEAR end-of-year problem
3/ 8/02, NBR - Fix computation of factor for interpolation
7/10/02, NBR - Implement new method of finding images (not offset by 14 days) (except for
ANY_YEAR)
030721 jake added "OR hdr.CROTA1 EQ 180." to ROLLED check
9/03/03, NBR - change hdr.CROTA1 check
03.10.10, nbr - Do ANY_YEAR if time since last available CURRENT monthly image is GT 15 days
04.02.18, nbr - use doy to determine endofyear and begofyear
04.03.02, nbr - Change behavior when model is >15 days old
04.04.09, nbr - Level-1 bkg is ANY_YEAR only
05/09/2006 KarlB - Level-1 bkg no longer ANY_YEAR. Various mods have been made to allow for
level-1 processed backgrounds. None of these changes affect LZ/QL data.
@(#)getbkgimg.pro 1.24, 05/09/06 - NRL LASCO IDL Library
(SCCS variables for IDL use)
[Previous]
[Next]
NAME:
GETCOLOR
PURPOSE:
The original purpose of this function was to enable the
user to specify one of the 16 colors supported by the
McIDAS color map by name. Over time, however, the function
has become a general purpose function for handling and
supporting drawing colors in a device-independent way.
In particular, I have been looking for ways to write color
handling code that will work transparently on both 8-bit and
24-bit machines. On 24-bit machines, the code should work the
same where color decomposition is turned on or off. The program
now supports 88 colors.
AUTHOR:
FANNING SOFTWARE CONSULTING:
David Fanning, Ph.D.
1645 Sheely Drive
Fort Collins, CO 80526 USA
Phone: 970-221-0438
E-mail: davidf@dfanning.com
Coyote's Guide to IDL Programming: http://www.dfanning.com
CATEGORY:
Graphics, Color Specification.
CALLING SEQUENCE:
result = GETCOLOR(color, index)
OPTIONAL INPUT PARAMETERS:
COLOR: A string with the "name" of the color. Valid names are:
black
magenta
cyan
yellow
green
red
blue
navy
pink
aqua
orchid
sky
beige
charcoal
gray
white
The color YELLOW is returned if the color name can't be resolved.
Case is unimportant.
If the function is called with just this single input parameter,
the return value is either a 1-by-3 array containing the RGB values of
that particular color, or a 24-bit integer that can be "decomposed" into
that particular color, depending upon the state of the TRUE keyword and
upon whether color decomposition is turned on or off. The state of color
decomposition can ONLY be determined if the program is being run in
IDL 5.2 or higher.
INDEX: The color table index where the specified color should be loaded.
If this parameter is passed, then the return value of the function is the
index number and not the color triple. (If color decomposition is turned
on AND the user specifies an index parameter, the color is loaded in the
color table at the proper index, but a 24-bit value is returned to the
user in IDL 5.2 and higher. This assumes the INDEXED keyword is NOT set.)
If no positional parameter is present, then the return value is either a 16-by-3
byte array containing the RGB values of all 16 colors or it is a 16-element
long integer array containing color values that can be decomposed into colors.
The 16-by-3 array is appropriate for loading color tables with the TVLCT command:
Device, Decomposed=0
colors = GetColor()
TVLCT, colors, 100
INPUT KEYWORD PARAMETERS:
NAMES: If this keyword is set, the return value of the function is
a 88-element string array containing the names of the colors.
These names would be appropriate, for example, in building
a list widget with the names of the colors. If the NAMES
keyword is set, the COLOR and INDEX parameters are ignored.
listID = Widget_List(baseID, Value=GetColor(/Names), YSize=16)
INDEXED: If this keyword is set, the return value is always an index
into the color table. In the absence of a color table INDEX
parameter, the color is loaded at !P.COLOR < (!D.Table_Size-1).
LOAD: If this keyword is set, all 88 colors are automatically loaded
starting at the color index specified by the START keyword.
Note that setting this keyword means that the return value of the
function will be a structure, with each field of the structure
corresponding to a color name. The value of each field will be
an index number (set by the START keyword) corresponding to the
associated color, or a 24-bit long integer value that creates the
color on a true-color device. What you have as the field values is
determined by the TRUE keyword or whether color decomposition is on
or off in the absense of the TRUE keyword. It will either be a 1-by-3
byte array or a long integer value.
START: The starting color index number if the LOAD keyword is set. This keyword
value is ignored unless the LOAD keyword is also set. The keyword is also
ignored if the TRUE keyword is set or if color decomposition in on in
IDL 5.2 and higher. The default value for the START keyword is
!D.TABLE_SIZE - 89.
TRUE: If this keyword is set, the specified color triple is returned
as a 24-bit integer equivalent. The lowest 8 bits correspond to
the red value; the middle 8 bits to the green value; and the
highest 8 bits correspond to the blue value. In IDL 5.2 and higher,
if color decomposition is turned on, it is as though this keyword
were set.
CALLS: ***
COLOR24
COMMON BLOCKS:
None.
SIDE EFFECTS:
None.
RESTRICTIONS:
The TRUE keyword causes the START keyword to be ignored.
The NAMES keyword causes the COLOR, INDEX, START, and TRUE parameters to be ignored.
The COLOR parameter is ignored if the LOAD keyword is used.
On systems where it is possible to tell the state of color decomposition
(i.e., IDL 5.2 and higher), a 24-bit value (or values) is automatically
returned if color decomposition is ON.
EXAMPLE:
To load a yellow color in color index 100 and plot in yellow, type:
yellow = GETCOLOR('yellow', 100)
PLOT, data, COLOR=yellow
or,
PLOT, data, COLOR=GETCOLOR('yellow', 100)
To do the same thing on a 24-bit color system with decomposed color on, type:
PLOT, data, COLOR=GETCOLOR('yellow', /TRUE)
or in IDL 5.2 and higher,
DEVICE, Decomposed=1
PLOT, data, COLOR=GETCOLOR('yellow')
To load all 88 colors into the current color table, starting at
color index 100, type:
TVLCT, GETCOLOR(), 100
To add the color names to a list widget:
listID = Widget_List(baseID, Value=GetColor(/Names), YSize=16)
To load all 88 colors and have the color indices returned in a structure:
DEVICE, Decomposed=0
colors = GetColor(/Load, Start=1)
HELP, colors, /Structure
PLOT, data, COLOR=colors.yellow
To get the direct color values as 24-bit integers in color structure fields:
DEVICE, Decomposed=1
colors = GetColor(/Load)
PLOT, data, COLOR=colors.yellow
Note that the START keyword value is ignored if on a 24-bit device,
so it is possible to write completely device-independent code by
writing code like this:
colors = GetColor(/Load)
PLOT, data, Color=colors.yellow
MODIFICATION HISTORY:
Written by: David Fanning, 10 February 96.
Fixed a bug in which N_ELEMENTS was spelled wrong. 7 Dec 96. DWF
Added the McIDAS colors to the program. 24 Feb 99. DWF
Added the INDEX parameter to the program 8 Mar 99. DWF
Added the NAMES keyword at insistence of Martin Schultz. 10 Mar 99. DWF
Reorderd the colors so black is first and white is last. 7 June 99. DWF
Added automatic recognition of DECOMPOSED=1 state. 7 June 99. DWF
Added LOAD AND START keywords. 7 June 99. DWF.
Replaced GOLD with CHARCOAL color. 28 Oct 99. DWF.
Added INDEXED keyword to force indexed color mode. 28 Oct 99. DWF.
Fixed problem of "aqua" and "pink" being mixed up. 18 Mar 00. DWF.
Changed ON_ERROR from 1 to 2, and improved error handling. 2 Aug 00. DWF.
Increased the known colors from 16 to 88. 19 October 2000. DWF.
[Previous]
[Next]
pckt = array of packets from TLM stream generated by DACS organized
with time as the second dimension
firstday is the kday number of the first day in time
time is a floating array of the number of hours since firstday
cpu time is year, doy, hour, min, sec
word: 1, 2 , 3 , 4 , 5
modified for pckt in either bytes or words, 3 Mar 1996 RAH
22 Mar 1996 RAH, if byte packets, then assume read in with /no_hdr option
@(#)getcputime.pro 1.1 01/23/98 :LASCO IDL LIBRARY
CALLS:
CALLED BY
FIX_DUP_PCKT, PLOT_HKLZ, gethkhr, plot_temps2 [1]
[Previous]
[Next]
NAME: getcurstr
Purpose: given ptrs to current values of menu keys assemble
the current key string.
CALLS: ***
ARR2STR [1], Arr2Str [2]
CALLED BY:
wmkkey_event [1], wmkkey_event [2]
History: written 14-jan-92
[Previous]
[Next]
$Id: getenv_slash.pro,v 1.1 2006/10/10 15:44:43 nathan Exp $
PROJECT: STEREO/SECCHI, SOHO/LASCO
NAME: GETENV_SLASH
PURPOSE: Calls GETENV to return the environment variable, and then checks to
see if a slash is at the end of the string and appends one if there
isn't.
CATEGORY: REDUCE, operating system, utility, file
CALLING SEQUENCE:
Result = GETENV_SLASH (Envvar)
INPUTS:
Envvar = String of the environment variable
OUTPUTS:
Result = Environment variable with a slash (delimiter)
CALLED BY:
CNVRT_ABC [2], COMB_FULL_EQ, FITS_HDR_LIST, FIX_TIME_JUMP, GET_MISSING_PCKTS
LZ_DISK_INIT [1], LZ_DISK_INIT [2], LZ_DISK_INIT3, MAKE_DIFF_MPEG
READ_CARR_LONG, REDUCE_IMG_HDR, REDUCE_IMG_HDR2, REDUCE_LEVEL_05, REDUCE_LEVEL_1
REDUCE_MAIN, REDUCE_TRANSFER, RTMVI [1], UNPACK_ALL_SCIENCE, UNPACK_LZ_SCIENCE
UNPACK_REDUCE_MAIN, WRITE_HT, WRITE_LAST_IMG [1], WRITE_LAST_IMG [2]
PROCEDURE:
If the environment variable is defined, a slash is appended to the
string returned by GETENV.
CALLS: ***
GET_DELIM
EXAMPLE:
s = GETENV_SLASH ('LEB_IMG')
If $LEB_IMG is defined to be /net/lasco6/data/packets
then the result would be: /net/lasco6/data/packets/
MODIFICATION HISTORY:
Written RA Howard, NRL, 1 Nov 1995
Version 1 RAH, Initial Release
Version 2 RAH, Use system variable !delimiter
8.16.01, NBR - Check existence of !delimiter using datatype
12.17.01, NBR - Use get_delim.pro instead of '/'
NRL LASCO IDL LIBRARY
$Log: getenv_slash.pro,v $
Revision 1.1 2006/10/10 15:44:43 nathan
updated version of LASCO utility
10/06/06 RCC - Check existence of !delimiter using defsysv
[Previous]
[Next]
NAME:
GETFITSVAL
PURPOSE:
Extract a string parameter from a FITS header.
CATEGORY:
File IO.
CALLING SEQUENCE:
STRING=GETFITSVAL,HEADER,KEYWORD
INPUTS:
HEADER, fitsheader
KEYWORD, keyword whose value to extract
KEYWORD PARAMETERS:
OUTPUTS:
STRING, extracted string from header, following the blank after the '=' sign.
CALLS: ***
FIND_KEY
CALLED BY:
FITSRD
SIDE EFFECTS:
RESTRICTIONS:
Assumes absolutely correct syntax of fits header (quotes at right places, etc)
PROCEDURE:
MODIFICATION HISTORY:
Jul. 1992 I. Zayer LPARL
[Previous]
[Next]
hk = array of all monitors from HK TLM stream generated by DACS
pcktnum is a number from 1 to 3 indicating one of the three HK packet
types
When Who What
Dec 09 1998 aee Added dacs and ecs keywords. Default is dacs.
@(#)getfphkn.pro 1.1 01/23/98 :LASCO IDL LIBRARY
[Previous]
[Next]
hk = array of all monitors from HK TLM stream generated by DACS
hr is a number from 0 to 23 indicating the starting hour to be returned
nhr is a number indicating the number of hours to be included
@(#)gethkhr.pro 1.1 01/23/98 :LASCO IDL LIBRARY
CALLS:
[Previous]
[Next]
hk = array of all monitors from HK TLM stream generated by DACS
pcktnum is a number from 1 to 3 indicating one of the three HK packet
types
@(#)gethkn.pro 1.1 01/23/98 :LASCO IDL LIBRARY
CALLED BY
GET_BAD_CMDS, MOTOR_DECODE, PLOT_HKLZ, get_cmds, get_tce_comm_errs, getlobt
plot_temps2 [1]
[Previous]
[Next]
Project : SOHO - LASCO/EIT
Name : GETIDLPID
Purpose : Returns IDL Process ID
Use : IDL> result = GETIDLPID()
Inputs :
Optional Inputs:
Outputs :
Keywords :
Comments :
CALLED BY:
GET_CACHE
Side effects:
Category :
Written : Jake Wendt, NRL, April 10, 2002
Version :
07/10/03 @(#)getidlpid.pro 1.4
[Previous]
[Next]
NAME:
GETIMAGE
PURPOSE:
The purpose of this function is to allow the user to open either
regular or XDR binary image files of two or three dimensions.
CATEGORY:
Widgets, File I/O.
CALLING SEQUENCE:
image = GETIMAGE(filename)
OPTIONAL INPUTS:
filename: The name of the file to open for reading.
OPTIONAL KEYWORD PARAMETERS:
CANCEL: An output variable that can be set to a named variable.
The value of the return variable will be 1 if the user clicked
the "Cancel" button or if there was a problem reading the file.
CATCH: Set this keyword to 0 if you wish to turn error catching OFF.
DIRECTORY: The name of the directory the file is located in. By
default the program looks in the "coyote" directory under the
main IDL directory, if one exists. Otherwise, it defaults to the
current directory.
FRAMES: The 3rd dimension of a 3D data set. Defaults to 0.
HEADER: The size of any header information in the file in BYTES.
Default is 0.
PARENT: The group leader for this widget program. The PARENT is
required if GETIMAGE is called from another widget program in order
to make this program a MODAL widget program.
XDR: Set this keyword if the binary file is of XDR type.
XOFFSET: This is the X offset of the program on the display. The
program will be placed approximately in the middle of the display
by default.
XSIZE: The size of the 1st dimension of the data.
YOFFSET: This is the Y offset of the program on the display. The
program will be placed approximately in the middle of the display
by default.
YSIZE: The size of the 2nd dimension of the data.
CALLS: ***
COYOTE_FIELD, COYOTE_FIELD_EVENT_HANDLER, COYOTE_FIELD_GET_VALUE
COYOTE_FIELD_KILL_NOTIFY, COYOTE_FIELD_RETURNVALUE, COYOTE_FIELD_SET_VALUE
COYOTE_FIELD_VALIDATE, COYOTE_FIELD__DEFINE, FGETIMAGE, FILEPATH
GETIMAGE_CENTERTLB, GETIMAGE_EVENT, GETIMAGE_FIND_COYOTE, GETIMAGE_NULL_EVENTS
XMANAGER
COMMON BLOCKS:
None.
SIDE EFFECTS:
A "CANCEL" operation is indicated by a 0 return value.
Any error in reading the file results in a 0 return value.
RESTRICTIONS:
None.
EXAMPLE:
To load the image "galaxy.dat" in the $IDL/examples/data
directory, type:
image = GETIMAGE('galaxy.dat', DIRECTORY=!DIR + '/examples/data', $
XSIZE=256, YSIZE=256, Cancel=cancelled, Parent=event.top)
IF NOT cancelled THEN TV, image
MODIFICATION HISTORY:
Written by: David Fanning, 3 February 96.
Fixed bug that prevented reading INTEGER data. 19 Dec 96.
Modifed program for IDL 5 MODAL operation. 19 Oct 97.
Added CANCEL keyword. 27 Oct 97. DWF.
Fixed CANCLE keyword spelling. Sigh... 29 JUN 98. DWF.
Added COYOTE_FIELD, improved appearance. 19 NOV 99. DWF.
Updated with latest version of COYOTE_FIELD. 18 FEB 2000. DWF.
Added CATCH keyword so the program will break when I want
it to. :-) 18 MAR 2000. DWF.
Added GROUP_LEADER keyword, which is synonymous with PARENT. 31 MAR 2000. DWF.
Updated obsolete PICKFILE call to DIALOG_PICKFILE. 17 JAN 2001. DWF.
2/5/04, nbr - Rename for SSW compatability
[Previous]
[Next]
PROJET
SOHO-LASCO
NAME:
getl05hdrparam
PURPOSE:
Extracts from fits header parameters of the image
CATEGORY
Fits Management
CALLING SEQUENCE:
getl05hdrparam,hdr,hdrfieldstruct
INPUTS:
hdr : header of a C2 or C3 image
KEYWORD INPUT:
offsetbias : set to compute the electronical offset bias
OPTIONAL INPUTS PARAMETERS:
none
OUTPUTS:
structure containing image parameters
filename : FILENAME
bitpix : BITPIX
detector : DETECTOR
sx : NAXIS1
sy : NAXIS2
fystart : R1ROW-1
fxstart : R1COL-20
fyend : P2ROW-1
fxend : P2COL-20
nrebinx : (fxend-fxstart+1)/sx
nrebiny : (fyend-fystart+1)/sy
bias : bias give by offset_bias
lebxsum : LEBXSUM
lebysum : LEBYSUM
sumcolx : SUMCOL (1,2,4: 1 instead of 0 in the header)
sumrowy : SUMROW (1,2,4: 1 instead of 0 in the header)
rebindex : = nrebinx if nrebinx==nrebiny else =-1
OPTIONAL OUTPUT PARAMETERS:
none
CALLED ROUTINES:
t_param.pre_offset_bias
CALLS: ***
OFFSET_BIAS, SXPAR [1], SXPAR [2], SXPAR [3], t_param
CALLED BY:
FIND_MISS_BLOCKS, FUZZY_IMAGE
HISTORY:
V1.0 coded by A.Thernisien on 17/01/2000 based upon ima05dim.pro from A.LL
[Previous]
[Next]
returns the LASCO LOBT from HK packet 1
The order of the raw bytes is byte flipped from the sun order
@(#)getlobt.pro 1.1 01/23/98 :LASCO IDL LIBRARY
CALLS:
[Previous]
[Next]
Project : SOHO - CDS
Name :
GETLOG()
Purpose :
Returns correct logical dir. for given operating system.
Explanation :
Returns the correct logical directory for the given operating system.
E.G. dat: for vms, $DAT/ for unix.
The operating system in !version.os is checked. If it equals:
'vms' then a ':' is appended.
else unix os is assumed and the input string is
uppercased, a '$' is prepended and a '/' is
appended.
Use :
GETLOG,lname
Inputs :
lname - the base name of the logical (without special characters).
Opt. Inputs : None.
Outputs :
Returns appropriate string.
Opt. Outputs: None.
Keywords : None.
Calls : None.
Common : None.
Restrictions:
Assumes that the created directory logical will have meaning to the host
operating system.
Side effects: None.
Category : Utilities, Operating_System
Prev. Hist. :
Written, JDNeill, May, 1990.
Modified, JDNeill,Sep, 1990 -- for unix return full path instead of
just environment variable name.
Written : J. D. Neill, May 1990
Modified : Version 1, William Thompson, GSFC, 29 March 1994
Incorporated into CDS library
Version : Version 1, 29 March 1994
[Previous]
[Next]
Name: getmenu
Purpose: Get information for buliding pull-down menus.
Input/keywords:
sxt request for sxt specific menu information
Returned:
.item button label-search key
.labels "pull-down menu" labels for button label
.vals actual value for each "pull-down menu" label
.type type of operation for each "pull-down" label
CALLS: ***
MAKE_STR [1], MAKE_STR [2], gt_expmode, gt_filta, gt_filtb, gt_res
CALLED BY:
wmkkey [1], wmkkey [2]
History: written 6-Jan-92, gal
[Previous]
[Next]
Name: getsd
Purpose: return data saved in saved_data widgets
Input Parameters:
sd - widget id for saved data
Optional parameters:
index - direct access subscript
desc=desc - use string match for selection
[Previous]
[Next]
NAME: gettime
PURPOSE:
Convert time string to range, msod, day etc.
CALLING SEQUENCE:
gettime, timestr, start, stop, range, type, msod, day
INPUTS:
timestr = character string of starting and stopping time.
(10:20:34 1-jan-92 // 2:35:36 2-jan-92)
must use '//' to separate starting and topping time.
can input only starting time or only stopping time.
If the stopping time does not include day-month-year, then use
day-month-year of starting time.
If input only starting time, then STOP=START.
If input only stopping time, then START=0 0 0 0 0 0 0
OUTPUTS:
start = starting time in INT array(7)
stop = stopping time in INT array(7)
range = [[start], [stop]], Int array(7,2)
msod = h:m:s in msec, Long array(2)
day = day, int array(2)
type = To indicate type of input timestr
if type=0 have both startng and stopping time
type=1 starting time only
type=2 stopping time only
type=3 error, stoppinr time only without d-m-y
CALLS: ***
Ex2Int [1], Ex2Int [2], STR2ARR [1], STR2ARR [2], timstr2ex [1], timstr2ex [2]
CALLED BY:
usertimes_event
COMMON BLOCKS:
None
RESTRICTIONS:
Input string must be in "h:m:s day-month-year // h:m:s
day-month-year".
For example:
timestr='10:20:30 1-jan-92 // 1:3:49 2-feb-92'
Stopping time can supply h:m:s only, if supply the starting
time. (Input stopping time only must have d-m-y)
PROCEDURE:
Use str2arr function to convert time string to TIMES array.
Use timstr2ex function to convert TIMES to int START and STOP.
Get RANGE from START and STOP.(RANGE=[[START],[STOP]])
Use ex2int procedure to get MSOD and DAY from RANGE.
Also determine the type of input string.
If no "day-month-year" in stopping time, then use
"day-month-year" of starting time. But if input only stopping
time must have day-month-year. (Can not use starting d-m-y)
if type=0 have both startng and stopping time
type=1 starting time only
type=2 stopping time only
type=3 input error, stopping time only must have d-m-y
PROCEDURE CALLED:
str2arr, timstr2ex, ex2int
MODIFICATION HISTORY:
Written by Fei-Mei chou Jan, 92
[Previous]
[Next]
NAME:
GETTOK
PURPOSE:
Function to retrieve the first part of the string
until the character char is encountered.
CALLING SEQUENCE:
token = gettok( st, char )
INPUT:
char - character separating tokens, scalar string
INPUT-OUTPUT:
st - (scalar) string to get token from (on output token is removed)
OUTPUT:
token - scalar string value is returned
CALLED BY:
CMP_ALL_PRO, DATE_CONV, DBCREATE [1], DBCREATE [2], DBCREATE [3], DBFPARSE [1]
DBFPARSE [2], DBFPARSE [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], DB_ITEM [1]
DB_ITEM [2], DB_ITEM [3], DOC_MENU, FDECOMP [1], FDECOMP [2], FDECOMP [3], FITSDIR
FITSHDR2STRUCT, FITS_INFO [1], FITS_INFO [2], FTADDCOL, FXBTDIM [1], FXBTDIM [2]
FXPAR [1], FXPAR [2], GETOPT, GET_LIB, GET_OBJECT, HESSI SOHDATA CLASS DEFINITION
IRAFRD, JPLEPHREAD, MRDFITS [1], MRDFITS [2], MRD_STRUCT [1], MRD_STRUCT [2]
NORH_CREATE_STRUCT [1], NORH_CREATE_STRUCT [2], NORH_FITS_INTERP [1]
NORH_FITS_INTERP [2], PATH_EXPAND, PIXCOLOR, QUERYVIZIER, READCOL [1], READCOL [2]
READCOL [3], READFMT, TABLE_CALC, TABLE_EXT, TAB_FORTOSPP, TAB_PRINT, TBPRINT
fits_interp
EXAMPLE:
If ST is 'abc=999' then gettok(ST,'=') would return
'abc' and ST would be left as '999'
HISTORY
version 1 by D. Lindler APR,86
Remove leading blanks W. Landsman (from JKF) Aug. 1991
[Previous]
[Next]
Project : SOHO - CDS
Name :
GETTOK()
Purpose :
Extracts tokens from strings.
Explanation :
Function to retrieve the first part of the string until the character
char is encountered.
If ST is 'abc=999' then gettok(ST,'=') would return 'abc' and ST would
be left as '999'.
This routine is included mainly to support older routines that were
written using it. Users are encouraged to use the similar routine
STR_SEP from the IDL User's Library instead for any new routines.
Use :
Token = GETTOK(ST,CHAR)
Inputs :
ST = Scalar string to get token from. On output the first token
is removed from the string.
CHAR = Character separating tokens, scalar string
Opt. Inputs :
None.
Outputs :
The result of the function is the first token in the string, from the
beginning of the string up to the first instance of the separator
character.
Opt. Outputs:
None.
Keywords :
None.
Calls :
None.
CALLED BY:
CMP_ALL_PRO, DATE_CONV, DBCREATE [1], DBCREATE [2], DBCREATE [3], DBFPARSE [1]
DBFPARSE [2], DBFPARSE [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], DB_ITEM [1]
DB_ITEM [2], DB_ITEM [3], DOC_MENU, FDECOMP [1], FDECOMP [2], FDECOMP [3], FITSDIR
FITSHDR2STRUCT, FITS_INFO [1], FITS_INFO [2], FTADDCOL, FXBTDIM [1], FXBTDIM [2]
FXPAR [1], FXPAR [2], GETOPT, GET_LIB, GET_OBJECT, HESSI SOHDATA CLASS DEFINITION
IRAFRD, JPLEPHREAD, MRDFITS [1], MRDFITS [2], MRD_STRUCT [1], MRD_STRUCT [2]
NORH_CREATE_STRUCT [1], NORH_CREATE_STRUCT [2], NORH_FITS_INTERP [1]
NORH_FITS_INTERP [2], PATH_EXPAND, PIXCOLOR, QUERYVIZIER, READCOL [1], READCOL [2]
READCOL [3], READFMT, TABLE_CALC, TABLE_EXT, TAB_FORTOSPP, TAB_PRINT, TBPRINT
fits_interp
Common :
None.
Restrictions:
None.
Side effects:
The input parameter ST is modified by this routine, so that it has one
less token in it.
Category :
Utilities, Strings.
Prev. Hist. :
version 1 by D. Lindler APR,86
Remove leading blanks W. Landsman (from JKF) Aug. 1991
Written :
Don Lindler, GSFC/HRS, April 1986.
Modified :
Version 1, William Thompson, GSFC, 12 April 1993.
Incorporated into CDS library.
Version :
Version 1, 12 April 1993.
[Previous]
[Next]
NAME:
GETUT
PURPOSE:
Retrieve base, start, or end time from common UTCOMMON.
CATEGORY:
CALLING SEQUENCE:
GETUT,UTBASE=base,UTSTART=start,UTEND=end ,/STR,/PRI
INPUTS:
None.
INPUT PARAMETERS:
BASE, START, END - keyword parameters select which time(s) to retrieve,
times returned are double precision seconds relative to 79/1/1, 0000
or string if /STRINGIT is specified
/STRINGIT - return times in strings with format YY/MM/DD,HHMM:SS.XXX
/PRINT - print times on the terminal (prints all three if none are
specified)
CALLS: ***
ATIME [1], ATIME [2], CHECKVAR [1], checkvar [2]
CALLED BY:
BATSE_ONTIMES, EDITOC, FLISTOC, FSOC, FS_ARCHIVE_RW, FS_SUBTITLE, GETUTBASE [1]
GETUTBASE [2], POINT [1], QLDISPLAY, QL_DAY_PLOT, RATESDUMPOC, RAWDUMPOC
SPEX_COMMONS [2], SPEX_COMMONS [4], SPEX_PROC [1], SPEX_PROC [2]
SPEX_THISTORY [1], SPEX_THISTORY [2], evt_grid, fem_grid [1], fem_grid [2]
get_utevent [1], get_utevent [2], goes_log, plotman, point [2], t_utplot [1]
t_utplot [2], utcursor [1], utcursor [2]
COMMON BLOCKS:
COMMON UTCOMMON, UTBASE, UTSTART, UTEND = base, start, and
end time for X axis in double precision variables containing
seconds since 79/1/1, 00:00.
COMMON LASTDATECOM, LASTDATE = YY/MM/DD string for last entry
into SETUT
SIDE EFFECTS:
None.
RESTRICTIONS:
None.
PROCEDURE:
ATIME is called to translate UTXXX to YY/MM/DD, HHMM:SS.XXX string
UTBASE is epoch day * 86400 + msec/1000 from 79/01/01
MODIFICATION HISTORY:
Written by Richard Schwartz for IDL Version 2, Feb. 1991
[Previous]
[Next]
NAME:
GETUTBASE
PURPOSE:
Function to retrieve value of utbase fromm common UTCOMMON without
having to declare common.
CALLING SEQUENCE:
RESULT = GETUTBASE()
INPUTS:
None
CALLS: ***
GETUT [1], GETUT [2]
CALLED BY:
ASCII_RATES, CONT_READ, DATPLOT, DCFSUMMARY, DISCSP_READ, DRAW_FLARE, EVAL_SHERB
FDBREAD, FSOC, FSPLOT, FS_ARCHIVE_DRAW, FS_ARCHIVE_RW, FS_AUTO_LOG, FS_GEN_ARR
FS_GRAPH, FS_OVERLAY, GET_PRAT_TCOUN, HXARCHIVE, HXFITS, HXRBS, HXR_DC2FITS
MAP_DISCLA2CONT, MEMORY_INTRVLS, PLOTBATSE, PLOTBATSE_QL, PLOT_OCC_ONDAY
READ_DISCLA, RUN_BATSE, SAVE_DCDATA, SC4TREAD, SPEX_BACKGROUND [1]
SPEX_BACKGROUND [2], SPEX_COMMONS [2], SPEX_COMMONS [4], SPEX_HANDLES [1]
SPEX_HANDLES [2], SPEX_PROC [1], SPEX_PROC [2], SPEX_SAVE [1], SPEX_SAVE [2]
SPEX_SAVE_DATA [1], SPEX_SAVE_DATA [2], SPEX_THISTORY [1], SPEX_THISTORY [2]
UTPLOT [1], UTPLOT [2], UTPLOT [3], UTPLOT [4], UTPLOT [5], Utime2str [1]
Utime2str [2], Y_AVERAGE [1], Y_AVERAGE [2], goes_plot [1], goes_plot [2]
goes_plot [3], goes_plot [4], goes_plot [5], help_merge [1], help_merge [2]
inv_get_data_spex [2], mark_intervals, plotman, read_batse_4_spex [1]
read_batse_4_spex [2], spectro_plot2, spex_delete [1], spex_delete [2]
spex_hold [1], spex_hold [2], spex_merge [1], spex_merge [2], spex_source [1]
spex_source [2], wbs_response [1], wbs_response [2]
PROCEDURE:
GETUT is called to retrieve utbase, See GETUT.PRO description.
MODIFICATION HISTORY:
Written by Richard Schwartz for IDL VERSION 2, Feb. 1991
[Previous]
[Next]
Project : SOHO - LASCO
Name :
Purpose :
Category :
Explanation :
Syntax :
CALLED BY:
WCALCL, WCURRENT, WIMG_INFO1, WIMG_INFO3, WIMG_INFO4, WINFO_ACTIV, WLOADC, WPLOT, WPLOT1
WSUNPROFILE, las_auto_exp, las_exp_norm, od_bright, poly_diffim, tvscl_image
Examples :
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3]
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 : GHOST_AMOUNT
Purpose : Find amount of ghosting
Explanation :
Use : ghost_array = GHOST_AMOUNT (CHAN, GSET_ID, ARM_POS [,/QUIET])
Inputs : CHAN = GIS channel (1-4)
GSET_ID = gset for the observation
ARM_POS = array of arm positions for each pixel - needed
only for the default processing
Opt. Inputs : None.
Outputs : Returns amount of ghosting for each pixel address
Opt. Outputs: None.
Keywords : QUIET = Do not report informational messages
Calls : ***
CHKARG, FILE_EXIST [2], TRIM, file_exist [1], file_exist [3]
CALLED BY:
GHOST_BUSTER, GHOST_INFO, GHOST_PLOT_ONE
Common : None.
Restrictions: None.
Side effects: None.
Category : Calibration, GIS, Intensity.
Prev. Hist. :
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 8 July 1998
Modified : v1.1, 8 Jul 98, erb, Better messages
v1.2, 10 Jul 98, erb, Check local directory too
v1.3, 30 Nov 98, erb, Changed default regions slightly
v1.4, 5 Jan 99, erb, Made better use of /quiet keyword
v1.5, 15 Mar 99, erb, Bug in /quiet processing!
Version : v1.4
[Previous]
[Next]
Project : SOHO - CDS
Name : GHOST_BUSTER
Purpose : Move GIS detector ghosts
Explanation : This procedure takes GIS data read with READCDSFITS and
removes ghosts. It uses three different methods:
o By default, ghost buster returns the qlds with all
the ghosting regions marked as uncalibratable.
i.e., ghost_buster returns only the ghost free regions.
o Optionally (by adding the detector number) it will plot the
data from one detector and prompt for manual ghost
correction. It then asks the user to bracket
known ghosts; these can be moved back where they came
from. Other information plotted includes left and right
shifted spectra with likely correllations and an
(optional) theoretical spectrum.
In manual mode areas of the spectrum can also be marked as
unusable.
It is also possible to save and restore manually corrected
information; for instance if the same corrections have to
be applied to more than one data set.
o To save manually corrections for ghosts, add the
detector number and the keyword SAVE=save_struct. The
program will plot and prompt for ghosts as in the manual
correction above.
o To restore saved ghost corrections, add the detector
number and the keyword RESTORE=save_struct. Note that
the qlds must use the same detector and GIS setup as in
the original SAVE.
Use : For ghost free regions or automatic corrections:
GHOST_BUSTER, QLDS [,/AUTOMATIC] [,/PLOT] $
[,/HARDCOPY] [,/ANGSTROMS] [,/NM]
or for manual corrections add the detector number:
GHOST_BUSTER, QLDS, DETNUMBER [,/PLOT] $
[,/HARDCOPY] [,/ANGSTROMS] [,/NM] [,/SAMPLE]
[,/LOGSCALE] [,/QUIET] [,SAVE=SAVE_STRUCT]
to restore previously saved ghosts:
GHOST_BUSTER, QLDS, DETNUMBER, RESTORE=SAVE_STRUCT [,/PLOT]
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
Opt. Inputs : DETNUMBER = The detector number (1-4) to ghost correct manually
Outputs : QLDS = returned with the ghosts corrected
Opt. Outputs: None.
Keywords : HARDCOPY = if set will plot the original and ghost busted
spectra to printer
PLOT = Plot the original and reslutant data
ANGSTROMS = plot in Angstroms
NM = plot in nanometers
SAMPLE = Plot a sample theoretical spectrum
LOGSCALE = Plot the log of the spectra
AUTOMATIC = Make a 'best guess' at restoring ghosts (the
default is to return only ghost-free spectra)
SAVE = If set to an empty variable then will return an
array of structures with saved ghosting parameters.
If not empty, then new ghosting parameters are
appended to the array. Note that the input array
must be from data with the same GSET and detector
number.
Alternatively, if set to a string, then this string
is interpreted as a filename, and the save
structure is written to the file. This is mainly
for internal use, to produce the files needed for
automatic ghost processing.
RESTORE = If supplied, will use the correction data in the
structure to move the ghosts.
QUIET = Do not report informational messages. All warnings
and errors are still reported.
Calls : ***
AVERAGE, Bell, CF_174LG, CF_177LG, CF_180LG, CF_765LG, CF_770LG, CHKARG, CONCAT_DIR [1]
CONCAT_DIR [2], CONCAT_DIR [3], COPY_QLDS, DATATYPE [1], DATATYPE [2]
DATATYPE [3], GHOST_AMOUNT, GHOST_BUSTER_AUTOMATIC, GHOST_BUSTER_FREE
GHOST_BUSTER_MANUAL, GHOST_CURSOR, GHOST_MOVE, GHOST_PLOTTHICK, GHOST_PLOT_ONE
GHOST_RESTORE, GIS_GHOSTING, GIS_PLOT, GT_WINDATA, GT_WINDESC, LOADCT, PIX2WAVE
PS [1], PS [2], PSPLOT [1], PSPLOT [2], RD_ASCII [1], RD_ASCII [2], STR_SEP
ST_WINDATA, TRIM, UNIQ [1], UNIQ [2], UNIQ [3], WAVE2PIX, YES_NO, concat_dir [4]
curdir [1], curdir [2]
CALLED BY:
GIS_FIT, GIS_UTPLOT
Common : None.
Restrictions: None.
Side effects: None.
Still To Do : Add more complex automatic processing
Marking unusable areas
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 13 November 1997
Modified : v2: 19 Nov 97, erb, Use ghost_test to plot correlation
information too
v2.1: 1 Feb 98, erb, added hardcopy and angstrom switches
and processing
v3: 2 Feb 98, erb, allowed user to re-process already
ghost-corrected data
v3.1: 24 Feb 98, erb, add SAMPLE keyword
v4.0: 3 Mar 98, erb, Added LOGSCALE keyword
v4.1: 10 Mar 98, erb, Use ghost_cursor cursor
v4.2: 12 Mar 98, erb, improved ghost_cursor
v4.3: 3 Jul 98, erb, IDLv5, use [] not ()
v5: 26 Nov 98, erb, Default to returning only ghost free
regions.
Also add /quiet to repeated ghost_amount calls
v5.1: 13 Jan 98, erb, Make gis_calib to work properly with
ghost free data - push all 'ghosting' data
into pixel 0 - thus maintain total detector
count rates
v5.2: 15 Jan 99, erb, minor improvement to GSET_ID
processing
v5.3: 03 Feb 99, erb, limit count rates for quiet sun zone,
plot thicker cursors, add nm switch
v5.4: 02 Mar 99, erb, remove redundant ghost_information_file
messages
v5.5: 15 Mar 99, erb, bug in amounts of ghosting! Also
default to Angstroms
v5.6: 25 May 99, erb, Issue warning when quiet sun count
rates very high; added QUIET keyword;
check for GIS data
v6: 28 Jun 99, erb, renamed 'ghost_restore' to
'ghost_move'; added RESTORE keyword processing;
print wavelengths of the cursors at the
bottom of the manual mode plot; plot input vs.
output data (via /PLOT and /HARDCOPY); added
some automatic processing
v6.1 22 Jul 99, erb, default to moving data to the Right;
added /cross_cor keyword; use sensible colour
table
v7 Aug 03, caf, Implimented autmomatic ghost correction so
now automatically corrects some ghosts.
Version : 7
[Previous]
[Next]
Project : SOHO - CDS
Name : GHOST_INFO
Purpose : Display the ghosting information associated with a QLDS
Explanation : The ghosting information is kept in a 'ghost information file'
on a pixel by pixel basis. This routine will translate the
information for one detector into wavelength scale, print
it to the screen and/or save the information as a returned
array.
Use : GHOST_INFO, QLDS, DETNO, [,INFO] [,/ANGSTROMS] [,/NM], $
[/NOPRINT]
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
DETNO = The detector number (1-4)
Outputs : None.
Opt. Outputs: INFO = The ghosting information stored in an array
The size of the array is 7*2048.
Column 1: pixel number
Column 2: Wavelength (nm or A)
Column 3: Left ghost position (or 0.0)
Column 4: Approx. left ghost amount (0-1)
Column 5: Right ghost position (or 0.0)
Column 6: Approx. right ghost amount(0-1)
Column 7: Spiral arm position
Keywords : ANGSTROMS = output information in Angstroms (default)
NM = output information in nanometers
NOPRINT = do not print the information to the screen
Calls : ***
FILEPATH, GHOST_AMOUNT, GIS_GHOSTING, PIX2WAVE, RESTORE_WAVECAL, TRIM
Common : None.
Restrictions: None.
Side effects: None.
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 19 July 1999
Modified :
Version : 1
[Previous]
[Next]
Project : SOHO - CDS
Name : GHOST_MOVE
Purpose : Manually move GIS detector ghosts
Explanation : This procedure moves GIS ghosts back. It is intended to be
used only by ghost_buster.
Use : GHOST_MOVE, qlds, ghost_left, ghost_right, direction, $
detno, save [,/pixels]
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
GHOST_LEFT = LHS of ghost to be moved, in nm.
GHOST_RIGHT = RHS of ghost to be moved, in nm.
DIRECTION = 'L' or 'R', for left or right direction of
movement
DETNO = The detector number to ghost bust
Opt. Inputs : None.
Outputs : QLDS = returned with the ghosts corrected
Opt. Outputs: SAVE = append valid ghosting parameters into a structure
Keywords : PIXELS = if set, then the LHS and RHS are in pixels, not nm.
Calls : ***
CONGRID [1], CONGRID [2], CONGRID [3], DATATYPE [1], DATATYPE [2], DATATYPE [3]
GIS_GHOSTING, GT_WINDATA, GT_WINDESC, ST_WINDATA, TRIM, WAVE2PIX
CALLED BY:
GHOST_BUSTER, GHOST_RESTORE
Common : None.
Restrictions: GHOST_PLOT_ONE must be called before using this
routine, unless /PIXELS is set
Side effects: None.
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 13 November 1997
Modified : v2: 2 Feb 98; erb; Tidied up and allowed time-series data
v2.1: 15 Jan 99; erb; improved gset_id processing
v3 22 Jun 99: erb; renamed ghost_move from ghost_restore,
added PIXELS keyword, checked for
save structure
v4 Aug 03: caf; removed check on size of moved array so
it will now move whole LUT arms etc
Version : v4
[Previous]
[Next]
Project : SOHO - CDS
Name : GHOST_PLOT_ALL
Purpose : Plots all 4 GIS detector data with likely ghost regions
Explanation : This function takes GIS images read with READCDSFITS and
plots the average spectra for each detector with:
blue shifted spectrum
red shifted spectrum
likely ghosting regions
Further software is being developed to 'move' selected ghosts
back to original locations
Use : GHOST_PLOT_ALL, QLDS
Suggested use:
Use GHOST_PLOT_ALL to give a rough idea of where
the likely ghosts are for all 4 detectors
then use GHOST_PLOT_ONE with and without /LogScale
to zoom in to the desired features
e.g.,
IDL> qlds = readcdsfits('s7128r00')
IDL> ghost_plot_all, qlds
IDL> ghost_plot_one, qlds, 3, /logscale
IDL> ghost_plot_one, qlds, 2
Inputs : qlds = Structure variable as read by READCDSFITS.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : ***
GHOST_PLOT_ONE, TRIM
Common : None.
Restrictions: None.
Side effects: None.
Category : Calibration, GIS, Intensity.
Prev. Hist. : None
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 7 March 1997
Modified : erb, 1 March 1999, added nm and angstrom switches
erb, 15 March 1999, default to Angstroms
Version : v3
[Previous]
[Next]
Project : SOHO - CDS
Name : GHOST_PLOT_ONE
Purpose : Plots a GIS detector data with likely ghost regions
Explanation : This procedure takes GIS data read with READCDSFITS and
plots the average spectra for each detector with:
blue shifted spectrum
red shifted spectrum
likely ghosting regions
GHOST_BUSTER, q.v., will 'move' selected ghosts back to
original locations.
GHOST_TEST, q.v., will plot correllation coefficients on top
of the resulting plot.
Use : GHOST_PLOT_ONE, QLDS, CHAN [, /NOLABEL] [, /LOGSCALE] $
[, /ANGSTROMS] $
[, WAVERANGE=[min,max] ] [, GHOSTDATA] [, /PIXELS] $
[, SMOOTHSIZE=smoothsize] [,/sample] [/noghost]
[, /CROSS_COR]
Suggested use:
Use GHOST_PLOT_ALL to give a rough idea of where
the likely ghosts are for all 4 detectors
then use GHOST_PLOT_ONE with or without /LogScale
to zoom in to the desired features
e.g.,
IDL> qlds = readcdsfits('s7128r00')
IDL> ghost_plot_all, qlds
IDL> ghost_plot_one, qlds, 1, /logscale
Inputs : qlds = Structure variable as read by READCDSFITS.
chan = Detector number (1-4)
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: GhostData = Optional output structure of spectrum and
ghost, for use in further processing.
Contains:
ghostdata.spec Original Spectrum
ghostdata.blue_spec left shifted spectrum
ghostdata.red_spec right shifted spectrum
ghostdata.wave_scale Wavelength scale used
ghostdata.wave_min Minimum plotted wavelength
ghostdata.wave_max Maximum plotted wavelength
Keywords : NoLabel = Do not draw labels around the plots -
mainly used by GHOST_PLOT_ALL
LogScale = Plot data with a log scale to show fine details
Angstroms = Use Angstroms
nm = Use nm
WaveRange = Array with the wavelength range for plotting
the data:
waverange(0) = minimum plotted wavelength in nm
waverange(1) = maximum plotted wavelength in nm
If /angstroms or /pixels is set, then
wavelengths are in angstroms or pixels.
The default is to plot over the whole detector.
pixels = plot in pixels, not by wavelength
sample = plot a theoretical sample spectrum
quiet = pass 'quiet' keyword to ghost_amount
noghost = do not display ghost information (mainly used
for test purposes)
cross_cor = plot a computer guess of ghosts by cross
correlating the shifted and original spectra
nocolour = plot data in b&w - useful for b&w printers
Calls : ***
CHKARG, CORRELATE, GHOST_AMOUNT, GHOST_PLOT_SAMPLE, GIS_GHOSTING, GT_HDR, GT_NUMEXP
GT_WINDATA, INTERPOL, LOADCT, PIX2WAVE, TRIM, WAVE2PIX
CALLED BY:
GHOST_BUSTER, GHOST_PLOT_ALL, GHOST_TEST, GIS_PLOT
Common : None.
Restrictions: None.
Side effects: None.
Category : Calibration, GIS, Intensity.
Prev. Hist. : None
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 7 March 1997
Modified : v2, erb, 21 Mar 97; Minor plotting details changed
v3, erb, 4 Apr 97; removed smoothing
v4, erb, 13 Nov 97; separated gis_ghosting routine
v5, erb, 17 Nov 97; minor data errors trapped
v5.1, erb, 2 Feb 98; some labels changed, and tidied up
v5.2, erb, 24 Feb 98; add a sample spectrum
v5.3, erb, 2 Mar 98; (from Vincenzo Andretta) fixed colour
table bug;
v5.4, erb, 3 Mar 98; improved log output scale
v6, erb, 9 Mar 98; Use GHOST_AMOUNT to get likely ghost
areas
v6.1, erb, 11 Mar 98; Used colour table 12, not 2 (a bug!)
v7, erb, 10 Jul 98; plot ghost amounts in different colours
v7.1, erb, 30 Nov 98; include ghost_test funtionality
v7.2, erb, 5 Jan 99: include quiet keyword
v7.3, erb, 15 Jan 99: Minor correction to gset_id processing
v7.4, erb, 1 Mar 99; add nm and noghost switches
v7.5, erb, 3 Mar 99; improved noghost function
v7.6, erb, 15 Mar 99; Default to angstroms
v7.7, erb, 18 May 99; correct a scaling bug with /noghost
v7.8, erb, 27 May 99; fixed bug in scaling bug fix!
v7.9, erb, 3 Jun 99; added better titles to /noghost output
v8, erb, 19 Jul 99; More scaling corrections (for the bright
HeII line); minor plot label changes;
added cross_cor keyword
v8.1, erb, 22 Jul 99; better /nolabel processing
v8.2, erb, 22 Jul 99: allow colour hardcopies
Version : 8.2
[Previous]
[Next]
Project : SOHO - CDS
Name : GHOST_PLOT_SAMPLE
Purpose : Plots (or returns) a theoretical sample GIS spectrum
Explanation : This routine will plot a sample spectrum covering the GIS
detector ranges. It uses data from a theoretical quiet sun as
calculated by Enrico Landi (E.Landi@damtp.cam.ac.uk).
Second order lines are guessed to be a factor 10 less intense than
1st order.
The HeII line has been suppressed (as with detector 2).
Some warnings and information from Enrico:
1 - the intensities have been calculated using the new version of the
Arcetri Spectral Code (landi and landini 1998 AA submitted) using a quiet
Sun diffrential emission measure.
2 - Some calcium lines
are calculate assuming level population from the ground level only and
for this reason can be badly overestimated. This is also possibly true for
other ions calculated with this assumption.
3 - Fe III lines included in the GIS 4 spectral range need to be taken
with caution since this ions still need some more checking.
Use : GHOST_PLOT_SAMPLE, DETNO, [SAMPLE_DATA]
Inputs : DETNO = Detector number (1-4)
Reads the save file ghost_plot_sample.save which contains the
details of the sample spectrum
Data from Enrico Landi, using Chianti
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: SAMPLE_DATA = Returns the sample spectrum. The data is not
plotted if this parameter is supplied
Keywords : ANGSTROMS = use angstroms instead on nanometers
PIXELS = use pixels instead of nanometers
WAVERANGE = 2 element array with the wavelength range to
be used. In nanometers, unless other keywords set.
LOGSCALE = plot using a log scale
Calls : ***
GAUSS_PUT, PIX2WAVE, TRIM, WAVE2PIX
CALLED BY:
GHOST_PLOT_ONE
Common : None.
Restrictions: Many! Resulting data to be taken with a pinch of salt.
Side effects: None.
Category : Calibration, GIS, Intensity.
Prev. Hist. : None
Written : 24 Feb 1998, Eddie Breeveld, erb@mssl.ucl.ac.uk
Modified : v1.1 erb 3 Mar 98 Added LOGSCALE keyword
Version : v1.1
[Previous]
[Next]
Project : SOHO - CDS
Name : GHOST_RESTORE
Purpose : Automatically move GIS detector ghosts
Explanation : This procedure moves GIS ghosts back from saved information.
It is intended to be used only by ghost_buster.
Use : GHOST_RESTORE, qlds, detno, save
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
SAVE = ghosting parameters to restore
Opt. Inputs : None.
Outputs : QLDS = returned with the saved ghosts moved
Opt. Outputs: None.
Keywords : QUIET = run quietly, without informational messages
Calls : ***
GHOST_MOVE, TRIM
CALLED BY:
GHOST_BUSTER
Common : None.
Restrictions: None, but intended to be called only from GHOST_BUSTER
Side effects: None.
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 9 June 1999
Modified :
Version : 1
[Previous]
[Next]
Project : SOHO - CDS
Name : GHOST_TEST
Purpose : Add correlation tests to GIS ghost plots
Explanation : This function takes GIS data read with READCDSFITS and
tests for ghosts. It uses known detector parmeters and
computes cross-correlation curves.
This procedure is intended to be called from GHOST_BUSTER, q.v.
Use : GHOST_TEST, QLDS, DETNO [,WAVERANGE=WAVERANGE] [,/ANGSROMS] $
[,/LOGSCALE] [,/PIXELS] [,GHOSTDATA], [/SAMPLE]
IDL> qlds = readcdsfits('s7128r00')
IDL> ghost_test, qlds, 1
Inputs : qlds = Structure variable as read by READCDSFITS.
DETNO = Detector number (1-4)
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: GHOSTDATA = ghosting parameters. See GHOST_PLOT_ONE
Keywords : ANGSTROMS = use angstroms instead on nanometers
PIXELS = use pixels instead of nanometers
WAVERANGE = 2 element array with the wavelength range to
be used. In nanometers, unless other keywords set.
SAMPLE = Add a sample theoretical spectrum
LOGSCALE = Plot using log scaling
Calls : ***
CHKARG, CORRELATE, GHOST_PLOT_ONE
Common : None.
Restrictions: None.
Side effects: None.
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : 24 Feb 1998, Eddie Breeveld, erb@mssl.ucl.ac.uk
Modified : v1.1, erb, 3 March 1998, Added LOGSCALE keyword and improved
window access
v1.2, erb, 6 April 1998, Fixed window>31 selection bug
Version : v1.2
[Previous]
[Next]
NAME:
GIF2JPG24
PURPOSE:
Change GIF format to 24 bit color JPEG
CATEGORY:
Image Processing
CALLING SEQUENCE:
GIF2JPG24, Gif_image,R,G,B,Jpg_image, JSIZE=[naxis1,naxis2]
INPUTS:
Gif_image
R red color table
G green color table
B blue color table
OPTIONAL INPUTS:
KEYWORD PARAMETERS:
JSIZE ARRAY(2) [horiz,vert] size of output image
OUTPUTS:
Jpg_image byte array (JSIZE(0),JSIZE(1),3) in 24 bit color with color info in 3rd dim
OPTIONAL OUTPUTS:
CALLS: ***
CONGRID [1], CONGRID [2], CONGRID [3]
CALLED BY:
GIFDIR2JPG24, MAKE_GIFS, RTMVI [1]
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
To change a GIF to a 1024x1024 JPEG
GIF2JPG24, Gif_image,R,G,B,Jpg_image,JSIZE=[1024,1024]
MODIFICATION HISTORY:
Written by: Dennis Wang, 18 Mar 1999
99/07/12 N. Rich Make jsize_x & _y optional keyword JSIZE
01/09/13 N. Rich Add messages
@(#)gif2jpg24.pro 1.3 09/13/01 LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
GIFDIR2JPG24
PURPOSE:
Converts all the GIFS in gif_dir to 24 bit JPEGs in another directory
CATEGORY:
Image Processing.
CALLING SEQUENCE:
GIFDIR2JPG24,Gif_dir,Jpg_dir,Jsize_x,Jsize_y
INPUTS:
Gif_dir
Jpg_dir
Jsize_x horz size for JPEGS
Jsize_y vert size for JPEGS
OPTIONAL INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
Output directory contains a 24 bit color JPEG for each GIF in the input directory
OPTIONAL OUTPUTS:
CALLS: ***
GIF2JPG24, READ_GIF, STR_SEP
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
GIFDIR2JPG24,'./gifs','./jpg24',1024,1024
MODIFICATION HISTORY:
Written by: Dennis Wang, 18 Mar 1999
@(#)gifdir2jpg24.pro 1.1 03/19/99 LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - LASCO/EIT
Name : GIFS2DIFS
Purpose : Make Diff Gifs from GIFS
Use : IDL> GIFS2DIFS, absoluteinputdir, absoluteoutputdir
Inputs : inputdir
Optional Inputs: None
Outputs : GIF, JPG, MPG files
Keywords :
Comments : Assumes name of gifs to be YYYYMMDD_HHMM_CAMERA.gif
CALLS: ***
CONGRID [1], CONGRID [2], CONGRID [3], LOADCT, READ_GIF, READ_PNG, RTMVIXY, WRITE_GIF
CALLED BY:
MAKE_DIFF_MPEG
Side effects:
Category : Image Display. Animation.
Written : Jake Wendt, NRL, February 2002
Version : 020508 Jake minor changes
030715 jake added PNG capability
10/13/06 @(#)gifs2difs.pro 1.10 :LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - LASCO/EIT
Name : GIFS2MPEG
Purpose : Make MPEG or Animated Gifs from Gifs
Use : GIFS2MPEG, mpegFileName, gif_match, gifdir, WHIRLGIF=WHIRLGIF, $
SCALE=scale, REFERENCE=reference, $
MPEG_DIR=mpeg_dir
Inputs : mpegFileName - Name of output file
gif_match - string (wildcards allowed) used to find input GIF file
gifdir - directory to search for input GIF files (string)
Optional Inputs:
Outputs :
Keywords : WHIRLGIF - Make Animated GIF using WHIRLGIF
SCALE -
REFERENCE -
MPEG_DIR - Name of directory to put MPEG file; default is gifdir
NFRAMES - set named variable to number of frames used (output)
Comments :
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], concat_dir [4]
CALLED BY:
MAKE_DIFF_MPEG, RTMVI [1], UPDATE_MPG
Side effects:
Category : Image Display. Animation.
Modified:
990316 NBR Change whirlgif options to loop indefinitely
990521 NBr Change paramfile INPUT
020204 Jake Added /SH to all SPAWN
020225, nbr - Change how files are selected and INPUT_DIR in idl2mpeg.params
030408 DW Comments added
030617, nbr - Make it unnecessary to have write permission in gifdir
030709, nbr - Fix problem from previous mod
030715 jake added PNG keyword
031010, nbr - Add NFRAMES keyword
061013 Karl B - if host is einstein or hercules use giftopnm instead of giftoppm
Version :
@(#)gifs2mpeg.pro 1.9 10/13/06 :LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_ARM
Purpose : To return arm and pixel positions to
help understand ghost locations
Explanation : Takes the LUT for an observation and produces
an array of arm locations for use in ghost_buster.
Use :
Inputs :
Opt. Inputs :
Outputs :
Opt. Outputs: None.
Keywords :
Calls : ***
GET_GSET
CALLED BY:
CF_174LG, CF_177LG, CF_180LG, CF_765LG, CF_770LG
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 : GIS_CALIB
Purpose : Applies calibration factors to GIS spectra and records errors
into qlds.
Explanation : This procedure corrects GIS data which has been read
with READCDSFITS and already smoothed (using gis_smooth)
and corrected for ghosts using ghost_buster.
Corrections performed include:
FIFO dead time
Simple correction for Quiz-show dead time
Analogue dead time
Short term gain depression check
Long term gain depression
Long slit (4, 5 and 6) optical correction
ERRORS :
The dominant source of error in the gis data are those associated
with the photon statistics and the Long term gain depression.
These errors are of the order of a few percent, and are combined
in quadrature and recorded directly into the quick look data structure
for later use with gis_fit. This routine takes the combined errors
and uses them as weights in the fitting process.
The resultant error in the amplitude and width, are also combined
in quadrature to determine the final error in the fitted intensities,
which are recorded as an addition tag in the returned structure.
sigma_I = sqrt((sigma_amplitude/amplitude)^2+(sigma_width/width)^2)
These combined errors can be extracted from the qlds using the
gis_error, if you fit the lines yourself. These errors should
be used as weights in the fitting process, the errors from which
should be combined in a similar fashion to determine the errors in
the intensities.
Use : GIS_CALIB, DATA [,ERRMSG=ERRMSG] [,/SETMISSING] [,/QUIET] $
[,/STERADIAN_M2] [,/ARCSEC2_CM2]
Inputs : DATA = Structure variable as read by READCDSFITS and
ghost corrected with GHOST_BUSTER.
Opt. Inputs : None.
Outputs : DATA = The calibrated data will be returned as a
structure with the same format as the input.
The units of the calibrated data will be
photon-events/pixel/sec.
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 = ''
CALIB = GIS_CALIB (DATA, ERRMSG=ERRMSG)
IF ERRMSG NE '' THEN ...
SETMISSING = if set, then uncalibrated data will be set to
missing. If not set, then the function aborts
with an error message if there is any
uncalibratable data
QUIET = Reduces the information printed to screen, but
errors and warnings are still printed.
HeII = Allow the HeII 30.4 line through. By default the
line is marked as missing in all the spectra
because it can't be calibrated.
CALLED BY:
GIS_FIT, GIS_UTPLOT
NOTE: if this switch is used, do NOT assume that
the region around 30.4 nm can be calibrated. This
area of the spectrum on detector 2 can ONLY be used
for morphology.
STERADIAN_M2 = Use best known detector efficiencies to convert
the data into:
photons/second/pixel/steradian/(meter^2)
ARCSEC2_CM2 = Use best known detector efficiencies to convert
the data into:
photons/second/pixel/(cm^2)/(meter^2)
Calls : ***
CHKARG, GIS_CALIB_ANALOGUE, GIS_CALIB_AREA, GIS_CALIB_EXTRACT, GIS_CALIB_FF_LTGD
GIS_CALIB_FIFO, GIS_CALIB_HEII, GIS_CALIB_LONGSLIT, GIS_CALIB_PRINT
GIS_CALIB_QUIZ, GIS_CALIB_STGD, GT_WINSIZE, RESTORE_WAVECAL, ST_WINDATA, gis_cqlds
Common : None.
Restrictions: Data must be ghost corrected before invoking this procedure.
GIS_CALIB only works with full GIS data windows (whole
detectors)
TO DO LIST:
edge effects
off-axis calibration (vignetting)
stray light
any other corrections?
Side effects: None?
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 30 January 1997
Modified : v2.0, erb 31 Jan 1997: Added smoothing
v3.0, erb 4 Feb 1997: Used $CDS_GIS_CAL_INT directory for files
v4.0, erb 4 Apr 1997: Remove smoothing and force use of ghost
corrected data.
v5.0, erb 20 Jan 1998: Changed to a routine instead of a
function. Added GIS_CALIB_AREA routine from
Giuilio del-Zanna
v5.1, erb 28 Jan 1998: Optimised array index ordering;
which also solved an extra returned dimension problem.
v5.2, erb 29 Jan 1998: Not all detectors have to be
ghost-corrected now.
v5.3, erb 1 Feb 1998: Separated out GIS_CALIB_AREA (to be
added later though!)
v5.4, erb 3 Feb 1998: Split into separate routines
v5.5, erb 27 Feb 1998: Corrected header description
v6, erb 22 Dec 1998: Added HeII switch for morphology only
v6.1, erb 08 Jan 1999: more info on number of missing pixels
v7 erb 25 Jan 1999: Add /steradian_m2 and /arcsec2_cm2
switches to further calibrate the data
v7.1 erb 01 Feb 1999: Correct the header information
v8.0 erb 25 May 1999: make corrections for long slits,
use new stgd and ltgd files
v8.1 erb 19 Jul 1999: Use calibration databases in
gis_calib_area; use full wavelength
calibration
v9.0 caf Aug 2003 : Fixed various bugs.
Now defaults to photons / sec / arcsec2 / cm2
Added error array to output qlds - extract with gis_error
Now able to calibrate observations obtained with a subset of the
GIS detectors
v10 caf 10 Oct 2003: added the option to return the fifo, and LTGD correction factors
v11 caf 7 Oct 2004: Passed errors through into qlds, combined in quadrature,
for use in gis_fit, and gt_error and added description of errors.
Version : 11.0
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_CALIB_ANALOGUE
Purpose : Applies analogue calibration factors to GIS spectra.
Explanation : This procedure takes GIS images read with READCDSFITS and
applies the analogue electronics calibration factors.
See GIS_CALIB. Reads $CDS_GIS_CAL_INT/deadtime.dat to get
the factors.
Use : GIS_CALIB_ANALOGUE, data, info, message, missing_array, $
setmissing, quiet
Inputs : DATA = Data as supplied by GIS_CALIB
INFO = Information about the data
MISSING_ARRAY = Array marking missing data
SETMISSING = Flag to set the data missing if unable to calibrate
QUIET = Flag to run quietly
Opt. Inputs : None.
Outputs : DATA = The calibrated data will be returned as a
structure with the same format as the input.
MESSAGE = Returns error messages (if any)
MISSING_ARRAY = Array marking missing and uncalibratable data
Opt. Outputs: None.
Keywords : None.
Calls : ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], SPLINE, concat_dir [4]
CALLED BY:
GIS_CALIB
Common : None.
Restrictions: None.
Side effects: None?
Category : Calibration, GIS, Intensity.
Prev. Hist. : Separated from GIS_CALIB
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 3 February 1998
Modified : v.2, erb, 17 Dec 98, Used spline for better interpolation
and ignored low count-rate corrections
because they have a high statistical error
v.3, caf Aug 03, fixed bug so now works with partial GIS data, $
and new error array.
Version : V.3
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_CALIB_AREA
Purpose : Applies effective area calibration to GIS data
Explanation : This function takes GIS data from the GIS_CALIB routine
and translates to (per steradian per m^2), or optionally
to (per arcsec^2 per cm^2)
Use : GIS_CALIB_AREA, data, slit, message, units, mir_posdata, $
date_obs, [,/arcsec2_cm2]
Inputs : DATA = Array variable as supplied by GIS_CALIB
SLIT = The slit used for the observation
MESSAGE = Error messages, if any
MIR_POSDATA = mirror positions for each exposure
DATE_OBS = date of observation
Opt. Inputs : None.
Outputs : DATA = The calibrated data will be returned as an
array with the same format as the input.
The units of the calibrated data will be
photon-events/pixel/sec/(unit area)/(unit square angle)
UNITS = The units of the returned data, as defined by
gis_stage.inc
Opt. Outputs: None.
Keywords : ARCSEC2_CM2 = convert output to per arcsec^2 per cm^2
default per steradian per m^2
Calls : ***
GET_EFFICIENCY, GET_EFF_AREA, PIX2WAVE, TRIM
CALLED BY:
GIS_CALIB
Common : None.
Restrictions: None.
Side effects: None.
Category : Calibration, GIS, Intensity.
Prev. Hist. :
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 27 January 1999
Modified : v2: 19 Jun 1999, erb, use calibration databases
v3: Aug 2003, caf fixed problem which caused crash for sit and stare observations !
made changes so error array included in qlds, and fixed bug
so now works with partial GIS data.
Version : 3
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_CALIB_EXTRACT
Purpose : Extracts GIS data for use with GIS_CALIB
Explanation : This procedure takes a GIS qlds and prepares data arrays
for use in GIS_CALIB, q.v.
Use : GIS_CALIB_EXTRACT, qlds, data, info, missing_array, message, $
quiet, setmissing
Inputs : QLDS = Structure variable as read by READCDSFITS and
ghost corrected with GHOST_BUSTER.
QUIET = Flag to run quietly
SETMISSING = Flag to mark uncalibratable data as missing
Opt. Inputs : None.
Outputs : DATA = The calibrated data will be returned as a
structure with the same format as the input.
The units of the calibrated data will be
photon-events/pixel/sec.
INFO = Information about the size of the dataset
MISSING_ARRAY = array marking missing data and uncalibratable
data
MESSAGE = Returns error messages (if any)
Opt. Outputs: None.
Keywords : None.
Calls : ***
GT_DIMENSION, GT_EXPTIME [2], GT_WINDATA, GT_WINDESC, GT_WINSIZE, TRIM
gt_exptime [1]
CALLED BY:
GIS_CALIB
Common : None.
Restrictions: None.
Side effects: None?
Category : Calibration, GIS, Intensity.
Prev. Hist. : Separated from GIS_CALIB
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 3 February 1998
Modified : v2, erb, 08 Jan 1999, Pixel 0 used for ghost_buster_free
processing: thus always set to missing
v3, erb, 27 Jan 1999, check for STERADIAN or ARCSEC2
calibrated data. More info with gis_calib_print.
v4, erb, 15 Feb 1999, fixed missing data bug
v5, erb, 25 May 1999, reduced amout of printing
v6, caf, Aug 2003, changed so works with new error array.
fixed bug so works with partial GIS data.
Version : 6
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_CALIB_FF_LTGD
Purpose : Corrects GIS data for flat field and long term gain depression
Explanation : This procedure is called as part of GIS_CALIB, q.v.
Reads the calibration file $CDS_GIS_CAL_INT/ff_*.dat nearest
in time to the study start time
Use : GIS_CALIB_FF_LTGD, qlds, data, info, message, quiet
Inputs : QLDS = Structure variable as read by READCDSFITS and
ghost corrected with GHOST_BUSTER.
DATA = GIS data as supplied by GIS_CALIB
INFO = QLDS information as supplied by GIS_CALIB
QUIET = Flag for running quietly
Opt. Inputs : None
Outputs : DATA = The calibrated data will be returned as a
structure with the same format as the input.
MESSAGE = Error message (if any) returned
Opt. Outputs: None.
Keywords : None
Calls : ***
ANYTIM2TAI, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FIND_FILE
GIS_CALIB_NEAREST, GT_EXPTIME [2], GT_START, concat_dir [4], gt_exptime [1]
CALLED BY:
GIS_CALIB
Common : None.
Restrictions: None.
Side effects: None.
Category : Calibration, GIS, Intensity.
Prev. Hist. : Separated from GIS_CALIB
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 3 February 1998
Modified : v.2, 10 May 1999, erb: Use XDR format for the binary file
v.3, Aug 2003, caf: Added Flat field files, and fixed
bug so now works with partial GIS data.
v.4, 1 Oct 2003, caf: fixed the way that the error in LTGD is
passed, and statistical error calculated from
non-normalised data.
v.5, 10 Oct 2003 added the option to return the ltgd correction
factor
v.6, 7 Oct 2004 Entered revised LTGD errors in and passed to qlds.
Version : 6
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_CALIB_FIFO
Purpose : Applies FIFO calibration factors to GIS spectra.
Explanation : This procedure takes GIS images read with READCDSFITS and
applies the appropriate calibration factors for the electronics
FIFO. Called from GIS_CALIB, q.v.
Use : GIS_CALIB_FIFO, data, info, quiet
Inputs : DATA = Data supplied by GIS_CALIB
INFO = Information about the data
QUIET = Flag to run quietly
Opt. Inputs : None.
Outputs : DATA = The calibrated data will be returned as a
structure with the same format as the input.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
GIS_CALIB
Common : None.
Restrictions: None.
Side effects: None?
Category : Calibration, GIS, Intensity.
Prev. Hist. : Separated from GIS_CALIB
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 3 February 1998
Modified : Carl Foley, caf@mssl.ucl.ac.uk 21 December 2000,
trapped error as suggested by Jim and Dave (RAL).
caf, 10 October 2003, revised to return fifo correction factor
Version : v.2, 10 October 2003
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_CALIB_HEII
Purpose : Marks HeII data uncalibratable in GIS spectra.
Explanation : This procedure marks the HeII line in GIS detector 2 as
uncalibratable. Called from GIS_CALIB, q.v.
Use : GIS_CALIB_HEII, missing_array, quiet
Inputs : MISSING ARRAY = Array marking missing/uncalibratable GIS data
as supplied by GIS_CALIB
QUIET = Flag to run quietly
Opt. Inputs : None.
Outputs : MISSING ARRAY = Array marking missing/uncalibratable GIS data
Opt. Outputs: None.
Keywords : None.
Calls : ***
WAVE2PIX
CALLED BY:
GIS_CALIB
Common : None.
Restrictions: None.
Side effects: None?
Category : Calibration, GIS, Intensity.
Prev. Hist. : Separated from GIS_CALIB
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 3 February 1998
Modified :
Version : v.1, 3 February 1998
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_CALIB_LONGSLIT
Purpose : Corrects GIS data for using the big slits (4, 5, and 6)
Explanation : Big slits (4, 5 and 6) cover an area bigger than the detectors,
this routine will correct the data for this.
The correction is from RAL tech Report RAL-TR-1999-036, The Laboratory
calibration of the SOHO Coronal Diagnostic Spectrometer, 18 May 1999,
J. Lang, et. al. p41f
n.b., this must be the last applied detector calibration, all the others work
on the counts as seen by the detectors, this correction extrapolates
to the counts that would have been seen by big enough detectors.
Use : GIS_CALIB_LONGSLIT, data, info, slit_num, quiet
Inputs : DATA = Data as supplied by GIS_CALIB
INFO = Information about the data
QUIET = Flag to run quietly
Opt. Inputs : None.
Outputs : DATA = The calibrated data will be returned as an
array with the same format as the input.
Opt. Outputs: None.
Keywords : None.
Calls : ***
PIX2WAVE, POLY, POLY_FIT, TRIM
CALLED BY:
GIS_CALIB
Common : None.
Restrictions: None.
Side effects: None?
Category : Calibration, GIS, Intensity.
Prev. Hist. : None
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 25 May 1999
Modified : Not yet
Version : 1
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_CALIB_PRINT
Purpose : Prints summary of GIS data.
Explanation : This procedure prinst a summary of GIS data as supplied
by GIS_CALIB, q.v.
Use : GIS_CALIB_PRINT, data [,units]
Inputs : DATA = GIS data as supplied by GIS_CALIB.
Opt. Inputs : UNITS = data units to be pronted
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : ***
AVERAGE
CALLED BY:
GIS_CALIB
Common : None.
Restrictions: None.
Side effects: None?
Category : Calibration, GIS, Intensity.
Prev. Hist. : Separated from GIS_CALIB
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 3 February 1998
Modified : v2, erb, 27 Jan 1999, Use 'g' format and added 'units'
v3, erb, 10 May 1999, ignore first pixel in the data
v4, caf, Aug 2003, fixed bug so now works with partial
GIS data.
Version : 4
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_CALIB_QUIZ
Purpose : Applies calibration factors for the GIS quiz-show.
Explanation : This procedure takes GIS images read with READCDSFITS and
applies the appropriate calibration factors for the GIS
electronic quiz show deadtimes. See GIS_CALIB.
Use : GIS_CALIB_QUIZ, data, info, message, missing_array, $
setmissing, quiet
Inputs : DATA = Input data from GIS_CALIB
INFO = Information about the GIS data
MISSING_ARRAY = Marks missing data
SETMISSING = Flag to mark uncalibratable data
QUIET = Flag to suppress information messages
Opt. Inputs : None.
Outputs : DATA = The calibrated data will be returned as a
structure with the same format as the input.
The units of the calibrated data will be
photon-events/pixel/sec.
MISSING_ARRAY = Marks previous and new missing data
MESSAGE = Returns error messages (if any)
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
GIS_CALIB
Common : None.
Restrictions: None.
Side effects: None?
Category : Calibration, GIS, Intensity.
Prev. Hist. : Separated from GIS_CALIB
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 30 January 1997
Modified :
Version : V.1 30 January 1998
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_CALIB_STGD
Purpose : Calibrates GIS data for short term gain depression
Explanation : This procedure applies short term gain depression calibration
factors to GIS data. Used as part of GIS_CALIB, q.v.
Reads calibration information from
$CDS_GIS_CAL_INT/shortterm.dat
Use : GIS_CALIB_STGD, data, message, missing_array, setmissing, $
quiet
Inputs : DATA = Supplied GIS data from GIS_CALIB
MISSING_ARRAY = Array marking missing data
SETMISSING = Flag to mark uncalibratable data
QUIET = Flag to run quietly
Opt. Inputs : None.
Outputs : DATA = The calibrated data will be returned as a
structure with the same format as the input.
MESSAGE = Returns error messages, if any.
MISSING_ARRAY = Array marking missing and uncalibratable data
Opt. Outputs: None.
Keywords : None.
Calls : ***
INTERPOL, POLY, POLY_FIT
CALLED BY:
GIS_CALIB
Common : None.
Restrictions: None.
Side effects: None?
Category : Calibration, GIS, Intensity.
Prev. Hist. : Separated from GIS_CALIB
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 3 February 1998
Modified : v2, erb, 09 Jan 1999, check only valid data points
v3, erb, 21 May 1999, use much better STGD data
v4, erb, 4 Jun 1999, correct bug if no valid data
v5, caf, August 2003, instead of marking unreliable data as missing
it is now passed and a suitable error entered into
the QLDS.
Version : 5
[Previous]
[Next]
Project : SOHO - CDS
Name : gis_cqlds
Purpose : To generate a copy of the QLDS which includes additional
windows to contain the error arrays.
Explanation : Reads the number of GIS windows in the data and
generates double this so an error array can be entered (from
gis_calib) which reflects the uncertainties in the calibration.
Use : qlds=gis_cqlds(qlds)
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
Opt. Inputs : NONE.
Outputs : QLDS, with double the number of windows for use in GIS_CALIB
Opt. Outputs: None.
Keywords :
Calls : ***
DELETE_QLDS, GT_WINDATA, QLMGR, TAG_EXIST [1], TAG_EXIST [2]
CALLED BY:
GIS_CALIB
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
v3.0, caf 26 Sep 2003 : fixed bug with caused array / scaler
error in idl versions pre 5.5a
Version : 3.
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_DUMMY
Purpose : Creates dummy data array for CDS GIS spectrograph
Explanation : Takes past solar EUV data, folds in CDS performance
and solar parameters to mimic GIS image. Includes -
(i) solar lines in correct location on image
(ii) intensities calculated from past data
folding in CDS efficiencies
(iii) variable slit use
(iv) two window options
(v) background intensities
(vi) statistical noise
Neglects pixel sampling effects (assumed small) and
grating scatter (assumed small w.r.t. slit image
spread).
If requested, the output array is written to a disk file
with an unformatted write. In order to retrieve the data
use the following commands:
IDL> gis = intarr(4,2048)
IDL> openr,lun,'gis.dat',/get_lun
IDL> readu,lun,gis
Use : IDL> gis_dummy [,slit=slit,expose=expose etc.]
IDL> gis_dummy, slit=4,length=4,expose=10,wlist=1,image=gis,
file='gis.dat'
Would return four profiles in variable gis (4,2048)
Also stores in file called gis.dat (4,2048)
Inputs : Slit width and length, Accumulation time and Window option
are prompted for if not supplied as keyword parameters.
Optional i/p : None
Outputs : None
Optional o/p : See Image keyword
Keywords : Slit The slit size (2,4,8 or 90 arcsec).
Length The slit length (for 2, 4 arcsec slit widths)
Expose The exposure time in seconds.
Wlist The line list reference number.
Image Name of data array returned
File Name of data file created (default image.dat)
No_file Inhibit saving of data on disk
Zone Determines source model
CALLED BY:
TP_GET_DUMDATA
Restrictions : Requires solar data in files gi1.dat, gi2.dat, gi3.dat
and gi4.dat.
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], GAUSS_PUT, PIX2WAVE
concat_dir [4]
Side effects : None
Category : Planning, Technical, Model
Written : R A Harrison, RAL, July 1993
Modified : C D Pike, 9 Sep 93. Added LENGTH keyword and updated header.
Changed output array 'image' to integer.
CDP, 24-Mar-95 added ZONE keyword.
CDP, 27-Mar-95 update data file format to handle 6 zones.
CDP, 07-Sep-95 include filaments as zone types, make
default zone = 4 (quiet).
CDP, handle filament variations. CDP, 17-Oct-95
CDP, Fix array range error. 19-Mar-96
CDP, Bump up line widths to match real data. 28-Apr-96
Version : Version 8, 28-Apr-96
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_ERROR
Purpose : Extracts GIS errors as stored in the QLDS, by GIS_CALIB.
Explanation : This routine extracts the errors from the QLDS which were
stored during calibration. Currently, this error only contains
that associated with the flat field correction. But it will shortly
contain, ghosting errors and those associated with inaccurate
Short term gain depression corrections. Currently, data qhich has
a STGD correction of the order of 5% are marked as missing
This happens to include data which are most interesting. So in
instead of marking this data as missing, a suitable uncertainly will
be included.
Use : error_array=gis_error(qlds, detno)
error_array=gis_error(qlds, 1, ltgd=ltgd)
Inputs : QLDS = Structure variable as read by READCDSFITS and
ghost corrected with GHOST_BUSTER.
DETNO = The Detector number for which the error estimate is wanted.
Opt. Inputs : None.
Outputs : The error array for each pixel.
Opt. Outputs: ltgd = This is the percentage error attributed to the LTGD correction.
Keywords : None.
Calls : ***
ANYTIM2TAI, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FIND_FILE
GIS_CALIB_NEAREST, GT_DIMENSION, GT_EXPTIME [2], GT_START, GT_WINDATA
concat_dir [4], gt_exptime [1]
CALLED BY:
CF_GIS1A, CF_GIS1B, CF_GIS1C, CF_GIS2A [1], CF_GIS4A, CF_GIS4B, CF_GIS4C
Common : None.
Restrictions: None.
Side effects: None?
Category : Calibration, GIS, Intensity.
Written : Carl Foley, caf@mssl.ucl.ac.uk August 2003
Modified : caf, 2 Oct 2003. Incorporated LTGD keyword so that the percentage
error attributed to the LTGD can be seen, and combined with other
non-statistical / statistical errors independantly if desired.
Changed notification to user.
Version : 2.
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_FIT
Purpose : Automatically fits GIS spectra
Explanation : Uses CFIT structures to automatically fit clearly identified lines
in the GIS spectra. The structure returned contains the intensities,
amplitudes and widths, from the fits along with their associated
uncertainties. The errors in the intensity are determined directly
from those in the amplitude and width, which are combined in quadrature :
sigma_I = sqrt((sigma_amplitude/amplitude)^2+(sigma_width/width)^2)
Use : gisfit=gis_fit(qlds, /plot)
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
Opt. Inputs : PLOT = Plots progress of fits
Outputs : GISFIT = resultant fit structure containing the line intensity
amplitude, width, position, along with other ancillory data.
Opt. Outputs: None.
Keywords :
Calls : ***
CF_GIS1A, CF_GIS1B, CF_GIS1C, CF_GIS2A [1], CF_GIS2A [2], CF_GIS4A, CF_GIS4B, CF_GIS4C
GHOST_BUSTER, GIS_CALIB, GIS_SMOOTH, GT_WINDESC, RESTORE_WAVECAL
CALLED BY:
GIS_UTPLOT
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
made structures anonymous to remove comflicts
when analysing different data sets.
Version : 1.1
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_GHOSTING
Purpose : Finds likely GIS ghost regions
Explanation : This procedure takes GIS data read with READCDSFITS and finds
the likely ghosting regions
Use : GIS_GHOSTING, GSET_ID, CHAN, GHOSTS
Mainly used within the GIS ghost plotting and correcting
software.
Inputs : gset_id = GSET that data is wanted for.
chan = Detector number (1-4)
Opt. Inputs : None.
Outputs : GHOSTS = an array containing ghosting information:
0,* = lower ghost pixel address
1,* = upper ghost pixel address
2,* = position in arm (0.0 - 1.0)
Opt. Outputs: none.
Keywords : None.
Calls : ***
GET_GSET
CALLED BY:
GHOST_BUSTER, GHOST_INFO, GHOST_MOVE, GHOST_PLOT_ONE
Common : None.
Restrictions: None.
Side effects: None.
Category : Calibration, GIS, Intensity.
Prev. Hist. : Split from GHOST_PLOT_ONE
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 13 Nov 1997
Modified : v1.1, erb, 10 Mar 1998, improved comments
v2, erb, 15 Jan 1999, improved GSET_ID processing by
using gset_id as input, thus all routines
calling this procedure will need to be
modified
v3, erb, 28 Jun 1999, clarified comments
Version : 3
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_HV_CAL()
Purpose : Rewrite the series tables with updated voltages for each
GIS run. Only works for study GIMCPS1.
Explanation : To calibrate the effect of HV changes, ten rasters are run
each with a different voltage. This routine overwrites the
values created in the series tables by CPT with the
required test values of the GIS HV. It reads the series
file/table ID numbers from the latest TTC file.
Use : IDL> gis_hv_cal
Inputs : None
Opt. Inputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
Bell, FIND_FILE, LAST_ITEM, RD_ASCII [1], RD_ASCII [2], STR2ARR [1], STR2ARR [2]
STR_PICK, TRIM, WRT_ASCII, YES_NO
Common : None
Restrictions: User must have write access to the command directory
/cs/data/plan/command/cvt
Side effects: None
Category : Calibration
Prev. Hist. : None
Written : C D Pike, RAL, 14-Jun-2004
Modified : Version 2. Corrected ambiguity in finding TTC files. CDP
Version 3. Modified to cope with multiple runs of
study GIMCPS1. CDP
Version : Version 3, 08-Sep-2004
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_IN_WINDOW()
Purpose : Decide which GIS line_window cursor is in, if any.
Explanation : In the technical planning display, decide whether the current
wavelength falls within the bounds of any of the currently
defined GIS line windows.
Use : IDL> hit = gis_in_window(line_structure, wavelength)
Inputs : line_structure - the data structure containing details of the
currently defined line windows list. The
structure is defined in tp_def_struct.
wavelength - the wavelength to test
Opt. Inputs : None
Outputs : The function return value is the number of the identified
line-window. A value of -1 is returned if the wavelength
is not within a window.
Opt. Outputs: None
Keywords : None
Calls : ***
PIX2WAVE, WHICH_GIS_BAND
CALLED BY:
MK_RASTER
Restrictions: Returns only the first line-window found, tough on overlapping
windows.
Side effects: None
Category : Technical planning
Prev. Hist. :
Written : C D Pike, RAL, 11-Jun-93
Modified :
Version : Version 1, 11-Jun-1993
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_PLOT
Purpose : Plots a summary of GIS detector data
Explanation : This procedure takes GIS data read with READCDSFITS and
plots the average spectra for each detector
Use : GIS_PLOT, QLDS, CHAN [, /LOGSCALE] $
[, /ANGSTROMS] [, /nm] [, /NOLABEL] $
[, WAVERANGE=[min,max] ] [, /PIXELS] $
Inputs : qlds = Structure variable as read by READCDSFITS.
chan = Detector number (1-4)
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : LogScale = Plot data with a log scale to show fine details
Angstroms = Use Angstroms
nm = Use nm
WaveRange = Array with the wavelength range for plotting
the data:
waverange(0) = minimum plotted wavelength in nm
waverange(1) = maximum plotted wavelength in nm
If /angstroms or /pixels is set, then
wavelengths are in angstroms or pixels.
The default is to plot over the whole detector.
pixels = plot in pixels, not by wavelength
notitle = suppress the top title
Calls : ***
CHKARG, GHOST_PLOT_ONE
CALLED BY:
GHOST_BUSTER
Common : None.
Restrictions: None.
Side effects: None.
Category : Calibration, GIS, Intensity.
Prev. Hist. : Developed from ghost_plot_one
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 5 March 1999
Modified : v2, erb, 21 Jul 1999, propagated /nolabel keyword
Version : 2
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_RAW_HEADER.PRO
Purpose : Decipher and print out the header of a GIS raw/pha file
Explanation :
Use :
IDL> head = bytarr (512)
IDL> openr, lun, /get_lun, 'raw_or_phafilename'
IDL> readu, lun, head
IDL> result = gis_raw_header (head)
Inputs : head a 512 byte array with the file header
Opt. Inputs : None
Outputs : 1) Prints out the header in "English"
2) returns "result" a structure with the raw file header
information
result = $
{ comment:comment, $ ; string comment
detector:detector, $ ; I*2 detector
bughv:bughv, $ ; I*2 HV reading
bugmcpb:bugmcpb, $ ; I*2 mcp bias
bigmcp:bigmcp, $ ; i*2 mcp current
bkgrcd:bkgrcd, $ ; I*2 raw count rate
bkgulcd:bkgulcd, $ ; I*2 upper level rate
bkgldld:bkgldld, $ ; I*2 lower level setting
bkghvl:bkghvl, $ ; I*2 HV LAST SETTING
filament:filament, $ ; I*2 filament number
fcurrent:fcurrent, $ ; I*2 filament current
slitn:slitn, $ ; I*2 slit number
slitp:slitp, $ ; I*2 slit position
mirror:mirror } ; I*2 mirror position
Opt. Outputs: None
Keywords : QUIET do not print out the header, just return the structure
Calls : tm_calib, dec2hex
CALLED BY:
CAT_RAW, VIEW_PHA, VIEW_RAW
Common : None
Restrictions: None
Side effects: !
Category : Telemetry
Prev. Hist. : None
Written : E Breeveld (erb@mssl.ucl.ac.uk) 6 March 1996
Cut from new_raw_gis.pro
Modified : ERB added decimal HV setting, 19 April 1996
ERB added quiet keyword; return hex and calibrated params
11 Jan 2000
Version : 2
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_SMOOTH
Purpose : Smooths GIS spectra to 'remove' fixed patterning
Explanation : This function takes GIS images read with READCDSFITS and
smooths the spectra.
Use : GIS_SMOOTH, QLDS [,ERRMSG=ERRMSG] [,SMOOTHSIZE=SMOOTHSIZE]
Inputs : QLDS = Structure variable as read by READCDSFITS.
Opt. Inputs : None.
Outputs : QLDS = The smoothed data will be returned as a
structure with the same format as the input.
The data will be marked as 'smoothed' for further
processing.
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 = ''
CALIB = GIS_CALIB (DATA, ERRMSG=ERRMSG)
IF ERRMSG NE '' THEN ...
SMOOTHSIZE = Size of smoothing function, default 7 pixels,
minimum 4 pixels. Any number less than 4 will result
in no smoothing
Calls : ***
CDS_FILL_MISSING, COPY_QLDS, DELETE_QLDS, GT_DIMENSION, GT_WINDATA, GT_WINDESC
GT_WINSIZE, HANNING, ST_WINDATA
CALLED BY:
GIS_FIT, GIS_UTPLOT
Common : None.
Restrictions: GIS_SMOOTH only works with full GIS data windows.
Side effects: None.
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 4 April 1997
Modified : Version 2: Vincenzo Andretta, VAndretta@solar.stanford.edu, 23 January 1998
Rearranged indexes in some key arrays to fix a problem
with spurious extra dimensions introduced in the output data.
Version 3: Vincenzo Andretta, VAndretta@solar.stanford.edu, 24 March 1998
Fixed a bug: missing pixels were never recognized as such.
Filling missing pixels before smoothing (using CDS_FILL_MISSING).
Use keyword EDGE_TRUNCATE in CONVOL.
Made SMOOTHSIZE=7 the default.
Version 4: erb, 24 May 1998;
Incorporated gis_stage.inc
v5. : caf, Aug 2003; fix to work with partial GIS
data.
Version : 5
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_UTPLOT
Purpose : front end wrapper for GIS to UTPLOT, to enable ploting of GIS data
Explanation : When called by GIS_FIT, automatically fits well known GIS lines
Use : GIS_UTPLOT,qlds,1,psym=1
Inputs : QLDS = Structure variable of GIS data as read by
READCDSFITS.
Opt. Inputs :
Outputs : Timeseries plot of GIS data
Opt. Outputs: None.
Keywords :
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4]
GHOST_BUSTER, GIS_CALIB, GIS_FIT, GIS_SMOOTH, GT_WINDATA, GT_WINSIZE, INT2UTC
LIST_EXPER, READCDSFITS, TAG_EXIST [1], TAG_EXIST [2], UTPLOT [1], UTPLOT [2]
UTPLOT [3], UTPLOT [4], UTPLOT [5], UTPLOT [6], UTPLOT_IO [1], UTPLOT_IO [2]
UTPLOT_IO [3], delvarx [5]
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
Updated to be consistent with revised output structure
from GIS_FIT
Version : 1.1
[Previous]
[Next]
Project : SOHO - CDS
Name : GIS_WRITE_CALIB
Purpose : Prints calibration factors for GIS spectra.
Explanation : This main program uses the data from RAL-TR-1999-036 to produce
values for the GIS for entering into the CDS intensity
databases.
Use : .run GIS_CALIB_WRITE
Inputs : None.
Opt. Inputs : None.
Outputs : Plots and prints calibration values to screen
Opt. Outputs: None.
Keywords : None.
Common : None.
Restrictions: None.
Side effects: None?
Category : Calibration, GIS, Intensity.
Prev. Hist. : None.
Written : Eddie Breeveld, erb@mssl.ucl.ac.uk 22 June 1999
Modified : None.
Version : 1
[Previous]
[Next]
Project : SOHO - CDS
Name : GISPLOT
Purpose : Plot engineering data from all four GIS detectors.
Explanation : This procedure reads engineering data from all four GIS
detectors and then generates a single plot that looks kinda
like a strip chart. Engineering data is read from tm files
and extracted into a number of arrays. After all the
requested data has been read, then a plot is created from the
stored engineering data. The program can also be run in
realtime mode where data is contiously displayed as it is
read in. The type of the data to be plotted as well as the
time range covered by the plot is specified by using keywords.
Use : GISPLOT, [keywords]
Inputs : None.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : START Start time for the plot. The plot may actually begin
later if this time falls during a data gap. This
keyword should be set to a UTC time in any acceptable
text format. This keyword can be used in realtime
mode to specify a start time earlier then the current
time.
STOP End time for the plot. This keyword should be set to
a UTC time in any acceptable text format. This
option is ignored if the RT keyword (realtime mode) is
set.
RAW If set, then the raw counts from all four GIS
is plotted out. This is the defualt option.
ULD If set, then the upper level discriminator counts from
all four GIS detectors is plotted out.
PROC If set, then the processed counts from all four GIS
is plotted out.
HVCUR If set, then the HV current from all four GIS
is plotted out.
PRINT If set, the plot is printed out on the defualt printer
instead of being displayed on a terminal. This option
is ingnored if the RT keyword (realtime mode) is set.
RT If set, then realtime plotting will be performed.
In this mode, plots are generated continuously as
as data is being read. Otherwise, a single plot
is created only after all the data has been
processed.
Calls : GET_UTC
ANYTIM2UTC [1], ANYTIM2UTC [2], BYTESWAP, GET_TM_FILE, MK_GIS_PLT, NEXT_TM_FILE
OBT2TAI, PS [1], PS [2], PSPLOT [1], PSPLOT [2], READ_IWS_PKT, TAI2UTC, TM_CALIB
UTC2SEC
Common : None.
Restrictions: None.
Side effects: There is currently no clean way to exit the program when
started in realtime (keyword RT) mode. Use Ctrl-C instead.
Category : Engineering.
Prev. Hist. : None.
Written : Ron Yurow, SM&A, 12 May 1999
Modified : Version 1, Initial Release RY, 12 May 1999
Version : Version 1, 12 May 1999
[Previous]
[Next]
NAME:
go_arch_sum
PURPOSE:
Grep through the control file archive to make summaries
HISTORY:
Written 13-Mar-96 by M.Morrison
18-Mar-96 (MDM) - added /bin/csh to spawn command to let it work in sh
V2.0 5-Aug-96 (MDM) - Modified to make the output directory $MDI_CAL_INFO
V2.1 21-Oct-97 (MDM) - Modified to run on diapason
V2.2 9-Nov-99 (RIB) - Removed trig_mirror command - to be run in separate
cron job
[Previous]
[Next]
NAME:
go_arch_sum2
PURPOSE:
Grep through the control file archive to make summaries of last 24-48 hours
HISTORY:
Written 16-Apr-96 by M.Morrison
8-May-96 (MDM) - Echo the rcp command
13-May-96 (MDM) - Changed grep command to always grep last24hrs.cfl_sum_cron
so that when there is only one cfl file executed in the day
it will list the file name
- Modified rcp command to have the destination file name
explicitly
V2.0 5-Aug-96 (MDM) - Modified to make the output directory $MDI_CAL_INFO
V2.1 28-Oct-98 (RIB) - Modified to send outfil0 to outdir instead of indir
V2.2 9-Nov-99 (RIB) - Removed trig_mirror command - to be run in a separate
cron job.
[Previous]
[Next]
Name: go_batch
Purpose: make and idl 'batch' job and 'submit' it (using VMS terminology)
(puts and end statement on your command list and calls idl_batch)
Input Parameters:
command_list - one or more idl statements to execute
Keyword Parameters:
nodelist - one or more nodes to submit job on (will choose 'best' node)
user - user for remote job (ignored if no nodelist)
remove - if set, remove selected node from nodelist (for distribuinting jobs)
batchdir - directory for job (added to IDL !path) - default = $DIR_SITE_BATCH
logdir - if set, directory for log file
nodelete - if set, do not delete job & log after succesful completion
defnodes - if set, will use node list specified by $SITE_BATCHNODES
(see is_bestnode documentation)
caller - string name of calling routine (passed to pr_status)
Calling Sequence:
go_batch, command_list [nodelist=nodelist, user=user, batchdir=batchdir, $
[logdir=logdir, logfile=logfile]
Calling Examples:
go_batch, 'daily_forecast' , nodelist=['flare13','flare14','flare15']
(runs the idl command 'daily_forecast' as a background task on the
(least utiilized machine in the nodelist)
CALLS: ***
ARR2STR [1], Arr2Str [2], BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3]
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FILE_EXIST [2], STR2ARR [1]
STR2ARR [2], break_file [4], 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], get_host [1], get_host [2], get_user [1], get_user [2]
is_bestnode [1], is_bestnode [2], pr_status [1], pr_status [2], rd_tfile [1]
rd_tfile [2], rsh, ut_time [1], ut_time [2]
CALLED BY:
pref_super, xso_search
Side Effects:
and idl child process is submitted in the background on the specified
or best node available.
History:
29-Sep-1994 (SLF) written to facilitated distributed processing
1-Oct-1994 (SLF) added job file capability
2-Oct-1994 (SLF) added CALLER keyword (passed to pr_status)
[Previous]
[Next]
NAME:
go_cam_list
PURPOSE:
To reformat the campaign listings and show only
the campaigns which run for over 20 and 40 minutes.
Also establish the template for the executive synopsis
table entry
HISTORY:
Written 27-Nov-96 by M.Morrison
8-Jan-97 (MDM) - Added "96"
5-Aug-98 (MDM) - Modified to display the last campaign for exec synop
(was not doing it because it may not be finished)
6-Aug-98 (MDM) - Further patch to 5-Aug-98 patch
11-Feb-99 (MDM) - Fixed 1-Jan-99 cutoff problem
6-Jan-00 (MDM) - Fixed Y2K bug
01-Apr-04 (SEG) - Putting in a temporary fix to the "Y2K fix" Mons did
in 2000. Changing ss = sel_timrange(sttim, '1-jul-96', '1-jan-04', /bet)
to ss = sel_timrange(sttim, '1-jul-96', '1-jan-07', /bet)
[Previous]
[Next]
NAME:
go_gif_last9
PURPOSE:
To make a gif file of the last few images in the sci160k file
INPUT PARAMETERS:
OUTFIL - the file to write the final gif image to
NXOUT - Number of columns
NYOUT - Number of rows
NOUT - Total number of output images (=NXOUT*NYOUT?)
OPTIONAL KEYWORD INPUTS:
QFORCE - If this is NOT set, then the datestamp of the last
generated image file is checked against the latest .tfrx
(telemetry directory) file. Gifs are only generated if the
image file is out of date. If qforce is set, then the
gifs are regenerated regardless.
HISTORY:
Written 23-Aug-96 by M.Morrison
16-Oct-96 (MDM) - Write out offset values
8-Jan-97 (MDM) - Made into subroutine and also save last 4 images
30-Sep-97 (MDM) - Added X0SHIFT to display tracking
16-Aug-99 (CED) - Added a modicum of documentation to Mons's spaghetti.
Added pageback capability if infil is not specified:
if there are no data at all in the current .tfrx file,
then we page back to the previous one, and so on up to
8 files back. If there are data in the current .tfrx
file, but not enough, we *don't* page back -- but in that
case we can at least generate something.
[Previous]
[Next]
HISTORY:
Written 1-Aug-96 by M.Morrison
5-Aug-96 (MDM) - Added "disp_mdi_hr_fov" to disp_gen call
15-Aug-96 (MDM) - Scaled to gauss
19-Aug-96 (MDM) - Removed /5 logic (since mk_mdi_fits does it now)
21-Aug-96 (MDM) - Added call to mk_gif_mag_index
20-Jan-97 (MDM) - Changed output directory from
/soho-archive/public/data/summary/mdi (to)
/soho-archive/public/data/summary/gif/YYMMDD
11-Jun-97 (MDM) - Modified to mask out the part of the data which
is off the limb (but within the crop radius)
25-Jul-97 (MDM) - Added creation of the continuum GIF images
- Changed headers
10-Nov-97 (JFC) - Added a couple of lines to adjust the scaling of the
conitnuum images to distinguish umbrae and penumbrae
while we are entering the active cycle
12-Feb-99 (RIB) - Set the output directory to /md86/gif; changed the
continuum color table to "3" (red-temperature)
04-Aug-99 (CED) - Changed output directory to $MDI_GIF_DIR
4-Jan-2000 (RIB) - Changed rebinning of continuum flatfield to match
incoming fits file
26-Jan-2001 (RIB) - Changed flatfield file to flat_jan2001.fits
07-Jul-2003 (RIB) - Inserted check of CROT = 180 while SOHO is rolled
25-Mar-2005 (SEG) - Changing flat field file to flat_mar2005.fits, see
flat_README for more details.
[Previous]
[Next]
NAME:
GO_MDI_SUM
PURPOSE
It is the running program to create the daily reports for mdi_summary
HISTORY
27-Feb-96 written by Dan Goldberg
[Previous]
[Next]
NAME:
go_mk_opsdb_list
PURPOSE:
To dump the current status of the database into a text file.
The job is intended to run as a cron job every hour
HISTORY:
Written 16-Jan-96 by M.Morrison
25-Jan-96 (MDM) - added /sort_id to the "all" listings
- added /sort_lab to the "active" listings
31-Jan-96 (MDM) - Added RCP commands to distribute the files
25-Apr-96 (MDM) - Added making RDB files (two more calls to OPSDB_PRINT)
7-Aug-96 (MDM) - Removed rcp, added trig_mirror
8-Aug-96 (MDM) - Added creation of latest two TFR file listings
19-Aug-96 (MDM) - Added creation of IPREG and QADR
9-Nov-99 (RIB) - Removed trig_mirror command - to be run in a separate
cron job
[Previous]
[Next]
NAME:
go_mon_health_1d
PURPOSE:
Make opsdb lists and gif summaries every 24 hours.
HISTORY:
Written 17-Oct-1999 by R. Bush
17-Feb-2001 (RIB) - added edac summary
29-May-2001 (RIB) - added shutter plot
29-Apr-2002 (RIB) - added 60 day loi_summary, and 2 year
loi-c and loi-v plots
11-Jun-2004 (SEG) - Adding a 4 day Shutter Perf plot
[Previous]
[Next]
NAME:
go_mon_health_1d
PURPOSE:
Make opsdb lists and gif summaries every 24 hours.
HISTORY:
Written 17-Oct-99 by R. Bush
[Previous]
[Next]
NAME:
go_mon_health_20m
PURPOSE:
Make text and gif summaries of the last 24 hours.
HISTORY:
Written 6-Oct-99 by R. Bush
Combines and replaces go_arch_sum2, go_seq_run_sum2,
go_mon_health, go_gif_last9.
24-Apr-2004 (SEG) - Temporarily commenting out the roll plot stuff
while we are in low rate this weekend. Other
other plots aren't updating because roll plot
is crashing.
26-Apr-2004 (SEG) - Uncommenting the roll_plot calls.
[Previous]
[Next]
NAME:
go_mon_health_20m
PURPOSE:
Make text and gif summaries of the last 24 hours.
HISTORY:
Written 6-Oct-99 by R. Bush
Combines and replaces go_arch_sum2, go_seq_run_sum2,
go_mon_health, go_gif_last9.
[Previous]
[Next]
NAME:
go_mon_health_6hr
PURPOSE:
Make sci5k data products and gif summaries every 6 hours.
HISTORY:
Written 7-Oct-99 by R. Bush
24-Apr-2004 (SEG) - Temporarily commenting out disp_limb stuff
because it's crashing while we are in low rate
this weekend. It's causing everything after
it to crash. Also going to comment out the
roll plot stuff, because I bet it will crash too.
26-Apr-2004 (SEG) - Uncommenting the roll_plot and disp_limbfig calls.
[Previous]
[Next]
NAME:
go_mon_health_6hr
PURPOSE:
Make sci5k data products and gif summaries every 6 hours.
HISTORY:
Written 7-Oct-99 by R. Bush
[Previous]
[Next]
NAME:
go_mon_sci5k
PURPOSE:
To see if the mon_sci5k process is running and to start it up if needed
HISTORY:
12-May-99 (CED) - Removed /disp_loi from the mon_sci5k call
11-May-99 (CED) - Added /daily flag to the mon_sci5k call
21-Apr-99 (CED) - Fixed bug that caused infinite loop (hence runaway
CPU hogging) if the last file in /md80/log/mon5k was
not owned by mdi. Used GSE_MON5K_DIR environment
variable instead of hardwired location.
2-Dec-97 (CED) - Modified error code to send message to idl-cron
instead of to morrison
30-Aug-96 (MDM) - Modified to call "pkt_time" to find out the time of
the newest packet and to not re-start if it's hung
because of no telemetry
8-Jul-96 (MDM) - Revised to kill the children processes too
24-Jul-96 (MDM) - Removed the mail message sending (since dynamics ended)
6-Jun-96 (MDM) - Added /FILE switch to the mon_sci5k call
30-May-96 (MDM) - Added call to "track_proc" to kill any earlier runs which
are hanging around or waiting for telemetry
29-May-96 (MDM) - Added call to get_dpc_info before mon_sci5k to avoid hangs
Written 29-May-96 by M.Morrison
[Previous]
[Next]
NAME:
go_seq_run_sum
PURPOSE:
Main program driver for SEQ_RUN_SUM to be run in batch
HISTORY:
Written 15-Jan-96 by M.Morrison
31-Jan-96 (MDM) - Corrected error which caused a run-away job
(first of the month)
- Added RCP command to update the 3 nodes
1-Feb-96 (MDM) - Added calls to CAM_RUN_SUM
16-Apr-96 (MDM) - Removed call to SEQ_RUN_SUM
[Previous]
[Next]
NAME:
go_seq_run_sum2
PURPOSE:
Main program driver for SEQ_RUN_SUM to be run in batch to make
summary of last 24 hours
HISTORY:
Written 5-Mar-96 by M.Morrison
12-Mar-96 (MDM) - Added copying of the opsdb_prep.genx file to all sites
15-Apr-96 (MDM) - Re-added the copying of last24hr logs to the http site
(the 7-Mar mod was lost during 12-mar update)
7-Mar update was also going to the wrong place
16-Apr-96 (MDM) - Removed call to SEQ_RUN_SUM
7-Aug-96 (MDM) - Removed rcp, added trig_mirror
9-Nov-99 (RIB) - Removed trig_mirror command - to be run in a separate
cron job.
[Previous]
[Next]
NAME:
GRAD
PURPOSE:
Designs a "gradient map", i.e. a image made with parallel lines, all of
them perpendicular to a given gradient direction
CALLING SEQUENCE:
g = grad (xsize, ysize, theta)
INPUTS:
xsize, ysize the size of the map image
theta the angle of the gradient vector (versus the (Ox) axis)
expressed in radians; the parallel lines are thus
along the direction theta+pi/2
OUTPUTS:
the (xsize) x (ysize) array where the value of each point is equal to
the distance beetween the line perpendicular to the gradient that pass
through this point and the origin.
The origin (just as for the dist function) is located at 1 of the 4
corner of the image, depending on the value of theta :
_ for theta in [0, pi/2], the origin = (0, 0)
- for theta in [pi/2, pi], the origin = (xsize-1, 0)
_ for theta in [pi, 3.pi/2], the origin = (xsize-1, ysize-1)
- for theta in [3.pi/2, 2.pi], the origin = (0, ysize-1)
CALLS:
CALLED BY
HCIE_ZONE [2], MULTI_INTERP, MULTI_SMOOTH, hcie_zone [1]
[Previous]
[Next]
NAME:
GRAD_ZONE
PURPOSE:
Returns the main gradient orientation of a zone containing MB
CATEGORY:
Missing Blocks
CALLING SEQUENCE:
angle = grad_zone (image, list_miss_blocks)
INPUTS:
image the image containing missing blocks
list_miss_blocks the missing blocks defining the zone
KEYWORD INPUT:
rebindex : rebin index (see fuzzy_image.pro)
OUTPUTS:
The angle of the gradient vector
CALLS: ***
READ_ZONE
CALLED BY:
FUZZY_IMAGE, GRAD, HCIE_ZONE [2], MULTI_INTERP, MULTI_SMOOTH, hcie_zone [1]
MODIFICATION HISTORY:
Written by J. More, November 1996
Add of rebindex keyword on 28/01/2000 by A.Thernisien
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_BIMAGE
Purpose : Return wavelength band integrated image.
Explanation : GT_BIMAGE returns a two-dimensional image from a CDS
observation raster. The image consists of intensities
integrated over a given wavelength band, for all the X/Y image
positions in the raster.
The integration is performed in a naive way, with partially
covered pixels contributing with weight corresponding to the
fraction of the pixel covered by the integration area.
The total pixel weight for each position is returned through
the keyword WEIGHT. I.e., to get the average counts per pixel,
divide by the WEIGHT, but beware of division with zero when
data is missing. A warning is given if the weight varies more
than 0.5% from the expected value.
If pixel weights differ more than 1% from the expected value,
the pixels are flagged as missing.
The returned array has dimensions (X,Y) given by the size of
the data contained in the QLDS.
In addition to the image, values for the physical parameters
XSOLAR, YSOLAR, and TIME returned through output keywords as
two-dimensional arrays with the same size as the image.
Use : im = gt_bimage(QLDS,lambda)
Inputs : QLDS: CDS QuickLook Data structure
LAMBDA1,
LAMBDA2: The low and high limit of the wavelength integration
area
Opt. Inputs :
Outputs : Two-dimensional image. Size determined by the content
of the QLDS.
Opt. Outputs: XSOLAR : Solar Cartesian X (arcsecs)
YSOLAR : Solar Cartesian Y (arcsecs)
TIME : Time of the exposures
WEIGHT : The (possibly fractional) number of dispersion pixels
that have been included in the integration.
Keywords : NOCHECK: Set to avoid call to QLMGR
NOPARCHECK: Set to avoid most parameter checking mostly for
internal use.
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], AVERAGE, GT_DETECTOR, GT_DIMENSION, GT_IIMAGE
GT_LAMBDA, GT_WAVEBAND, GT_WINDATA, GT_WINDOW, LOAD_WAVECAL, PARCHECK, PIX2WAVE, QLMGR
ST_WINDATA, TRIM, TYP, WAVE2PIX
CALLED BY:
MK_CDS_IMAP, POLY_SPEC
Common : None.
Restrictions: QLDS == QL Data Structure.
Side effects: None known.
Category : GET
Prev. Hist. : Previous version deleted with a tar cvf gt*.pro command!
Written : SVH Haugan, UiO, 2-November-1995
Modified : Version 2, SVHH, UiO, 6 April 1996
Changed logic for finding the initial image,
to avoid calling gt_iimage too many times.
Included keyword /QUICK for gt_iimage calls.
Version 3, SVHH, UiO, 14 April 1996
Using LOAD_WAVECAL for wavelength calibrations.
Also fixed typo that made it *not* compile.
Version 4, SVHH, UiO, 13 August 1996
Corrected a bug caused by an improved implementation
of the /QUICK keyword in gt_iimage.
This routine now detects missing pixels, excludes
them in the integration, and flags pixels with less
than half the expected pixel weight as missing.
Version 5, SVHH, UiO, November-January 1997
New, faster version (vectorized).
Version 6, SVHH, 18 February 1999
Fixed bug with DETX > 2048 for GIS bands.
Version 7, DMZ, 1 April 1999
Added ERR and /CONT
Version 8, Zarro (SM&A/GSFC), 19 Oct 1999
Added size check on DL
Version : 8
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_BINX()
Purpose : Return detector X binning factor for a QLDS.
Explanation : Uses the information in the QLDS to find the BINX
value.
Use : BINX = GT_BINX(QLDS)
Inputs : QLDS: Quick Look Data Structure.
Opt. Inputs : None.
Outputs : Returns the binning factor.
Opt. Outputs: None.
Keywords : NOPARCHECK: Set to avoid call to QLMGR.
Calls : ***
QLMGR
CALLED BY:
GT_IIMAGE, GT_WINDOW
Common : None.
Restrictions:
Side effects: None.
Category : GET
Prev. Hist. : None.
Written : SVH Haugan, UiO, 30-October-1995
Modified :
Version : 1.0, 30-October-1995
[Previous]
[Next]
Project : SOHO-CDS
Name : GT_CDS_QL
Purpose : read a sequence of CDS FITS QL files into memory
Category : data analysis
Explanation :
Syntax : data=gt_cds_ql(fstart,fend)
Examples :
Inputs : FSTART,FEND = start/end FITS file numbers
Opt. Inputs : None
Outputs : DATA = array of quicklook structures
Opt. Outputs: None
Keywords : CALIB = set to FlatField
: CLEAN = set to remove spikes
: PROMPT = set to prompt for window
: WINDOW = window to select
CALLS: ***
BOOST_ARRAY [1], BOOST_ARRAY [2], BOOST_ARRAY [3], CDS_CLEAN, EXIST
FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3], GT_CDS_WINDOW
GT_WINDATA, LIST_EXPER, MAKE_STR [1], MAKE_STR [2], QLMGR, READCDSFITS, REM_ANON_TAG
SET_CDS_SDB, TRIM, UNIQ [1], UNIQ [2], UNIQ [3], VDS_CALIB
Common : None
Restrictions: None
Side effects: None
History : Written 22 October 1996, D. Zarro, ARC/GSFC
Contact : dzarro@solar.stanford.edu
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_CDS_TIME
Purpose : Returns the time of a specified exposure
Explanation : This function is supposed to return the most correct time
coordinate for given data points in a QLDS.
The parameter XIX, YIX, and TIX may be either arrays or a
scalars. All array inputs must be of the same size. The result
will be of the same size as the input, with the exception that
singular dimensions will be reform'ed away.
Use : GT_CDS_TIME(QLDS,XIX,YIX,TIX)
Inputs : QLDS: CDS QuickLook Data structure
XIX: The X index of the exposure/data point for which the time
is requested.
YIX: The Y index of the exposure/data point.
TIX: The Time index of the exposure/data point.
Opt. Inputs : None.
Outputs : Returns the time of the specified exposures.
Opt. Outputs: None.
Keywords : NOCHECK: Set to avoid call to QLMGR
NOPARCHECK: Avoid all parameter checking
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], GT_DETECTOR, GT_DIMENSION, PARCHECK, QLMGR
SAME_DATA [1], SAME_DATA [2], TYP, UTC2TAI
CALLED BY:
GT_IIMAGE, GT_SCANP, GT_SCANT, GT_SCANX, GT_SCANY, GT_SPECTRUM, NDSPSPEC
Common : None.
Restrictions: QLDS == QL Data Structure.
Side effects: None.
Category : CDS, QuickLook, Data_Handling.
Prev. Hist. :
Written : S.V.H. Haugan, 11-Sept-1995
Modified : Version 2, SVHH, 20-December-1995
Added NOPARCHECK keyword.
Version 3, SVHH, 27 February 1996
ND based on N_elements(....axes) instead of
del_timedata's dimensionality.
Version 4, SVHH, 22 February 1996
Added some support for mis-named axes.
Version 5, SVHH, 4 March 1996
Fixed single-exposure case with misnamed axis.
And re-fixed logic for NIS cases.
Version 6, SVHH, 12 April 1996
Renamed gt_time -> gt_cds_time
Version 7, SVHH, 12 October 1996
Detecting and propagating missing values.
Checking that array inputs are always same size, and
promoting non-array inputs to arrays.
Version 8, Zarro (EITI/GSFC) 14-Feb-02
added check for single dimension vectors
Version : 8
[Previous]
[Next]
Project : SOHO-CDS
Name : GT_CDS_WINDOW
Purpose : useful function for getting CDS window number
Category : data analysis
Explanation :
Syntax : window=gt_cds_window(ql)
or,
window=gt_cds_window(ras_id,ras_var)
CALLED BY:
CDS_TILT_COR, FIT_CDS_QL, GT_CDS_QL, MK_CDS_IMAP, MK_CDS_MAP, MK_CDS_SMAP
Examples :
Inputs : QL = CDS quicklook data structure
or,
RAS_ID = raster id
RAS_VAR = raster variation
Opt. Inputs : None
Outputs : WINDOW = selected window number(s)
Opt. Outputs: None
Keywords : NWIND = number of windows selected
CALLS: ***
EXIST, GET_LINELIST, PR_SYNTAX, QLMGR, STR2ARR [1], STR2ARR [2], TRIM, WHERE_VECTOR
Common : None
Restrictions: None
Side effects: None
History : Written 22 October 1996, D. Zarro, ARC/GSFC
Contact : dzarro@solar.stanford.edu
[Previous]
[Next]
NAME:
gt_conv2str
PURPOSE:
After a "GT" routine has extracted the relevant information, optionally
convert the information to a string.
METHOD:
INPUT:
item - An integer scalar or array. Any check on it's proper range
should have been done in the calling routine.
str_long
str_short
header_array - A list of the header strings available.
header_array(0) - used by /string and /fmt
and /spaces options
header_array(1) - used by /short option
OPTIONAL INPUT:
string - If present, return the string nemonic for the
filter (long notation)
short - If present, return the short string nemonic for
the filter
spaces - If present, place that many spaces before the output
string. The long notation is used unless /short
is specified.
fmt - Format statement to be used if /string, /short, or
/spaces option is used.
OUTPUT:
returns - If requested to make a conversion, then return the string
equivalent of the input. It is a vector
if the input is a vector
OPTIONAL OUTPUT:
header - A string that describes the item that was selected
to be used in listing headers.
CALLED BY:
get_info [3], get_info [4], gt_EITfilter, gt_EITsector, gt_adoor, gt_comp
gt_corner_cmd, gt_dp_mode [1], gt_dp_mode [2], gt_dp_rate [1], gt_dp_rate [2]
gt_dpe, gt_entry, gt_expdur [1], gt_expdur [2], gt_expmode, gt_filta, gt_filtb
gt_grs1, gt_grs2, gt_hxs [1], gt_hxs [2], gt_hxt_hk_temp, gt_mbe [1], gt_mbe [2]
gt_obsregion, gt_or_expnum, gt_percentd, gt_percentover, gt_pfi_ffi, gt_rbmsc
gt_rbmsd, gt_res, gt_seq_num, gt_seq_tab, gt_shape, gt_shape_cmd, gt_sum_h [1]
gt_sum_h [2], gt_sum_l [1], gt_sum_l [2], gt_sum_m1 [1], gt_sum_m1 [2]
gt_sum_m2 [1], gt_sum_m2 [2], gt_sxs1 [1], gt_sxs1 [2], gt_sxs2 [1], gt_sxs2 [2]
gt_temp_ccd, gt_temp_hk, gt_total_cnts [1], gt_total_cnts [2], hxt_hk_temp
sxt_fits_info
HISTORY:
Written 13-Nov-91 by M.Morrison
3-Jun-93 (MDM) - Modified to use a LONG variable for the for loop
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_DATA_UNITS()
Purpose : Returns the current data units in the QLDS
Explanation : Information taken from the header.
Use : UNITS = GT_DATA_UNITS(QLDS)
Inputs : QLDS: Quick Look Data Structure
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : NOCHECK: Set to avoid call to QLMGR
Calls : ***
QLMGR
CALLED BY:
CDS_SATURATE
Common : None.
Restrictions:
Side effects: None.
Category : GET routine
Prev. Hist. : None.
Written : 25-Jan-1999, CDP
Modified :
Version : 1, 25-Jan-1999
[Previous]
[Next]
NAME:
gt_day
PURPOSE:
To extract the word corresponding to day and optionally
return a string variable for that item. If the item passed is an
integer type, it is assumed to be the 7-element external representation
of the time.
CALLING SEQUENCE:
x = gt_day(roadmap)
x = gt_day(index)
x = gt_day(index.sxt, /space) ;put single space before string
x = gt_day(index, space=3) ;put 3 spaces
METHOD:
The input can be a structure or a scalar. The structure can
be the index, or roadmap, or observing log.
INPUT:
item - A structure or scalar. It can be an array.
(or)
The "standard" 7 element external representation
of time (HH,MM,SS,MSEC,DD,MM,YY)
CALLS: ***
Int2Ex [1], Int2Ex [2], anytim2ints [1], anytim2ints [2], tbeep [1], tbeep [2]
tbeep [3]
CALLED BY:
ALIGN_AR, ARC2LEN, ATIME [1], ATIME [2], BCS_ACCUM [1], BCS_ACCUM [2], BCS_DP_CHECK
BCS_DT_INTERP [1], BCS_DT_INTERP [2], BSC_TIM2DSET, CCCA, CHKTERM, DATAGET3_GRS
DATAGET3_HXS, EIT_GBO, FIX_OLD_ATT [1], FIX_OLD_ATT [2], F_ATIME [1], F_ATIME [2]
GETCAL_ATT [1], GETCAL_ATT [2], GET_FRAME_TIME, GET_POINTS, GET_SUNCENTER [1]
GET_SUNCENTER [2], GET_YOHKOH_POS, GT_BSC_TIME, HXAXY2SXT, HXT2SXSPC, HXT_4CHPLOT
HXT_DUMP, INF_STR, IRUHXASCAN2SXT [1], IRUHXASCAN2SXT [2], LIST_BDA, LIST_BSC [1]
LIST_BSC [2], LIST_GEV, LIST_NAR, MAKE_VTRANGE, MDI_GBO, MK_GRSPCH, MK_GRSPCL
MK_GRSPHH1, MK_GRSPHH2, MK_GRSPHL1, MK_GRSPHL2, MK_HXI_MAP, MK_HXSPC, MK_HXSPH
MK_RBMPC, MK_SXT_MAP, NORP_RDT2DATA_17G, NORP_RDT2DATA_1G, NORP_RDT2DATA_2G
NORP_RDT2DATA_35G, NORP_RDT2DATA_4G, NORP_RDT2DATA_80G, NORP_RDT2DATA_9G
OUT_GRSPHL1, OUT_GRSPHL2, OUT_HXSPH, OVER_THE_LIMB, PLOT_GRSPCH, PLOT_GRSPCL
PLOT_GRSPHH, PLOT_GRSPHL, PLOT_HXSPC, PLOT_HXSPH, PRINT_GEV, PRINT_NAR, RD_AR, RES_FFI
SEL_AR, SPLINE_LC, SPLINE_PLOT, SSDA, SXI_GBO, SXT2HXAXY, SXT_ECLIPSE, SXT_OBSRPT
SXT_TEEM1 [1], SXT_TEEM1 [2], SXT_TEEM1 [3], TRACE_GBO, WBDA [1], WBDA [2], WBSC [1]
WBSC [2], WBS_DB, anystr2tim [1], anystr2tim [2], anytim [1], anytim [2], anytim [3]
anytim [4], anytim [5], anytim2ex [1], anytim2ex [2], anytim2ints [1]
anytim2ints [2], anytim2weekid [1], anytim2weekid [2], auto_toban, bbso_copy [1]
bbso_copy [2], bcs_survey, bcs_trange, cam_run_sum, carr2btime [2]
cdrom_files [2], check_sci5k_trunc, cnvt [2], cont2time [1], cont2time [2]
contacts [1], contacts [2], db_gbo, do_ads, doy2ex [1], doy2ex [2], dpc_img_summary
dsn_input, eit_fulldiskdb, eitoversxt, exp_scale min_exp max_exp [1]
filetimes [1], filetimes [2], fits_disp_month [1], fits_disp_month [2]
fl_goesplot [1], fl_goesplot [2], fl_goesplot [3], fl_mktext, fmt_pass
fmt_tim [1], fmt_tim [2], function timeintervalab, get_ar, get_dc_image [2]
get_dc_image [3], get_leak_image [1], get_leak_image [2], get_leak_image [3]
get_linearity sig e_min e_max, get_selsis, get_visible, goes3sec_copy, goes_gaps
goes_plot [1], goes_plot [2], goes_plot [3], goes_plot [4], goes_plot [5]
goes_summary, grs_plot, gtab_file, hsi_gbo, html_form_addtime [1]
html_form_addtime [2], html_form_addtime [3], hxt_images2ps, hxt_impulsivness
hxt_mcaccum, hxtimg_accum, int2sec [1], int2sec [2], ipcom, iperr_sea
jitter_gif_xyimg, killold [1], killold [2], last_lc, list_nrt_times, ltc, mdipict
mk_bsa_interv [1], mk_bsa_interv [2], mk_desat_wl, mk_gev [1], mk_gev [2], mk_gx
mk_hst_summary, mk_imgsum_html, mk_limb_pixmap, mk_mdi_iap, mk_nar [1], mk_nar [2]
mk_orbit_files, mk_ptv_title, mk_sdmi, mk_sfd [1], mk_sfd [2], mk_sfd [3]
mk_sfd [4], mk_sfw, mk_syn_sfc [1], mk_syn_sfc [2], mk_title [2], mk_week_file [1]
mk_week_file [2], mk_ydbtab, monitor_center [1], nob_img_copy, obs_summary
plot_ref, pr_conf, pr_dates_warm [1], pr_dates_warm [2], pr_mdihk_trans [1]
pr_mdihk_trans [2], pr_nar, pr_trav_summ, pr_visible
pro interpretfemfemfemtimefemflgfemstrfemstrverboseverbose
pro loadopfemfiletimeOGfemverboseverbose
pro loadoptextfiletimeOGverboseverbose, pro showaoslosgdfemtimefemflg
rd_raw_station_plan, rd_sci5k, rd_selsis, rd_sfd_carr, rd_so_at_ftr
rd_station_plan, rd_therm_rs232, rd_week_file [1], rd_week_file [2]
rd_week_file [3], rd_week_file [4], read_eit, read_ltc file, redo_mon_sci5k
reltime [1], reltime [2], res_freq, ret_day, run_dsnfil, sda2fits, selsis_copy [1]
selsis_copy [2], seq_run_sum [1], seq_run_sum [2], show_contacts
soon_search [1], soon_search [3], sxt_align, sxt_combine, sxt_composite [1]
sxt_composite [2], sxt_composite [3], sxt_images2ps, sxt_mauna
sxt_sff_composite [1], sxt_sff_composite [2], tim2dow, tim2dset [1]
tim2dset [2], time_add1s, time_addxa, timeline, timeline2html, tr_decode_head [1]
tr_decode_head [2], usertimes_event, weekid [2], wrt_fits_bin_exten [2]
wrtsxtmap, xdate [1], xdate [2], xhkplot, xread_hist, ydb_exist [2]
OPTIONAL KEYWORD INPUT:
string - If present, return the string mnemonic (long notation)
spaces - If present, place that many spaces before the output
string.
leadzero - If present, put a leading zero for dates 1 thru 9
lower - If present, have the characters after the lead character be in
lower case.
longmonth - If present, then use the full length month name
fits - If present, then use the FITS slash format of the type DD/MM/YY
OUTPUT:
returns - The day, a integer value or a string
value depending on the switches used. It is a vector
if the input is a vector
Sample String: 12-OCT-91
OPTIONAL OUTPUT:
header - A string that describes the item that was selected
to be used in listing headers.
HISTORY:
Written 13-Nov-91 by M.Morrison
4-Jun-92 (MDM) - Added "leadzero" option
21-Oct-92 (MDM) - Added "lower" option
10-Mar-93 (MDM) - Added "longmonth" option
16-May-93 (MDM) - Modified to accept string time as input
27-May-93 (MDM) - Modified to handle years after 1999
4-Aug-95 (MDM) - Added /FITS keyword
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_DETECTOR
Purpose : Returns the detector name ('NIS' or 'GIS')
Explanation : Information taken from the header.
Use : detector = GT_DETECTOR(QLDS)
Inputs : QLDS: Quick Look Data Structure
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : NOCHECK: Set to avoid call to QLMGR
Calls : ***
QLMGR
CALLED BY:
GT_BIMAGE, GT_CDS_TIME, GT_DETY, GT_DIMENSION, GT_IIMAGE, GT_LAMBDA, GT_MIMAGE
GT_SCANP, GT_SCANT, GT_SCANX, GT_SCANY, GT_SOLARX, GT_SPECTRUM, GT_VALID, GT_WINDOW
NIS_MRGDATA, RESTORE_WAVECAL, dsp_menu
Common : None.
Restrictions: QLDS - later on it may also be a file spec.
Side effects: None.
Category : GET routine
Prev. Hist. : None.
Written : 4-Sept-1995, Stein Vidar Hagfors Haugan
Modified : SVHH, Version 2, 30-October-1995
Added /NOCHECK keyword and on_error handling.
Version : 2, 30-October-1995
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_DETY
Purpose : Return detector Y guess (for NIS) given YIX and waveband.
Explanation : WARNING! Since there is no one-to-one relationship between
waveband and the starting detector Y value (with windows not
aligned to start at the same detector Y position), this
routine should only be used to get a "guess" at the detector Y
position whenever there is no detector window covering the
given pixel.
Actually, this routine was written on the wrong assumption
that the windows would be aligned, so don't use this when
other methods are available, like finding a window covering
the pixel with gt_window and then using information in the
QLDS.detdesc structure.
Use : dety=gt_dety(QLDS,YIX,BAND)
Inputs : QLDS: Quick Look Data Structure
YIX: Y index (Scalar or array)
BAND: Wavelength band (1 or 2).
Opt. Inputs : None.
Outputs : Returns detector Y.
Opt. Outputs: None.
Keywords : NOCHECK: Skip call to QLMGR
NOPARCHECK: Skip all parameter checks
Calls : ***
GET_VDS_SLITPOS, GT_DETECTOR, PARCHECK, QLMGR, TYP
CALLED BY:
GT_SCANT, GT_SCANX, GT_SCANY, NDSPSPEC
Common : None.
Restrictions: None.
Side effects: None.
Category : GET
Prev. Hist. : None.
Written : S.V.H. Haugan, UiO, 20-December-1995
Modified : Version 2, SVHH, 5-February-1996
Added hack around lacking state information,
supplying default values + warning.
Version 3, SVHH, 16 April 1996
Using GET_VDS_SLITPOS instead of cp_get_state.
This function (gt_dety) doesn't return correct
values all the time, since dety is a function
of window number as well as yix and band.
Version 4, SVHH, 18 November 1996
Updated documentation to reflect the shortfalls of
this routine. Basing the dety estimate on the
*average* position of the slit center instead of just
the short-wavelength version.
Version : 4, 18 November 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_DIMENSION
Purpose : Returns information on the dimensionality of a QLDS
Explanation : Based on the information in the QuickLook Data Stucture,
an IDL structure describing the dimensionality of the
detector data windows is returned with the following tags:
WAVELNTH : TRUE if the spectral dimension is present
SOLAR_X: TRUE if the SOLAR_X dimension is present
SOLAR_Y: TRUE if the SOLAR_Y dimension is present
DEL_TIME: TRUE if the DEL_TIME dimension is present
NDIMS: The number of present dimensions
Note that a dimension may be singular even if it is present.
Whenever the last dimension of an array is singular, it will
vanish instantly in IDL.
There is also a tag for each of the dimensions that
describes the size of the dimension, named SWAVELNTH,
SSOLAR_X, SSOLAR_Y, SDEL_TIME.
For programs displaying two-dimensional "images", i.e.,
results of gt_scanx/y or gt_i/m/bimage, there are tags with
information on solar x/yñ and del_time origin and spacing, for
use with e.g., PLOT_IMAGE. The tags are called
SOLAR_X_ORIGIN/SOLAR_X_SPACING etc. Note that this information
is a crude linear approximation of the physical coordinates.
The tags WAVELNTH_ORIGIN/WAVELNTH_SPACING are arrays with four
entries, representing the origin/spacing of the wavelength in
each band. For NIS, only two entries will be used, the others
will be zero. The spacing values of the wavelength is made by
dividing the total wavelength span with the number of pixels.
Use : info = GT_DIMENSION(QLDS)
Inputs : QLDS: QuickLook Data Structure, see CDS software note #9
Opt. Inputs : None.
Outputs : Returns a structure with information on the dimensionality
of the data windows in the QLDS
Opt. Outputs: None.
Keywords : NOCHECK : Set to avoid checking the validity of the QLDS
Calls : ***
GT_DETECTOR, LOAD_WAVECAL, PIX2WAVE, QLMGR, QL_SIZE
CALLED BY:
CDS_CLEAN_EXP, CDS_CLEAN_SPIKE, CDS_FILL_MISSING, CDS_NEW_SPIKE, CDS_REPAIR_TOP
CWQ_DSPWAV [1], DSPEXP, DSPWAV, DSP_INFO, DSP_MOVIE, DSP_POINT, GDSPSPEC
GIS_CALIB_EXTRACT, GIS_ERROR, GIS_SMOOTH, GT_BIMAGE, GT_CDS_TIME, GT_IIMAGE
GT_LAMBDA, GT_MIMAGE, GT_SCANP, GT_SCANT, GT_SCANX, GT_SCANY, GT_SOLARX, GT_SOLARY
GT_SPECTRUM, GT_VALID, GT_WINDOW, MK_CDS_IMAP, MK_CDS_MAP, MK_CDS_SMAP, MK_SYNOPTIC
MONO_SPEC, NIS_MRGDATA, QL_DIMENSIONS, XCDS_COSMIC, cwq_dspwav [2], dsp_menu
Common : GT_DIMENSION_CACHE : Cache for speeding up this otherwise
quite slow routine.
Restrictions: QLDS should conform to CDS software not #9
Side effects: None known.
Category : CDS QuickLook
Prev. Hist. : Taken from QL_DIMENSIONS
Written : Stein Vidar Hagfors Haugan, 25-Aug-1995
Modified : Version 2, SVHH, 17 June 1996
Added memory cache since this routine was very slow
and often used.
Version 3, SVHH, 12 August 1996
Now compatible with old and new storage system.
Version 4, SVHH, 15 August 1996
No longer referring to the data at all.
Version 5, SVHH, 22 August 1996
Added origin/spacing fields.
Version 6, SVHH, 27 August 1996
No longer requiring windows to be read in, since the
size should be correct anyway.
Version 7, William Thompson, GSFC, 26-Oct-2005
Make sure DEL_TIME_ORIGIN and DEL_TIME_SPACING follow
their historic behavior.
Version : Version 7, 26-Oct-2005
[Previous]
[Next]
NAME:
gt_dp_mode
PURPOSE:
To extract the bits corresponding to DP Mode and optionally
return a string mnemonic.
CALLING SEQUENCE:
print, gt_dp_mode() ;to list the nemonics
x = gt_dp_mode(index)
x = gt_dp_mode(roadmap)
x = gt_dp_mode(index.gen, /string)
x = gt_dp_mode(dp_mode, /short)
x = gt_dp_mode(indgen(6)+1) ;used with menu selection
x = gt_dp_mode(index, space=3) ;put 3 spaces
METHOD:
The input can be a structure or a scalar. The structure can
be the index, or roadmap, or observing log. If the input
is non-byte type, it assumes that the bit extraction had
already occurred and the "mask" is not performed on the input.
INPUT:
item - A structure or scalar. It can be an array. If this
value is not present, a help summary is printed on the
filter names used.
OPTIONAL INPUT:
string - If present, return the string mnemonic (long notation)
short - If present, return the short string mnemonic
spaces - If present, place that many spaces before the output
string.
OUTPUT:
returns - The filter selected, a integer value or a string
value depending on the switches used. It is a vector
if the input is a vector
OPTIONAL OUTPUT:
header - A string that describes the item that was selected
to be used in listing headers.
CALLS: ***
MASK, gt_conv2str [1], gt_conv2str [2], tag_index [1], tag_index [2]
CALLED BY:
AVE_CTS2 [1], AVE_CTS2 [2], AVE_CTS2 [3], FIND_FAST_DATA, GET_FRAME_TIME
GET_POINTS, GOES_TEK [1], GOES_TEK [2], HXT_AUTOIMG, HXT_DUMP, HXT_FANS, HXT_HI_SUM
HXT_LOW_SUM, HXT_MED1_SUM, HXT_MED2_SUM, HXT_PRESTORE [1], HXT_PRESTORE [2]
HXT_PRESTORE [3], HXT_PRESTORE [4], HXT_PRESTORE [5], HXT_SUMMER, HXT_TIME2FRAME
PREFLARE_SEARCH, QUICK_DPE, READ_HXT_CAL, SXT_HYST, SXT_QLOOK, WBS_DB, WBS_DB2
WBS_TVEC, WL_CUBE_II, fl_goesplot [1], fl_goesplot [2], fl_goesplot [3]
get_info [1], get_info [2], get_info [3], get_info [4], get_utevent [1]
get_utevent [2], grs_plot, hxt_chsums, hxt_mcaccum, hxtimg_accum, mk_evn [1]
mk_evn [2], mk_mask, mk_pnt, mk_ptv_title, mk_ssl, mk_title [2], pfi_dominant
plot_evn, ploty [1], ploty [2], pr_evn [2], pr_sxt_term, rd_sda_flare
read_yohkoh_4_spex [1], read_yohkoh_4_spex [2], sda2fits, seq_2fl, show_obs2
show_obs3, show_obs4, sswhere, sxt_fits_info, sxt_tfl, sxt_tflx, xsearch_obs
HISTORY:
Written 13-Nov-91 by M.Morrison
1-May-92 (MDM) - Modified to handle the case of BCS data.
3-May-92 (MDM) - Modified to handle ADA data (error
introduced by BCS patch of 1-May)
6-Aug-92 (MDM) - Modification to handle BCS lookup conversion
properly
[Previous]
[Next]
NAME:
gt_dp_rate
PURPOSE:
To extract the bits corresponding to DP Mode and optionally
return a string mnemonic.
CALLING SEQUENCE:
print, gt_dp_rate() ;to list the nemonics
x = gt_dp_rate(index)
x = gt_dp_rate(roadmap)
x = gt_dp_rate(index.gen, /string)
x = gt_dp_rate(dp_rate, /short)
x = gt_dp_rate(indgen(6)+1) ;used with menu selection
x = gt_dp_rate(index, space=3) ;put 3 spaces
METHOD:
The input can be a structure or a scalar. The structure can
be the index, or roadmap, or observing log. If the input
is non-byte type, it assumes that the bit extraction had
already occurred and the "mask" is not performed on the input.
INPUT:
item - A structure or scalar. It can be an array. If this
value is not present, a help summary is printed on the
filter names used.
OPTIONAL INPUT:
string - If present, return the string mnemonic (long notation)
short - If present, return the short string mnemonic
spaces - If present, place that many spaces before the output
string.
OUTPUT:
returns - The filter selected, a integer value or a string
value depending on the switches used. It is a vector
if the input is a vector
OPTIONAL OUTPUT:
header - A string that describes the item that was selected
to be used in listing headers.
CALLS: ***
MASK, gt_conv2str [1], gt_conv2str [2]
CALLED BY:
FIND_FAST_DATA, GET_FRAME_TIME, GOES_TEK [1], GOES_TEK [2], HXT_DUMP, HXT_FANS
HXT_HI_SUM, HXT_LOW_SUM, HXT_MED1_SUM, HXT_MED2_SUM, HXT_PRESTORE [1]
HXT_PRESTORE [2], HXT_PRESTORE [3], HXT_PRESTORE [4], HXT_PRESTORE [5]
HXT_SUMMER, MK_GRSPCH, MK_GRSPCL, MK_GRSPHH1, MK_GRSPHH2, MK_GRSPHL1, MK_GRSPHL2
MK_HXSPC, MK_HXSPH, MK_RBMPC, OUT_GRSPHL1, OUT_GRSPHL2, OUT_HXSPH, PLOT_GRSPCH
PLOT_GRSPCL, PLOT_GRSPHH, PLOT_GRSPHL, PLOT_HXSPC, PLOT_HXSPH, READ_HXT_CAL
SXT_EXPOSURE_MAP, WBS_DB, WBS_DB2, WBS_TVEC, cnvt [2], dprate2sec [1]
dprate2sec [2], get_info [1], get_info [2], get_info [3], get_info [4], grs_plot
mk_pnt, mk_ptv_title, mk_title [2], plott_hi_sum, plott_low_sum, plott_med1_sum
plott_med2_sum, pr_sxt_term, sda2fits, show_obs2, show_obs3, show_obs4
sxt_fits_info
HISTORY:
Written 13-Nov-91 by M.Morrison
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_DURATION()
Purpose : Get the duration of a raster from a file or data structure.
Explanation : Depending on the nature of the input parameter (structure or
file name) the routine extracts and returns the duration
of the raster.
Use : IDL> dur = gt_duration(file_str)
Inputs : file_str - either:- the name of a CDS FITS file
or:- the name of a CDS data structure
Opt. Inputs : None
Outputs : Function returns the raster duration in a intarr(3) giving
the hours, minutes and seconds.
Opt. Outputs: None
Keywords : SECONDS - return duration in seconds otherwise [hr,min,sec]
Calls : ***
ANYTIM2TAI, Bell, GT_EXPTIME [2], GT_NUMEXP, GT_START, LAST_ITEM, STR2UTC [1]
STR2UTC [2], STR2UTC [3], UTC2TAI, gt_exptime [1]
CALLED BY:
MK_CDS_IMAP, MK_CDS_SMAP
Common : None
Restrictions: None
Side effects: None
Category : Data_handling, FITS
Prev. Hist. : None
Written : C D Pike, RAL, 15-Jun-94
Modified : Allow for exposures to be in reverse order. CDP, 20-Mar-96
Add SECONDS keyword. CDP, 29-Mar-96
Handle missing exposure start times. CDP, 20-Feb-98
Version : Version 4, 20_Feb-98
[Previous]
[Next]
NAME:
gt_EITfilter
PURPOSE:
To extract the EIT filter number optionally return a string mnemonic.
CALLING SEQUENCE:
print, gt_EITfilter() ;to list the mnemonics
filters = gt_EITfilter(index)
filters = gt_EITfilter(roadmap)
filters = gt_EITfilter(index.eit, /string)
filters = gt_EITfilter(index, /short)
filters = gt_EITfilter(indgen(4)) ;used with menu selection
filters = gt_EITfilter(index.eit, /space) ;put single space before string
filters = gt_EITfilter(index.eit, space=3) ;put 3 spaces
METHOD:
The input can be a vector or a scalar.
The input can be a integer or a structure.
The structure can be the index, or roadmap, or observing log.
The integer value corresponding to the EIT definition. To
check, use print,gt_EITfilter()
INPUT:
item - A integer or structure, which can be scalar or an array. If this
value is not present, a help summary is printed with the filter
names used.
OPTIONAL INPUT:
string - If present, return the string mnemonic (long notation)
short - If present, return the short string mnemonic
spaces - If present, place that many spaces before the output
string.
OUTPUT:
returns - The filter selected, a integer value or a string
value depending on the switches used. It is a vector
if the input is a vector
OPTIONAL OUTPUT:
header - A string that describes the item that was selected
to be used in listing headers.
CALLS: ***
gt_conv2str [1], gt_conv2str [2], str_tagval [1], str_tagval [2]
CALLED BY:
eit_eff_area, plot_eit_area, plot_eit_flux
HISTORY:
10-Jun-1995, J. R. Lemen (LPARL), Written
[Previous]
[Next]
NAME:
gt_EITsector
PURPOSE:
To extract the EIT sector number optionally return a string mnemonic.
CALLING SEQUENCE:
print, gt_EITsector() ;to list the mnemonics
sectors = gt_EITsector(index)
sectors = gt_EITsector(roadmap)
sectors = gt_EITsector(index.eit, /string)
sectors = gt_EITsector(index, /short)
sectors = gt_EITsector(indgen(4)) ;used with menu selection
sectors = gt_EITsector(index.eit, /space) ;put single space before string
sectors = gt_EITsector(index.eit, space=3) ;put 3 spaces
sectors = gt_EITsector(index,/wave) ;Same as /short, but return integers
METHOD:
The input can be a vector or a scalar.
The input can be a integer or a structure.
The structure can be the index, or roadmap, or observing log.
The integer value corresponding to the EIT definition. To
check, use print,gt_EITsector()
INPUT:
item - A integer or structure, which can be scalar or an array. If this
value is not present, a help summary is printed on the
wavelength sector names used.
OPTIONAL INPUT:
string - If present, return the string mnemonic (long notation)
short - If present, return the short string mnemonic
wave - If present, return wavelengths as integers
spaces - If present, place that many spaces before the output
string.
OUTPUT:
returns - The filter selected, a integer value or a string
value depending on the switches used. It is a vector
if the input is a vector
OPTIONAL OUTPUT:
header - A string that describes the item that was selected
to be used in listing headers.
CALLS: ***
gt_conv2str [1], gt_conv2str [2], str_tagval [1], str_tagval [2]
CALLED BY:
eit_eff_area, plot_eit_area, plot_eit_flux, plot_eit_mirror
RESTRICTIONS:
The /wave keyword overrides /short and /string keywords.
HISTORY:
10-Jun-1995, J. R. Lemen (LPARL), Written
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_EXPTIME()
Purpose : To retrieve the exposure time from a file or data structure.
Explanation : Depending on the nature of the input parameter (structure or
file name) the routine extracts and returns the exposure
time used in the raster.
Use : IDL> s = gt_exptime(file_str)
Inputs : file_str - either:- the name of a CDS FITS file
or:- the name of a CDS data structure
Opt. Inputs : None
Outputs : Function returns the exposure time (secs) used.
Opt. Outputs: None
Keywords : None
Calls : ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], FILE_EXIST [2], FXBCLOSE [1], FXBCLOSE [2], FXBOPEN [1], FXBOPEN [2]
FXBOPEN [3], FXPAR [1], FXPAR [2], QLMGR, concat_dir [4], file_exist [1]
file_exist [3]
CALLED BY:
CDS_SATURATE, GIS_CALIB_EXTRACT, GIS_CALIB_FF_LTGD, GIS_ERROR, GT_DURATION
Common : None
Restrictions: Factor of 100 fudge for calibration files.
Side effects: None
Category : Data_handling, FITS
Prev. Hist. : None
Written : C D Pike, RAL, 24-May-94
Modified : To allow standard FITS directory, CDP, 25-May-94
To assume header value is now in seconds. CDP, 10-Jul-95
Version : Version 3, 10-Jul-95
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_FPOINT()
Purpose : Gets the pointing from FITS file header.
Explanation : The routine extracts and returns the pointing
used in the rasters of a given study number.
Use : IDL> s = gt_fpoint(FITS_number [,/ops])
Inputs : FITS_number - the number of a CDS FITS file
Opt. Inputs : None
Outputs : Function returns the pointing in either OPS or Solar terms
for each raster.
Opt. Outputs: None
Keywords : OPS - return pointing for in OPS L/R coordinates, otherwise
in Solar X/Y arcsecs.
QUIET - no screen output
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], FMT_VECT, HEADFITS [1], HEADFITS [2]
HEADFITS [3], LIST_FITS, STR_PICK, TRIM
Common : None
Restrictions: None
Side effects: None
Category : Data_handling, FITS
Prev. Hist. : None
Written : C D Pike, RAL, 12-May-96
Modified :
Version : Version 1, 12-May-1996
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_HDR()
Purpose : Return value of FITS header parameter for a given QLDS
Explanation : Most header parameter values are accessible as tags under the
HEADER tag of the QLDS. In order to provide an alternative way
of reaching these values, it is possible to use GT_HDR to read
directly from the header text array, stored as a text array
in the tag HDRTEXT of the QLDS.1
Use : result = gt_hdr(QLDS,PARAMETER)
Inputs : QLDS: Quick Look Data Structure.
PARAMETER: Text containing the name of the FITS parameter
to be read.
Opt. Inputs : None.
Outputs : Returns FXPAR(QLDS.HDRTEXT,strPARAMETER)
Opt. Outputs: None.
Keywords : None.
Calls : ***
FXPAR [1], FXPAR [2], PARCHECK, QLMGR, TYP
CALLED BY:
GHOST_PLOT_ONE
Common : None.
Restrictions: None.
Side effects: None.
Category : GET
Prev. Hist. : None.
Written : Stein Vidar H. Haugan, UiO, 22-February-1996
Modified : Never.
Version : 1, 22-February-1996
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_IIMAGE
Purpose : Return image formed at a given dispersion pixel number
Explanation : GT_IIMAGE returns a two-dimensional image from
a CDS observation raster. The image consists of the
intensities at a specific dispersion pixel number, for
all the X/Y image positions in the raster.
Note that the wavelength need not be constant over
the whole image, depending on the observational
parameters and the wavelength calibration.
The dispersion pixel number may be specified with
either the wavelength BAND and a detector X value,
or a detector window name/number plus an offset
that is added to the starting detector x placement
of that detector window.
The returned array has dimensions (X,Y) given by
the size of the data contained in the QLDS.
In addition to the image, values for the physical
parameters XSOLAR, YSOLAR, TIME and LAMBDA is
returned through output keywords as two-dimensional
arrays with the same size as the image.
Use : im = gt_iimage(QLDS, <keywords>)
Inputs : QLDS: CDS QuickLook Data structure
In addition, *either* BAND + DETX
*or* WINDOW + OFFSET keywords
must be specified.
Opt. Inputs : BAND: Which wavelength band should be returned.
DETX: The detector X (dispersion) pixel number.
NIS: 0..1024
GIS: 0..2048
WINDOW: The number or name of a detector data window
in the QLDS.
OFFSET: Added to the starting detector X (dispersion)
value for the selected window.
Outputs : Two-dimensional image. Size determined by the content
of the QLDS.
Opt. Outputs: LAMBDA : wavelength for each pixel (Angstrom)
XSOLAR : Solar Cartesian X (arcsecs)
YSOLAR : Solar Cartesian Y (arcsecs)
TIME : Time of the exposures
Keywords : NOCHECK: Set to avoid call to QLMGR
NOPARCHECK: Set to avoid most parameter checking mostly for
internal use.
QUICK: Set to avoid calculation of physical parameters
TIME, XSOLAR AND YSOLAR.
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], GT_BINX, GT_CDS_TIME, GT_DETECTOR
GT_DIMENSION, GT_LAMBDA, GT_SOLARX, GT_SOLARY, GT_WINDATA, GT_WINDOW, GT_WNUM
PARCHECK, QLMGR, ST_WINDATA, TAG_EXIST [1], TAG_EXIST [2], TRIM, TYP
CALLED BY:
CWQ_IMAGE [1], DSPWAV, GT_BIMAGE, GT_MIMAGE, MK_CDS_IMAP, cwq_image [2]
Common : None.
Restrictions: QLDS == QL Data Structure.
Side effects: None known.
Category : GET
Prev. Hist. :
Written : SVH Haugan, UiO, 27-October-1995
Modified : Version 1.1, SVH, 2-November-1995
Updated "Calls" documentation field.
Version 2, SVHH, 16-January-1995
Fixed problem with calculating OFFSET from
detx - detdesc(window).detx **MOD 2048**
Version 3, SVHH, 6 April 1996
Included keyword QUICK, changed calculation
of wwidth to use ixstart/ixstop.
Version 4, SVHH, 12 April 1996
Renamed gt_time -> gt_cds_time
Version 5, SVHH, 28 June 1996
Changed upper limit on OFFSET to account for
binning. Also, missing values are not altered when
dividing by the binning factor.
Version 6, SVHH, 9 August 1996
Improved the handling of the /QUICK keyword, speedup
about a factor of 10 achieved.
Version 7, SVHH, 15 August 1996
Compatible with old and new storage system.
Version : 7, 15 August 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_LAMBDA
Purpose : Returns the wavelength for data points
Explanation : This function is supposed to return the most correct
wavelength for given data points.
In order to be able to compensate for possible misalignments
etc., data points must be fully specified with detector X
values, detector Y (or slit position for GIS), and mirror
position.
Other relevant information is taken from the QLDS.
All parameters except the QLDS may be either arrays or
scalars. The returned array with solar x values will be of the
same size as the expression:
RESULT = c1*DETX + c2*DETY + c3*MIRPIX
I.e., having DETX = [0,1] and DETY=[0,1,2] does not produce an
error, but the result will be a fltarr(2) - NOT a fltarr(2,3)
or fltarr(3,2) etc.
Use : GT_LAMBDA(QLDS,DETX, DETY || SLITPIX ,MIRPIX)
Inputs : QLDS: CDS QuickLook Data structure
DETX: Detector X values. 0..1023 for NIS,
0..8191 for GIS (i.e., DETX also specifies
the waveband).
DETY: Detector Y values for the NIS detector.
SLITPIX: Slit positions index for the GIS detector.
Range 0..N(slit positions)
MIRPIX: Mirror position index
Range 0..N(mirror positions)
Opt. Inputs : None.
Outputs : Returns the wavelength (in Angstrom) for the specified data
points. Return value has the same dimension as a linear
combination of the input parameters.
Opt. Outputs: None.
Keywords : NOCHECK: Set to avoid call to QLMGR
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], GET_MIRSHIFT, GET_TILTCAL, GT_DETECTOR
GT_DIMENSION, LOAD_WAVECAL, PARCHECK, PIX2WAVE, POLY, QLMGR, TRIM, TYP
CALLED BY:
GT_BIMAGE, GT_IIMAGE, GT_SCANP, GT_SCANT, GT_SCANX, GT_SCANY, GT_SPECTRUM
NIS_PIX_ANALYSE
Common : None.
Restrictions: QLDS == QL Data Structure.
Currently, only the DETDESC.origin/spacing fields
are used.
Side effects: None.
Category : CDS, QuickLook, Data_Handling.
Prev. Hist. :
Written : S.V.H. Haugan, 18-October-1995
Modified : Version 1.1: SVHH, 19-October-1995
Moved division between NIS band 1/2 to 511
The identity of the two bands were also switched.
Version 2.0, SVHH, 1-November-1995
Added the use of !DEBUG flag to "turn on" simulation
of mis-aligned spectrum/detector for testing purposes.
Version 3, SVHH, 5-December-1995
Fixed an error for the GIS case (DetX -> iDetX).
Version 4, SVHH, 14 April 1996
Using LOAD_WAVECAL()
Version 5, SVHH, 23 February 1999
Included calibrated tilt/mirror shift coefficients
in the calculation.
Version 6, 13 April 1999, William Thompson, GSFC
Call PIX2WAVE with /NOLIMIT
Version 7, SVHH, 2 December 1999
Allow floats/fractional input values for DETX/Y
Version : 7, 2 December 1999
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_MIMAGE
Purpose : Return monochromatic image.
Explanation : GT_MIMAGE returns a two-dimensional image from a CDS
observation raster. The image consists of intensities at a
specific wavelength, for all the X/Y image positions in the
raster.
The image is formed by interpolating linearly between
neighbouring dispersion pixels, using the best current values
for the pixel/wavelength relationship.
The returned array has dimensions (X,Y) given by the size of
the data contained in the QLDS.
In addition to the image, values for the physical parameters
XSOLAR, YSOLAR, and TIME is returned through output keywords
as two-dimensional arrays with the same size as the image.
Use : im = gt_mimage(QLDS,lambda)
Inputs : QLDS: CDS QuickLook Data structure
LAMBDA: The wavelength of the monochromatic image.
Opt. Inputs : [SAMPLE]: Not implemented yet.
Outputs : Two-dimensional image. Size determined by the content
of the QLDS.
Opt. Outputs: XSOLAR : Solar Cartesian X (arcsecs)
YSOLAR : Solar Cartesian Y (arcsecs)
TIME : Time of the exposures
Keywords : NOCHECK: Set to avoid call to QLMGR
NOPARCHECK: Set to avoid most parameter checking mostly for
internal use.
QUICK : Set to avoid calculating physical parameters
XSOLAR, YSOLAR and TIME.
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], GT_DETECTOR, GT_DIMENSION, GT_IIMAGE, GT_WAVEBAND
GT_WINDOW, LOAD_WAVECAL, PARCHECK, QLMGR, TRIM, TYP, WAVE2PIX
CALLED BY:
MK_CDS_IMAP, POLY_SPEC
Common : None.
Restrictions: QLDS == QL Data Structure.
Side effects: None known.
Category : GET
Prev. Hist. :
Written : SVH Haugan, UiO, 1-November-1995
Modified : Version 1.1, SVHH, 2-November-1995,
Removed LAMBDA output keyword from documentation
and added "Calls" documentation field.
Version 2, SVHH, 6 April 1996
Added keyword QUICK. Using /QUICK in calls
to gt_iimage. Calculating wwidth from ixstart/stop.
Tried to speed up things a bit.
Version 3, SVHH, 14 April 1996
Using LOAD_WAVECAL().
Version 4, Zarro (SM&A/GSFC), 19 Oct 1999
Added return for /QUICK
Version : 4
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_MIRRPOS()
Purpose : To retrieve the mirror posns from a file or data structure.
Explanation : Depending on the nature of the input parameter (structure or
file name) the routine extracts and returns the mirror
positions used in the raster.
Use : IDL> s = gt_mirrpos(file_str)
Inputs : file_str - either:- the name of a CDS FITS file
or:- the name of a CDS data structure
Opt. Inputs : None
Outputs : Function returns the mirror posns used in an integer array.
Opt. Outputs: None
Keywords : None
Calls : ***
AUXREAD, CAL_AUXREAD, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1]
DATATYPE [2], DATATYPE [3], FILE_EXIST [2], FXBCLOSE [1], FXBCLOSE [2]
FXBOPEN [1], FXBOPEN [2], FXBOPEN [3], FXPAR [1], FXPAR [2], QLMGR, concat_dir [4]
file_exist [1], file_exist [3]
CALLED BY:
PLOT_RASTER
Common : None
Restrictions: None
Side effects: None
Category : Data_handling, FITS
Prev. Hist. : None
Written : C D Pike, RAL, 24-May-94
Modified : To allow standard FITS directory, CDP, 25-May-94
Fix bug in tag name in file case. CDP, 14-Jun-94
Include cal/ops test. CDP, 15-Jun-94
Fix bug related to previous change. CDP, 10-Jul-95
New tag names in non-calibration QLDS, SVHH, 4-Oct-95
Version : Version 6, 4-Oct-1995
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_NIS_ALIGNMENT
Purpose : Retrieve the NIS-1 to NIS-2 alignment offsets
Category : Class3, Calibration
Explanation : Returns the NIS-1 to NIS-2 alignment offsets.
Syntax : GT_NIS_ALIGNMENT, QLDS, XOFFSET, YOFFSET
CALLED BY:
GT_SOLAR_XY, NIS_ROTATE
Examples :
Inputs : QLDS = A CDS quicklook data structure, from READCDSFITS.
Opt. Inputs : None.
Outputs : XOFFSET, YOFFSET = The offsets of NIS-1 relative to NIS-2 in
arcseconds.
Opt. Outputs: None.
Keywords : None.
Calls : ***
POLY
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : Previously part of GT_SOLAR_XY
History : Version 1, 30-Aug-2000, William Thompson
Version 2, 22-Aug-2003, William Thompson
Use INS_X0,INS_Y0 instead of XCEN,YCEN
Handle case when spacecraft is upside-down
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_NUMEXP()
Purpose : Get the number of exposures from a file or data structure.
Explanation : Depending on the nature of the input parameter (structure or
file name) the routine extracts and returns the number
of exposures in the raster.
Use : IDL> s = gt_numexp(file_str)
Inputs : file_str - either:- the name of a CDS FITS file
or:- the name of a CDS data structure
Opt. Inputs : None
Outputs : Function returns the number of exposures used.
Opt. Outputs: None
Keywords : None
Calls : ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], FILE_EXIST [2], FXBCLOSE [1], FXBCLOSE [2], FXBOPEN [1], FXBOPEN [2]
FXBOPEN [3], FXPAR [1], FXPAR [2], QLMGR, concat_dir [4], file_exist [1]
file_exist [3]
CALLED BY:
GHOST_PLOT_ONE, GT_DURATION
Common : None
Restrictions: None
Side effects: None
Category : Data_handling, FITS
Prev. Hist. : None
Written : C D Pike, RAL, 25-May-94
Modified :
Version : Version 1, 25-May-94
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_NUMWIN()
Purpose : Get the number of windows from a file or data structure.
Explanation : Depending on the nature of the input parameter (structure or
file name) the routine extracts and returns the number
of windows in the raster.
Use : IDL> s = gt_numwin(file_str)
Inputs : file_str - either:- the name of a CDS FITS file
or:- the name of a CDS data structure
Opt. Inputs : None
Outputs : Function returns the number of windows used.
Opt. Outputs: None
Keywords : None
Calls : ***
CAL_DETREAD, CAL_DETSELECT, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
DATATYPE [1], DATATYPE [2], DATATYPE [3], DETREAD, DETSELECT, FILE_EXIST [2]
FXBCLOSE [1], FXBCLOSE [2], FXBOPEN [1], FXBOPEN [2], FXBOPEN [3], FXPAR [1]
FXPAR [2], QLMGR, concat_dir [4], file_exist [1], file_exist [3]
CALLED BY:
CDS_CLEAN_SPIKE, CDS_NEW_SPIKE, CDS_SATURATE, GT_SCANP, GT_SCANT, GT_SCANX, GT_SCANY
GT_SPECTRUM, NIS_MRGDATA, NIS_PIX_ANALYSE, NIS_QUICKLOOK
Common : None
Restrictions: None
Side effects: None
Category : Data_handling, FITS
Prev. Hist. : None
Written : C D Pike, RAL, 3-Jun-94
Modified : Update to new file reading routines. CDP, 14-Jun-94
Insert cal/ops test. CDP, 15-Jun-94
Version : Version 3, 15-Jun-94
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_POINT()
Purpose : Gets the pointing from a data structure.
Explanation : Depending on the nature of the input parameter (structure or
file name) the routine extracts and returns the pointing
used in the raster.
Use : IDL> s = gt_point(qlds_str [,/ops])
Inputs : qlds_str - the name of a CDS data structure
Opt. Inputs : None
Outputs : Function returns the pointing in either OPS or Solar terms
Opt. Outputs: None
Keywords : OPS - return pointing for in OPS L/R coordinates, otherwise
in Solar X/Y arcsecs.
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], QLMGR
Common : None
Restrictions: None
Side effects: None
Category : Data_handling, FITS
Prev. Hist. : None
Written : C D Pike, RAL, 2-May-96
Modified :
Version : Version 1, 2-May-1996
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_SCANP
Purpose : Return a "slit spectrogram" from freely chosen points.
Explanation : Analogous to the way GT_SCANX/GT_SCANY return a "slit
spectrogram" with the "slit" oriented either along the
solar X or the Y axis, this routine returns an array
with 2 dimensions (LAMBDA,POSITION). The first
dimension is along the dispersion direction, and the
second is a spatial dimension, although the spatial
position (the points to be covered by the "slit") can
be specified arbitrarily.
The QLDS must contain appropriate data, e.g., the data
must have two spatial dimensions. This means that the
observations must be represented with an array with
dimensions (LAMBDA,SOLARX,SOLARY,DEL_TIME) where
SOLARX > 1 and SOLARY > 1.
Unlike GT_SCANX/GT_SCANY, all the points to be
included in the spectrogram must be explicitly
specified through their X and Y indices.
Although GT_SCANP always returns a two-dimensional
array, the size of the dimensions may vary, depending
on the input parameters (XIX/YIX for the POISITION
dimension) and wavelength window/band selection (for
the LAMBDA dimension).
If a specific wavelength band is specified, all the
(deselected) data from that wavelength band/detector
is returned (i.e., 1024 elements for NIS, 2048
elements from GIS), although the deselection into full
detector size can be overridden by using the
/NODESELECT keyword.
If specific wavelength windows are specified, the data
are packed into a contiguous array.
In case the sumline compression scheme has been used, the
counts will be spread out over the original detector area
where the summation has been performed.
In addition to returning the detector counts, GT_SCANP
returns other relevant quantities such as wavelength,
solar x/y and time through the use of output
keywords. The names of the keywords are constructed in
order to make efficient use of abbreviations.
These auxiliary data are returned either as an array
with the same size as the spectrum, or as a scalar (if
the value is truly a constant over the whole spectrum,
e.g., time).
Use : data = gt_scanp(QLDS, <keywords>)
Inputs : QLDS: CDS QuickLook Data structure
Some keyword parameters *are* required, though which
ones are sufficient may vary.
Opt. Inputs : BAND: Which wavelength band should be returned.
WINDOW: The number or name of a detector data window
in the QLDS. If it's an array, the data from
the specified windows will be packed in a
contiguous array
YIX: Solar Cartesian Y index (0..)
YIX: Solar Cartesian X index.
TIX: Time index (exposure no.) (0..)1
Outputs : Returns a two-dimensional array corresponding to a slit
spectrogram with the slit covering the positions
(XIX,YIX,TIX).
Opt. Outputs: LAMBDA : wavelength for each pixel (Angstrom)
XSOLAR : Solar Cartesian X (arcsecs)
YSOLAR : Solar Cartesian Y (arcsecs)
TIME : Time of the exposures
Keywords : NODESELECT: Set to use the (wavelength) packed format.
NOCHECK: Set to avoid call to QLMGR
NOPARCHECK: Set to avoid most parameter checking mostly for
internal use. Automatically sets NOCHECK
NOEXTRA: Set to skip calculating LAMBDA,X/YSOLAR,TIME
QUICK: Sets /NOCHECK, /NOPARCHECK, and /NOEXTRA
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DEFAULT, GT_CDS_TIME, GT_DETECTOR
GT_DIMENSION, GT_LAMBDA, GT_NUMWIN, GT_SOLARX, GT_SOLARY, GT_WINDATA, GT_WNUM
PARCHECK, QLMGR, ST_WINDATA, TAG_EXIST [1], TAG_EXIST [2], TRIM, TYP
CALLED BY:
POLY_SPEC
Common : None.
Restrictions: QLDS == QL Data Structure.
Side effects: None known.
Category : GET
Prev. Hist. :
Written : SVH Haugan, UiO, 27-October-1995
Modified : Version 2, SVHH, 12-December-1995
Added keywords NOEXTRA + QUICK. Fixed bug
in handling TIX when NOPARCHECK was set.
Version 3, SVHH, 8 April 1996
Fixed collapse of lambda (first) dimension
in REFORM when NOT originally collapsed *but*
singular.
Version 4, SVHH, 12 April 1996
Renamed gt_time -> gt_cds_time
Version 5, SVHH, 9 August 1996
New data storage system with handles.
Better handling of the /QUICK and /NOEXTRA keywords.
Version 6, SVHH, 15 August 1996
Compatible with both storage systems.
Blank scans may be extracted when deselection is used.
Version 7, SVHH, 27 August 1996
Made it cope (I think) with variable wavelength size
windows.
Version : 7, 27 August 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_SCANT
Purpose : Return a "slit spectrogram" with (lambda,TIME) dimension
Explanation : This function is analogous to GT_SCANX/Y and returns a
"slit spectrogram" from a QLDS in the form of an array
with 2 dimensions. The first dimension is along the
dispersion direction, but unlike SCANX/Y, the second
is TIME, i.e., it returns the spectrum at a specific
point as a function of time.
The QLDS must contain appropriate data, e.g., there
must be a series of observations in the raster. This
means that the observations must be represented with
an array with dimensions
(LAMBDA,SOLARX,SOLARY,DEL_TIME) WHERE DEL_TIME > 1.
If the QLDS contains data for several solar X positions, the
instrument X position index (XIX) must be supplied. The solar
X position index is the mirror position index.
Likewise, if the QLDS contains data for several solar
Y positions, the instrument Y position index (YIX)
must be supplied. The solar Y position index is
analogous to instrument y index (NIS) or slit position
index (GIS).
Although GT_SCANT always returns a two-dimensional array,
the size of the wavelength dimension may vary, depending
on the nature of the request.
The second (TIME) dimension size is determined by the
number of repetitive operations stored in the QLDS.
If a specific wavelength band is specified, all the
(deselected) data from that wavelength band/detector
is returned (i.e., 1024 elements for NIS, 2048
elements from GIS), although this can be overridden by
using the /NODESELECT keyword.
If specific wavelength windows are specified, there is
a choice between deselecting to a full detector
(1024(NIS)/2048(GIS)) or simply packed into a
contiguous array.
In case the sumline compression scheme has been used, the
counts will be spread out over the original detector area
where the summation has been performed.
In addition to returning the detector counts, GT_SCANX
returns other relevant quantities such as wavelength,
solar x/y and time through the use of output
keywords. The names of the keywords are constructed in
order to make efficient use of abbreviations.
These auxiliary data are returned either as an array
with the same size as the spectrum, or as a scalar (if
the value is truly a constant over the whole spectrum,
e.g., time).
Use : data = gt_scant(QLDS, <keywords>)
Inputs : QLDS: CDS QuickLook Data structure
Some keyword parameters *are* required, though which
ones are sufficient may vary.
Opt. Inputs : BAND: Which wavelength band should be returned.
WINDOW: The number or name of a detector data window
in the QLDS. If it's an array, the data from
the specified windows will be packed in a
contiguous array
XIX: Solar Cartesian X index (0..)
YIX: Solar Cartesian Y index (0..)
Outputs : Returns a two-dimensional array corresponding to a
slit spectrogram with the slit along the solar X
direction.
Opt. Outputs: LAMBDA : wavelength for each pixel (Angstrom)
XSOLAR : Solar Cartesian X (arcsecs)
YSOLAR : Solar Cartesian Y (arcsecs)
TIME : Time of the exposures
Keywords : NODESELECT: Set to use the (wavelength) packed format.
NOCHECK: Set to avoid call to QLMGR
NOPARCHECK: Set to avoid most parameter checking mostly for
internal use. Automatically sets NOCHECK
NOEXTRA: Set to skip calculating LAMBDA,X/YSOLAR,TIME
QUICK: Sets /NOCHECK, /NOPARCHECK, and /NOEXTRA
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DEFAULT, GT_CDS_TIME, GT_DETECTOR, GT_DETY
GT_DIMENSION, GT_LAMBDA, GT_NUMWIN, GT_SOLARX, GT_SOLARY, GT_WINDATA, GT_WNUM
PARCHECK, QLMGR, ST_WINDATA, TAG_EXIST [1], TAG_EXIST [2], TRIM, TYP
CALLED BY:
DSP_MOVIE
Common : None.
Restrictions: QLDS == QL Data Structure.
Side effects: None known.
Category : GET
Prev. Hist. : Based on gt_scanx/scany
Written : SVH Haugan, UiO, 20-October-1995
Modified : Version 2, SVHH, 27-October-1995
Slightly rewritten to make all gt_scan_
functions similar.
Version 3, SVHH, 12-December-1995
Added keywords NOEXTRA + QUICK. Fixed bug
in handling XIX + YIX when NOPARCHECK was set.
Version 4, SVHH, 8 April 1996
Fixed collapse of lambda (first) dimension
in REFORM when NOT originally collapsed *but*
singular.
Version 5, SVHH, 12 April 1996
Renamed gt_time -> gt_cds_time
Version 6, SVHH, 7 August 1996
New storage system with handles.
Added extraction of blank scans when
BAND is set and NODESELECT is NOT set.
(Haven't found any files to test this on...)
Version 7, SVHH, 15 August 1996
Compatible with both storage systems.
Version 8, SVHH, 27 August 1996
Taking variable DETY window positions into account
when calculating solar y position.
Version : 9, 27 August 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_SCANX
Purpose : Return a "slit spectrogram" with (lambda,X) dimension
Explanation : This function returns a "slit spectrogram" from a QLDS in the
form of an array with 2 dimensions. The first dimension
is along the dispersion direction, and the second is along
the solar X/scan mirror direction, thus simulating a
slit spectrogram with the slit placed in the X direction.
The QLDS must contain appropriate data, e.g., there must
be more than 1 scan mirror position in the raster.
This means that the observations must be represented with
an array with dimensions (LAMBDA,SOLARX,SOLARY,DEL_TIME)
where SOLARX > 1.
If the QLDS contains data for several solar Y positions, the
instrument Y position index (YIX) must be supplied. The solar
Y position index is analogous to instrument y (NIS) or
slit position (GIS).
Although GT_SCANX always returns a two-dimensional array,
the size of the wavelength dimension may vary, depending
on the nature of the request.
The second (X) dimension size is determined by the
size of the data stored in the QLDS.
If a specific wavelength band is specified, all the
(deselected) data from that wavelength band/detector
is returned (i.e., 1024 elements for NIS, 2048
elements from GIS), although this can be overridden by
using the /NODESELECT keyword.
If specific wavelength windows are specified, there is
a choice between deselecting to a full detector
(1024(NIS)/2048(GIS)) or simply packed into a
contiguous array.
In case the sumline compression scheme has been used, the
counts will be spread out over the original detector area
where the summation has been performed.
In addition to returning the detector counts,
GT_SCANX returns other relevant quantities such as
wavelength, solar x/y and time through the use of
output keywords. The names of the keywords are
constructed in order to make efficient use of
abbreviations.
These auxiliary data are returned either as an array
with the same size as the spectrum, or as a scalar (if
the value is truly a constant over the whole spectrum,
e.g., time).
Use : data = gt_scanx(QLDS, <keywords>)
Inputs : QLDS: CDS QuickLook Data structure
Some keyword parameters *are* required, though which
ones are sufficient may vary.
Opt. Inputs : BAND: Which wavelength band should be returned.
WINDOW: The number or name of a detector data window
in the QLDS. If it's an array, the data from
the specified windows will be packed in a
contiguous array
YIX: Solar Cartesian Y index (0..)
TIX: Time index (exposure no.) (0..)1
Outputs : Returns a two-dimensional array corresponding to a
slit spectrogram with the slit along the solar X
direction.
Opt. Outputs: LAMBDA : wavelength for each pixel (Angstrom)
XSOLAR : Solar Cartesian X (arcsecs)
YSOLAR : Solar Cartesian Y (arcsecs)
TIME : Time of the exposures
Keywords : NODESELECT: Set to use the (wavelength) packed format.
NOCHECK: Set to avoid call to QLMGR
NOPARCHECK: Set to avoid most parameter checking mostly for
internal use. Automatically Sets NOCHECK.
NOEXTRA: Set to skip calculating LAMBDA,X/YSOLAR,TIME
QUICK: Sets /NOCHECK, /NOPARCHECK, and /NOEXTRA
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DEFAULT, GT_CDS_TIME, GT_DETECTOR, GT_DETY
GT_DIMENSION, GT_LAMBDA, GT_NUMWIN, GT_SOLARX, GT_SOLARY, GT_WINDATA, GT_WNUM
PARCHECK, QLMGR, ST_WINDATA, TAG_EXIST [1], TAG_EXIST [2], TRIM, TYP
CALLED BY:
DSP_MOVIE
Common : None.
Restrictions: QLDS == QL Data Structure.
Side effects: None known.
Category : GET
Prev. Hist. :
Written : SVH Haugan, UiO, 18-October-1995
Modified : Version 2, SVHH, 27-October-1995
Slightly rewritten to make all gt_scan_
functions similar.
Version 3, SVHH, 12-December-1995
Added keywords NOEXTRA + QUICK. Fixed bug
in handling TIX + YIX when NOPARCHECK was set.
Version 4, SVHH, 8 April 1996
Fixed collapse of lambda (first) dimension
in REFORM when NOT originally collapsed *but*
singular.
Version 5, SVHH, 12 April 1996
Renamed gt_time -> gt_cds_time
Version 6, SVHH, 3 August 1996
New storage system with handles.
Added extraction of blank scans when
BAND is set and NODESELECT is NOT set.
Version 7, SVHH, 15 August 1996
Compatible with both storage systems.
Version 8, SVHH, 29 January 1997
Fixed MISSING problem with binned data.
Version : 8, 29 January 1997
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_SCANY
Purpose : Return a "slit spectrogram" with (lambda,X) dimension
Explanation : This function returns a "slit spectrogram" from a QLDS in the
form of an array with 2 dimensions. The first dimension
is along the dispersion direction, and the second is along
the solar Y/slit (position) direction, thus simulating a
slit spectrogram with the slit placed in the Y direction.
The QLDS must contain appropriate data, e.g., there must be
more than 1 slit position (or positions along the slit) in the
raster. This means that the observations must be represented
with an array with dimensions (LAMBDA,SOLARX,SOLARY,DEL_TIME)
where SOLARY > 1.
If the QLDS contains data for several solar X positions, the
instrument X position index (XIX) must be supplied. The solar
X position index is analogous to the slit position. If the
QLDS represents a time series (DEL_TIME > 1) then the
time index TIX (repetition index) must be specified.
Although GT_SCANY always returns a two-dimensional array,
the size of the wavelength dimension may vary, depending
on the nature of the request.
The second (Y) dimension size is determined by the
size of the data stored in the QLDS.
If a specific wavelength band is specified, all the
(deselected) data from that wavelength band/detector
is returned (i.e., 1024 elements for NIS, 2048
elements from GIS), although this can be overridden by
using the /NODESELECT keyword.
If specific wavelength windows are specified, there is
a choice between deselecting to a full detector
(1024(NIS)/2048(GIS)) or simply packed into a
contiguous array.
In case the sumline compression scheme has been used, the
counts will be spread out over the original detector area
where the summation has been performed.
In addition to returning the detector counts,
GT_SCANY returns other relevant quantities such as
wavelength, solar x/y and time through the use of
output keywords. The names of the keywords are
constructed in order to make efficient use of
abbreviations.
These auxiliary data are returned either as an array
with the same size as the spectrum, or as a scalar (if
the value is truly a constant over the whole spectrum,
e.g., time).
Use : data = gt_scany(QLDS, <keywords>)
Inputs : QLDS: CDS QuickLook Data structure
Some keyword parameters *are* required, though which
ones are sufficient may vary.
Opt. Inputs : BAND: Which wavelength band should be returned.
WINDOW: The number or name of a detector data window
in the QLDS. If it's an array, the data from
the specified windows will be packed in a
contiguous array
XIX: Solar Cartesian X index (0..)
TIX: Time index (exposure no.) (0..)1
Outputs : Returns a two-dimensional array corresponding to a
slit spectrogram with the slit along the solar Y
direction.
Opt. Outputs: LAMBDA : wavelength for each pixel (Angstrom)
XSOLAR : Solar Cartesian X (arcsecs)
YSOLAR : Solar Cartesian Y (arcsecs)
TIME : Time of the exposures
Keywords : NODESELECT: Set to use the (wavelength) packed format.
NOCHECK: Set to avoid call to QLMGR
NOPARCHECK: Set to avoid most parameter checking mostly for
internal use. Automatically sets NOCHECK
NOEXTRA: Set to skip calculating LAMBDA,X/YSOLAR,TIME
QUICK: Sets /NOCHECK, /NOPARCHECK, and /NOEXTRA
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DEFAULT, GT_CDS_TIME, GT_DETECTOR, GT_DETY
GT_DIMENSION, GT_LAMBDA, GT_NUMWIN, GT_SOLARX, GT_SOLARY, GT_WINDATA, GT_WNUM
PARCHECK, QLMGR, ST_WINDATA, TAG_EXIST [1], TAG_EXIST [2], TRIM, TYP
CALLED BY:
DSPEXP, DSP_MOVIE, NDSPSPEC
Common : None.
Restrictions: QLDS == QL Data Structure.
Side effects: None known.
Category : GET
Prev. Hist. :
Written : SVH Haugan, UiO, 18-October-1995
Modified : Version 2, SVHH, 27-October-1995
Slightly rewritten to make all gt_scan_
functions similar.
Version 3, SVHH, 12-December-1995
Added keywords NOEXTRA + QUICK. Fixed bug
in handling TIX + XIX when NOPARCHECK was set.
Version 4, SVHH, 5-February-1996
Added the possibility of extracting blank
scans when BAND is set and NODESELECT is NOT set.
Version 5, SVHH, 8 April 1996
Fixed collapse of lambda (first) dimension
in REFORM when NOT originally collapsed *but*
singular.
Version 6, SVHH, 12 April 1996
Renamed gt_time -> gt_cds_time
Version 7, SVHH, 7 August 1996
New storage system with handles.
Version 8, SVHH, 15 August 1996
Compatible with both storage systems.
Version 9, SVHH, 29 January 1997
Coping (at least) with BINY > 1 cases.
Version : 9, 29 January 1997
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_SLITNUM()
Purpose : To retrieve the slit number from a file or data structure.
Explanation : Depending on the nature of the input parameter (structure or
file name) the routine extracts and returns the slit number
used in the raster.
Use : IDL> s = gt_slitnum(file_str)
Inputs : file_str - either:- the name of a CDS FITS file
or:- the name of a CDS data structure
Opt. Inputs : None
Outputs : Function returns the slit number used.
Opt. Outputs: None
Keywords : None
Calls : ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], FILE_EXIST [2], FXBCLOSE [1], FXBCLOSE [2], FXBOPEN [1], FXBOPEN [2]
FXBOPEN [3], FXPAR [1], FXPAR [2], QLMGR, concat_dir [4], file_exist [1]
file_exist [3]
Common : None
Restrictions: None
Side effects: None
Category : Data_handling, FITS
Prev. Hist. : None
Written : C D Pike, RAL, 18-May-94
Modified : Allow std directory for FITS file, CDP, 25-May-94
Version : Version 2, 25-May-94
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_SLITPOS()
Purpose : Retrieve the slit positions from a file or data structure.
Explanation : Depending on the nature of the input parameter (structure or
file name) the routine extracts and returns the slit positions
used in the raster.
Use : IDL> s = gt_slitpos(file_str)
Inputs : file_str - either:- the name of a CDS FITS file
or:- the name of a CDS data structure
Opt. Inputs : None
Outputs : Function returns the slit positions used in an integer array.
Opt. Outputs: None
Keywords : None
Calls : ***
AUXREAD, CAL_AUXREAD, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1]
DATATYPE [2], DATATYPE [3], FILE_EXIST [2], FXBCLOSE [1], FXBCLOSE [2]
FXBOPEN [1], FXBOPEN [2], FXBOPEN [3], FXPAR [1], FXPAR [2], QLMGR, concat_dir [4]
file_exist [1], file_exist [3]
CALLED BY:
PLOT_RASTER
Common : None
Restrictions: None
Side effects: None
Category : Data_handling, FITS
Prev. Hist. : None
Written : C D Pike, RAL, 24-May-94
Modified : To allow standard FITS file directory, CDP, 25-May-94
Fix bug in tag name in file case. CDP, 14-Jun-94
Insert cal/ops test. CDP, 15-Jun-94
Fix bug related to previous change. CDP, 10-Jul-95
New tag names in non-calibration QLDS, SVHH, 4-Oct-95
Version : Version 6, 4-Oct-1995
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_SOLAR_XY
Purpose : Return solar X and Y values for a CDS data window
Category : Class2, CDS, Analysis, Coordinates
Explanation : This routine returns an array of solar X and Y values for a CDS
data window. The returned arrays have the same dimensions as
the window itself. Thus, if one uses GT_WINDATA to return the
window, then GT_SOLAR_XY returns the X and Y positions for
every pixel in the window.
If one uses VDS_ROTATE on a data window, then the same
VDS_ROTATE can be used on the X and Y arrays. (This routine
will also recognize if NIS_ROTATE has been applied to the
entire QLDS.)
For GIS data, the first (wavelength) dimension in the X and Y
arrays is set to a single pixel--GIS pointing does not depend
on the detector pixel.
If the observation is a "sit-and-stare", i.e. contains a fourth
time dimension, then the time dimension will be omitted from
the output X and Y arrays, unless the EXTEND keyword is used.
When used with the 90x240 arcsecond slit, the effect of the
slit width on the NIS detector is taken into account when
calculating X positions. However, this feature is only
activated when the window width is comparable to the slit
width. A critical assumption is made that the line being
observed is in the center of the window.
For cases where solar feature tracking is turned on, then the
returned pointings will be referenced back to the start time of
the raster.
Syntax : GT_SOLAR_XY, QLDS, WINDOWI, SOLAR_X, SOLAR_Y
CALLED BY:
MK_CDS_IMAP, MK_CDS_SMAP
Examples : A = READCDSFITS('s3300r00.fits')
GT_SOLAR_XY, A, 0, X, Y
Inputs : QLDS = A CDS quicklook data structure from READCDSFITS.
WINDOWI = The window index, from 0 to N-1.
Opt. Inputs : None.
Outputs : SOLAR_X = The array of solar X values.
SOLAR_Y = The array of solar Y values.
Opt. Outputs: None.
Keywords : NOCHECK = If set, then don't check that the QLDS is a proper
quicklook data structure.
NOPADDING = If set, then the data will be returned without
padding. Thus, different data windows could be
returned with different sizes. For example, when
reading in full NIS readout, the window for NIS1
will have a different height than that for NIS2,
because of the different slants in each band.
UPDATE = If set, then call UPD_CDS_POINT before extracting the
X and Y arrays. Any other keywords accepted by
UPD_CDS_POINT, such as NOROLL are also accepted.
EXTEND = The fourth time dimension is normally omitted from the
returned SOLAR_X and SOLAR_Y arrays. Setting /EXTEND
will put this dimension in when appropriate.
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 = ''
X = GT_SOLAR_XY( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4], FIND_WITH_DEF [1]
FIND_WITH_DEF [2], FIND_WITH_DEF [3], GET_VDS_SLITPOS, GT_NIS_ALIGNMENT
GT_WINDESC, QLMGR, TAG_EXIST [1], TAG_EXIST [2], UPD_CDS_POINT, delvarx [5]
Common : None.
Restrictions: At the moment, subpixel shifts in the Y pointing due to the
round-off of the window positions adjusted for slant are not
accounted for. To do this right, second order effects would
have to be taken into account.
Side effects: When the UPDATE keyword is used, then the input data structure
is changed by UPD_CDS_POINT.
Prev. Hist. : None.
History : Version 1, 13-May-1997, William Thompson, GSFC
Version 2, 17-Dec-1997, William Thompson, GSFC
Allow pass-through of any UPD_CDS_POINT keywords
Version 3, 28-Feb-2000, William Thompson, GSFC
Work with header-only quicklook structures.
Version 4, 23-May-2000, William Thompson, GSFC
Add offsets between NIS-1 and NIS-2
Version 5, 01-Jun-2000, William Thompson, GSFC
Detect if NIS_ROTATE has been applied.
Version 5, 30-Aug-2000, William Thompson, GSFC
Detect if NIS_ROTATE was called with /ALIGN
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_SOLARX
Purpose : Returns the Solar X coordinates for data points
Explanation : This function is supposed to return the most correct solar
coordinates for given data points.
In order to be able to compensate for possible misalignments
etc., data points must be fully specified with detector X
values, detector Y (or slit position for GIS), and mirror
position.
Other relevant information is taken from the QLDS.
All parameters except the QLDS may be either arrays or
scalars. The returned array with solar x values will either
be a scalar, or of the same size as the expression:
RESULT = c1*DETX + c2*DETY + c3*MIRPIX
*or*
RESULT = c1*DETY
I.e., having DETX = [0,1] and DETY=[0,1,2] does not produce an
error, but the result will be a fltarr(2) - NOT a fltarr(2,3)
or fltarr(3,2) etc.
Use : GT_SPECTRUM(QLDS,DETX, DETY || SLITPIX ,MIRPIX)
Inputs : QLDS: CDS QuickLook Data structure
DETX: Detector X values. 0..1023 for NIS, 0..8191 for GIS
(i.e., DETX also specifies the waveband).
DETY: Detector Y values for the NIS detector.
SLITPIX: Slit positions index for the GIS detector.
Range 0..N(slit positions)-1
MIRPIX: Mirror position index
Range 0..N(mirror positions)-1
Opt. Inputs : None.
Outputs : Returns the solar x coordinates for the specified data
points. Return value has the same dimension as a linear
combination of the input parameters.
Opt. Outputs: None.
Keywords : NOCHECK: Set to avoid call to QLMGR
Calls : ***
GT_DETECTOR, GT_DIMENSION, PARCHECK, QLMGR, TYP
CALLED BY:
GT_IIMAGE, GT_SCANP, GT_SCANT, GT_SCANX, GT_SCANY, GT_SPECTRUM, NDSPSPEC
Common : None.
Restrictions: QLDS == QL Data Structure.
Currently, only the DETDESC.origin/spacing fields
are used.
Side effects: None.
Category : CDS, QuickLook, Data_Handling.
Prev. Hist. :
Written : S.V.H. Haugan, 18-October-1995
Modified : Version 1.1: SVHH, 19-October-1995
Loosened restrictions on NIS DETY parameter
until more correct procedure is found.
Version : 1.1, 19-October-1995
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_SOLARY
Purpose : Returns the Solar Y coordinates for data points
Explanation : This function is supposed to return the most correct solar
coordinates for given data points.
In order to be able to compensate for possible misalignments
etc., data points must be fully specified with detector X
values, detector Y (or slit position for GIS), and mirror
position.
Other relevant information is taken from the QLDS.
All parameters except the QLDS may be either arrays or
scalars. The returned array with solar x values will either
be a scalar, or of the same size as the expression:
RESULT = c1*DETX + c2*DETY + c3*MIRPIX
*or*
RESULT = c1*DETY
I.e., having DETX = [0,1] and DETY=[0,1,2] does not produce an
error, but the result will be a fltarr(2) - NOT a fltarr(2,3)
or fltarr(3,2) etc.
Use : GT_SPECTRUM(QLDS,DETX, DETY || SLITPIX ,MIRPIX)
Inputs : QLDS: CDS QuickLook Data structure
DETX: Detector X values. 0..1023 for NIS, 0..8191 for GIS
(i.e., DETX also specifies the waveband).
DETY: Detector Y values for the NIS detector.
SLITPIX: Slit positions index for the GIS detector.
Range 0..N(slit positions)-1
MIRPIX: Mirror position index
Range 0..N(mirror positions)-1
Opt. Inputs : None.
Outputs : Returns the solar y coordinates for the specified data
points. Return value has the same dimension as a linear
combination of the input parameters.
Opt. Outputs: None.
Keywords : NOCHECK: Set to avoid call to QLMGR
Calls : ***
GET_VDS_SLITPOS, GT_DIMENSION, PARCHECK, QLMGR, TYP
CALLED BY:
GT_IIMAGE, GT_SCANP, GT_SCANT, GT_SCANX, GT_SCANY, GT_SPECTRUM, NDSPSPEC
Common : None.
Restrictions: QLDS == QL Data Structure.
Currently, only the DETDESC.origin/spacing fields
are used.
Side effects: None.
Category : CDS, QuickLook, Data_Handling.
Prev. Hist. :
Written : S.V.H. Haugan, 18-October-1995
Modified : Version 1.1: SVHH, 19-October-1995
Loosened restrictions on NIS DETY parameter
until more correct procedure is found.
Version 2, SVHH, 20-December-1995
Rewrote some of the NIS DETY handling.
Version 3, SVHH, 17 June 1996
Taking the tilt on the NIS detector into account.
Version 4, CDP, 20 Feb 2002
Fix for y-binned data on line 162 as suggested by SVHH.
Version : 4, 20 February 2002
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_SPECTRUM
Purpose : Returns one-dimensional spectrum at specified point
Explanation : The GT_SPECTRUM function returns a one-dimensional array with
a spectrum from the supplied QLDS.
The extracted spectrum must be uniquely determined among the
QLDS data by supplying all the relevant parameters. E.g., with
a one-exposure GIS data set, no additional information is
required other than e.g., the wavelength band or a window
name/number, but a time series with multiple exposures with
the NIS would require a solar x index plus a time (exposure
no.) index in order to specify which spectrum should be
extracted.
Failure to supply enough data to uniquely determine which
spectrum should be extracted results in an error.
Although GT_SPECTRUM always returns a one-dimensional
spectrum, the number of elements in the returned array may
vary depending on the nature of the request.
If a specific wavelength band is specified, all the
(deselected) data from that wavelength band/detector is
returned (i.e., 1024 elements for NIS, 2048 elements from
GIS), although this can be overridden by using the /NODESELECT
keyword.
If specific wavelength windows are specified, there is a
choice between deselecting to a full detector
(1024(NIS)/2048(GIS)) or simply packed into a contiguous
array.
In case the sumline compression scheme has been used, the
counts will be spread out over the original detector area
where the summation has been performed.
In addition to returning the detector counts, GT_SPECTRUM
returns other relevant quantities such as wavelength, solar
x/y and time through the use of output keywords. The names of
the keywords are constructed in order to make efficient use of
abbreviations.
These auxiliary data are returned either as an array with the
same size as the spectrum, or as a scalar (if the value is
truly a constant over the whole spectrum, e.g., time).
Use : result = GT_SPECTRUM(QLDS,<keywords>)
Inputs : QLDS: CDS QuickLook Data structure
Some keyword parameters *are* required, though which
ones are sufficient may vary.
Opt. Inputs : BAND: Which wavelength band should be returned.
WINDOW: The number or name of a detector data window
in the QLDS. If it's an array, the data from
the specified windows will be packed in a
contiguous array
YIX: Solar Cartesian Y index (0..)
XIX: Solar Cartesian X index (0..)
TIX: Time index (exposure no.) (0..)
Outputs : Returns a one-dimensional array with a spectrum at the
specified point.
Opt. Outputs: LAMBDA : wavelength for each pixel (Angstrom)
XSOLAR : Solar Cartesian X (arcsecs)
YSOLAR : Solar Cartesian Y (arcsecs)
TIME : Time of the exposure
Keywords : NOCHECK: Set to avoid call to QLMGR
NODESELECT: Set to use the (wavelength) packed format.
NOPARCHECK: Set to avoid most parameter checking mostly for
internal use.
NOEXTRA : Don't calculate optional outputs LAMBDA, XSOLAR etc.
QUICK : Sets /NOEXTRA and /NOCHECK and /NOPARCHECK
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DEFAULT, GT_CDS_TIME, GT_DETECTOR
GT_DIMENSION, GT_LAMBDA, GT_NUMWIN, GT_SOLARX, GT_SOLARY, GT_WINDATA, GT_WNUM
PARCHECK, QLMGR, ST_WINDATA, TAG_EXIST [1], TAG_EXIST [2], TRIM, TYP
CALLED BY:
CDS_VEL_SLICE [2], CWQ_SPECTR [1], DSPWAV, DSP_POINT, FIT_CDS_QL, GDSPSPEC
NIS_PIX_ANALYSE, PLOT_SPEC [2], POLY_SPEC, XCDS_ANALYSIS, cwq_spectr [2]
Common : None.
Restrictions: QLDS == QL Data Structure.
Side effects: None.
Category : CDS, QuickLook, Data_Handling.
Prev. Hist. : Based on POINTSLICE
Written : SVH Haugan, UiO, 18-October-1995
Modified : Version 2, SVHH, 8-December-1995
Fixed waveband conversion error for GIS
Version 3, SVHH, 12 April 1996
Renamed gt_time -> gt_cds_time
Version 4, SVHH, 18 August 1996
Compatible with new and old storage system.
Added NOEXTRA and QUICK keywords, and the possibility
to extract blank scans.
Version : 4, 18 August 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_START()
Purpose : Gets the exposure start times from a file or data structure.
Explanation : Depending on the nature of the input parameter (structure or
file name) the routine extracts and returns the exposure
start times used in the raster.
Use : IDL> s = gt_start(file_str [,/EXPOSURE, /INT, /EXT, /ECS, $
/DATE_ONLY,/TIME_ONLY,/UPPERCASE,/TRUNCATE,/VMS,/STIME,/ERRMSG])
e.g.:
IDL>print,gt_start(QLDS,/ecs ) --->1996/08/28 11:57:14.426
IDL>print,gt_start(QLDS,/vms ) --->28-Aug-1996 11:57:14.426
IDL>print,gt_start(QLDS,/ecs,time_only,truncate)-->11:57:14
Inputs : file_str - either:- the name of a CDS FITS file
or:- the name of a CDS data structure
Opt. Inputs : None
Outputs : Function returns the exposure start times. The default
format is standard CCSDS string with other options available
via keywords; you can either have the /INTERNAL, or /EXTERNAL,
or one or more of the UTC2STR.PRO keywords.
See UTC2STR.PRO for details about formats!!
Opt. Outputs: None
Keywords : EXPOSURE - return start time for all exposures, otherwise
just the raster start.
INTERNAL - return times in internal CDS format.
EXTERNAL - return times in external CDS format.
those of UTC2STR.PRO:
ECS - return times in ECS string format.
VMS = If set, then the output will be in VMS format
STIME = If set, then the output will be in STIME format
TRUNCATE = If set, then the time will be truncated to
1 second accuracy (rounding down)
DATE_ONLY = If set, then only the date is returned.
TIME_ONLY = If set, then only the time is returned.
UPPERCASE = If set, then the month field in either the VMS or
STIME format is returned as uppercase.
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.
Calls : ***
AUXREAD, CAL_AUXREAD, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1]
DATATYPE [2], DATATYPE [3], FILE_EXIST [2], FXBCLOSE [1], FXBCLOSE [2]
FXBOPEN [1], FXBOPEN [2], FXBOPEN [3], FXPAR [1], FXPAR [2], INT2UTC, QLMGR
STR2UTC [1], STR2UTC [2], STR2UTC [3], UTC2STR, concat_dir [4], file_exist [1]
file_exist [3]
CALLED BY:
CDS_TILT_COR, DSP_RASTER, GIS_CALIB_FF_LTGD, GIS_ERROR, GT_DURATION, MK_CDS_IMAP
MK_CDS_SMAP, NDSPSPEC, PLOT_EXPINT, PLOT_RASTER, PLOT_VDS_BIAS, RESTORE_WAVECAL
Common : None
Restrictions: Reads OBS_DATE instead of DATE_OBS from calibration files.
Side effects: None
Category : Data_handling, FITS
Prev. Hist. : None
Written : C D Pike, RAL, 24-May-94
Modified : Fix bug in structure tag name in file case. CDP, 14-Jun-94
Insert cal/ops test. CDP, 15-Jun-94
Fix bug caused by different tag names in cal/ops and
change .dat --> .mjd and now that delta times are in
seconds not msec. CDP, 7-Feb-95
Handle case of /exp keyword and only one exposure.
CDP, 6-Jun-95
Substituted DELTDATA --> DEL_TIMEDATA
Keep 2-d format if raster was 2-d (eg GIS with slit & mirror
movements). CDP, 13-Jan-96
Version 7, SVHH, UiO, 28 February 1996
Fixed spelling mistake (ev(over) => et(over))
Check for bad time values. CDP, 18-Mar-96
Version 9, GDZ, UCLAN, 15-Oct-1996 added
all the UTC2STR.PRO KEYWORDS
Version : Version 9, 15-Oct-1996
[Previous]
[Next]
Name: gt_tagval
Purpose: return value stored in specified tag - (nested N-deep struct OK)
Input Parameters:
item - structure (FITS header)
tag/field - tag to search for
Optional Keyword Parameters:
str_pattern (input) - optional match pattern in structure name
struct (output) - structure name at match level
found (output) - nest level where match found
[ -1 -> not found, 0 -> top level, 1 -> nested one down, etc)
Calling Sequence:
tag_val=gt_tagval(item, tagname [,str_patt='pattern', struct=struct, $
found=found])
Calling Examples:
tagval=gt_tagval(structure,'tagname',found=level)
tagval=gt_tagval(index,'periph',str_pattern='sxt',found=level)
tagval=gt_tagval(rmap ,'periph',str_pattern='sxt',found=level)
Method:
recursive for nested structures
CALLS: ***
data_chk [1], data_chk [2], tag_index [1], tag_index [2], wc_where [1]
wc_where [2]
CALLED BY:
EIT_FXPAR, GET_FITS_CDELT, GET_FITS_CEN, HSI_EVENTLIST_TO_SPECTROGRAM [1]
HSI_EVENTLIST_TO_SPECTROGRAM [2], HSI_FOVBOX, HSI_HIST_GROUP, HSI_RMAP_DIM
HSI_SPECTROGRAMCHAN_OVERLAP_FIX, HSI_SPECTROGRAM_DECIM_CORRECT
HSI_SPECTROGRAM_DECIM_TABLE, MDI__DEFINE, READ_ANALIST
SPECTROGRAM CLASS DEFINITION, SPEX_DATA_GENX [1], SPEX_DATA_GENX [2]
TRACE_LIST_INDEX, TRACE_PREP, TRACE_SSWHERE [1], TR_DARK_SUB, TR_EXT_SUBIMG
TR_FLAT_SUB, eit_fulldiskdb, eit_gt_filter, eit_gt_wave, eit_proton_summary
get_history, get_infox, get_solar_indices, goes_value2class, gt_yo_station
gtt_info, hsi_spectrogramACCBIN [2], hsi_spectrogram__define [1]
hsi_spectrogram__define [2], hsi_spectrogram__define [3]
hsi_spectrogram__get_obs [1], hsi_spectrogram__livetime [1], index2fov
les_archive_info, map2index, mreadfits, mreadfits_fixup, mreadfits_sxig12
mxf_decomp_data, mxf_dset_map, mxf_read_data, mxfdset_map, mxfread, plot_ace
plot_fov [1], plot_goesp, pr_his_index [1], pr_his_index [2], pr_his_index [3]
rd_mdi [1], rd_mdi [2], read_eit, read_lapalma, read_soon, read_sxt, read_trace
required_tags, return a solar disk mask using SSW standard keywords
return solar disk mask constrained by XY limits using SSW standards
ssw_apkpbar, ssw_build_trace, ssw_contrib_info, ssw_contrib_monitor
ssw_contrib_ok2online, ssw_expand_times, ssw_findstuff2html, ssw_flare_locator
ssw_fov_context, ssw_fs_maskdbase, ssw_getdst, ssw_install [1], ssw_install [2]
ssw_nar2armurl, ssw_pos2zenith, ssw_subimage, ssw_track_fov, sswstruct_fill [1]
sxt_his_info [2], sxt_mornint, sxt_orhis, sxt_prep [1], sxt_prep [2], sxt_prep [3]
tr_head_info, tr_mech_summary_img month, tr_wrt_fits_i1 [2], trace_bin_struct
trace_cat2cosmic, trace_cat2data, trace_cen2pix, trace_comsmic_norm
trace_cosmic2filename, trace_get1www_image, trace_get_vignette
trace_jpeg_dbase, trace_jpeg_decomp, trace_last_movie [1]
trace_last_movie [3], trace_movies_prioritize [1]
trace_movies_prioritize [2], trace_scale, trace_special_movie [1]
trace_special_movie [2], trace_special_movie [3], trace_special_movie2
trace_sswhere [2], trace_sswhere [3], trace_sswhere [4], trace_struct2filename
trace_sub2point, trace_submit_request, trace_wave2point, trace_write_genxcat
write_genxcat, write_trace_bin, xdisp_trace [1], yoh_orb_interp [1]
yoh_orb_interp [2]
Restrictions:
need to add case where item is FITS header (call WT routine)
[Previous]
[Next]
NAME:
gt_time
PURPOSE:
To extract the word corresponding to time and optionally
return a string variable for that item. If the item passed is an
integer type, it is assumed to be the 7-element external representation
of the time.
CALLING SEQUENCE:
x = gt_time(roadmap)
x = gt_time(index)
x = gt_time(index.sxt, /space) ;put single space before string
x = gt_time(index, space=3) ;put 3 spaces
METHOD:
The input can be a structure or a scalar. The structure can
be the index, or roadmap, or observing log.
INPUT:
item - A structure or scalar. It can be an array.
(or)
The "standard" 7 element external representation
of time (HH,MM,SS,MSEC,DD,MM,YY)
OPTIONAL INPUT:
string - If present, return the string mnemonic (long notation)
spaces - If present, place that many spaces before the output
string.
msec - If present, also print the millisec in the formatted
output.
nolead0 - If present, do not include a leading "0" on the hour string
for hours less than 10. (ie: return 9:00:00 instead of 09:00:00)
OUTPUT:
returns - The time, a integer value or a string
value depending on the switches used. It is a vector
if the input is a vector
Sample String: 23:25:10
OPTIONAL OUTPUT:
header - A string that describes the item that was selected
to be used in listing headers.
CALLS: ***
Int2Ex [1], Int2Ex [2], anytim2ints [1], anytim2ints [2], tbeep [1], tbeep [2]
tbeep [3]
CALLED BY:
ALIGN_AR, ATIME [1], ATIME [2], BCS_ACCUM [1], BCS_ACCUM [2], BCS_DP_CHECK
BCS_DT_INTERP [1], BCS_DT_INTERP [2], BORN_AGAIN, BSC_TIM2DSET, CCCA
CHECK_SFC_PNT, COVER_PAGE [1], COVER_PAGE [2], DATAGET3_GRS, DATAGET3_HXS, DAY_IN
EIT_GBO, F_ATIME [1], F_ATIME [2], GETCAL_ATT [1], GETCAL_ATT [2], GET_FRAME_TIME
GET_POINTS, GET_SUNCENTER [1], GET_SUNCENTER [2], GET_YOHKOH_POS, GT_BSC_TIME
HXT_4CHPLOT, HXT_DUMP, INF_STR, IRU_OFFS, LIST_BDA, LIST_BSC [1], LIST_BSC [2]
LIST_GEV, MAKE_VTRANGE, MDI_GBO, MK_GRSPCH, MK_GRSPCL, MK_GRSPHH1, MK_GRSPHH2
MK_GRSPHL1, MK_GRSPHL2, MK_HXI_MAP, MK_HXSPC, MK_HXSPH, MK_RBMPC, MK_SXT_MAP
NORH_PR_EVX [1], NORH_PR_EVX [2], ORB_EXTRAP, OUT_GRSPHL1, OUT_GRSPHL2, OUT_HXSPH
OVER_THE_LIMB, PLOT_GRSPCH, PLOT_GRSPCL, PLOT_GRSPHH, PLOT_GRSPHL, PLOT_HXSPC
PLOT_HXSPH, PLOT_HXT, PREFLARE_SEARCH, PRINT_GEV, RD_AR, RES_FFI, SEL_AR, SPLINE_LC
SPLINE_PLOT, SSDA, SXI_GBO, SXTASEQ, SXT_HYST, SXT_OBSRPT, TIM2JD [1], TIM2JD [2]
TIME_INFO, TRACE_GBO, TVF_SLICE, WBDA [1], WBDA [2], WBSC [1], WBSC [2]
WBSC_LTC_EV [1], WBSC_LTC_EV [2], WBS_DB, WBS_DB2, anytim [1], anytim [2]
anytim [3], anytim [4], anytim [5], anytim2ex [1], anytim2ex [2], anytim2ints [1]
anytim2ints [2], auto_toban, bcs_survey, bcs_trange, cam_run_sum, carr2btime [2]
cnvt [2], contacts [1], contacts [2], db_gbo, filetimes [1], filetimes [2], fmt_pass
fmt_tim [1], fmt_tim [2], function timeintervalab, get_dc_image [2]
get_dc_image [3], get_info_lp, get_leak_image [1], get_leak_image [2]
get_leak_image [3], goes_summary, grs_plot, gtab_file, hsi_gbo, hxt_images2ps
img_seq [1], int2sec [1], int2sec [2], ip_que_dmpver, jitter_gif_xyimg
lastsfd [1], lastsfd [2], list_tfi, mdi_display, mk_bsa_interv [1]
mk_bsa_interv [2], mk_desat_wl, mk_hxt_sum_64, mk_mdi_iap, mk_ptv_title, mk_sdmi
mk_sfd [1], mk_sfd [2], mk_sfd [3], mk_sfd [4], mk_sfw, mk_title [1], mk_title [2]
mk_title [3], mon_sci5k, obs_summary, op_bdr_opt, op_pass_sheets [1]
op_pass_sheets [2], pass_sheets, plot_ref, pr_evn [2], pr_fdss_viewpd, pr_fem
pr_gbe, pr_gev, pr_visible
pro interpretfemfemfemtimefemflgfemstrfemstrverboseverbose
pro loadopfemfiletimeOGfemverboseverbose
pro loadoptextfiletimeOGverboseverbose
pro optimizedbdrfileshowparamshowparam, pro showaoslosgdfemtimefemflg
rd_raw_station_plan, rd_sci5k, rd_sfd_carr, rd_so_at_ftr, rd_station_plan
rd_therm_rs232, read_eit, redo_disploi, redo_mon_sci5k, ret_day, sacpeak_image
sda2fits, show_contacts, sxt_align, sxt_combine, sxt_composite [1]
sxt_composite [2], sxt_composite [3], sxt_images2ps, sxt_sff_composite [1]
sxt_sff_composite [2], tim2dset [1], tim2dset [2], tim2orbit [1], tim2orbit [2]
tim2tfss, time_add1s, time_addxa, timeline, tr_decode_head [1], tr_decode_head [2]
usertimes_event, wrtsxtmap, xhkplot, xread_hist, xy_raster [1], xy_raster [2]
xy_raster [3]
HISTORY:
Written 13-Nov-91 by M.Morrison
15-Nov-91 (MDM) - Added "msec" and "nolead0" options. Made the default
different from before for leading 0 (it will have a leading
zero unless the /nolead0 option is used)
16-May-93 (MDM) - Modified to accept string time as input
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_VALID()
Purpose : Determine if keyword values are valid for gt_xxx calls.
Explanation : This routine may be used to test for the validity of
keyword values before calling e.g., GT_SCANX/Y/T/P or
GT_IIMAGE etc. Useful when the keyword values are
taken from user input.
Use : VALID = GT_VALID(QLDS, ...)
Inputs : QLDS : Quick Look Data Structure.
Opt. Inputs : None.
Outputs : Returns 1 if no inconsistencies are found, zero otherwise.
Opt. Outputs: None.
Keywords : XIX : X index, scalar or array ; Of those that are defined,
YIX : Y index, scalar or array ; these must have identical
TIX : Time index, scalar or array ; sizes, and be within
; the valid ranges.
; DIMENSION < 2
BAND : Scalar, causes error if no loaded data in this band.
DETX : Scalar. Combination of BAND/DETX tests for loaded data
covering that pixel. DETX cannot be set unless BAND
is set.
WINDOW : Scalar or array, string or integer. Causes error
if out of range or referring to an unloaded window.
If BAND and WINDOW is set then all WINDOWs must
be in BAND.
OFFSET : Scalar. Must be 0 < OFFSET < WINDOW_WIDTH
Cannot be set without also setting window to a
scalar value.
LAMBDA : Scalar or array. Checks to see if there's data
present at that wavelength. If it's an array with
2 elements (representing lower/upper integration
limits for GT_BIMAGE) they should refer to the
same wavelength band.
NOCHECK: Don't check that the QLDS is a QLDS
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DATATYPE [1], DATATYPE [2], DATATYPE [3]
GT_DETECTOR, GT_DIMENSION, GT_WAVEBAND, GT_WINDOW, LOAD_WAVECAL, PARCHECK, QLMGR, TRIM
TYP, WAVE2PIX
CALLED BY:
GDSPSPEC
Common : None.
Restrictions: None.
Side effects: None.
Category : Get routines
Prev. Hist. : None.
Written : Stein Vidar H. Haugan, UiO, 27 February 1996
Modified : Version 2, SVHH, 14 April 1996
Using LOAD_WAVECAL().
Version : 2, 14 April 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_WAVEBAND()
Purpose : Return the waveband number given detector and wavelengt
Explanation : Based on the input detector name ("GIS" or "NIS"), the
waveband number corresponding to the supplied wavelength is
returned.
Use : BAND = GT_WAVEBAND(DETECTOR,LAMBDA)
Inputs : DETECTOR: Either "NIS" or "GIS"
LAMBDA: Wavelength.
Opt. Inputs : None.
Outputs : Returns the waveband number, or 0 if outside limits.
Opt. Outputs: None.
Keywords : None.
Calls : ***
PARCHECK, PIX2WAVE, TRIM, TYP
CALLED BY:
GT_BIMAGE, GT_MIMAGE, GT_VALID, POLY_SPEC
Common : None.
Restrictions: Wavelength should be within specified limits.
Only 1st order calculations are made.
Side effects: None.
Category : GET
Prev. Hist. : None.
Written : SVH Haugan, UiO, 27-October-1995
Modified : Version 2, 8-December-1995, SVHH
Fixed error FOR the GIS case.
Version : 2, 8-December-1995
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_WINDATA()
Purpose : Return block of detector data from one detector window.
Explanation : This function is meant as a quick and safe way of extracting
the full data "cube" corresponding to a data extraction window
in a Quick Look Data Structure.
CALLED BY:
BP_SEEK_POS, CDS_CLEAN_EXP, CDS_CLEAN_SPIKE, CDS_FILL_MISSING, CDS_MOSAIC
CDS_NEW_SPIKE, CDS_PAD_QLDS, CDS_QUASI_FIT, CDS_READ_MISSING, CDS_REPAIR_TOP
CDS_SATURATE, CDS_SAVE_MISSING, CDS_SNAPSHOT, CDS_THUMBNAIL, CDS_TILT_COR
CF_174LG, CF_177LG, CF_180LG, CF_765LG, CF_770LG, CF_GIS1A, CF_GIS1B, CF_GIS1C
CF_GIS2A [1], CF_GIS4A, CF_GIS4B, CF_GIS4C, COPY_QLDS, CWQ_CUBE, DSPEXP
FIND_COSMIC_RAYS, FIT_CDS_QL, GHOST_BUSTER, GHOST_MOVE, GHOST_PLOT_ONE
GIS_CALIB_EXTRACT, GIS_ERROR, GIS_SMOOTH, GIS_UTPLOT, GT_BIMAGE, GT_CDS_QL
GT_IIMAGE, GT_SCANP, GT_SCANT, GT_SCANX, GT_SCANY, GT_SPECTRUM, MK_CDS_ANALYSIS
MK_CDS_SMAP, MK_SYNOPTIC, MONO_SPEC, NIS_MRGDATA, NIS_QUICKLOOK, NIS_ROTATE
SNAP_MOVIE, XCDS_ANALYSIS, XCDS_COSMIC, XCOR_CDS, gis_cqlds
Example:
Let's say you have a GIS raster scanning 15x15 points in a
30x30 arcsecond area of the sun, and you want the
averaged spectrum from band 1 for the whole area,
you first locate which data window corresponds to
wavelength band 1 (use e.g., gt_wlimits). Let's say
it's window 0. Now you can use:
data = gt_windata(qlds,0) ;; Returns (2048,15,15) array.
data = total(data,2) ;; Sum to (2048, 15) array
data = total(data,2) ;; Sum to (2048).
data = data/gt_numexp(qlds) ;; Average. Done!
Use : data=gt_windata(QLDS,WINDOWI)
Inputs : QLDS : Quick Look Data Structure.
WINDOWI : Scalar integer/long with the index of the
desired data window.
Opt. Inputs : None.
Outputs : Returns the block of data for the data extraction window.
Opt. Outputs: None.
Keywords : NOCHECK : Don't check that the QLDS is a QLDS.
QUICK : Set NOCHECK, and don't check the validity of
WINDOWI.
NO_COPY : Set to use the NO_COPY keyword when getting the
data from the handle. REMEMBER TO PUT THE DATA BACK
WITH ST_WINDATA IF YOU USE THIS KEYWORD.
NOPADDING : If set, then the window will be returned without
padding. Thus, different data windows could be
returned with different sizes. For example, when
reading in full NIS readout, the window for NIS1
will have a different height than that for NIS2,
because of the different slants in each band.
INVERT : If set, and if the data were taken when SOHO was
upside-down, then the X and Y axes will be flipped.
ERRMSG : Set to a defined variable to receive an error
message through this keyword instead of crashing.
Calls : ***
DEFAULT, PARCHECK, QLMGR, REARRANGE, TAG_EXIST [1], TAG_EXIST [2], TYP
Common : None.
Restrictions: None.
Side effects: None.
Category : Data_handling, Get
Prev. Hist. : Prompted by request from Eddie Breeveld.
Written : Stein Vidar H. Haugan, UiO, 8 April 1996
Modified : Version 2, SVHH, 12 August 1996
Compatible with old/new storage systems.
Added keyword errmsg.
Version 3, SVHH, 18 August 1996
Made the old storage system use both ixstart/ixstop
when extracting data, to make cds_pad_qlds work
better, with correct filling-in of missing values.
Version 4, 13-May-1997, William Thompson, GSFC
Added keyword NOPADDING
Version 5, 03-Aug-2004, William Thompson, GSFC
Added keyword INVERT
Version : Version 4, 03-Aug-2004
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_WINDESC()
Purpose : Return descriptor structure for one detector window.
Explanation : This function is meant as a quick and safe way of extracting
the description of a data extraction window in a Quick Look
Data Structure.
Use : data=gt_windesc(QLDS,WINDOWI)
Inputs : QLDS : Quick Look Data Structure.
WINDOWI : Scalar integer/long with the index of the
desired data window.
Opt. Inputs : None.
Outputs : Returns the descriptor structure for the data
extraction window.
Opt. Outputs: None.
Keywords : NOCHECK : Don't check that the QLDS is a QLDS.
QUICK : Set NOCHECK, and don't check the validity of
WINDOWI.
ERRMSG : Set to a defined variable to receive an error
message through this keyword instead of crashing.
Calls : ***
PARCHECK, QLMGR, TAG_EXIST [1], TAG_EXIST [2], TYP
CALLED BY:
CDS_MOSAIC, CDS_QUASI_FIT, CDS_SNAPSHOT, CDS_THUMBNAIL, GHOST_BUSTER, GHOST_MOVE
GIS_CALIB_EXTRACT, GIS_FIT, GIS_SMOOTH, GT_SOLAR_XY, NIS_ROTATE, SNAP_MOVIE
Common : None.
Restrictions: None.
Side effects: None.
Category : Data_handling, Get
Prev. Hist. : Modified from GT_WINDATA.
Written : William Thompson, GSFC, 6 January 1997
Modified : Version 1, William Thompson, GSFC, 6 January 1997
Version 2, William Thompson, GSFC, 28 February 2000
Modified to not check if window loaded when /QUICK is
used.
Version : Version 2, 28 February 2000
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_WINDOW()
Purpose : Find a (valid) window from BAND + DETX
Explanation : Returns the index of those windows covering a specific
dispersion pixel. If no windows meet the criteria, -1 is
returned.
Use : result = GT_WINDOW(QLDS, BAND,DETX)
Inputs : QLDS: CDS QuickLook Data structure
BAND: Detector band number.
DETX: Detector X pixel.
Opt. Inputs : None.
Outputs : Returns indices (possibly an array) of those windows
covering pixel DETX in waveband BAND. Returns -1 if none.
Opt. Outputs: None.
Keywords : LOADED: Set to discard those windows that are not
stored in the qlds.detdata array.
Calls : ***
GT_BINX, GT_DETECTOR, GT_DIMENSION, PARCHECK, QLMGR, TYP
CALLED BY:
GT_BIMAGE, GT_IIMAGE, GT_MIMAGE, GT_VALID
Common : None.
Restrictions: Valid inputs are assumed.
Side effects: None.
Category : GET
Prev. Hist. :
Written : SVH Haugan, UiO, 27-October-1995
Modified : Version 1.1, SVHH, 4-December-1995
Detector X values taken MOD 2048 (only affects GIS).
Version 2, SVHH, 15-January-1996
Now using detx + wwidth MINUS ONE before MOD 2048.
Version 3, SVHH, 6 April 1996
Calculating wwidth from DETDESC.
Version : 3, 6 April 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_WINSIZE()
Purpose : Get the size of data windows from a file or data structure.
Explanation : Depending on the nature of the input parameter (structure or
file name) the routine extracts and returns the size
of data windows in the raster.
Use : IDL> s = gt_winsize(file_str)
Inputs : file_str - either:- the name of a CDS FITS file
or:- the name of a CDS data structure
Opt. Inputs : None
Outputs : Function returns the size of windows used.
Opt. Outputs: None
Keywords : None
Calls : ***
CAL_DETSELECT, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1]
DATATYPE [2], DATATYPE [3], DETSELECT, FILE_EXIST [2], FXBCLOSE [1], FXBCLOSE [2]
FXBOPEN [1], FXBOPEN [2], FXBOPEN [3], FXPAR [1], FXPAR [2], QLMGR, concat_dir [4]
file_exist [1], file_exist [3]
CALLED BY:
GIS_CALIB, GIS_CALIB_EXTRACT, GIS_SMOOTH, GIS_UTPLOT, MK_CDS_IMAP, NIS_PIX_ANALYSE
NIS_QUICKLOOK, SHOW_AXES
Common : None
Restrictions: None
Side effects: None
Category : Data_handling, FITS
Prev. Hist. : None
Written : C D Pike, RAL, 3-Jun-94
Modified : Update to new file reading routines. CDP, 14-Jun-94
Insert cal/ops test. CDP 15-Jun-94
Version : Version 3, 15-Jun-94
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_WLABEL()
Purpose : Get the label of a window from a file or data structure.
Explanation : Depending on the nature of the input parameter (structure or
file name) the routine extracts and returns the label
of a window or windows in the raster.
Use : IDL> s = gt_wlabel(file_str [, win])
Inputs : file_str - either:- the name of a CDS FITS file
or:- the name of a CDS data structure
Opt. Inputs : win - either a string/integer scalar or vector of windows
to be identified. If not given the labels of all
windows in the input are returned.
Outputs : Function returns the labels(s) of the window(s) used.
Opt. Outputs: None
Keywords : None
Calls : ***
CAL_DETREAD, CAL_DETSELECT, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
DATATYPE [1], DATATYPE [2], DATATYPE [3], DETREAD, DETSELECT, FILE_EXIST [2]
FXBCLOSE [1], FXBCLOSE [2], FXBOPEN [1], FXBOPEN [2], FXBOPEN [3], FXPAR [1]
FXPAR [2], QLMGR, concat_dir [4], file_exist [1], file_exist [3]
CALLED BY:
CDS_CLEAN_SPIKE, CDS_NEW_SPIKE, CDS_SATURATE, NIS_PIX_ANALYSE, NIS_QUICKLOOK
Common : None
Restrictions: None
Side effects: None
Category : Data_handling, FITS
Prev. Hist. : Based on GT_WNUM
Written : C D Pike, RAL, 20-Apr-95
Modified :
Version : Version 1, 20-Apr-95
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_WLIMITS()
Purpose : To retrieve the window limits from a file or data structure.
Explanation : Depending on the nature of the input parameter (structure or
file name) the routine extracts and returns the window
limits used in the raster.
Use : IDL> s = gt_wlimits(file_str)
Inputs : file_str - either:- the name of a CDS FITS file
or:- the name of a CDS data structure
Opt. Inputs : None
Outputs : Function returns the window limits used in a (2xN) array
for GIS data or a (4xN) array for VDS data.
Opt. Outputs: None
Keywords : WAVE - if specified, the window limits in the dispersion
direction are returned as wavelengths.
QUIET - no extra info to screen.
BAND - returns the band ID for each window
SHORT - gives a compressed version of the output info
WSORT - sorts into wavelength order (in SHORT mode only)
HARDCOPY - hardcopy listing - only in /SHORT mode
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
DATATYPE [1], DATATYPE [2], DATATYPE [3], FILE_EXIST [2], LOAD_WAVECAL, PIX2WAVE
PRINT_STR, QLMGR, READCDSFITS, STRPAD, concat_dir [4], file_exist [1]
file_exist [3]
CALLED BY:
CDS_VEL_SLICE [2], CWQ_WINSEL [1], MK_CDS_IMAP, MONO_SPEC, PLOT_SPEC [2]
PLOT_WINDOWS, POLY_SPEC, cwq_winsel [2]
Common : None
Restrictions: None
Side effects: None
Category : Data_handling, FITS
Prev. Hist. : None
Written : C D Pike, RAL, 26-May-94
Modified : Take account of negative .detdesc.ixstart(0) returned when
/header keyword used in FITS reading routines. CDP, 3/6/94
Use new file reading routines. CDP, 14-Jun-94
Insert cal/ops test. CDP, 15-Jun-94
: Updated NIS band definition and y max limit "error". Also
now lists a summary of limits with a quiet option to over-
ride this. BJKE, 15-Nov-95.
Add the band keyword. CDP, 28-Nov-95
Version 7, SVHH, UiO, 29 February 1996
Added some support for old calibration NIS files.
Version 8, SVHH, UiO, 14 April 1996
Added calls to load_wavecal for input == QLDS,
and using readcdsfits (which calls load_wavecal)
when input == filename.
Add SHORT AND WSORT keywords. CDP, 27-Mar-96
Add HARDCOPY keyword for SHORT mode. CDP, 8-Sep-1996
Fix typo in last update. CDP, 24-9-96
Tidy quiet version. CDP, 26-Aug-99
Version : Version 11, 26-Aug-99
[Previous]
[Next]
Project : SOHO - CDS
Name : GT_WNUM()
Purpose : Get the number of a window from a file or data structure.
Explanation : Depending on the nature of the input parameter (structure or
file name) the routine extracts and returns the number
of a window or windows in the raster. If the name of the
window is given, the numerical number of the corresponding
window is returned, otherwise the window number is just
echoed. Array can be handled.
Use : IDL> s = gt_wnum(file_str [, win])
Inputs : file_str - either:- the name of a CDS FITS file
or:- the name of a CDS data structure
Opt. Inputs : win - either a string/integer scalar or vector of windows
to be identified. If not given the numbers of all
windows in the input are returned.
Outputs : Function returns the number(s) of the window(s) used.
Opt. Outputs: None
Keywords : None
Calls : ***
CAL_DETREAD, CAL_DETSELECT, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
DATATYPE [1], DATATYPE [2], DATATYPE [3], DETREAD, DETSELECT, FILE_EXIST [2]
FXBCLOSE [1], FXBCLOSE [2], FXBOPEN [1], FXBOPEN [2], FXBOPEN [3], FXPAR [1]
FXPAR [2], QLMGR, concat_dir [4], file_exist [1], file_exist [3]
CALLED BY:
GT_IIMAGE, GT_SCANP, GT_SCANT, GT_SCANX, GT_SCANY, GT_SPECTRUM
Common : None
Restrictions: None
Side effects: None
Category : Data_handling, FITS
Prev. Hist. : Based on WINDOWNO by S V Haugan.
Written : C D Pike, RAL, 6-Jun-94
Modified : Use new file reading routines. CDP, 14-Jun-94
Version : Version 2, 14-Jun-94