[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],