[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 window