[Previous]
[Next]
NAME:
T_CARTES
PURPOSE:
To convert polar co-ordinates into cartesians (reverse of T_POLAR)
CATEGORY:
Image manipulation.
CALLING SEQUENCE:
T_CARTES,IMAGE_IN,IMAGE_OUT,XC,YC,RAD1,RAD2,AZ1,AZ2,COL,LIN
INPUTS:
IMAGE_IN = input image
XC,YC = centre of rotation
RAD1,RAD2 = inner and outer radius
AZ1,AZ2 = starting and finishing azimuth in degrees.
COL,LIN = the number of columns and lines in the output
OPTIONAL INPUT PARAMETERS:
NONE
OUTPUTS:
IMAGE_OUT = output image
OPTIONAL OUTPUT PARAMETERS:
NONE
CALLS: ***
XY_BILIN
CALLED BY:
WC2P
COMMON BLOCKS:
NONE
SIDE EFFECTS:
NONE
RESTRICTIONS:
NOTE THAT NO MASK IS APPLIED SO THERE WILL BE EDGE EFFECTS
PROCEDURE:
TRIVIAL
MODIFICATION HISTORY:
5-12-89 NT
14-06-1993 NT Version 3.0
[Previous]
[Next]
PROJECT:
SOHO - LASCO
NAME:
t_param.pro
PURPOSE:
Gets main telescope parameters
CALLING SEQUENCE:
value = t_param( detector, key )
EXAMPLE
pixsze = t_param('C2','PIXEL')
INPUTS:
detector 'C1','C2','C3' STRING
key parameter name STRING
'PIXEL' pixelsize (in mm)
'SCALE' angular scale for pixel (in deg)
'FOCAL' equivalent focal (in mm)
'FIELD' field (in deg)
'DFIELD' diagonal field (in deg)
'BIAS' electric bias of each amplifier (in ADU)
get byas from offset_bias.pro (needs the header)
'OCCULTER' radius of occlusion due to internal oculter
in 'CCD pixel units'
'DISTORTION' set of coefs of distortion (to be used in mm)
CALLED BY:
getl05hdrparam
NOTE: drho = a0*rho+a1*rho^3+a2*rho^5
'DISCNTR' distortion center (in mm)
'CENTER' Sun center (in pixels)
'OCCENTER' occulter center (in pixels)
KEYWORD INPUT
none
OUTPUTS:
value searched value
OUTPUTS INPUTS:
none
PROCEDURE:
Gets parameters from a set of internal data
CALLED PROCEDURES:
none
HISTORY:
Def. and code: A.Llebaria (LAS-CNRS) Aug 1996
Corrected and modified by Dr. M.-V. Bout on March, 4th, 1998
NOTA :
Distortion parameters: ; rho*(a0+a1*rho^2+a2*rho^4)
history
pm.distortion = [0.0060519645, -0.00014672423, 2.0899603e-07]
list9604_1ora_00_g_ldist.dat
pm.distortion = [0.0051344125, -0.00012233862, 1.0978595e-07]
list9603_1ora_00_a_ldist.dat
pm.distortion = [0.0044836143, -0.00011276272, 5.9968042e-08]
list9602_2ora_00_a_ldist.dat
pm.distortion = [0.0051344125, -0.00012233862, 1.0978595e-07]
list9603_1ora_00_a_ldist.dat
pm.distortion = [0.0056511656, -0.00013827504, 1.6940201e-07]
list9604_1ora_00_h_ldist.dat
[Previous]
[Next]
NAME:
T_POLAR
PURPOSE:
Polar coordinate transform
CATEGORY:
Image manipulation.
CALLING SEQUENCE:
T_POLAR,P,P1,X,Y,RAD1,RAD2,AZ1,AZ2,COL,LIN
INPUTS:
P = input array
X,Y = centre of rotation
RAD1,RAD2 = inner and outer radius
AZ1,AZ2 = starting and finishing azimuth in degrees.
COL = number of samples in radius
LIN = number of samples in azimuth
OPTIONAL INPUT PARAMETERS:
NONE
KEYWORDS:
NONE
OUTPUTS:
P1 = OUTPUT ARRAY
OPTIONAL OUTPUT PARAMETERS:
NONE
CALLS: ***
XY_BILIN
CALLED BY:
WC2P
COMMON BLOCKS:
NONE
SIDE EFFECTS:
NONE
RESTRICTIONS:
NONE
PROCEDURE:
TRIVIAL
MODIFICATION HISTORY:
10-JUN-1987 NT
5-12-1989 NT Modified to speed up but uses larger arrays!!
14-6-1993 NT Version 3.0 IDL
[Previous]
[Next]
NAME: t_utplot
PURPOSE:
Given the input time vector, x0, prepare the time variable, xplot, for utplot.
Put it in a standard form, seconds from 79/1/1, set the plot range, xrange,
determine the plot reference time, xstart, and decide whether utbase needs to
be set or changed.
CATEGORY: Graphics
CALLING SEQUENCE: t_utplot, x0, xplot=x, xrange=xrange, xstart=xst, utbase=utbase, $
timerange=timerange
CALLED BY: utplot, set_utplot
CALLS TO: anytim
INPUTS:
x0 - time axis variable in any accepted anytim format
utbase - current value of utbase
xstart - current value of plot reference time
timerange - xrange specified with two fully referenced times
base_time - passed reference time for double precession seconds time array
OUTPUTS:
xrange - plot range relative to xstart
utbase
xstart
CALLS: ***
CHECKVAR [1], DATATYPE [1], DATATYPE [2], DATATYPE [3], FCHECK, GETUT [1], GETUT [2]
SETUT [1], SETUT [2], SETUTBASE [1], SETUTBASE [2], anytim [1], anytim [2]
anytim [3], anytim [4], anytim [5], checkvar [2]
CALLED BY:
DEF_UTPLOT
MODIFICATION HISTORY:
pulled from utplot and set_utplot, ras- 5-jan-94
xst is set to a yohkoh time format (external 7xn Int2) prior to return, ras, 25-jan-94
[Previous]
[Next]
Name: tag_index
Purpsose: return tag position (index) of 'tag' within 'str'
Input Parameters:
str - structure
tag - tag name (string scaler or vector )
Output:
function returns indices of tag within str (-1 if not found)
longword scaler returned if tag is scaler, else longword vector
CALLED BY:
BFITS, FIX_OLD_ATT [1], FIX_OLD_ATT [2], GET_LATLON, GET_TAG_INDEX, HXTPIXON
HXT_ERROR, HXT_LCURVE, HXT_QLOOK, IDEPROJECT, MK_SOHO_MAP_EARTH, PIXSQUARE, PLOT_HSI
PLOT_HXT, RD_BDA [1], RD_BDA_DATA, REP_TAG_VALUE, diff_str [1], diff_str [2]
fitshead2struct, get_index_ver, goes2str, gt_dp_mode [1], gt_dp_mode [2], gt_hxa
gt_iru, gt_tagval [1], gt_tagval [2], gt_tfss, hxtpix, make_mirror, mreadfits_fixup
plot_ace, plot_eit_filters, plot_eit_mirror, plotman, pr_evn [2], read_eit, sav_bsc
soon_search_www, ssw_install [1], ssw_install [2], sswstruct_fill [1]
str_tagval [1], str_tagval [2], struct2fitshead, timeavg [1], timeavg [2]
trace_scale, write_trace, xspr [1], xspr [2], yoh_orb_interp [1]
yoh_orb_interp [2]
History: slf
modified, 21-feb-92 for to allow tag vector
[Previous]
[Next]
Project : SOHO - CDS
Name : TAI2OBT()
Purpose : Converts TAI to OBT/LOBT
Explanation : This procedure takes a double precision number containing the
Atomic International Time (TAI) in seconds from midnight, 1
January 1958, and converts it into the 6 byte (local) on-board
time from the spacecraft.
Use : Result = TAI2OBT( TAI )
Inputs : TAI = The time in TAI format as a double precision number or
array.
Opt. Inputs : None.
Outputs : The result of the function will be a byte array with the first
dimension having six elements.
Opt. Outputs: None.
Keywords : ERRMSG = If defined and passed, then any error messages
will be returned to the user in this parameter
rather than being 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 = ''
RESULT = TAI2OBT( TAI, ERRMSG=ERRMSG )
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], HOST_TO_IEEE [1], HOST_TO_IEEE [2]
HOST_TO_IEEE [3], HOST_TO_IEEE [4]
Common : None.
Restrictions: None.
Side effects: If an error is encountered and the ERRMSG keyword is set,
TAI2OBT returns a byte array of all zeros.
Category : Utilities, Time.
Prev. Hist. : None.
Written : William Thompson, GSFC, 6 July 1995
Modified : Version 1, William Thompson, GSFC, 6 July 1995
Version : Version 1, 6 July 1995
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TAI_HEAD()
PURPOSE:
Calculates the TAI-Time when the integration of a SUMER image started
CATEGORY:
RAW Processing
EXPLANATION:
SYNTAX:
Result = tai_head(header)
EXAMPLES:
INPUTS:
header
OPTIONAL INPUTS:
None.
OUTPUTS:
Tai Time in double presition Value
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
Calls OBT2TAI
SIDE EFFECTS:
None.
HISTORY:
Version 1, January 6, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (Dietmar Germerott@linmpi.mpg.de)
[Previous]
[Next]
Project : SOHO - CDS
Name : TAPRD
Purpose : Emulates VMS TAPRD procedure on UNIX machines.
Explanation : Emulates VMS TAPRD procedure on UNIX machines. However, the
actions of this routine may differ from the VMS equivalent in
nonstandard situations.
*** Unix only ***
Use : TAPRD, ARRAY, UNIT [, BYTE_REVERSE ]
Inputs : ARRAY = Variable into which the data should be read. The
datatype and number of values to attempt to read is
based on this array.
UNIT = Specifies the magnetic tape unit. Not to be confused
with logical unit numbers. In UNIX, the number
refers to one of the environment variables MT0, MT1,
etc., which translate into a physical device name,
e.g.
setenv MT0 /dev/nrst0
Opt. Inputs : BYTE_REVERSE = If present, then even and odd bytes are swapped.
Outputs : The output is read into ARRAY. Also, !ERR is set to the number
of bytes actually read.
Opt. Outputs: None.
Keywords : None.
Calls : ***
CHECK_TAPE_DRV [1], CHECK_TAPE_DRV [2]
CALLED BY:
FITSTAPE, RD_EXB, TCOPY, mt, vmscopytape
Common : None.
Restrictions: This routine may not have all the abilities of the VMS
equivalent, particularly in regards to the !ERR system
variable.
The environment variable "MTn", where n corresponds to the
variable UNIT, must be defined. E.g.,
setenv MT0 /dev/nrst0
Requires IDL v3.1 or later.
Side effects: The device file is opened.
Category : Utilities, I/O, Tape.
Prev. Hist. : William Thompson, GSFC, June 1991.
Written : William Thompson, GSFC, June 1991.
Modified : Version 1, William Thompson, GSFC, 21 December 1993.
Rewrote to use READU with TRANSFER_COUNT keyword.
Version 2, William Thompson, GSFC, 22 December 1993.
Added check of ARRAY variable.
Version : Version 2, 22 December 1993.
[Previous]
[Next]
Project : SOHO - CDS
Name : TAPWRT
Purpose : Emulates VMS TAPWRT procedure on UNIX machines.
Explanation : Emulates VMS TAPWRT procedure on UNIX machines.
*** Unix only ***
Use : TAPWRT, ARRAY, UNIT [, BYTE_REVERSE ]
Inputs : ARRAY = Variable into which the data should be read.
UNIT = Specifies the magnetic tape unit. Not to be confused
with logical unit numbers. In UNIX, the number
refers to one of the environment variables MT0, MT1,
etc., which translate into a physical device name,
e.g.
setenv MT0 /dev/nrst0
Opt. Inputs : BYTE_REVERSE = If present, then even and odd bytes are swapped.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : ***
CHECK_TAPE_DRV [1], CHECK_TAPE_DRV [2]
CALLED BY:
FITSTAPE, TCOPY, vmscopytape
Common : None.
Restrictions: The environment variable "MTn", where n corresponds to the
variable UNIT, must be defined. E.g.,
setenv MT0 /dev/nrst0
Requires IDL v3.1 or later.
Side effects: The device file is opened.
Category : Utilities, I/O, Tape.
Prev. Hist. : William Thompson, GSFC, June 1991.
Written : William Thompson, GSFC, June 1991.
Modified : Version 1, William Thompson, GSFC, 21 December 1993.
Rewrote to use WRITEU.
Version : Version 1, 21 December 1993.
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TARGET()
PURPOSE:
Return the Target Zone Number
CATEGORY:
EXPLANATION:
SYNTAX:
Result = target()
CALLED BY:
ar_prep, background, darklimb_correct, gbo_rot_t, rd_lonlat, rect_rot, rm_darklimb
rt_hdha, rt_mag, rt_nkr, set_back, wl_process
EXAMPLES:
INPUTS:
header - BYTARR(92) Image Header
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 7, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
Name: tbb_info
Purpose: team bb information
Calling Sequence:
tbb_info,'name',/address
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], MORE [1], MORE [2], concat_dir [4]
rd_tfile [1], rd_tfile [2], wc_where [1], wc_where [2]
History:
24-Feb-1994
[Previous]
[Next]
Name: tbeep
Purpose: beep terminal
Input Paramters:
nbeeps - number of beeps (defalut=1)
ibwait - inter-beep wait
Keyword Parameters:
waitn - inter-beep wait (can be positional too)
History - slf, 2-Sep-92 (couldnt rembember existing one)
CALLED BY:
ACOPY [1], CH_XMENU_SEL, COVER_PAGE [1], COVER_PAGE [2], DPE_GUESS
FIX_OLD_ATT [1], FIX_OLD_ATT [2], GET_SUNCENTER [1], GET_SUNCENTER [2], HXT_EFF
PICK_CAN_PRELIM, RD_HXT_DBOOK, ROT, STEPPER [3], STEPPER [4], SXT_PREP0, SXT_TE
SXT_TEEM [1], SXT_TEEM [2], SXT_TEEM1 [1], SXT_TEEM1 [2], SXT_TEEM1 [3]
SXT_TEEM2 [1], SXT_TEEM2 [2], SXT_TEEM2 [3], UNIX_CMD [1], UNIX_CMD [2]
WL_CUBE_II, XMENU_SEL [1], XMENU_SEL [2], azimuth_avg, cancel_dsn
check_compile [1], check_compile [2], check_log [1], check_log [2], collexc [1]
collexc [2], cont2time [1], cont2time [2], cube_edit, daily_forecast [2]
dark_sub [1], dark_sub [2], dark_sub [3], dbase2disk, delete_week [1]
delete_week [2], do_demo [1], do_demo [2], dont_use_this [1], dont_use_this [2]
dummy [10], dummy [11], dummy [12], dummy [13], dummy [14], dummy [1], dummy [2]
dummy [3], dummy [4], dummy [5], dummy [6], dummy [7], dummy [8], dummy [9]
eit_getobs, evt_demo, evt_grid, file_compress [1], file_compress [2]
file_uncompress [1], file_uncompress [2], first_bcs, first_over, fitstap2tap [1]
fitstap2tap [2], flares2disk, fort2hxi [1], fort2hxi [2], ftp_copy2sites
genx_newver [1], genx_newver [2], get_last_tfr, get_sfc_info, get_utevent [1]
get_utevent [2], goes_plot [1], goes_plot [2], goes_plot [3], goes_plot [4]
goes_plot [5], gt_day [1], gt_day [2], gt_expdur [1], gt_expdur [2], gt_time [1]
gt_time [2], gtt_info, hardcopy [1], hardcopy [2], hxt_survey, is_alive [1]
is_alive [2], jitter_gif_xyimg, lcur_image, mdi_display, mk_mdi_load, mk_pix [1]
mk_pix [2], mk_sdm, mk_sfc [1], mk_sfc [2], mk_trace_i0, mk_vcr, mk_week_file [1]
mk_week_file [2], mo_check, mo_init [1], mo_init [2], mo_patch, mo_prep, mod_res
nobeyama_update, ocontour [1], ocontour [2], ocontour [5], op_pass_sheets [1]
op_pass_sheets [2], op_same_time [1], op_same_time [2], op_times, pass_sheets
plot_eit_flux, pointing, pr_visible, pref_super, radial_avg, rd_atodat [1]
rd_atodat [2], rd_old_obs, rd_tr_seq_head, rd_trace_i0 [1], rd_ydbtap, res_freq
run_dsnfil, sector_avg, sel_dc_image [1], sel_dc_image [2], sel_dc_image [3]
set_printer [1], set_printer [2], set_printer [5], sft2sfc, show_contacts
show_pixf, sonyloop [1], sonyloop [2], soon_search [1], soon_search [3]
sxt_cen [1], sxt_cen [2], sxt_decon [1], sxt_decon [2], sxt_dn_unc, sxt_eff_area
sxt_etemp, sxt_flux [1], sxt_flux [2], sxt_flux [3], sxt_interp [1]
sxt_interp [2], sxt_mwave, sxt_prep [1], sxt_prep [2], sxt_prep [3], sxt_sumtime
sxt_sumxy, sxt_vignette, sxt_xsaa, tim2dbase, tim2pass, timeavg [1], timeavg [2]
timeline, topsdb [1], topsdb [2], tr_build_img [1], ut_time [1], ut_time [2]
video_menu, web_seq, where_change [1], where_change [2], where_pattern [1]
where_pattern [2], xcheckip, xdisp_fits, xdisp_sci5k, xdisp_tfr, xdisp_trace [1]
xdisp_trace2, xdisp_trace3, xhkplot, xread_hist, xsearch_obs, xset_chain [1]
xset_chain [2], xso_butevents [1], xso_butevents [2], xso_search, xspr [1]
xspr [2], xsw2tree, xsw2tree_event, xswlist [2], xsxt_prep, xsxt_prep_event
ydb_install [1], ydb_install [2], yoyo_man2, zcurs_ok
Restrictions:
if ibwait is less then .15, not all beeps are visible
[Previous]
[Next]
NAME:
teambb
PURPOSE:
Display items from the teambb
CALLS: ***
ADD, BAN, BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CDIR, CHECK_TREE, CLEAR
CLEAR_SCREEN [1], CLEAR_SCREEN [2], ET_TOPIC, ET_TOPIC_NOLIST, INTER_STIR
MORE [1], MORE [2], MORE_TBB, NEWS, OLD, PRINT_AST, QUIT_TEAM_BB, SCI, SCI_CL, SCI_EA
SCI_ET, SCI_EV, SCI_SU, SCI_TH, SCI_UW, SETLOG, SET_TREE, SPACE_RETURN, SU_NOLIST
TBB_HELP, break_file [4], rd_tfile [1], rd_tfile [2], scratch [1], scratch [2]
str_replace [1], str_replace [2], yesnox [1], yesnox [2]
Note: needs logical or environment variable DIR_GEN_TBB defined.
CALLING SEQUENCE:
teambb
teambb,'add' ; Access member addresses
teambb,'sci' ; Access the science menu
INPUTS:
command = The entry top level menu item
MODIFICATION HISTORY:
D.M. fecit, 9 December, 1993. Version A.0.3.
11-dec-93, J. R. Lemen, V A.0.4 Changed to a procedure;
write temporary files to user's home directory
13-dec-93, JRL, V A.0.5 Changed directory name strategy; Fixed some bugs
14-dec-93, DMZ, V A.0.6 Changed DIR_GEN_TBB to $DIR_GEN_TBB
10-feb-94, JRL, V A.0.7 Deleted the trailing '\' in inter_stir. Save the
entry directory to return there on exiting.
Renamed "more" procedure to more_tbb.
Renamed file_list variables to file_list_t
17-feb-94, JRL, V A.0.8 Call clear_screen if VMS
13-oct-94, NN, V A.0.81 Add 'mi' in the author search
13-feb-95, JRL, V A.0.9 Added access to completed items. Changed code
to use break_file so that items are correctly
listed on an VMS system
28-apr-95, SLF, Add SCI_EV procedure
[Previous]
[Next]
Project : SOHO - CDS
Name : TEK
Purpose : Sets graphics device to Tektronix 4010 mode.
Explanation : SETPLOT is called to save and set the system variables.
Use : TEK
Inputs : None.
Opt. Inputs : None.
Outputs : A message is printed to the screen.
Opt. Outputs: None.
Keywords : None.
Calls : ***
SETPLOT [1], SETPLOT [2]
Common : None. But calls SETPLOT, which uses common block PLOTFILE.
Restrictions: It is best if the routines TEK, REGIS, etc. (i.e. those
routines that use SETPLOT) are used to change the plotting
device.
In general, the SERTS graphics devices routines use the special
system variables !BCOLOR and !ASPECT. These system variables
are defined in the procedure DEVICELIB. It is suggested that
the command DEVICELIB be placed in the user's IDL_STARTUP file.
Side effects: If not the first time this routine is called, then system
variables that affect plotting are reset to previous values.
Category : Utilities, Devices.
Prev. Hist. : W.T.T., Nov. 1987.
Written : William Thompson, GSFC, November 1987.
Modified : Version 1, William Thompson, 27 April 1993.
Renamed to TEK, and incorporated into CDS library.
Version : Version 1, 27 April 1993.
[Previous]
[Next]
Project : SOHO - CDS
Name : TEK4105
Purpose : Sets the graphics device for Tektronix 4105 terminals.
Explanation : SETPLOT is called to save and set the system variables. Then
DEVICE is called to enable TEK4100 mode with 8 colors.
Use : TEK4105
Inputs : None.
Opt. Inputs : None.
Outputs : A message is printed to the screen.
Opt. Outputs: None.
Keywords : None.
Calls : ***
SETPLOT [1], SETPLOT [2]
Common : None. But calls SETPLOT, which uses common block PLOTFILE.
Restrictions: It is best if the routines TEK, REGIS, etc. (i.e. those
routines that use SETPLOT) are used to change the plotting
device.
In general, the SERTS graphics devices routines use the special
system variables !BCOLOR and !ASPECT. These system variables
are defined in the procedure DEVICELIB. It is suggested that
the command DEVICELIB be placed in the user's IDL_STARTUP file.
Side effects: If not the first time this routine is called, then system
variables that affect plotting are reset to previous values.
Category : Utilities, Devices.
Prev. Hist. : W.T.T., Nov. 1987.
W.T.T., Mar. 1991, split TEK into TEK4105 and TEK4211.
Written : William Thompson, GSFC, November 1987.
Modified : Version 1, William Thompson, GSFC, 27 April 1993.
Incorporated into CDS library.
Version : Version 1, 27 April 1993.
[Previous]
[Next]
Project : SOHO - CDS
Name : TEK4211
Purpose : Sets graphics device for Tektronix 4211 color terminal.
Explanation : SETPLOT is called to save and set the system variables. Then
DEVICE is called to enable TEK4100 mode with 64 colors.
Use : TEK4211
Inputs : None.
Opt. Inputs : None.
Outputs : A message is printed to the screen.
Opt. Outputs: None.
Keywords : None.
Calls : ***
SETPLOT [1], SETPLOT [2]
Common : None. But calls SETPLOT, which uses common block PLOTFILE.
Restrictions: It is best if the routines TEK, REGIS, etc. (i.e. those
routines that use SETPLOT) are used to change the plotting
device.
In general, the SERTS graphics devices routines use the special
system variables !BCOLOR and !ASPECT. These system variables
are defined in the procedure DEVICELIB. It is suggested that
the command DEVICELIB be placed in the user's IDL_STARTUP file.
Side effects: If not the first time this routine is called, then system
variables that affect plotting are reset to previous values.
Category : Utilities, Device.
Prev. Hist. : W.T.T., Nov. 1987.
W.T.T., Mar. 1991, split TEK into TEK4105 and TEK4211.
Written : William Thompson, GSFC, November 1987.
Modified : Version 1, William Thompson, GSFC, 27 April 1993.
Incorporated into CDS library.
Version : Version 1, 27 April 1993.
[Previous]
[Next]
Project : SOHO - CDS
Name : TEKMONO
Purpose : Sets graphics device for Tek 4100+ terminals, mono mode.
Explanation : SETPLOT is called to save and set the system variables. Then
DEVICE is called to enable TEK4100 mode with 2 colors (black
and white).
Use : TEKMONO
Inputs : None.
Opt. Inputs : None.
Outputs : A message is printed to the screen.
Opt. Outputs: None.
Keywords : None.
Calls : ***
SETPLOT [1], SETPLOT [2]
Common : None. But calls SETPLOT, which uses common block PLOTFILE.
Restrictions: It is best if the routines TEK, REGIS, etc. (i.e. those
routines that use SETPLOT) are used to change the plotting
device.
In general, the SERTS graphics devices routines use the special
system variables !BCOLOR and !ASPECT. These system variables
are defined in the procedure DEVICELIB. It is suggested that
the command DEVICELIB be placed in the user's IDL_STARTUP file.
Side effects: If not the first time this routine is called, then system
variables that affect plotting are reset to previous values.
Category : Utilities, Devices.
Prev. Hist. : W.T.T., Nov. 1987.
W.T.T., Mar. 1991, split TEK into TEKMONO and TEK4211.
Written : William Thompson, GSFC, November 1987.
Modified : Version 1, William Thompson, GSFC, 27 April 1993.
Incorporated into CDS library.
Version : Version 1, 27 April 1993.
[Previous]
[Next]
NAME:
TELESCOPE_POINTING
PURPOSE:
This function returns the telescope pointing information for SUNDIST.
CATEGORY:
LASCO DATA_ANAL
CALLING SEQUENCE:
Result = TELESCOPE_POINTING (Hdr)
INPUTS:
Hdr: The image header as a LASCO header structure.
OUTPUTS:
This function returns a 4 element floating point array of the
telescope pointing information:
word 1: column coordinates of the center of the sun
word 2: row coordinates of the center of the sun
word 3: roll angle to solar north, in degrees, measured westward
word 4: size of the solar radius in pixels
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], FXPAR [1], FXPAR [2], GET_SEC_PIXEL
GET_SOLAR_RADIUS, GET_SOLAR_ROLL, GET_SUN_CENTER [1], GET_SUN_CENTER [2]
GET_SUN_CENTER [3], LASCO_FITSHDR2STRUCT, MLO_FITSHDR2STRUCT
CALLED BY:
CALC_CME_MASS
SIDE EFFECTS:
Calls GET_SUN_CENTER, GET_SEC_PIXEL, GET_SOLAR_RADIUS, GET_SOLAR_ROLL
PROCEDURE:
The SUNDIST procedure needs the pointing information to be supplied
in an array.
EXAMPLE:
Return the pointing information for the image pointed to by header.
Coords = TELESCOPE_POINTING(Hdr)
MODIFICATION HISTORY:
Written by: RA Howard, 30 Apr 1997
Mods to accept MLO headers
@(#)telescope_pointing.pro 1.3 08/28/98 LASCO IDL LIBRARY
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
TEXT_ANOMALY()
PURPOSE:
Convert the contents of an anomaly structure into an ascii array
CATEGORY:
SOHO Anomaly report
SYNTAX:
Result = text_anomaly(anomaly)
INPUTS:
ANOMALY - Anomaly structure
OPTIONAL INPUTS:
None.
OUTPUTS:
RESULT - String array, containing contents of an anomaly
report entry
OPTIONAL OUTPUTS:
None.
KEYWORDS:
ALL - Set this keyword to get all tags even when their
values are empty
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DATATYPE [1], DATATYPE [2], DATATYPE [3]
STR2LINES
CALLED BY:
XREPORT, XREPORT_EDIT
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, January 25, 1996, Liyun Wang, GSFC/ARC. Written
CONTACT:
Liyun Wang, GSFC/ARC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
NAME:
TEXTARRAY
PURPOSE:
To create a two dimensional array containing
text in vector font.
CATEGORY:
PICO
CALLING SEQUENCE:
result=TEXTARRAY(text)
INPUTS:
text: A string containing the text
OPTIONAL INPUTS:
None
KEYWORD PARAMETERS:
CHARSIZE, CHARTHICK: Normal signification
as for other graphical output
COLOR: The color index to be used.
Default: 255
OUTPUTS:
result: a two dimensional array. The background
is 0 whereas the text is written in
the specified color. The textarray
can be inserted in an image using
PUT_TEXT.
OPTIONAL OUTPUTS:
None
CALLED BY:
LAYOUT
COMMON BLOCKS:
None
SIDE EFFECTS:
Unknown
RESTRICTIONS:
None
PROCEDURE:
Straightforward
MODIFICATION HISTORY:
V1.0 Alexander Epple, Pic Du Midi, 15-OCT-1995
Jun-2000, B. Podlipnik - Add BOLD, XP, YP keywords
[Previous]
[Next]
Project : SOHO - CDS
Name :
TEXTCLOSE
Purpose :
Closes file specified by !TEXTOUT. Used by ASTRON routines.
Explanation :
Procedure to close file for text output as specifed
by the (non-standard) system variable !TEXTOUT.
Use :
textclose, [ TEXTOUT = ]
Inputs : None.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords :
textout - Indicates output device that was used by
TEXTOPEN
Calls : None.
CALLED BY:
DBCOMPARE [1], DBCOMPARE [2], DBHELP [1], DBHELP [2], DBHELP [3], DBPRINT [1]
DBPRINT [2], DBPRINT [3], FITSDIR, FITS_INFO [1], FITS_INFO [2], FORPRINT, FTAB_HELP
FTHELP, FTPRINT, IMLIST, IRAFDIR, PCA, TABLE_HELP, TABLE_LIST, TABLE_PRINT [1]
TAB_PRINT, TBHELP, TBPRINT, UVBYBETA, table_print [2]
Common : None.
Restrictions: None.
Side effects:
if !textout is not equal to 5 and the textunit is
opened. Then unit !textunit is closed and released
Category : Utilities, User_interface
Prev. Hist. :
D. Lindler Dec. 1986 (Replaces PRTOPEN)
Test if TEXTOUT is a scalar string W. Landsman August 1993
Written : D. Lindler, GSFC/HRS, December 1986
Modified : Version 1, William Thompson, GSFC, 30 March 1994
Incorporated into CDS library
Version : Version 1, 30 March 1994
[Previous]
[Next]
Project : SOHO - CDS
Name :
TEXTOPEN
Purpose :
Opens file for text output.
Explanation :
Procedure to open file for text output. The type of output
device (disk file or terminal screen) is specified by the
TEXTOUT keyword or the (nonstandard) system variable !TEXTOUT.
Use :
textopen, program, [ TEXTOUT = ]
Inputs :
program - scalar string giving name of program calling textopen
Opt. Inputs : None.
Outputs :
The following dev/file is opened for output.
textout=0 Nowhere
textout=1 TERMINAL using /more option
textout=2 TERMINAL without /more option
textout=3 <program>.prt
textout=4 laser.tmp
textout=5 user must open file
textout = filename (default extension of .prt)
The unit it is opened to is obtained with the procedure GET_LUN
unless !TEXTOUT=5. The unit number is placed in system variable
!TEXTUNIT. For !TEXTOUT=5 the user must set !TEXTUNIT to the
appropriate unit number.
Opt. Outputs: None.
Keywords :
TEXTOUT - Integer scalar (0-6) specifying output file/device to be
opened (see below) or scalar string giving name of output file.
If TEXTOUT is not supplied, then the (non-standard) system
variable !TEXTOUT is used.
Calls : ***
FILEPATH
CALLED BY:
DBCOMPARE [1], DBCOMPARE [2], DBHELP [1], DBHELP [2], DBHELP [3], DBPRINT [1]
DBPRINT [2], DBPRINT [3], FITSDIR, FITS_INFO [1], FITS_INFO [2], FORPRINT, FTAB_HELP
FTHELP, FTPRINT, IMLIST, IRAFDIR, PCA, TABLE_HELP, TABLE_LIST, TAB_PRINT, TBHELP, TBPRINT
UVBYBETA
Common : None.
Restrictions:
Uses the following non-standard system variables:
DEFSYSV,'!TEXTOUT',1
DEFSYSV,'!TEXTUNIT',0
Side effects:
Note that TEXTOUT = 1 or TEXTOUT = 2 will open a unit to the terminal,
SYS$OUTPUT (VMS) or /dev/tty (Unix). However, this terminal
output will *not* appear in an IDL JOURNAL session, unlike text
printed with the PRINT command.
Category : Utilities, User_interface.
Prev. Hist. :
D. Lindler Dec. 1986
Keyword textout added, J. Isensee, July, 1990
Made transportable, D. Neill, April, 1991
Trim input PROGRAM string W. Landsman Feb 1993
Don't modify TEXTOUT value W. Landsman Aug 1993
Written : D. Lindler, GSFC/HRS, December 1986
Modified : Version 1, William Thompson, GSFC, 30 March 1994
Incorporated into CDS library
Version : Version 1, 30 March 1994
[Previous]
[Next]
NAME:
tfr_decom
PURPOSE:
To decompress a single telemetry frame
SAMPLE CALLING SEQUENCE:
decom_rec = tfr_decom(rec)
COMMENTS:
idl_speed & read_mdi,'/md54/mdisw_idl_guide/940422_035054',1,img,h & idl_speed,1
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], concat_dir [4], get_host [1]
get_host [2]
CALLED BY:
mdifocus2, rdtfr, tfr_summary, tfr_summary2
HISTORY:
Written Apr-94 by M.Morrison & R.Chevalier
31-Mar-95 (MDM) - Added a new option to use CALL_EXTERNAL
for MDI SGI machines. The old method is
still available which uses a pipe with STDIO
which is much slower
3-Apr-95 (MDM) - Added umbra to the machines that can use
CALL_EXTERNAL
6-Apr-95 (MDM) - Expanded to work with Ultrix machines
19-Jun-95 (MDM) - Removed using CALL_EXTERNAL for mdisas
- Added ON_IOERROR logic to trap on problems
28-Feb-96 (MDM) - Removed using CALL_EXTERNAL for umbra (now nobody
uses it)
3-Sep-96 (MDM) - Added protection againgst TFR_DECOM crashing
and causing IDL to exit.
[Previous]
[Next]
NAME:
tfr_summary
SAMPLE CALLING SEQUENCE:
tfr_summary, file_list('/md66/log/sci160k','950329_000458*.tfr', /bydate)
tfr_summary, file_list('/md66/log/sci160k','*.tfr', /bydate)
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], FILE_EXIST [2], anytim2ints [1]
anytim2ints [2], break_file [4], data_type [1], data_type [2], dec2sun [1]
dec2sun [2], file_exist [1], file_exist [3], fmt_tim [1], fmt_tim [2], list_tfi
read_mdi, tfr_decom
HISTORY:
Written 3-Apr-95 by M.Morrison
[Previous]
[Next]
NAME:
tfr_summary2
PURPOSE:
To display information on a per-image basis for a tfr file.
SAMPLE CALLING SEQUENCE:
tfr_summary2, file_list('/md65/log/sci160k','950921_222120*.tfr')
tfr_summary2, file_list('/md65/log/sci160k','95092*.tfr', /bydate)
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], FILE_EXIST [2], STDEV
anytim2ints [1], anytim2ints [2], break_file [4], data_type [1], data_type [2]
dec2sun [1], dec2sun [2], file_exist [1], file_exist [3], fmt_tim [1], fmt_tim [2]
list_tfi, read_mdi, tfr_decom
HISTORY:
Written 25-Sep-95 by M.Morrison
[Previous]
[Next]
Project : SOHO - CDS
Name : three_moment
Purpose : calculate 3-moment of line profile
Explanation : 3-moment calculated using simpson intergration
Use : IDL> three_moment, x-array, y-array, dispersion,
max. intensity, line shift, line width
Inputs : x-array, y-array, dispersion
Opt. Inputs : None
Outputs : intensity, shift, width
Opt. Outputs: None
Keywords : None
Calls : ***
simpson_a
CALLED BY:
hrts_w [1], hrts_w [2]
Common : None
Restrictions: None
Side effects: None
Category : ?
Prev. Hist. : ?
Written : Olav Kjeldseth-Moe, ITA, UiO
Modified : Version 1 Nils Brynildsen, ITA, UiO, 1-July-1993
Version : Version 1 1-July-1993
[Previous]
[Next]
NAME:
CALLS:
[Previous]
[Next]
Project : SOHO - CDS
Name : TILT_NIS1_DEMO
Purpose : Demonstrate variation of NIS1 spectral line tilt.
Explanation : The spectral lines in NIS1 are tilted with respect to the
dispersion direction. This tilt is a function of wavelength
(or equivalently spectral bin) as shown in this plot.
Note that the sign convention is such that spectral lines at
the bottom (south) of the slit are moved to larger bin numbers.
Use : IDL> tilt_nis1_demo
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
CDS_PLOT_ERR, CIRCLE_SYM, FIND_WITH_DEF [1], FIND_WITH_DEF [2]
FIND_WITH_DEF [3], LINECOLOR, OPLOT_ERR, POLYFITW, POLY_FIT
Common : None
Restrictions: None
Side effects: None
Category : Calibration
Prev. Hist. : None
Written : C D Pike, RAL, 12-Nov-96
Modified : Version 2, 2-Jul-1998, William Thompson, GSFC
Brought up-to-date with latest data
Version : Version 2, 2-Jul-1998
[Previous]
[Next]
Project : SOHO - CDS
Name : TILT_NIS2_DEMO
Purpose : Demonstrate variation of NIS2 spectral line tilt.
Explanation : The spectral lines in NIS2 are tilted with respect to the
dispersion direction. This tilt is a function of wavelength
(or equivalently spectral bin) as shown in this plot. Note
that the convention is that the spectral line at the bottom
(south) of the slit is shifted towards larger bin numbers.
Note also that the data are fitted with a quadratic mainly
because the values at bins ~990 are well defined from other
observations and would be inconsistent with a linear fit
through the data.
Use : IDL> tilt_nis2_demo
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
CDS_PLOT_ERR, CIRCLE_SYM, FIND_WITH_DEF [1], FIND_WITH_DEF [2]
FIND_WITH_DEF [3], LINECOLOR, OPLOT_ERR, POLYFITW, POLY_FIT
Common : None
Restrictions: None
Side effects: None
Category : Calibration
Prev. Hist. : None
Written : C D Pike, RAL, 12-Nov-96
Modified : Version 2, 2-Jul-1998, William Thompson, GSFC
Brought up-to-date with latest data
Version : Version 2, 2-Jul-1998
[Previous]
[Next]
NAME:
tim2dset
PURPOSE:
Given a structure (roadmap or index), find the dataset with
the time closest to an input time.
CALLING SEQUENCE:
xx = tim2dset(roadmap, tarr)
xx = tim2dset(roadmap, '12:33 5-Nov-91',delta_sec=delta_sec)
print, tim2set(roadmap)
INPUT:
struct - The roadmap or index structure to search
tim_in - The reference time to search the dataset for.
Form can be (1) structure with a .time and .day
field, (2) the standard 7-element external representation
or (3) a string of the format "hh:mm dd-mmm-yy"
- If no input is passed, the user is prompted for the
time to use
OPTIONAL OUTPUT KEWORDS:
delta_sec - Absolute value of the time difference in secs.
offset - The time difference in seconds
CALLS: ***
Int2Ex [1], Int2Ex [2], anytim2ints [1], anytim2ints [2], gt_day [1], gt_day [2]
gt_time [1], gt_time [2], input [1], input [2], int2secarr [1], int2secarr [2]
CALLED BY:
ACRIM_READER, ALIGN_AR, ANAL_STIMS, CHECK_SFC_PNT, ECL_FRAC, GET_SUNCENTER [1]
GET_SUNCENTER [2], GET_TRANGE, Goes_bck0, HELIO_FOOT, HXA2HEL, HXA_SUNC, HXA_SUNC2
HXA_SUNCENTER, HXTPIXON, HXT_QLOOK, IRUHXASCAN2SXT [1], IRUHXASCAN2SXT [2]
PFI_CENT, PR_PATROLS, QUICKDARK [2], QUICKLIMB [1], QUICKLIMB [2], RD_AR, SFD_PHOT
TERM_FIDS, TERM_QUICK, TERM_REVIEW, TERM_REVIEW_GIF, TIM2UPOS, TRACE_SSWHERE [1]
WBS_DB, WBS_DB2, XMOVIE_SFM, ada2str, ads_into_att, ads_into_pnt
check_oldprocess [1], check_oldprocess [2], check_oldprocess [3]
check_oldprocess [4], choose_pairs, disp_sci5k, eit_files, get_ads [1], get_atr
get_att, get_gevloc_data, get_mk3 [1], get_mk3 [2], get_pnt, get_sfm
get_solar_indices, get_suncenter2, get_sxa, go_lasdisk golaserdisk
go_lasdisk2 golaserdisk, go_nvs5, goes_log, grid_data [1], grid_data [2]
hkplot_info, hxtaccumulate, iperr_sea, kluge_att, lapalma_files, lastsfd [1]
lastsfd [2], les_archive_info, match_index [1], match_index [2], mdi_files
mk_coal_movie, mk_obs_str, mk_pnt, mk_sd2, mk_sdc [2], mk_sdc [3], mk_sdc [4], mk_sdm
mk_sfc [1], mk_sfc [2], mk_sff_pair [1], mk_sff_pair [2], mk_ssc [1], mk_ssc [2]
new_disp_sci5k [1], new_disp_sci5k [2], op_term_score, pfi_loc, plot_fov [1]
rd_sxtgoes, rd_xda_same, read_genxcat, ref_term [2], reget_dc_image, sft2sfc
show_contacts, ssc_files [1], ssc_files [2], ssc_files [3], ssc_scan2
ssw_build_trace, ssw_fov_context, ssw_fs_cat2db, ssw_timestat, ssw_track_fov
sswdb_files, sxi_files, sxl2radiance, sxl_select, sxt_adjacent_image, sxt_chk_era
sxt_his2dbase, sxt_mornint, sxt_patch_att, sxt_prep [1], sxt_prep [2]
sxt_prep [3], tim2orbit [1], tim2orbit [2], tim2tfss, trace_files, trace_isorbevt
trace_orbevt, trace_sswhere [2], trace_sswhere [3], trace_sswhere [4]
wrt_fits_bin_exten [2], xspr [1], xspr [2], yohkoh_legacy_files [1]
yohkoh_legacy_files [2]
HISTORY:
Written Oct-91 by M.Morrison
20-apr-92, J.R. Lemen, Speeded up the alogorithm.
2-May-92 (MDM) Removed call to make_str - hardwired
the structure name
20-may-92, JRL, Added the delta_sec keyword
9-Jun-92, MDM, Removed code and used ANYTIM2INTS
27-Jul-92, MDM, Return a scalar if there is only one element
9-Mar-93, MDM, Made the FOR loop an integer*4 value
20-Jul-93, MDM, Added OFFSET option
11-Jan-94, MDM, Updated document header
[Previous]
[Next]
Name:
tim2file
Purpose:
Given a time (or array of times) return the file that
the data should be in.
Input:
tim_in - Can be a structure with the .TIME and .DAY
fields
(OR)
The "standard" 7 element external representation
of time (HH,MM,SS,MSEC,DD,MM,YY)
Optional Input:
keyfile - The file prefix to use for the directory search
If not present, it uses ADA.
dirs - An array of the directories to search. If not
present, it calls "DATA_PATH".
The path does NOT include a trailing '/'
qstop - Stop at the bottom of the program for debuggin
purposes.
Output:
Returns the whole data path to the file in question
dir_out - An array of the directory path. The path
DOES include a trailing '/'
fileid - An array of only the fileIDs
Method:
Perform a directory listing (with FINDFILE) on all of
the directories, sort, and find where the input time
falls.
TODO - Later?
What it should do is look at the observing log and
get a list of FileIDs
day_str - Optional) just the date part of the string
time_str - (Optional) just the time part of the string
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], DATA_PATHS, Int2Ex [1], Int2Ex [2]
break_file [4]
CALLED BY:
chk_flares [1], chk_flares [2]
History:
19-Oct-91 by M.Morrison
[Previous]
[Next]
Name: tim2intstr
Purpose: convert ext/int to standard yohkoh structure
{xx,Time:0l,Day:0}
Input Parameters:
time0 - external time if one parameter, msod if two parameters
time1 - days since 1/1/79
CALLS: ***
Ex2Int [1], Ex2Int [2], MAKE_STR [1], MAKE_STR [2]
History: slf, 17-Apr-1992
[Previous]
[Next]
NAME:
TIM2JD
PURPOSE:
Compute Julian day number from item.
CATEGORY:
CALLING SEQUENCE:
jd = tim2jd(item)
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
jd = Julian Day number (like 2447000). out
CALLS: ***
anytim2ex [1], anytim2ex [2], anytim2ints [1], anytim2ints [2], gt_time [1]
gt_time [2]
CALLED BY:
GET_SUN [1], GET_SUN [2], JD2EX, get_zenang
COMMON BLOCKS:
NOTES:
MODIFICATION HISTORY:
R. Sterner, 23 June, 1985 --- converted from FORTRAN.
Johns Hopkins University Applied Physics Laboratory.
RES 18 Sep, 1989 --- converted to SUN
Copyright (C) 1985, 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:
tim2match
PURPOSE:
Give an array of reference times, determine if the input times fall
within any of the time ranges
SAMPLE CALLING SEQUENCE:
out = tim2match(evn, gev) ;uses GOES start
out = tim2match(evn, gev, /entim_dur) ;uses GOES time span
out = tim2match(evn, gev, /peak) ;uses GOES peak time
ii = where(tim2match(sttim, gev, entim_ref=entim) gt 0) ;subscript of GEV where match
INPUT:
sttim_ref -
sttim_ref/entim_ref: ...........xxxxxxxxxxxxx...........
sttim_input: ......x............................ 0000 = 0
..................x................ 0001 = 1
sttim_input/entim_input:...xxx............................. 0000 = 0
................xxxx............... 0011 = 3
...............xxxxxxxxxxxxxxx..... 0001 = 1
......xxxxxxxxxxxxx................ 0010 = 2
......xxxxxxxxxxxxxxxxxxxxxxxx..... 0100 = 4
Special cases:
CALLS:
CALLED BY
gtt_orbit, obs_summary, soon_search [1], soon_search [3]
[Previous]
[Next]
NAME:
tim2orbit
PURPOSE:
Given a time, find the orbit for which that time falls within.
CALLING SEQUENCE:
tim2orbit, roadmap, fid=fid
tim2orbit, roadmap, wid=wid
tim2orbit, '1-apr-92 2:22', fid=fid, wid=wid, tim2fms=tim2fms, orbit=orbit
tim2orbit, index, fem=fem
INPUT:
tim_in - The reference time to search the orbit for.
Form can be (1) structure with a .time and .day
field, (2) the standard 7-element external representation
or (3) a string of the format "hh:mm dd-mmm-yy"
CALLS: ***
CHECK_TIME, anytim2ints [1], anytim2ints [2], fmt_tim [1], fmt_tim [2]
gt_time [1], gt_time [2], int2secarr [1], int2secarr [2], rd_fem, tim2dset [1]
tim2dset [2]
CALLED BY:
BCS_CAT, GET_SUBARR2, GET_TRACUBE, HXAXY2SXT, HXT_AUTOIMG, MK_SSX, SXT2HXAXY
ads_into_att, ads_into_pnt, adsdirs [1], adsdirs [2], atr2hxa_dbase, att_exst
chk_pointing, daily_forecast [2], dark_orbit, delete_week [1], delete_week [2]
find_dbo_dir, gen_file_id [1], gen_file_id [2], get_afile_size [1]
get_afile_size [2], get_atr, get_att, get_info [3], get_pnt, get_sfc_info
get_suncenter2, get_sxa, getwid, lastsfd [1], lastsfd [2], mk_att [1], mk_att [2]
mk_orbit [1], mk_orbit [2], mk_pnt, mk_sdmi, mk_sdp, mk_sfc [1], mk_sfc [2]
mk_sfd [1], mk_sfd [2], mk_sfd [3], mk_sfd [4], mk_sff_pair [1], mk_sff_pair [2]
mk_sfs, mk_sft [1], mk_sft [2], mk_sfw, mk_sl [1], mk_sl [2], mk_sot, mk_spd
mk_week_file [1], mk_week_file [2], mo_check, op_term_score, op_terminator [1]
op_terminator [2], pnt_exst, pr_evn [2], pr_sxt_term, rd_week_file [2], saa_in [1]
saa_in [2], sxt_clean [1], sxt_clean [2], sxt_uvf_info [1], sxt_uvf_info [3]
term_obs, tim2tfss, trace_goodobs, weekid [2], wl_process, ydb_exist [1]
ydb_exist [2], ydb_exist [3], ydb_exist [4], yoyo_man2
OPTIONAL KEYWORD INPUT:
print - If set, print out a summary of the conditions to the screen
simple - If set, just calculate the "tim2fms" and "tim2night"
nowid - If set, calculate everything except the WID (takes a while)
KEYWORD OUTPUT:
fid - a string array with the file ID for the input times
wid - a string array with the week ID for the input times
tim2fms - a floating point array with the number of minutes from
the first minute of sun (FMS) that the dataset exists for
tim2night- a floating point array with the number of minutes before
S/C night starts
orbit - an integer array with the orbit number (approximately the
revolution number)
scday - a boolean array set true if the input time happens during
S/C day
saa - a boolean array set true if the input time happens in the
middle of a SAA passage.
fem - The FEM structures for the time range covered by the input
times (It is NOT the full FEM structure for the orbit for
EACH INPUT TIME as it was originally)
HISTORY:
Written 25-May-92 by M.Morrison
30-May-92 (MDM) - Added "scday" and "saa"
8-Jun-92 (MDM) - Added "print" option
9-Jun-92 (MDM) - Added "tim2night" option
17-Jul-92 (MDM) - Corrected an error in weekID generation
(string formats)
19-Aug-92 (MDM) - Fixed a problem with WeekID generation. IDL trunactes
at 256 (or 128) lines when using command "string(array)"
15-Sep-92 (MDM) - Fixed problem with WeekID generation. Since the user
might only specify HH:MM, and the FEM resolution is
better than 1 second, the WeekID (and FileID for that
matter) might be off. The fix is to add 59 seconds to
the input time when the seconds/milliseconds is zero.
(User could ask for 1-SEP-91 03:03 (FID 910901.0303) and
it would give FID 910901.0126 because the true orbit
start time is 03:03:45). The 59 seconds is only added
if ALL input times have seconds and milliseconds = 0.
23-Feb-93 (MDM) - Added case where the information of the SAA time is in
the prior orbit record. For example:
SSSSSSSS
NNNNNNNDDDDDDDD
^ - time of interest
9-Apr-93 (MDM) - Changed call to RD_FEM to use /FULL_WEEKS
29-Apr-93 (MDM) - Modification to handle bad input times
24-May-93 (MDM) - Modified to make the for loop variable integer*4
20-Jun-93 (MDM) - Changed the definition of the FEM output. It used to be
a FEM structure for each input time, now it is only a
single FEM structure for each orbit for the range of
input times.
20-Jul-93 (MDM) - Changed logic considerably (removed for loops)
which sped things up
- Added /SIMPLE and /NOWID options
18-Feb-94 (MDM) - Corrected header information
[Previous]
[Next]
Name:
TIME_CORRECTION
Purpose:
To return the OBE - LOBT time difference that is equal to or right before the
the input obe-time from the values in TIME_DIFFERENCE_DB.
Input Parameters:
OBE_TIME - An input obe_time for which the time offset is to be obtained.
Output:
DELTA_ERROR - A two element string array.
RETURN VALUE:
DT - A two element long array containing the time offset as
delta_mjd and delta_ms.
Keywords:
CORRECTION_STRING - Used to return an ASCII string with the
time difference.
VERBOSE - If set, print out time selection info.
Calling Sequence:
dt = TIME_CORRECTION(obe_time, delta_error, CORRECTION_STRING = CORRECTION_STRING, /VERBOSE)
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CONVERT_TIME, FILEPATH, MODIFIED_BINARY_SEARCH
TAI2UTC, UTC2STR, UTC2TAI, WORD_SWAP
Restrictions:
If large jumps in the difference occur between realtime contacts, this
routine could return inaccurate values.
History:
1997 April 17 - D.M. fecit.
1997 August 27 - Added CORRECTION_STRING keyword D.M. fecit.
1999 Feb 7 - Added binary search and indexing to speed finding
the right record, created unix version for Solaris - DW
2002 Jul 10 - Added DELTA_ERROR parameter - Ed Esfandiari
2002 Jul 10 - Also added a true binary search - Ed Esfandiari
2003 Mar 11 - Add REDUCE_HISTORY common block;
change datafile calls; delta_error=N/A for c2_offsets - NRich
2004 Sep 15 - Change OS_version check to 'endian-ness' check, since
not all unix platforns are necessarily big-endian - GR Lawrence
@(#)time_correction.pro 1.4, 10/03/05 NRL IDL LIBRARY
[Previous]
[Next]
NAME:
time_vec
PURPOSE:
Given a time vector (in the form of "days since
1979" and "millisec of day" and a rate, and a
number of repeats within a major frame, return
a single time vector (in units of minutes from
the first time)
It is used to plot parameters where there is
more than value in a major frame (since there
is only one time returned for each major frame)
INPUT:
time - millisec of day
day - days since 1979
rate - DP telemetry rate
nrep_mf - Number of repeats for this entry
per major frame
OUTPUT:
Returns - Number of minuts since first entry
CALLS:
[Previous]
[Next]
Name: timeavg
Purpose: sum & average data values,
Input Parameters:
intimes - input (assume yohkoh data structure)
tag - string tag name or integer (tag index), scaler or array
Output:
function returns structure with standard Yohkoh structure format
Optional Keyword:
bin - (in) bin width in seconds (integration time)
center - (in) switch, if set, time is bin center (default)
start - (in) switch, if set, time is bin start
alltags - (in) switch, if set, average all vector tags
nsamp - (out) lonarr, number of valid samples per summed time
Calling Sequence:
outstr=timeavg(instr [,tagarray, bin=bin, /alltags, nsamp=nsamp] )
Calling Examples:
rd_gxd, t0, t1, goesdata ; read 3 second goes data
onemin=timeavg(goesdata) ; 1min avgs,all 1D tags (default)
fivemin=timeavg(goesdata,'lo',bin=300.) ; 5min avgs,lo channel only
(illustration for goes 3 second data averaging)
IDL> help,goesdata,onemin,fivemin
GOESDATA STRUCT = -> GXD_DATA_REC Array(1176)
ONEMIN STRUCT = -> MS_159127700002 Array(59)
FIVEMIN STRUCT = -> MS_159127700002 Array(13)
IDL> help,onemin,fivemin,/str
** Structure MS_159127700002, 4 tags, length=16:
TIME LONG 50402212
DAY INT 5146
LO FLOAT 1.57314e-06
HI FLOAT 5.15764e-08
** Structure MS_159138295005, 3 tags, length=12:
TIME LONG 50402212
DAY INT 5146
LO FLOAT 1.55500e-06
CALLED BY:
mk_week_file [1], mk_week_file [2]
History:
10-Jan-1995 (SLF) dusted off / revamped avg_data.pro
13-Jan-1995 (SLF) fix problem with tag subset
2-sep-1995 (SLF) protect against outgrid has 1 elements
CALLS: ***
ARR2STR [1], Arr2Str [2], MAKE_STR [1], MAKE_STR [2], data_chk [1], data_chk [2]
deriv_arr [1], deriv_arr [2], int2secarr [1], int2secarr [2], rem_elem [1]
rem_elem [2], tag_index [1], tag_index [2], tbeep [1], tbeep [2], tbeep [3]
timegrid
Restrictions:
maybe good to 1 second or so, maybe plus or minus I think.
[Previous]
[Next]
NAME:
timstr2ex
PURPOSE:
Subroutine to convert a date/time string to a seven element array
CALLING SEQUENCE:
tarr = timstr2ex('4-oct-91 15:22')
tarr = timstr2ex(!stime)
INPUT:
dattim_str - Character string
4-OCT-91 14:20
4-OCT-91 4:20:00
4-OCT-91 4:20:00.10
14:20:00 4-Oct-91
14:20:00 4-Oct-1991
92/12/25 OK
25/12/92 OK
12/25/92 NEED "MDY" SWITCH
If the year is missing, it will assume the current year
CALLS: ***
ARR2STR [1], Arr2Str [2], STR2ARR [1], STR2ARR [2]
CALLED BY:
BCS_24HR_PLOT [1], BCS_24HR_PLOT [3], BCS_BROWSE24, LIST_BDA, MANY_DAYS
WR_PLAN_AREA, XMOVIE_SFM, anytim [1], anytim [2], anytim [3], anytim [4], anytim [5]
anytim2ex [1], anytim2ex [2], anytim2ints [1], anytim2ints [2], doytim2ex [1]
doytim2ex [2], dsn_input, eis_timeline_plot_gui [1], eis_timeline_plot_gui [2]
gettime, go_get_sirius, input_time [1], input_time [2], mk_orbit_sum, mon_sci5k
op_times, pr_fem, pr_gbe, pr_gev, pr_nar, pr_nel, redo_disploi, redo_mon_sci5k
OPTIONAL KEYWORD INPUT:
mdy - When using the "/" notation for the date, and having the
order MM/DD/YY, then it is necessary to use this switch.
OUTPUT:
returns - 7 ELEMENT INTEGER*2 ARRAY CONTAINING, IN ORDER,
HRS MIN SECS MILLISECS DAY MON YR ('90)
ASSUMPTIONS:
Date is separated by - and comes before the month
No spaces before/after the -
Month is three letters
Time is separated by :
Number of characters for minutes is two
Number of characters for seconds is two
Fractions of seconds is designated by a decimal after the seconds
Need at least one space between date and time
For "/" notation for the date:
No spaces before/after the /
Assumes month is the middle number unless using the /mdy switch
Must include all three items (date, month, year)
Year must be the first or last item
HISTORY:
Written Sep-91 by M.Morrison
15-Nov-91 (MDM) - Modified to break the string into two parts
before tackling the decompression. That fixed
some problems that were found.
7-Jun-92 (MDM) - Modified to accept an array of times
4-Jan-93 (MDM) - Modified to accept the "/" notation for date
7-May-93 (MDM) - Modified the millisec extraction due to a
roundoff error(?)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_ASSIGN
PURPOSE:
Assign Value to Variable
CATEGORY:
EXPLANATION:
SYNTAX:
tki_assign,
CALLED BY:
TKI_EXECINSTR
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE, TKI_POPDATA
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_ATPOINTER
PURPOSE:
Load Data found on Address to Stack
CATEGORY:
EXPLANATION:
SYNTAX:
tki_atpointer,
CALLED BY:
TKI_EXECINSTR
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_LOADDATA, TKI_MESSAGE, TKI_POPDATA
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_BINARY
PURPOSE:
Execute the binary function indicated by the token
CATEGORY:
EXPLANATION:
SYNTAX:
tki_binary,
CALLED BY:
TKI_EXECINSTR
EXAMPLES:
INPUTS:
token - the token (Byte)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE, TKI_POPDATA, TKI_PUSHDATA
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_CALCMOT()
PURPOSE:
Compute MotionTime of Mechanisms
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_calcmot()
CALLED BY:
TKI_DO_MC_CMD, TKI_MCPOS2, TKI_MC_TST_REL, TKI_SPHEL
EXAMPLES:
INPUTS:
s_steps - number of motor steps
s_ramplen - steps per start and stop ramp
f_freqmax - maximum step frequency
sfirst - first or following motion
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
CALCSTEP, FREQ_RAMP
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_CALL
PURPOSE:
Main Calling Routine for Simulator as Standalone
CATEGORY:
EXPLANATION:
SYNTAX:
tki_call, file_spec [,/inter[,/advance[,/noscreen]]]
CALLED BY:
FULLTEST_TKI
EXAMPLES:
INPUTS:
file_spec - Name of UDP to be simulated
tmp_par - Dummy to avoid error in case of former usage
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
interactive - start Simulater in interactive Mode
advance - start Simulater in advanced Mode
noscreen - no graphic screen output
test - do not load compiled routines
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], GET_COMPILED_TKI, GET_UDP_HEAD, RSTRPOS, TAG_EXIST [1]
TAG_EXIST [2], TEST_OPEN, TKI_CALL_PAR, TKI_CHKIT, TKI_EVAL, TKI_GRAPH_STC
TKI_LAMBDA11, TKI_MASTER, TKI_MASTER_ADV, TKI_MESSAGE, TKI_TCMD, concat_dir [4]
COMMON:
@tki_common_share
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 2, November 10, 1998, Dietmar Germerott, MPAE Lindau
modified detection of current set detector
Version 3, November 11, 1998, Dietmar Germerott, MPAE Lindau
added detector sensitive global parameter loading
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_CALL_PAR()
PURPOSE:
Check for Parameter and load them into a Structure
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_call_par()
CALLED BY:
TKI_CALL, XTKI
EXAMPLES:
INPUTS:
file_spec - Name of File with Parameters
par_struct - Structure where Parameters are load in
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_LOAD_PAR_C
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_CALLFUNC
PURPOSE:
Call a function inside a UDP/POP
CATEGORY:
EXPLANATION:
SYNTAX:
tki_callfunc
CALLED BY:
TKI_EXECINSTR
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE, TKI_PUSH16, TKI_PUSHDATA
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_CELOBJ()
PURPOSE:
Simulate the Celestial Object Function
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_celobj()
CALLED BY:
TKI_L3CTRL
EXAMPLES:
INPUTS:
tmax - maximal search time in seconds
tstp - TimeStep (see SCL Celestial_obj)
nimg - Number of Images per WAVL (see...)
dark - dark signal value (see..)
lambda - start wavelength
d_lambda - wavelength increment
nrinc - Number of WAVL increments (see...)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CLOCK, TKI_DO_MC_CMD, TKI_DO_POW_CMD, TKI_GET_MCPOWER, TKI_IIM_READ
TKI_LAMBDA, TKI_MCMOVE, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_CHANGE_PAR
PURPOSE:
Writing the parameters (global/UDP) to their position
CATEGORY:
EXPLANATION:
SYNTAX:
tki_change_par,
EXAMPLES:
INPUTS:
par_nr - Parameter index #
par_ty - Parameter type #
par_val - Parameter value #
par_base_ptr - Parameter base pointer (Glob/UDP) #
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_CHECK_CNT()
PURPOSE:
Check the Countrates for SUMER
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_check_cnt()
CALLED BY:
TKI_L3CTRL, TKI_LAMBDA
EXAMPLES:
INPUTS:
lam_511 - lambda on Pixel 511
specwave - Array of Wavelength
specint - Array of Intensities
slit - slitnr
detector - used Detector
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_DET_RANGE
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 22, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_CHECK_COMP()
PURPOSE:
Check for right Compression Format
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_check_comp()
CALLED BY:
TKI_FULLDISK, TKI_L3CTRL, TKI_REFSPEC
EXAMPLES:
INPUTS:
informat -
m_info -
p_format -
@tki_image_tab
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_IMAGE_FORM, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_CHKIT
PURPOSE:
CHeck User
CATEGORY:
EXPLANATION:
SYNTAX:
Res = tki_chkit()
CALLED BY:
ST_TKI_INIT, TKI_CALL, XTKI
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
Res = Structure of User information
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], concat_dir [4]
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 29, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 2, February 9, 1999, Dietmar Germerott, MPAE Lindau
mod default level to 'f0'xb
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_CINT
PURPOSE:
Main Program for Tokencode interpreter
CATEGORY:
EXPLANATION:
SYNTAX:
tki_cint,
CALLED BY:
TKI_INSERT_UDP, TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CLOCK, TKI_CONVERT, TKI_EXECINSTR, TKI_GETINSTR, TKI_PUSH16, TKI_PUSHDATA
TKI_P_SEARCH
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_CLOCK
PURPOSE:
Processing Timeline of simulation
CATEGORY:
EXPLANATION:
SYNTAX:
tki_clock,
CALLED BY:
TKI_CELOBJ, TKI_CINT, TKI_DO_MC_CMD, TKI_DO_POW_CMD, TKI_IIM_READ, TKI_L34EXEC
TKI_L3CTRL, TKI_LIBCTRL, TKI_MCPOS2, TKI_MC_TST_REL, TKI_POWERUP, TKI_RSCON
TKI_RSC_EXEC, TKI_SETMCPHIGHV, TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
d_time - Deltatime to process
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_COMP_HANDLE, TKI_FDELETE, TKI_IMAGE_FORM, TKI_MESSAGE, TKI_TELEMETRY
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
April 29, 1997 Dietmar Germerott, MAPE Lindau.
Move tm_info.ratio = tm_info.ratio + step to
tki_telemetry for more exact calculation.
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_CLOSE_UNIT
PURPOSE:
Close all needed UNITs for Output
CATEGORY:
EXPLANATION:
SYNTAX:
tki_close_unit,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_CMD_FUNC()
PURPOSE:
Return Function Information in a STRUCT
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_cmd_func()
CALLED BY:
TKI_L34EXEC, TKI_LIBCALL, TKI_SCAN_PAR, TKI_TCMD, XTKI
EXAMPLES:
INPUTS:
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau.
Written
Version 1.1, December 7, 2004, Dietmar Germerott, MPAE Lindau
Modified user cmd level for PutSystemX Cmd from 0xc0 to
0xff (allow everyone to use the CMD in UDP)
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_COMMON_PRIV
PURPOSE:
Common Variables for Simulator Internal
CATEGORY:
EXPLANATION:
SYNTAX:
@tki_common_priv
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_share
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 2, June 23, 1998, Dietmar Germerott, MPAE Lindau
added repoint_stc
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_COMMON_SHARE
PURPOSE:
Common Variables as Interface to SC_SUMER
CATEGORY:
EXPLANATION:
SYNTAX:
tki_common_share,
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_COMP_HANDLE
PURPOSE:
COMPUTING RAM ALLOCATION WITH COMP/NOCOMP
CATEGORY:
EXPLANATION:
SYNTAX:
tki_comp_handle,
CALLED BY:
TKI_CLOCK
EXAMPLES:
INPUTS:
d_time - delta time for event
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_COMPRESSION, TKI_FCREATE, TKI_FDELETE, TKI_IMAGE_FORM
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_COMPRESSION()
PURPOSE:
Compute the time for Compression
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_compression()
CALLED BY:
TKI_COMP_HANDLE
EXAMPLES:
INPUTS:
tmp_entry - structure of actual dir_entry
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_IMAGE_FORM
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_CONVERT
PURPOSE:
Convert the PC-REAL format to VAX-REAL format
CATEGORY:
EXPLANATION:
SYNTAX:
tki_convert,
CALLED BY:
TKI_CINT
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_FINDCONST
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_COTOPOS
PURPOSE:
Calculate MC Position from Pointing Coordinates
CATEGORY:
EXPLANATION:
SYNTAX:
tki_cotopos,
CALLED BY:
TKI_POINTTELE, TKI_SET_SPC
EXAMPLES:
INPUTS:
azimco - Telescope Azimuth Position
elevco - Telescope Elevation Position
mc2newpos - Return Variable for MC2 Position
mc3newpos - Return Variable for MC3 Position
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DATABYTES()
PURPOSE:
Returns the number of bytes occupied by data
CATEGORY:
EXPLANATION:
Returns the number of bytes allocated in memo__
by the type of variable
SYNTAX:
Result = tki_databytes()
CALLED BY:
TKI_FINDCONST, TKI_GENINIT, TKI_INITELEM, TKI_INITVAR
EXAMPLES:
INPUTS:
type - DATA type of variable
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DET_COVER()
PURPOSE:
Dummy Function for DET_COVER
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_det_cover()
CALLED BY:
TKI_EXEC_DET
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DET_HIGHV()
PURPOSE:
Switch HV for Detector ON/OFF
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_det_highv()
CALLED BY:
TKI_EXEC_DET
EXAMPLES:
INPUTS:
act - Action 1 = HV-ON
0 = HV-OFF
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DET_MCPHIGH()
PURPOSE:
Set MCP High Voltage Value
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_det_mcphigh()
CALLED BY:
TKI_EXEC_DET
EXAMPLES:
INPUTS:
voltage - High Voltage Value (0..255)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DET_QUALIFY()
PURPOSE:
Simulate the Det_Qualify Cmd
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_det_qualify()
CALLED BY:
TKI_EXEC_DET
EXAMPLES:
INPUTS:
act - Action 0=OFF / 1=ON
stim - Stimpulse 0=OFF / 1=ON
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DET_RANGE()
PURPOSE:
Compute Wavelength Range on Detector
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_det_range()
CALLED BY:
TKI_CHECK_CNT, TKI_DISPLAY_DET, TKI_LAMBDA11, TKI_SHOW_LAM, XSPECT
EXAMPLES:
INPUTS:
lambda511 - Wavlength on Pixel 511
det_pix - Pixel to check which Lambda is on
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
detector - Current used Detector (STRING)
pixel - Reference Pixel (if set Lambda on Pixel 511 Det A ist returned)
CALLS: ***
TKI_LAMBDA_511
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 19, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DET_READOUT()
PURPOSE:
Dummy Function for DET_Readout
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_det_readout()
CALLED BY:
TKI_EXEC_DET
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DET_X_CHARG()
PURPOSE:
Set the X-Charge Threshold
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_det_x_charg()
CALLED BY:
TKI_EXEC_DET
EXAMPLES:
INPUTS:
threshold - Threshold Value
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DET_X_TIM()
PURPOSE:
Set the X-Timing Threshold
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_det_x_tim()
CALLED BY:
TKI_EXEC_DET
EXAMPLES:
INPUTS:
threshold - Threshold Value
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DET_X_UPPER()
PURPOSE:
Set the X-Upper Threshold
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_det_x_upper()
CALLED BY:
TKI_EXEC_DET
EXAMPLES:
INPUTS:
threshold - Threshold Value
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DET_Y_CHARG()
PURPOSE:
Set the Y-Charge Threshold
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_det_y_charg()
CALLED BY:
TKI_EXEC_DET
EXAMPLES:
INPUTS:
threshold - Threshold Value
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DET_Y_TIM()
PURPOSE:
Set the Y-Timing Threshold
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_det_y_tim()
CALLED BY:
TKI_EXEC_DET
EXAMPLES:
INPUTS:
threshold - Threshold Value
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DET_Y_UPPER()
PURPOSE:
Set the Y-Upper Threshold
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_det_y_upper()
CALLED BY:
TKI_EXEC_DET
EXAMPLES:
INPUTS:
threshold - Threshold Value
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DETPOWER()
PURPOSE:
Switch ON/OFF Detector
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_detpower()
CALLED BY:
TKI_SHUTDOWN, TKI_STANDBY
EXAMPLES:
INPUTS:
state - 1 = ON, 0 = OFF
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_DO_POW_CMD, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DISPERSE()
PURPOSE:
Compute Dispersion for Lambda Function
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_disperse()
CALLED BY:
TKI_LAMBDA, TKI_LAMBDA_511, XSPECT
EXAMPLES:
INPUTS:
lambda - wavelength
n - Focal length
detpixsize - Pixel Size
dispr - r for disperse
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DISPLAY_DET
PURPOSE:
Display the Wavelrngthrange and Readout Windows
CATEGORY:
EXPLANATION:
SYNTAX:
tki_display_det,
CALLED BY:
TKI_LAMBDA11, TKI_SHOW_LAM
EXAMPLES:
INPUTS:
lam_511 - Wavelength on Det A Pixel 511
pix_pos - Centerpixel for lam_x
lam_x - Wavelength on dedicated Pixel
y_img - Width for readout Window (in Pixel)
slit_nr - actual Slit number for compute Total
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
base - Widget topbase
det - Detector for compute Display
log - Display Detector Cnts LOG
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], CONGRID [1], CONGRID [2]
CONGRID [3], PSTORE, SET_LINE_COLOR, SLIDE_IMAGE, TAG_EXIST [1], TAG_EXIST [2]
TKI_DET_RANGE, TKI_GRAPH_STC, TKI_INTERPRET, concat_dir [4]
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 21, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 1.1, May 21, 1996, Dietmar Germerott, MAPE Lindau.
check if tag 'x_flag' exist. If not tki_graph has to be
initialized
Version 1.2, May 23, 1997, Liyun Wang, NASA/GSFC
Added calls to PSTORE to save plotting parameters
of spectrum and detector plotting windows
Version 1.3, July 2, 1997, Liyun Wang, NASA/GSFC
Improved the way the spectrum is plotted
Version 1.4, January 20, 1999, Dietmar Germerott, MPAE Lindau
Correct the Cnts/sec calculation
Version 1.5, June 1, 1999, Dietmar Germerott, MPAE Lindau
added print capability
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DO_DET_CMD()
PURPOSE:
Handle Detector Functions
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_do_det_cmd()
CALLED BY:
TKI_L3CTRL, TKI_L4CTRL, TKI_LAMBDA, TKI_POWERUP, TKI_RESTORESET, TKI_SETMCPHIGHV
TKI_STANDBY
EXAMPLES:
INPUTS:
cmd - Command
par_1 - Parameter 1
par_2 - Parameter 2
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_EXEC_DET, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DO_MC_CMD()
PURPOSE:
Handle MC Commands
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_do_mc_cmd()
CALLED BY:
TKI_CELOBJ, TKI_GET_MCPOWER, TKI_L4CTRL, TKI_MCMOVE, TKI_MCPOS2, TKI_ROT_MOVE
TKI_RSCSCAN, TKI_SPHEL
EXAMPLES:
INPUTS:
mc_cmd - command
dev - motor controller (0 - 6)
par_1...3 - parameter
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
MCGETERAMVALUE, MCGETERR, MCGETFREQ, MCGETIRAMVALUE, MCGETSTEPS, MCREADHK, MCRELPOS
MCRELPOSANS, MCRESET, MCSCANSTEP, MCSELFTEST, MCSETERAMVALUE, MCSETIRAMVALUE
MCSETVARIABLE, TKI_CALCMOT, TKI_CLOCK, TKI_DRAW_POS, TKI_MC_TST_REL, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DO_POW_CMD()
PURPOSE:
Handle Power CMDs
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_do_pow_cmd()
CALLED BY:
TKI_CELOBJ, TKI_DETPOWER, TKI_GET_MCPOWER, TKI_L3RSC, TKI_L4CTRL, TKI_LAMBDA
TKI_POINTTELE, TKI_ROT_MOVE, TKI_RSCSCAN, TKI_SLITPOS, TKI_SPHEL
EXAMPLES:
INPUTS:
cmd - Command
dev - disired Relais
act - 0 = off, 1 = on
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CLOCK, TKI_MESSAGE, TKI_POWEXECUTE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DRAW_POS
PURPOSE:
Plot the Position in SUN Simulation Window
CATEGORY:
EXPLANATION:
SYNTAX:
tki_draw_pos,
CALLED BY:
TKI_DO_MC_CMD
EXAMPLES:
INPUTS:
_p_old - Pointing Position before moving (1/16 arcsec)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
SET_LINE_COLOR
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_DUMP_GLO
PURPOSE:
Print the Global Parameters
CATEGORY:
EXPLANATION:
SYNTAX:
tki_dump_glo,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
globals - structure with Global Parameters
start_p - First Parameter to Display
end_p - last Parameter to Display
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_ENTRY
PURPOSE:
Execute the program entry operation
CATEGORY:
EXPLANATION:
SYNTAX:
tki_entry,
CALLED BY:
TKI_EXECINSTR, TKI_P_SEARCH
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE, TKI_PUSH16
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_EVAL
PURPOSE:
Setup Procedure for Result Plot
CATEGORY:
EXPLANATION:
SYNTAX:
tki_eval,
CALLED BY:
TKI_CALL, TKI_TCMD_EXEC, XTKI, XTKI_CMD_EXE
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], TKI_RESGRAPH, break_file [4]
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
!p.multi is set to 0
!p.charsize is set to 1.0
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 2, April 15, 1998, GERMEROTT, MPAE LINDAU
added KEYWORD DETECTOR to call of TKI_RESGRAPH
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_EXEC_DET()
PURPOSE:
Execute and handle Detector Commands
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_exec_det()
CALLED BY:
TKI_DO_DET_CMD
EXAMPLES:
INPUTS:
cmd - Detector Cmd
par_1 - Cmd Parameter 1
par_2 - Cmd Parameter 2
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_DET_COVER, TKI_DET_HIGHV, TKI_DET_MCPHIGH, TKI_DET_QUALIFY, TKI_DET_READOUT
TKI_DET_X_CHARG, TKI_DET_X_TIM, TKI_DET_X_UPPER, TKI_DET_Y_CHARG, TKI_DET_Y_TIM
TKI_DET_Y_UPPER, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_EXECINSTR
PURPOSE:
Handle Execution of Token Instruction
CATEGORY:
EXPLANATION:
SYNTAX:
tki_execinstr,
CALLED BY:
TKI_CINT
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_ASSIGN, TKI_ATPOINTER, TKI_BINARY, TKI_CALLFUNC, TKI_ENTRY, TKI_GENINIT
TKI_GETPAR, TKI_INITELEM, TKI_INITVAR, TKI_JUMPS, TKI_L3CALL, TKI_L4CALL
TKI_LIBCALL, TKI_LOADADDR, TKI_LOADCON, TKI_LOADSUBSCRA, TKI_LOADVAR, TKI_LVALUEAT
TKI_MESSAGE, TKI_MNEMO, TKI_POPDATA, TKI_RETURN, TKI_RETVALUE, TKI_TYPECAST
TKI_UNARY
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_FCREATE()
PURPOSE:
Create a new File in SUMER DPU Memory
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_fcreate()
CALLED BY:
TKI_COMP_HANDLE, TKI_IIMMEM, TKI_LIBCTRL, TKI_RSCIH
EXAMPLES:
INPUTS:
num_b - number of Bytes for the new File
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_FDELETE()
PURPOSE:
Delete the File indicated by handle in Memeory
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_fdelete()
CALLED BY:
TKI_CLOCK, TKI_COMP_HANDLE, TKI_LIBCTRL, TKI_TELEMETRY
EXAMPLES:
INPUTS:
handle - File ID to be deleted
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_FIND_CMD()
PURPOSE:
Find SUMER Cmd by Pattern search
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_find_cmd()
CALLED BY:
TKI_HLP_ON_CMD, XTKI
EXAMPLES:
INPUTS:
search_str - Search Pattern String
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MNEMOL3, TKI_MNEMOL4, TKI_MNEMOLIB, TKI_MNEMOTCI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 14, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_FINDCONST()
PURPOSE:
Find the address where a constant is stored
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_findconst()
CALLED BY:
TKI_CONVERT, TKI_GENINIT, TKI_INITELEM, TKI_INITVAR, TKI_LOADCON
EXAMPLES:
INPUTS:
idx_t - Constant Index
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_DATABYTES
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_FINDVARDATA()
PURPOSE:
Find the address where a variable's data is stored
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_findvardata()
CALLED BY:
TKI_GENINIT, TKI_INITELEM, TKI_INITVAR, TKI_LOADADDR, TKI_LOADVAR
EXAMPLES:
INPUTS:
idx - variables index
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_FINDVARDECL
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_FINDVARDECL()
PURPOSE:
Find the address where a variable's declaration is stored
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_findvardecl()
CALLED BY:
TKI_FINDVARDATA, TKI_GENINIT, TKI_INITELEM, TKI_INITVAR, TKI_LOADADDR, TKI_LOADVAR
EXAMPLES:
INPUTS:
idx - Index to Variable Declaration
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_FINIT()
PURPOSE:
Initialize Ram Disk
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_finit()
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_FOCUSPOS()
PURPOSE:
Calculate new position for focus MC&Grating
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_focuspos()
CALLED BY:
TKI_LAMBDA
EXAMPLES:
INPUTS:
lambda - Wavelength of spectralline
n -
r -
f0 -
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_FULLDISK()
PURPOSE:
Simulate the Fulldisk Function
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_fulldisk()
CALLED BY:
TKI_L3CTRL
EXAMPLES:
INPUTS:
dy - Delta Step (see SCL full_disk) #
sch - Number of Schmierschritt (see SCL full_disk) #
cen - scan mode (see SCL full_disk) #
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CHECK_COMP, TKI_ROT_MOVE, TKI_SET_SPC, TKI_SPHEL
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_GEN_CMD()
PURPOSE:
Find SUMER Cmd by Pattern search
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_gen_cmd()
CALLED BY:
TKI_MASTER_ADV
EXAMPLES:
INPUTS:
search_str - Search Pattern String
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MNEMOL3, TKI_MNEMOL4, TKI_MNEMOLIB, TKI_MNEMOTCI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 14, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_GENINIT
PURPOSE:
Initialize elements of an array
CATEGORY:
EXPLANATION:
SYNTAX:
tki_geninit,
CALLED BY:
TKI_EXECINSTR
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_DATABYTES, TKI_FINDCONST, TKI_FINDVARDATA, TKI_FINDVARDECL
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_GET_MCPOWER()
PURPOSE:
Check if Motor is on, if not switch on
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_get_mcpower()
CALLED BY:
TKI_CELOBJ, TKI_LAMBDA, TKI_POINTTELE, TKI_ROT_MOVE, TKI_RSCSCAN, TKI_SLITPOS
TKI_SPHEL
EXAMPLES:
INPUTS:
dev - MC Dev (0 - 6)
switch_num - power converter channel
result - result from Power command
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_DO_MC_CMD, TKI_DO_POW_CMD
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_GETINSTR
PURPOSE:
Get next Token Instruction in UDP/POP
CATEGORY:
EXPLANATION:
SYNTAX:
tki_getinstr,
CALLED BY:
TKI_CINT
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_GETMESS
PURPOSE:
Print the current Settings for Output
CATEGORY:
EXPLANATION:
SYNTAX:
tki_getmess,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
out_state - Current Output Flag Setting
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_GETPAR
PURPOSE:
Get a parameter of a function call
CATEGORY:
EXPLANATION:
SYNTAX:
tki_getpar,
CALLED BY:
TKI_EXECINSTR
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_PUSHDATA
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_GRAPH_STC()
PURPOSE:
Make initial Tki_graph structure
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_graph_stc()
CALLED BY:
ST_TKI_INIT, TKI_CALL, TKI_DISPLAY_DET, TKI_PHOTO_BASE, XSPECT, XTKI
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 29, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 2, May 23, 1997, Liyun Wang, NASA/GSFC
Added following tags to the TKI_GRAPH structure: sun_pid, tech_pid,
spec_pid, det_pid, spec_arr, and p_flag to be set by PSTORE
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_HLP_ON_CMD
PURPOSE:
Get SUMER Cmd by Pattern and print Information
CATEGORY:
EXPLANATION:
SYNTAX:
tki_hlp_on_cmd,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
sear_str - Cmd Pattern to find
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_FIND_CMD, TKI_MESSAGE, TKI_SCAN_PAR
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 14, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_I_PARSTRUCT
PURPOSE:
Initialize the Parameter Struct for Parameter search
CATEGORY:
EXPLANATION:
SYNTAX:
tki_i_parstruct,
CALLED BY:
TKI_INSERT_UDP, TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_IIM_READ
PURPOSE:
Manage Integrationtime and Schmierschritt
CATEGORY:
EXPLANATION:
SYNTAX:
tki_iim_read,
CALLED BY:
TKI_CELOBJ, TKI_READIMAGE, TKI_SPHEL
EXAMPLES:
INPUTS:
m_info - Measure Info Struct
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CLOCK, TKI_IIMMEM
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_IIMMEM
PURPOSE:
Handle Image readout and put into RAM DISK
CATEGORY:
EXPLANATION:
SYNTAX:
tki_iimmem,
CALLED BY:
TKI_IIM_READ
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_FCREATE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_IMAGE_FORM()
PURPOSE:
Returns the Picture Parameter
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_image_form()
CALLED BY:
RAW2BIN, TKI_CHECK_COMP, TKI_CLOCK, TKI_COMPRESSION, TKI_COMP_HANDLE, TKI_LIBCTRL
TKI_RSCIH, TKI_SETUP_IMG, TKI_TRANS_TIM
EXAMPLES:
INPUTS:
form - imageformat
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_IMAGE_TAB
PURPOSE:
Table for Image Information
CATEGORY:
EXPLANATION:
SYNTAX:
@tki_image_tab
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_IMAGEFUNC
PURPOSE:
Simulate the LIB-Image Functions
CATEGORY:
EXPLANATION:
SYNTAX:
tki_imagefunc,
CALLED BY:
TKI_LIBCALL
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_L34EXEC, TKI_MESSAGE, TKI_MNEMOLIB, TKI_POPDATA, TKI_PUSHDATA, TKI_TRIM_CMD
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_INIT_DET
PURPOSE:
Initialize Variables with which Detector is used
CATEGORY:
EXPLANATION:
SYNTAX:
tki_init_det,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 1.1, November 11, 1998, Dietmar Germerott, MPAE Lindau
initialize tki_current_det with A in case of wrong type
Version 1.2, January 20, 1999, Dietmar Germerott, MPAE Lindau
initialize det_info.char still forgotten up to now - sorry
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_INIT_DISP
PURPOSE:
Initialize Graphic Display and scale the plotting area
CATEGORY:
EXPLANATION:
SYNTAX:
tki_init_disp,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
OPLOT
CALLS: ***
SET_LINE_COLOR, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_INIT_MAIN
PURPOSE:
Initialize some previews needed Variables for TKI
CATEGORY:
EXPLANATION:
SYNTAX:
tki_init_main
CALLED BY:
ST_SUMER, TKI_SCL2OBJgroupgroup, TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 27, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 2, November 11, 1998, Dietmar Germerott, MPAE Lindau
modified to version 3.01
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_INIT_MEM
PURPOSE:
Initialize the main Variables for Simulator
CATEGORY:
EXPLANATION:
SYNTAX:
tki_init_mem,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
SET_LINE_COLOR, TKI_READGLOPAR, TKI_SLIT
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 2, June 23, 1998, Dietmar Germerott, MPAE Lindau
added repoint_stc
Version 2.1, January 20, 1999, Dietmar Germerott, MPAE Lindau
added tag slit to spec_info
Version 2.2, February 28, 1999, Dietmar Germerott, MPAE Lindau
added tag sphel_f to global_s structure
Version 2.3, June 1, 1999, Dietmar Germerott, MPAE Lindau
added tag act_pxcnt to spec_info and variable imgspec_info
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_INIT_PAR
PURPOSE:
Write Parameter Values to their Position in Memory
CATEGORY:
EXPLANATION:
SYNTAX:
tki_init_par,
CALLED BY:
TKI_LOAD_PAR_F, TKI_LOAD_PAR_V
EXAMPLES:
INPUTS:
par_nr - Parameter number
par_ty - Parameter type
par_val - Parameter value
par_base_ptr - Parameter base pointer (glob/UDP)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_INIT_SPEC
PURPOSE:
Initialize the spectral Data for Simulation
CATEGORY:
EXPLANATION:
SYNTAX:
tki_init_spec,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], concat_dir [4]
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 22, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_INIT_TM
PURPOSE:
Initialize Variables with which Telemetry Rate is used
CATEGORY:
EXPLANATION:
SYNTAX:
tki_init_tm,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_INITELEM
PURPOSE:
Initialize a number of Alements in an Array
CATEGORY:
EXPLANATION:
SYNTAX:
tki_initelem,
CALLED BY:
TKI_EXECINSTR
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_DATABYTES, TKI_FINDCONST, TKI_FINDVARDATA, TKI_FINDVARDECL, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_INITVAR
PURPOSE:
Initialize a single Variable by a Constant
CATEGORY:
EXPLANATION:
SYNTAX:
tki_initvar,
CALLED BY:
TKI_EXECINSTR
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_DATABYTES, TKI_FINDCONST, TKI_FINDVARDATA, TKI_FINDVARDECL, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_INSERT
PURPOSE:
Insert Name of UDP in LOG and TRC Files
CATEGORY:
EXPLANATION:
SYNTAX:
tki_insert,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_INSERT_UDP()
PURPOSE:
Insert UDP in UDP list, check for Parameter and Slot
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_insert_udp()
EXAMPLES:
INPUTS:
udp_nr - Number of UDP Slot
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CINT, TKI_I_PARSTRUCT, TKI_MESSAGE, TKI_RET_PARAM
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_JUMPS
PURPOSE:
Execute the Jump Operation indicated by the Token
CATEGORY:
EXPLANATION:
SYNTAX:
tki_jumps,
CALLED BY:
TKI_EXECINSTR, TKI_P_SEARCH
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE, TKI_POPDATA
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_L34EXEC
PURPOSE:
Handle different Calls to Level CTRL-Routines
CATEGORY:
EXPLANATION:
SYNTAX:
tki_l34exec,
CALLED BY:
TKI_IMAGEFUNC, TKI_L3CALL, TKI_L4CALL, TKI_TCMD
EXAMPLES:
INPUTS:
lvl - Functionlevel / 45h = L3, 46h = L4
func - Function
cnt - Number of Parameters
data - Parameter Data
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CLOCK, TKI_CMD_FUNC, TKI_L3CTRL, TKI_L4CTRL, TKI_LIBCTRL, TKI_MESSAGE
TKI_MNEMOL3, TKI_MNEMOL4, TKI_MNEMOLIB, TKI_PUSHDATA, TKI_TRIM_CMD
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_L3CALL
PURPOSE:
Call the level 3 function indicated in Instruction
CATEGORY:
EXPLANATION:
SYNTAX:
tki_l3call,
CALLED BY:
TKI_EXECINSTR
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_L34EXEC, TKI_POPDATA
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_L3CTRL
PURPOSE:
Call the Level 3 Simulation Function
CATEGORY:
EXPLANATION:
SYNTAX:
tki_l3ctrl,
CALLED BY:
TKI_L34EXEC
EXAMPLES:
INPUTS:
func - L3 - Function nr
param - Parameter array with the function parameters
result - Variable for function results
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CELOBJ, TKI_CHECK_CNT, TKI_CHECK_COMP, TKI_CLOCK, TKI_DO_DET_CMD, TKI_FULLDISK
TKI_L3RSC, TKI_LAMBDA, TKI_MCINITPOS, TKI_MCMOVE, TKI_MCPOS2, TKI_MESSAGE
TKI_POINTTELE, TKI_POWERUP, TKI_READIMAGE, TKI_REFSPEC, TKI_RESTORESET
TKI_ROT_INIT, TKI_ROT_MOVE, TKI_RSCSCAN, TKI_SAVESETTING, TKI_SETMCPHIGHV
TKI_SET_SPC, TKI_SHUTDOWN, TKI_SLITPOS, TKI_SPHEL, TKI_STANDBY
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 2, June 23, 1998, Dietmar Germerott, MPAE Lindau
modified the cont function for use of repoint
Version 3, January 20, 1999, Dietmar Germerott, MPAE Lindau
added count rate check in slit selection
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_L3RSC()
PURPOSE:
Simulate SUMER RSC Cmd
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_l3rsc()
CALLED BY:
TKI_L3CTRL
EXAMPLES:
INPUTS:
itgtime - integrationtime (see OPG SCL)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_DO_POW_CMD, TKI_MESSAGE, TKI_RSCIH, TKI_RSC_EXEC
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_L4CALL
PURPOSE:
Call the level 4 Function indicated in Instruction
CATEGORY:
EXPLANATION:
SYNTAX:
tki_l4call,
CALLED BY:
TKI_EXECINSTR
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_L34EXEC, TKI_POPDATA
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_L4CTRL
PURPOSE:
Call the Level 4 Simulating Functions
CATEGORY:
EXPLANATION:
SYNTAX:
tki_l4ctrl,
CALLED BY:
TKI_L34EXEC
EXAMPLES:
INPUTS:
func - L4 - Function nr
param - Parameter array with the function parameters
result - Variable for function results
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_DO_DET_CMD, TKI_DO_MC_CMD, TKI_DO_POW_CMD, TKI_MESSAGE, TKI_RSC_EXEC
TKI_SYSCONFIG
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_LAM_OUT
PURPOSE:
Print Current Settings For Lambda and Pixel
CATEGORY:
EXPLANATION:
SYNTAX:
tki_lam_out,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
in_glo - Global Parameter Struct
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_LAMBDA()
PURPOSE:
Calulate Pixel Positions , init Linregister
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_lambda()
CALLED BY:
TKI_CELOBJ, TKI_L3CTRL, TKI_REFSPEC
EXAMPLES:
INPUTS:
px - Reference Pixel
reg - Line Register (Main (0) / Alt (1))
l3funcid - Lambda1X (X = 1,3,8)
spec_line - fltarr(8) with lines
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
refspec - controls some outputs in case of RefSpec-Function
CALLS: ***
CONVERS4, CONVERS5, POLY, TKI_CHECK_CNT, TKI_DISPERSE, TKI_DO_DET_CMD
TKI_DO_POW_CMD, TKI_FOCUSPOS, TKI_GET_MCPOWER, TKI_LAMBDA11, TKI_LAMBDA_511
TKI_MCPOS2, TKI_MESSAGE, TKI_NEXT_LAMBDA, TKI_ORDER
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 1.1, January 20, 1999, Dietmar Germerott, MPAE Lindau
added spec_info.slit
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_LAMBDA11
PURPOSE:
Display Wavelength range on Detector Layout
CATEGORY:
EXPLANATION:
SYNTAX:
tki_lambda11,
CALLED BY:
TKI_CALL, TKI_LAMBDA, TKI_PHOTO_BASE, XSPECT, XTKI, XTKI_CMD_EXE
EXAMPLES:
INPUTS:
pixel - Reference Pixel (like in lambda1x)
lambdax - Wavelength Array (lambda(0) is Reference Wavlength)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
format - Picture Format
slit - Slit number
detector - used Detector
compression - Compression Scheme
spec - Binning spectral
spat - Binning spatial
log - display Intensity on Det Log
print_ - create postscript file in tki_display_det
CALLS: ***
TKI_DET_RANGE, TKI_DISPLAY_DET, TKI_ORDER, TKI_SETUP_IMG
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 21, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_LAMBDA_511()
PURPOSE:
Normalize lambda to the standard configuration (pixel 511)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_lambda_511()
CALLED BY:
TKI_DET_RANGE, TKI_LAMBDA
EXAMPLES:
INPUTS:
px - Reference Pixel
lambda - Lambda
n -
detpixsize -
dispr -
dl_0 -
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_DISPERSE
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_LIBCALL
PURPOSE:
Call the Library Function indicated in Instruction
CATEGORY:
EXPLANATION:
SYNTAX:
tki_libcall,
CALLED BY:
TKI_EXECINSTR, TKI_P_SEARCH
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CMD_FUNC, TKI_IMAGEFUNC, TKI_MATHFUNC, TKI_MESSAGE, TKI_MNEMOLIB
TKI_PARSYSFUNC
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_LIBCTRL
PURPOSE:
Call the Lib Simulating Functions
CATEGORY:
EXPLANATION:
SYNTAX:
tki_libctrl,
CALLED BY:
TKI_L34EXEC
EXAMPLES:
INPUTS:
func - LIB - Function nr
param - Parameter array with the function parameters
result - Variable for function results
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CLOCK, TKI_FCREATE, TKI_FDELETE, TKI_IMAGE_FORM, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_LOAD_PAR_C()
PURPOSE:
Load UDP Parameter from File into Param Struct
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_load_par_c()
CALLED BY:
TKI_CALL_PAR
EXAMPLES:
INPUTS:
filename - File Where Parameters for UDP/POP stored (ASCII)
par_struct - Structure where to put Values
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_LOAD_PAR_F
PURPOSE:
Loading Parameters for POP/UDP from a file
CATEGORY:
EXPLANATION:
SYNTAX:
tki_load_par_f,
EXAMPLES:
INPUTS:
par_file_name - file containing the parameters
par_base_ptr - pointer to the param section (glb/UDP)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_INIT_PAR
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_LOAD_PAR_V
PURPOSE:
Loading Parameters from a Struct Variable
CATEGORY:
EXPLANATION:
SYNTAX:
tki_load_par_v,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
par_struct - struct variable containing parameters
par_base_ptr - pointer to the param section (glb/UDP)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_INIT_PAR, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_LOAD_SCL()
PURPOSE:
Load the SCL-Code into a String Array
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_load_scl()
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
scl_file - Name of the SCL-File to read
OPTIONAL INPUTS:
None.
OUTPUTS:
String Array with SCL-Code
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 18, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_LOAD_UDP
PURPOSE:
Read the object File and write it into the Array
CATEGORY:
EXPLANATION:
SYNTAX:
tki_load_udp,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
dpu_file - OBJ - filename
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_LOADADDR
PURPOSE:
Load the Address of a Variable onto Stack
CATEGORY:
EXPLANATION:
SYNTAX:
tki_loadaddr,
CALLED BY:
TKI_EXECINSTR, TKI_P_SEARCH
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_FINDVARDATA, TKI_FINDVARDECL, TKI_MESSAGE, TKI_PUSHDATA
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_LOADCON
PURPOSE:
Load a Constant onto Stack
CATEGORY:
EXPLANATION:
SYNTAX:
tki_loadcon,
CALLED BY:
TKI_EXECINSTR, TKI_P_SEARCH
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_FINDCONST, TKI_LOADDATA, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_LOADDATA()
PURPOSE:
Load DATA Array (5 Bytes) to Stack
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_loaddata()
CALLED BY:
TKI_ATPOINTER, TKI_LOADCON, TKI_LOADSUBSCRA, TKI_LOADVAR, TKI_LVALUEAT
EXAMPLES:
INPUTS:
ty - pointer of the type information
ad - pointer to the data
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE, TKI_PUSHDATA
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_LOADSUBSCRA
PURPOSE:
Load a Value of an Array to Stack
CATEGORY:
EXPLANATION:
Pop an array's address and an index value off the
stack, compute the effectiv address, and push it onto
stack.
SYNTAX:
tki_loadsubscra,
CALLED BY:
TKI_EXECINSTR
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_LOADDATA, TKI_MESSAGE, TKI_POPDATA
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_LOADVAR
PURPOSE:
Load a Variable onto Stack
CATEGORY:
EXPLANATION:
SYNTAX:
tki_loadvar,
CALLED BY:
TKI_EXECINSTR
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_FINDVARDATA, TKI_FINDVARDECL, TKI_LOADDATA, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_LVALUEAT
PURPOSE:
Load Value at Adress to Stack
CATEGORY:
EXPLANATION:
SYNTAX:
tki_lvalueat,
CALLED BY:
TKI_EXECINSTR
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_LOADDATA, TKI_POPDATA
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_MASTER
PURPOSE:
Run TCMD in Master Mode
CATEGORY:
EXPLANATION:
SYNTAX:
tki_master,
CALLED BY:
TKI_CALL, TKI_MASTER_CALL
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_PARSE
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_MASTER_ADV
PURPOSE:
Run TCMD in Master Mode
CATEGORY:
EXPLANATION:
SYNTAX:
tki_master_adv,
CALLED BY:
TKI_CALL
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_GEN_CMD, TKI_PARSE, TKI_SCAN_PAR
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_MASTER_CALL
PURPOSE:
Call TKI in Master Mode and initialize Variables
CATEGORY:
EXPLANATION:
SYNTAX:
tki_master_call,
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], TKI_MASTER, concat_dir [4]
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 2, November 10, 1998, Dietmar Germerott, MPAE Lindau
modified detection of current set detector
Version 3, November 11, 1998, Dietmar Germerott, MPAE Lindau
added detector sensitive global parameter loading
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_MATHFUNC
PURPOSE:
Execute the indicated math Function in Simulator
CATEGORY:
EXPLANATION:
SYNTAX:
tki_mathfunc,
CALLED BY:
TKI_LIBCALL
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE, TKI_MNEMOLIB, TKI_POPDATA, TKI_PUSHDATA, TKI_TRIM_CMD
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_MC_TST_REL()
PURPOSE:
Calculate Motion Time of MC_TST_Rel_Pos
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_mc_tst_rel()
CALLED BY:
TKI_DO_MC_CMD
EXAMPLES:
INPUTS:
DEV - Device number (0 - 6)
NUM_STEP - number of steps
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
MCRELPOS, TKI_CALCMOT, TKI_CLOCK
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_MCINITPOS()
PURPOSE:
Simulate Initialize MC Position
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_mcinitpos()
CALLED BY:
TKI_L3CTRL
EXAMPLES:
INPUTS:
dev - MC Device to be initialized (0 - 6)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_MCMOVE()
PURPOSE:
Move 1 MC and calculate the time
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_mcmove()
CALLED BY:
TKI_CELOBJ, TKI_L3CTRL, TKI_MCPOS2, TKI_ROT_MOVE, TKI_RSCSCAN, TKI_SLITPOS
TKI_SPHEL
EXAMPLES:
INPUTS:
dev - Mc Device (0 - 6)
new_pos - new MC Position (in steps)
mc_mode - 1: use MC_TST_RELPOS
0: use MCSCANMOTION
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_DO_MC_CMD, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_MCPOS2()
PURPOSE:
Position two MCs and calculate Time
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_mcpos2()
CALLED BY:
TKI_L3CTRL, TKI_LAMBDA, TKI_POINTTELE, TKI_SPHEL
EXAMPLES:
INPUTS:
dev1 - 1. MC to move (0 - 6)
dev2 - 2. MC to move (0 - 6)
new_pos1 - abs position where to move 1 MC
new_pos2 - abs position where to move 2 MC
res_1 - result of function for 1 MC
res_2 - result of function for 2 MC
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CALCMOT, TKI_CLOCK, TKI_DO_MC_CMD, TKI_MCMOVE, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_MESSAGE
PURPOSE:
Handle the diffenrent output
CATEGORY:
EXPLANATION:
SYNTAX:
tki_message,
CALLED BY:
MCGETERAMVALUE, MCGETERR, MCGETFREQ, MCGETIRAMVALUE, MCGETSTEPS, MCPOWER, MCREADHK
MCRELPOS, MCRELPOSANS, MCRESET, MCSCANMOTION, MCSCANSTEP, MCSELFTEST, MCSETERAMVALUE
MCSETIRAMVALUE, MCSETVARIABLE, TKI_ASSIGN, TKI_ATPOINTER, TKI_BINARY, TKI_CALL
TKI_CALLFUNC, TKI_CELOBJ, TKI_CHECK_COMP, TKI_CLOCK, TKI_DETPOWER, TKI_DET_HIGHV
TKI_DET_MCPHIGH, TKI_DET_QUALIFY, TKI_DET_X_CHARG, TKI_DET_X_TIM
TKI_DET_X_UPPER, TKI_DET_Y_CHARG, TKI_DET_Y_TIM, TKI_DET_Y_UPPER, TKI_DO_DET_CMD
TKI_DO_MC_CMD, TKI_DO_POW_CMD, TKI_DUMP_GLO, TKI_ENTRY, TKI_EXECINSTR
TKI_EXEC_DET, TKI_FCREATE, TKI_FDELETE, TKI_GETMESS, TKI_HLP_ON_CMD, TKI_IMAGEFUNC
TKI_INITELEM, TKI_INITVAR, TKI_INIT_DET, TKI_INIT_DISP, TKI_INIT_TM
TKI_INSERT_UDP, TKI_JUMPS, TKI_L34EXEC, TKI_L3CTRL, TKI_L3RSC, TKI_L4CTRL
TKI_LAMBDA, TKI_LAM_OUT, TKI_LIBCALL, TKI_LIBCTRL, TKI_LOADADDR, TKI_LOADCON
TKI_LOADDATA, TKI_LOADSUBSCRA, TKI_LOADVAR, TKI_LOAD_PAR_V, TKI_LOAD_UDP
TKI_MATHFUNC, TKI_MCINITPOS, TKI_MCMOVE, TKI_MCPOS2, TKI_OPEN_UNIT, TKI_PARSE
TKI_PARSYSFUNC, TKI_POWERUP, TKI_POWEXECUTE, TKI_P_SEARCH, TKI_REFSPEC
TKI_RESTORESET, TKI_RETURN, TKI_RETVALUE, TKI_RET_PARAM, TKI_ROT_INIT
TKI_ROT_MOVE, TKI_RSCON, TKI_RSCSCAN, TKI_RSC_EXEC, TKI_SAVESETTING, TKI_SAVE_UDP
TKI_SCL2OBJgroupgroup, TKI_SETMCPHIGHV, TKI_SLITPOS, TKI_SPHEL, TKI_SPUPD
TKI_SYSCONFIG, TKI_TCMD, TKI_TCMD_EXEC, TKI_TYPECAST, TKI_UNARY, XTKI
EXAMPLES:
INPUTS:
mess_text - output value (string or data)
index_byte - type of message
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_MNEMO()
PURPOSE:
Return the regular token's Mnemonic
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_mnemo()
CALLED BY:
TKI_EXECINSTR, TKI_P_SEARCH
EXAMPLES:
INPUTS:
tok - the token
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_MNEMOL3()
PURPOSE:
Return a level 3 Function subtoken's Mnemonic
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_mnemol3()
CALLED BY:
TKI_FIND_CMD, TKI_GEN_CMD, TKI_L34EXEC, TKI_SCAN_PAR, TKI_TCMD, TKI_USED_FUNC
EXAMPLES:
INPUTS:
tok - the token
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_MNEMOL4()
PURPOSE:
Return a level 4 Function Subtoken's Mnemonic
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_mnemol4()
CALLED BY:
TKI_FIND_CMD, TKI_GEN_CMD, TKI_L34EXEC, TKI_SCAN_PAR, TKI_TCMD, TKI_USED_FUNC
EXAMPLES:
INPUTS:
tok - the token
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_MNEMOLIB()
PURPOSE:
Return a Library Function Subtoken's Mnemonic
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_mnemolib()
CALLED BY:
TKI_FIND_CMD, TKI_GEN_CMD, TKI_IMAGEFUNC, TKI_L34EXEC, TKI_LIBCALL, TKI_MATHFUNC
TKI_PARSYSFUNC, TKI_SCAN_PAR, TKI_TCMD, TKI_USED_FUNC
EXAMPLES:
INPUTS:
tok - the token
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_MNEMOTCI()
PURPOSE:
Return a TCI Control Functions Mnemonic
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_mnemotci()
CALLED BY:
TKI_FIND_CMD, TKI_GEN_CMD, TKI_SCAN_PAR, TKI_TCMD_HELP
EXAMPLES:
INPUTS:
tok - the token
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 15, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_NEXT_LAMBDA()
PURPOSE:
Compute Pixel Difference from Startlambda to Endlambda
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_next_lambda()
CALLED BY:
TKI_LAMBDA, XSPECT
EXAMPLES:
INPUTS:
startlambda, endlambda, dl_0
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_OPEN_UNIT
PURPOSE:
Open all needed UNITs for Output
CATEGORY:
EXPLANATION:
SYNTAX:
tki_open_unit,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_ORDER
PURPOSE:
Convert Lines to same Order
CATEGORY:
EXPLANATION:
SYNTAX:
tki_order,
CALLED BY:
TKI_LAMBDA, TKI_LAMBDA11, TKI_SHOW_LAM
EXAMPLES:
INPUTS:
end_2, start_1, detline
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_P_SEARCH
PURPOSE:
Execute the UDP Step by Step for PARAMETER Searching
CATEGORY:
EXPLANATION:
SYNTAX:
tki_p_search,
CALLED BY:
TKI_CINT
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_ENTRY, TKI_JUMPS, TKI_LIBCALL, TKI_LOADADDR, TKI_LOADCON, TKI_MESSAGE, TKI_MNEMO
TKI_RETURN
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_PAR_OUT
PURPOSE:
Print the known Parameters for a UDP on Screen
CATEGORY:
EXPLANATION:
SYNTAX:
tki_par_out,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
par_struct - Structure where Parameters are load in
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_PAR_READ()
PURPOSE:
Read the Parameters and fill Structure and File
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_par_read()
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
file_spec - Name of File for Parameters
par_struct - Structure where Parameters are load in
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_PARSE
PURPOSE:
Extract CMDs for TCMD from CMD String
CATEGORY:
EXPLANATION:
SYNTAX:
tki_parse,
CALLED BY:
TKI_MASTER, TKI_MASTER_ADV, XTKI_CMD_EXE
EXAMPLES:
INPUTS:
in_string - Command String to be extracted
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE, TKI_TCMD
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_PARSYSFUNC
PURPOSE:
Read a POP/UDP Parameter or System Variable
CATEGORY:
EXPLANATION:
SYNTAX:
tki_parsysfunc,
CALLED BY:
TKI_LIBCALL
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE, TKI_MNEMOLIB, TKI_POPDATA, TKI_PUSHDATA, TKI_TRIM_CMD
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
TKI_PHOTO_BASE()
PURPOSE:
Build the Base for the Photometric Result Widget
CATEGORY:
EXPLANATION:
SYNTAX:
result = tki_photo_base()
CALLED BY:
ST_SUMER_WIN, XTKI
EXAMPLES:
INPUTS:
None required
OPTIONAL INPUTS:
PARENT - ID of a base widget on which the photometric widget is
displayed
OUTPUTS:
Result - ID of photometric widget
OPTIONAL OUTPUTS:
None.
KEYWORDS:
TKI_UDP_STC - UDP structure returned by TKI
MAP - Keyword to map or unmap photometric widget
WID - Strcuture containing various widget IDs including
SPEC_WIN, DET_WIN, DROP_BASE, DROP_ID
CALLS: ***
MK_DFONT, TKI_GRAPH_STC, TKI_LAMBDA11, TKI_PHOTO_BASE_EVENT, XMANAGER
COMMON:
@tki_common_share (used in event handler)
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 23, 1996, Liyun Wang, NASA/GSFC. Written
Version 1.1, June 5, 1997, Dietmar Germerott, MPAE Lindau.
added slit=tki_udp_stc.image(i).slit to call of
tki_show_lam. Otherwise the computed count rates are
wrong.
Version 1.2, July 3, 1997, Dietmar Germerott, MAPE Lindau
renamed tki_show_lam to tki_lambda11
CONTACT:
Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_POINTTELE()
PURPOSE:
Position Telescope Mirrors
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_pointtele()
CALLED BY:
TKI_L3CTRL
EXAMPLES:
INPUTS:
azimco - Telescope Azimuth Position
elevco - Telescope Elevation Position
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_COTOPOS, TKI_DO_POW_CMD, TKI_GET_MCPOWER, TKI_MCPOS2
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_POP16()
PURPOSE:
POP a 16 bit Number onto Stack
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_pop16()
CALLED BY:
TKI_RETURN
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_SPUPD
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_POPDATA()
PURPOSE:
POP a DATA Structure onto Stack
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_popdata()
CALLED BY:
TKI_ASSIGN, TKI_ATPOINTER, TKI_BINARY, TKI_EXECINSTR, TKI_IMAGEFUNC, TKI_JUMPS
TKI_L3CALL, TKI_L4CALL, TKI_LOADSUBSCRA, TKI_LVALUEAT, TKI_MATHFUNC
TKI_PARSYSFUNC, TKI_RETURN, TKI_RETVALUE, TKI_TYPECAST, TKI_UNARY
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_SPUPD
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_POWERUP()
PURPOSE:
Control Detector Power Up
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_powerup()
CALLED BY:
TKI_L3CTRL
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CLOCK, TKI_DO_DET_CMD, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_POWEXECUTE()
PURPOSE:
Handle Pow_switch Array
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_powexecute()
CALLED BY:
TKI_DO_POW_CMD
EXAMPLES:
INPUTS:
dev - Power Switch
act - Action (on / off)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_PUSH16
PURPOSE:
Push a 16 bit number to the Stack
CATEGORY:
EXPLANATION:
SYNTAX:
tki_push16,
CALLED BY:
TKI_CALLFUNC, TKI_CINT, TKI_ENTRY
EXAMPLES:
INPUTS:
num - 16 bit number
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_SPUPD
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_PUSHDATA
PURPOSE:
Push a DATA structure to the Stack
CATEGORY:
EXPLANATION:
SYNTAX:
tki_pushdata,
CALLED BY:
TKI_BINARY, TKI_CALLFUNC, TKI_CINT, TKI_GETPAR, TKI_IMAGEFUNC, TKI_L34EXEC
TKI_LOADADDR, TKI_LOADDATA, TKI_MATHFUNC, TKI_PARSYSFUNC, TKI_RETURN, TKI_TYPECAST
TKI_UNARY
EXAMPLES:
INPUTS:
num - DATA (in bytarr(5))
DATA(0) = Variable type
DATA(1:4) = Variables value
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_SPUPD
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_READ_STUDY
PURPOSE:
Read Studyname and build Log Filenames
CATEGORY:
EXPLANATION:
SYNTAX:
tki_read_study,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_READGLOPAR
PURPOSE:
Read in the SUMER Global Parameter into Common Variable
CATEGORY:
SUMER/Simulator
EXPLANATION:
SYNTAX:
tki_readglopar
CALLED BY:
TKI_INIT_MEM, TKI_TCMD_EXEC, XSPECT_SETSUMPAR
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, July 2, 1997, Dietmar Germerott, MAPE Lindau. Written
Version 1.1, November 11, 1998, Dietmar Germerott, MPAE Lindau
added message for information of global parameter file
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_READIMAGE()
PURPOSE:
Readout Image from IIM
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_readimage()
CALLED BY:
TKI_L3CTRL
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_IIM_READ
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_REFSPEC()
PURPOSE:
Aquire a reference Spectrum
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_refspec()
CALLED BY:
TKI_L3CTRL
EXAMPLES:
INPUTS:
dt -- integration time in steps of 0.25 s
f -- image format
lambda -- wavelength start
delta -- wavelength step
nrinc -- number of increments
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CHECK_COMP, TKI_LAMBDA, TKI_MESSAGE, TKI_ROT_MOVE, TKI_SPHEL
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 22, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_RESGRAPH
PURPOSE:
Plot the Result on Screen or to File
CATEGORY:
EXPLANATION:
SYNTAX:
tki_resgraph, _stat, title, maxtime
CALLED BY:
TKI_EVAL
EXAMPLES:
INPUTS:
_stat - Array of Simulation Result
title - Title String for Plot
maxtime - maximum time of timeline in seconds
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
detector - current detector used for simulation in ASCII
CALLS: ***
BORDERS, SET_LINE_COLOR
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 2, April 15, 1998, GERMEROTT, MPAE LINDAU
added KEYWORD DETECTOR for dependend plot of lines for
Lyman alpha on detector
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_RESTORESET()
PURPOSE:
Restore the actual Settings of the Detector
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_restoreset()
CALLED BY:
TKI_L3CTRL
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], TKI_DO_DET_CMD, TKI_MESSAGE
TKI_SETMCPHIGHV, concat_dir [4]
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_RET_PARAM
PURPOSE:
Return found Parameters in Param search Mode
CATEGORY:
EXPLANATION:
SYNTAX:
tki_ret_param,
CALLED BY:
TKI_INSERT_UDP, TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_RET_RESULT
PURPOSE:
Return Scan Areas and Result STRUCT
CATEGORY:
EXPLANATION:
SYNTAX:
tki_ret_result,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_RETURN
PURPOSE:
Return from a Function Call
CATEGORY:
EXPLANATION:
SYNTAX:
tki_return,
CALLED BY:
TKI_EXECINSTR, TKI_P_SEARCH
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE, TKI_POP16, TKI_POPDATA, TKI_PUSHDATA
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_RETVALUE
PURPOSE:
Save a Function's Return Value
CATEGORY:
EXPLANATION:
SYNTAX:
tki_retvalue,
CALLED BY:
TKI_EXECINSTR
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE, TKI_POPDATA
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_ROT_INIT()
PURPOSE:
Rotation Compensation Initialization
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_rot_init()
CALLED BY:
TKI_L3CTRL
EXAMPLES:
INPUTS:
dt - timestep in seconds when MC 2 has to be moved
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_ROT_MOVE()
PURPOSE:
Perform Rotation Compensation MC2 Motion
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_rot_move()
CALLED BY:
TKI_FULLDISK, TKI_L3CTRL, TKI_REFSPEC
EXAMPLES:
INPUTS:
whichsphel - spectrohelio1-4
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_DO_MC_CMD, TKI_DO_POW_CMD, TKI_GET_MCPOWER, TKI_MCMOVE, TKI_MESSAGE
TKI_ROTSTEPS, TKI_ROT_VAL
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_ROT_VAL()
PURPOSE:
Compute the rotation compensation time step
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_rot_val()
CALLED BY:
TKI_ROT_MOVE
EXAMPLES:
INPUTS:
_Y - Solar Y coordinate
_Z - Solar Z coordinate
_eps - angle of pole axis
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_ROTSTEPS()
PURPOSE:
Compute Number of Sync Steps for Rot_comp
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_rotsteps()
CALLED BY:
TKI_ROT_MOVE
EXAMPLES:
INPUTS:
timestep -
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_RSC_EXEC()
PURPOSE:
Call L4 RSC Functions
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_rsc_exec()
CALLED BY:
TKI_L3RSC, TKI_L4CTRL, TKI_RSCSCAN
EXAMPLES:
INPUTS:
cmd - Command to be executed
time - integration time
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CLOCK, TKI_MESSAGE, TKI_RSCON
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_RSCIH()
PURPOSE:
Handle integration of Picture and transfer to RAM
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_rscih()
CALLED BY:
TKI_L3RSC, TKI_RSCSCAN
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_FCREATE, TKI_IMAGE_FORM
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_RSCON()
PURPOSE:
Start Readout of RSC Picture
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_rscon()
CALLED BY:
TKI_RSC_EXEC
EXAMPLES:
INPUTS:
time - Integration time ID
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CLOCK, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_RSCSCAN()
PURPOSE:
Record 50 RSC Pictures with defined Integrationtime
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_rscscan()
CALLED BY:
TKI_L3CTRL
EXAMPLES:
INPUTS:
itgtime - integrationtime
incdx - MC increments in MC steps
numofloops - number of loops
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_DO_MC_CMD, TKI_DO_POW_CMD, TKI_GET_MCPOWER, TKI_MCMOVE, TKI_MESSAGE, TKI_RSCIH
TKI_RSC_EXEC
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 2, November 10, 1998, Dietmar Germerott, MPAE Lindau
added privilege controled rastering
Version 3, March 14, 2000, Dietmar Germerott, MPAE Lindau
mod priviledge level for raster to 'e0'xb (was 'f0'xb)
Version 4, April 13, 2005, Dietmar Germerott, MPAE Lindau
mod priviledge level for raster to 'f0'xb (was 'e0'xb)
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_SAVE_UDP
PURPOSE:
Save the Result structure of a simulated UDP
CATEGORY:
EXPLANATION:
SYNTAX:
tki_save_udp,
CALLED BY:
ST_SUMER, TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
tki_udp_stc - Result Structure of UDP
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
udp_rst_file - Filename of Save file
CALLS: ***
TKI_MESSAGE
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 18, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_SAVESETTING()
PURPOSE:
Save the actual settings of the active Detector
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_savesetting()
CALLED BY:
TKI_L3CTRL
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], TKI_MESSAGE, concat_dir [4]
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_SCAN_PAR()
PURPOSE:
Scan all available CMDs for Parameter
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_scan_par()
CALLED BY:
TKI_HLP_ON_CMD, TKI_MASTER_ADV, TKI_TCMD_EXEC, XTKI
EXAMPLES:
INPUTS:
cmd_inf - Command as String (Case Sensitive)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CMD_FUNC, TKI_MNEMOL3, TKI_MNEMOL4, TKI_MNEMOLIB, TKI_MNEMOTCI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 16, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_SCL2OBJ(group=group)
PURPOSE:
Select SCL-File compile it and return OBJ-Filename
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_scl2obj()
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
Filename of OBJ-file
OPTIONAL OUTPUTS:
None.
KEYWORDS:
group -
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], MK_DFONT, PICKFILE2, TKI_INIT_MAIN
TKI_MESSAGE, TKI_SCL2OBJ, break_file [4]
COMMON:
@tki_common_share
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 30, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_SET_SPC
PURPOSE:
Set Pointing Center for Spectrohelio3/4
CATEGORY:
EXPLANATION:
SYNTAX:
tki_set_spc,
CALLED BY:
TKI_FULLDISK, TKI_L3CTRL
EXAMPLES:
INPUTS:
azimco - Telescope Azimuth Position
elevco - Telescope Elevation Position
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_COTOPOS
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 1.1, February 28, 1999, Dietmar Germerott, MPAE Lindau
added initialisation of flag for spec3/4 check
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_SETMCPHIGHV()
PURPOSE:
Set MCP HIGH Voltage of active Detector
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_setmcphighv()
CALLED BY:
TKI_L3CTRL, TKI_RESTORESET, TKI_STANDBY
EXAMPLES:
INPUTS:
volt - MCP HV value (-2000 or -5500)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CLOCK, TKI_DO_DET_CMD, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_SETUP_IMG()
PURPOSE:
Setup Parameters for Image format
CATEGORY:
EXPLANATION:
Compute Detector Readout Area, in case of Error
Max Area is Returned
SYNTAX:
Result = tki_setup_img()
CALLED BY:
TKI_LAMBDA11, TKI_SHOW_LAM
EXAMPLES:
INPUTS:
informat - Picture Format
bin_spec - spectral Binning
bin_spat - spatial Binning
comp - compression Scheme
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_IMAGE_FORM
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 21, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_SHOW_LAM
PURPOSE:
Display Wavelength range on Detector Layout
CATEGORY:
EXPLANATION:
SYNTAX:
tki_show_lam,
CALLED BY:
ST_MK_UDP_STC, ST_SUMER_WIN
EXAMPLES:
INPUTS:
pixel - Reference Pixel (like in lambda1x)
lambdax - Wavelength Array (lambda(0) is Reference Wavlength)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
format - Picture Format
slit - Slit number
detector - used Detector
compression - Compression Scheme
spec - Binning spectral
spat - Binning spatial
log - display Intensity on Det Log
CALLS: ***
TKI_DET_RANGE, TKI_DISPLAY_DET, TKI_ORDER, TKI_SETUP_IMG
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 21, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_SHUTDOWN()
PURPOSE:
Shut Down Detector
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_shutdown()
CALLED BY:
TKI_L3CTRL
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_DETPOWER, TKI_STANDBY
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_SLIT()
PURPOSE:
Return the slit Parameters in 1/16 arcsec
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_slit()
CALLED BY:
TKI_INIT_MEM, TKI_SLITPOS
EXAMPLES:
INPUTS:
idx - Slit number (see SCL Slit)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_SLITPOS()
PURPOSE:
Position MC4SLITSelect
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_slitpos()
CALLED BY:
TKI_L3CTRL
EXAMPLES:
INPUTS:
newslit - slit number of slit table see OP-G cmd slit
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_DO_POW_CMD, TKI_GET_MCPOWER, TKI_MCMOVE, TKI_MESSAGE, TKI_SLIT
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_SPHEL()
PURPOSE:
Simulate the SUMER Spectrohelio Functions
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_sphel()
CALLED BY:
TKI_FULLDISK, TKI_L3CTRL, TKI_REFSPEC
EXAMPLES:
INPUTS:
incdx - Delta Step (see SCL SpectrohelioX)
numofpic - Number of Scans (see SCL SpectrohelioX)
whichsphel - Which spectrohelio ( 1, 2, 3, 4) as L3
Function number
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CALCMOT, TKI_DO_MC_CMD, TKI_DO_POW_CMD, TKI_GET_MCPOWER, TKI_IIM_READ
TKI_MCMOVE, TKI_MCPOS2, TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 2, November 10, 1998, Dietmar Germerott, MPAE Lindau
added privilege controled rastering
Version 3, February 9, 1999, Dietmar Germerott, MPAE Lindau
mod priviledge level for raster to 'f0'xb (was 'e0'xb)
Version 4, March 14, 2000, Dietmar Germerott, MPAE Lindau
mod priviledge level for raster to 'e0'xb (was 'f0'xb)
Version 5, April 13, 2005, Dietmar Germerott, MPAE Lindau
mod priviledge level for raster to 'f0'xb (was 'e0'xb)
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_SPUPD
PURPOSE:
Update the stack offset. Check for underflow/overflow
CATEGORY:
EXPLANATION:
SYNTAX:
tki_spupd,
CALLED BY:
TKI_POP16, TKI_POPDATA, TKI_PUSH16, TKI_PUSHDATA
EXAMPLES:
INPUTS:
corr - correction for Stack update
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_STANDBY()
PURPOSE:
Switch selected Detector to Standby Mode
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_standby()
CALLED BY:
TKI_L3CTRL, TKI_SHUTDOWN
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_DETPOWER, TKI_DO_DET_CMD, TKI_SETMCPHIGHV
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_SWEETDREAM
PURPOSE:
Simulating UDP during the night
CATEGORY:
VMS SUMER Simulation support
EXPLANATION:
SYNTAX:
tki_sweetdream
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
filename - SCL-Filname or Wildcard
exclude - usernames to be excluded from simulation
quiet - No Mail Message in case of success of Batch
COMMON:
None.
RESTRICTIONS:
Only usefull on VMS SUMER NODES at GSFC
SIDE EFFECTS:
None.
HISTORY:
Version 1, November 4, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_SYSCONFIG()
PURPOSE:
Simulate SysConfig Cmd of SUMER
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_sysconfig()
CALLED BY:
TKI_L4CTRL
EXAMPLES:
INPUTS:
w_1 .. w_5 Config Words (see OPG Section 6 SYS_Config)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
TKI_TCMD
PURPOSE:
Driverroutine for Technical Simulator
CATEGORY:
EXPLANATION:
Handles the Telecommands for the Simulation
SYNTAX:
tki_tcmd, cmd_str [, p_1,...,p_12]
CALLED BY:
ST_MK_UDP_STC, TKI_CALL, TKI_PARSE, TKI_TCMD_EXEC, XTKI, XTKI_CMD_EXE
EXAMPLES:
INPUTS:
cmd_str - Name of Sumer Cmd / TKI-Control-Cmd
OPTIONAL INPUTS:
p_1 ... p_12 - Parameters for cmd_str
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_CMD_FUNC, TKI_L34EXEC, TKI_MESSAGE, TKI_MNEMOL3, TKI_MNEMOL4, TKI_MNEMOLIB
TKI_TCMD_EXEC
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, April 12, 1995, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_TCMD_EXEC
PURPOSE:
Execute Commands of TCMD
CATEGORY:
EXPLANATION:
Executes the Commands for Tokeninterpreter/Simulator Control
SYNTAX:
tki_tcmd_exec, cmd_f, cmd_p, p_1, ..., p_12
CALLED BY:
TKI_TCMD
EXAMPLES:
INPUTS:
CMD_F - Commandnr in Byte
CMD_P - Number of required Par for Cmd
P_1 ... P_12 - Parameter of Command
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], COMPARE_VAR, CONCAT_DIR [1]
CONCAT_DIR [2], CONCAT_DIR [3], RSTRPOS, TKI_CINT, TKI_CLOCK, TKI_CLOSE_UNIT
TKI_DUMP_GLO, TKI_EVAL, TKI_FINIT, TKI_GETMESS, TKI_HLP_ON_CMD, TKI_INIT_DET
TKI_INIT_DISP, TKI_INIT_MAIN, TKI_INIT_MEM, TKI_INIT_SPEC, TKI_INIT_TM, TKI_INSERT
TKI_I_PARSTRUCT, TKI_LAM_OUT, TKI_LOAD_PAR_V, TKI_LOAD_SCL, TKI_LOAD_UDP
TKI_MESSAGE, TKI_OPEN_UNIT, TKI_PAR_OUT, TKI_PAR_READ, TKI_READGLOPAR
TKI_READ_STUDY, TKI_RET_PARAM, TKI_RET_RESULT, TKI_SAVE_UDP, TKI_SCAN_PAR
TKI_TCMD, TKI_TCMD_HELP, break_file [4], concat_dir [4]
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 12, 1996, Dietmar Germerott, MAPE Lindau. Written
Version 1.1, September 3, 1997, Dietmar Germerott, MAPE Lindau
added /dump comand to save stat array
Version 1.2, November 11, 1998, Dietmar Germerott, MPAE Lindau
added change of globals when switching detector
Version 1.3, February 28, 1999, Dietmar Germerott, MPAE Lindau
added check if spectrohelio3/4 is used when Set_SphelPointCenter
is set, otherwise -> Error (requested by KW)
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_TCMD_HELP
PURPOSE:
Print Help on Commands for Simulator
CATEGORY:
EXPLANATION:
SYNTAX:
tki_tcmd_help,
CALLED BY:
TKI_TCMD_EXEC
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MNEMOTCI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_TELEMETRY
PURPOSE:
COMPUTE SENDED DATA
CATEGORY:
EXPLANATION:
SYNTAX:
tki_telemetry,
CALLED BY:
TKI_CLOCK
EXAMPLES:
INPUTS:
d_time - delta time
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_FDELETE
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_TOK_FUNC()
PURPOSE:
Return the Function Nr of CMD String in STRUCT
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_tok_func()
EXAMPLES:
INPUTS:
cmd_str - the Commandstring
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_TRANS_TIM()
PURPOSE:
Compute the transmission time of given Image
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_trans_tim()
EXAMPLES:
INPUTS:
image_form = SUMER Image format
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
high_rate = Calculate for high TM rate (21 kb/s)
CALLS: ***
TKI_IMAGE_FORM
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 26, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_TRIM_CMD()
PURPOSE:
Concatenate CMD and Parameters and trim to a string
CATEGORY:
EXPLANATION:
SYNTAX:
Result = tki_trim_cmd()
CALLED BY:
TKI_IMAGEFUNC, TKI_L34EXEC, TKI_MATHFUNC, TKI_PARSYSFUNC
EXAMPLES:
INPUTS:
cmd_str - string of command to concatenate with par #
parameter_arr - includes the params to be concatenate #
cnt - number of parameters
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_TYPECAST
PURPOSE:
Execute the type cast operation indicated by token
CATEGORY:
EXPLANATION:
SYNTAX:
tki_typecast,
CALLED BY:
TKI_EXECINSTR
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE, TKI_POPDATA, TKI_PUSHDATA
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_UDPSLIT()
PURPOSE:
Get the first used slit in UDP out of tki_udp_stc
CATEGORY:
Util SUMER
EXPLANATION:
SYNTAX:
Result = tki_udpslit(filename [,error=error,allslit=allslit,
lastslit=lastslit,firstslit=firstslit)
EXAMPLES:
INPUTS:
filename - MMD-Filenamae
OPTIONAL INPUTS:
None.
OUTPUTS:
Status - defined or not (1/0)
OPTIONAL OUTPUTS:
None.
KEYWORDS:
error - error
allslit - return all used slits in UDP
firstslit - return first used slit in UDP
lastslit - return last used slit in UDP
CALLS: ***
DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4], TEST_OPEN, UNIQ [1], UNIQ [2]
UNIQ [3], delvarx [5]
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, July 7, 1997, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
TKI_UNARY
PURPOSE:
Execute the unary function indicated by the token
CATEGORY:
EXPLANATION:
SYNTAX:
tki_unary,
CALLED BY:
TKI_EXECINSTR
EXAMPLES:
INPUTS:
token - the token
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MESSAGE, TKI_POPDATA, TKI_PUSHDATA
COMMON:
@tki_common_priv
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 13, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
TKI_USED_FUNC
PURPOSE:
Display all used functions inside a UDP/POP, sorted by l3,l4,lib
CATEGORY:
EXPLANATION:
SYNTAX:
tki_used_func, func_arrl3, funcarrl4, func_arrlib
EXAMPLES:
INPUTS:
func_arrl3, func_arrl4, func_arrlib
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
TKI_MNEMOL3, TKI_MNEMOL4, TKI_MNEMOLIB
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 11, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
PROGRAM: to check data generated by the IP instruction TWAVG.
The program expects the name of a decom file containing 13
images, the first 12 being data images while the 13th is the
weighted average of the images.
This data set is generated by the control procedures, DOTWAVG
(which calls TWAVG).
CALLS:
[Previous]
[Next]
Project : SOHO - CDS
Name : tot_int
Purpose : Calculate the totel line intensity
Explanation : The total line intensity is calculated in three
different ways: 1) By adding the pixel values
across the selected line
2) By finding the FWHM and maximum
intensity
3) By fitting with a gaussian and
routine LSTSQR.
Use : IDL> tot_int, 'selected spectral line', x posisjon
in raster, y posisjon in raster
Inputs : line to fine total intensity of and its raster
position
Opt. Inputs : None
Outputs : Total intensities (only displayed in widget!!)
Opt. Outputs: None
Keywords : None
Calls : ***
LSTSQR, funct_1, int_fwhm [1], int_fwhm [2], int_sum, read_cds_im
CALLED BY:
tot_int_w_event
Common : tot.com
Restrictions: None
Side effects: None
Category : ?
Prev. Hist. : None
Written : Nils Brynildsen, ITA, UiO 20-Sep.-1993
Modified : Version 1 Nils Brynildsen, ITA, UiO, 20-Sep.-1993
Version : Version 1 20-Sep.-1993
[Previous]
[Next]
Project : SOHO - CDS
Name : tot_int_w
Purpose : Set up widget window
Explanation :
Use : IDL> tot_int_w
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
XMANAGER, XPDMENU
Common : tot.com
Restrictions: None
Side effects: None
Category : ?
Prev. Hist. : None
Written : Nils Brynildsen, ITA, UiO 20-Sep.-1993
Modified : Version 1 Nils Brynildsen, ITA, UiO, 20-Sep.-1993
Version : Version 1 20-Sep.-1993
[Previous]
[Next]
Project : SOHO - CDS
Name : tot_int_w_event
Purpose : Widget control
Explanation : Controls widget
Use : ?
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
tot_int
Common : tot.com
Restrictions: None
Side effects: None
Category : ?
Prev. Hist. : None
Written : Nils Brynildsen, ITA, UiO 20-Sep.-1993
Modified : Version 1 Nils Brynildsen, ITA, UiO, 20-Sep.-1993
Version : Version 1 20-Sep.-1993
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_BSCALE()
Purpose : Scales VDS data for display with TP_COLTABLE color table.
Explanation : This procedure scales simulated VDS data for display with the
color table loaded by the routine TP_COLTABLE. The array is
scaled logarithmically, so that values in the approximate range
0-41 are in the lower third of the color table (blue), 41-410
in the middle third (orange) and 410-4095 in the upper third
(white). Values of 4096 and above are displayed as red pixels.
Use : TV, TP_BSCALE(ARRAY)
EXPTV, TP_BSCALE(ARRAY), /NOSCALE
Inputs : ARRAY = Simulated VDS data array from VDS_DUMMY, or
equivalent.
Opt. Inputs : None.
Outputs : The result of the function is a logarithmically scaled byte
array with the values matched to the number of colors for the
currently selected graphics device.
Opt. Outputs: None.
Keywords : TOP = The maximum value of the scaled image array, as used
by BSCALE. The default is !D.N_COLORS-1.
Calls : ***
BSCALE
CALLED BY:
DISPLAY_NIS_WIN, ERASE_NIS_WIN, LOAD_TP_STRUCT, MK_RASTER, TP_COLBAR, TP_REDISPLAY
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, Technical.
Prev. Hist. : None.
Written : William Thompson, GSFC, 23 September 1993.
Modified : Version 1, William Thompson, GSFC, 23 September 1993.
Version : Version 1, 23 September 1993.
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_CALC_COMP
Purpose : To calculate effect of compression on VDS data array
Explanation : For the sum over line and sum over windows compression
schemes, this routine performs that summation over the
the data windows in the displayed data.
Use : tp_calc_comp, data, str
Inputs : data - the VDS data array intarr(1024,256)
Opt. Inputs : None
Outputs : Data array is updated
Opt. Outputs: None
Keywords : None
Calls : None
CALLED BY:
TP_GET_DUMDATA
Common : None
Restrictions: None
Side effects: None
Category : Technical, planning
Prev. Hist. : None
Written : C D Pike, RAL, 20-Oct-94
Modified : Updated numbers of sum line/window schemes. CDP, 2-Nov-95
Handle unlikely case of FULL CCD extraction. CDP, 08-Jan-96
Changed method of displaying summed data. CDP, 14-Mar-96
Version : Version 4, 14-Mar-96
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_CALL_HELP
Purpose : Put up a help window for widget event generated.
Explanation : When the mk_raster routine is in ONLINE HELP mode then the
widget events are trapped and the user-value of the widget
generating the event is passed to here so the appropriate
help can be generated.
Use : tp_call_help, user_value, ev
Inputs : user_value - the user value specified at the creation of the
widget.
ev - the event structure
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
POPUP_MSG, TAG_EXIST [1], TAG_EXIST [2]
CALLED BY:
MK_RASTER
Common : None
Restrictions: None
Side effects: None
Category : Help, planning
Prev. Hist. : None
Written : C D Pike, RAL, 16-Feb-95
Modified :
Version : Version 1, 16-Feb-95
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_CHK_RAST()
Purpose : Check feasibility of fundamental raster parameters.
Explanation : First approximation to checks on the fundamental raster
parameters. ie is the scan area sensible for mechanisms
and for the slit requested. Further tests to be added.
Use : IDL> status = tp_chk_raster(tp_obs [,errmsg=errmsg,$
warnmsg=warnmsg)
Inputs : tp_obs - TPLAN internal-type structure
Opt. Inputs : None
Outputs : Function returns 1 if raster considered OK or 0 if not.
(See also keywords)
Opt. Outputs: None
Keywords : errmsg - if defined on entry then will return with any error
message
warnmsg - if defined on entry then will return with any
warning messages.
Calls : ***
TP_CHK_RASTER
Common : None
Restrictions: None
Side effects: None
Category : Technical, planning
Prev. Hist. : None
Written : C D Pike, RAL, 14-Oct-94
Modified : Eliminate check on raster description. CDP, 18-Oct-95
Version : Version 2, 18-Oct-95
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_CLEAR_LINES
Purpose : Clears LINES/WINDOWS branches of tp_obs structure.
Explanation : Sets the contents of the .line_list(2), .data_win(2)
.vds_win, .line_w and .flag_w tags in the main observation
definition structure to their default values.
Use : IDL> tp_clear_lines [,/win]
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : WIN - set if only want extraction windows cleared.
Calls : ***
XREGISTERED
CALLED BY:
MK_RASTER, TP_RECALC_DEW
Restrictions: None
Side effects: None
Category : Planning Technical
Prev. Hist. : None
Written : C D Pike, RAL 12-Jul-94
Modified : Add /WIN keyword. CDP, 29-Nov-94
Include clearing of higher up IDs. CDP, 10-Nov-95
Version : Version 3, 10-Nov-95
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_CLEAR_RASTER
Purpose : Clears raster branch of structure used in the tech planning.
Explanation : Clears all details apart from the instrument kept in the
raster_p and raster_v structures.
Use : IDL> tp_clear_raster
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : None
CALLED BY:
MK_RASTER
Restrictions: None
Side effects: None
Category : Planning, Technical
Prev. Hist. : None
Written : C D Pike, RAL, 6-Dec-94
Modified : Include ief_id in raster variation. CDP, 09-Nov-95
Version : Version 2, 09-Nov-95
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_CLEAR_STATE
Purpose : Clears STATE branch of structure used in the tech planning.
Explanation : Sets the contents of the .state tag in the main observation
definition structure to the default values.
Use : IDL> tp_clear_state
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
XREGISTERED
CALLED BY:
MK_RASTER
Restrictions: None
Side effects: None
Category : Planning, Technical
Prev. Hist. : None
Written : C D Pike, RAL, 12-Jul-94
Modified :
Version : Version 1, 12-Jul-94
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_COLBAR
Purpose : Displays colour bar on TPLAN screen.
Explanation : Displays a colour bar to show the image-colour scaling
in the main TPLAN display window.
Use : tp_colbar
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
COLOR_BAR, TP_BSCALE
CALLED BY:
MK_RASTER, TP_REDISPLAY
Common : TPLAN common blocks
Restrictions: Only for use with TPLAN
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 18-Oct-94
Modified : Version 1, C D Pike, RAL, 18-Oct-94
Version 2, William Thompson, GSFC, 20 October 1994
Modified to correctly reflect quasi-logarithmic nature
of tp_bscale.
Version 3, William Thompson, GSFC, 21 October 1994
Allow highest plotted color to vary, depending on the
data.
Version 4, William Thompson, GSFC, 21 March 1995
Added /DISABLE keyword to COLOR_BAR call
Version : Version 4, 21 March 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_COLTABLE
Purpose : Loads a special color table for technical planning.
Explanation : This routine loads a special color table for technical
planning. It is to be used in conjunction with TP_BSCALE. The
first third of the color table is mainly blue. This gradually
turns to orange and then to white. This is to provide
visibility over three decades of VDS data. The topmost color
is pure red to indicate saturation.
Use : TP_COLTABLE
Inputs : None.
Opt. Inputs : None.
Outputs : The color tables for the current graphics device are modified.
Opt. Outputs: None.
Keywords : None.
Calls : ***
REVERSE
CALLED BY:
LOAD_TP_STRUCT, MK_RASTER
Common : Uses the standard IDL common block COLORS.
Restrictions: None.
Side effects: None.
Category : Planning, Technical.
Prev. Hist. : None.
Written : William Thompson, GSFC, 23 September 1993.
Modified : Version 1, William Thompson, GSFC, 23 September 1993.
Version 2, CDP, To handle B&W terminals. 12-Jan-96
Version 3, William Thompson, GSFC, 8 April 1998
Changed !D.N_COLORS to !D.TABLE_SIZE for 24-bit displays
Version : Version 3, 8 April 1998
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_DB2INT
Purpose : Transfer database line list structure to TPLAN internal.
Explanation : The structure returned by the linelist database interrogation
routine get_linelist is not that required internally by the
technical planning procedure TPLAN. This procedure loads
the TPLAN internal structures from data contained in the
database structure.
Use : IDL> tp_db2int,db_ll, raster
Inputs : db_ll - structure returned by routine GET_LINELIST
raster - raster structure returned by GET_RASTER
Opt. Inputs : None
Outputs : None - internal structure held in common
Opt. Outputs: None
Keywords : None
Calls : ***
COPY_STRUCT [1], COPY_STRUCT [2], COPY_STRUCT [3]
CALLED BY:
LOAD_TP_STRUCT, TP_DISP_LLIST, TP_DISP_RAST
Common : None
Restrictions: None
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 24-Aug-94
Modified : Use copy_struct. CDP, 7-Apr-95
Version : Version 2, 5-Apr-95
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_DISP_IEF
Purpose : Defines display of ief definitions.
Explanation : Creates the widgets which form the window within which
the ief definitions are displayed.
Use : tp_disp_ief, status
Inputs : None
Opt. Inputs : None
Outputs : status - 1 if entries found in database, 0 else.
Opt. Outputs: None
Keywords : None
Calls : ***
Bell, DEL_WINDOW, DISPLAY_GIS_WIN, DISPLAY_NIS_WIN, ERASE_NIS_WIN, FLASH_MSG
GET_IEF, PIX2WAVE, SORT_WINDOWS, TP_D_FLG_EVENT, TP_RECALC_DEW, XREGISTERED
CALLED BY:
MK_RASTER
Restrictions: For use with MK_RASTER
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 07-Nov-95
Modified :
Version : Version 1, 07-Nov-95
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_DISP_LLIST
Purpose : Defines display of database line lists.
Explanation : Creates the widgets which form the window within which
the database line lists are displayed.
Use : tp_disp_llist, status
Inputs : None
Opt. Inputs : None
Outputs : status - equals 1 if entries found 0 else
Opt. Outputs: None
Keywords : None
Calls : ***
FLASH_MSG, FMT_VECT, GET_DATAWIN, GET_LINELIST, GET_RASTER, LIST_DATAWIN
LIST_LINELIST, LOAD_TP_STRUCT, TP_DB2INT, TP_D_LL_EVENT, TP_RECALC_DEW
XREGISTERED
CALLED BY:
MK_RASTER
Restrictions: For use with TPLAN
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 24-Aug-94
Modified : Add selection of data window parameters. CDP, 18-oct-94
Add return status. CDP, 6-Dec-94
Added picking up of data windows. CDP, 21-Feb-95
Fixed bug when no linelists found. CDP, 28-Sep-95
Rest variation ID when LL selected and fix format. CDP, 21-May-97
Version : Version 5, 21-May-97
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_DISP_RAST
Purpose : Defines display of raster parameters.
Explanation : Creates the widgets which form the window within which
the raster parameters are displayed.
Use : tp_disp_rast, status
Inputs : None
Opt. Inputs : None
Outputs : status - 1 if entries found in database, 0 else.
Opt. Outputs: None
Keywords : None
Calls : ***
COPY_STRUCT [1], COPY_STRUCT [2], COPY_STRUCT [3], DBCLOSE [1], DBCLOSE [2]
DBCLOSE [3], DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3]
DBUPDATE [1], DBUPDATE [2], DBUPDATE [3], DBUPDATE [4], FLASH_MSG, GET_DATAWIN
GET_F_RASTER, GET_LINELIST, GET_RASTER, LIST_F_RASTER, LIST_V_RASTER
LOAD_TP_STRUCT, TP_DB2INT, TP_D_R_EVENT, TP_RECALC_DEW, XREGISTERED
CALLED BY:
MK_RASTER
Restrictions: For use with TPLAN
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 23-Aug-94
Modified : Include detector specification. CDP, 6-Sep-94
Handle empty databases. CDP, 28-Nov-94
Add status return. CDP, 6-Dec-94
Added handling of data windows. CDP, 21-Feb-95
Added facility to update database descriptions. CDP, 27-Nov-95
Fix ID format size. CDP, 3-Feb-97
Fixed bug when selecting rasters from database. CDP, 21-Jul-97
Version : Version 8, 21-Jul-97
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_DISPLAY_DEW
Purpose : Defines the window to display Data Extraction Windows.
Explanation : Creates the widgets which form the window within which
the DEWs are displayed.
Use : tp_display_dew
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
PS [1], PS [2], PSPLOT [1], PSPLOT [2], TP_D_DEW_EVENT, TP_PLOT_DEW, XPDMENU
XREGISTERED
CALLED BY:
MK_RASTER
Restrictions: For use with TPLAN
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 14-Jul-94
Modified :
Version : Version 1, 14-Jul-94
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_DISPLAY_GP
Purpose : Defines the window to display VDS parameters.
Explanation : Creates the widgets which form the window within which
the VDS detector parameters are displayed.
Use : tp_display_gp
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
TP_D_GP_EVENT, XREGISTERED
Restrictions: For use with TPLAN
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 12-Jul-94
Modified :
Version : Version 1, 12-Jul-94
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_DISPLAY_VP
Purpose : Defines the window to display VDS parameters.
Explanation : Creates the widgets which form the window within which
the VDS detector parameters are displayed.
Use : tp_display_vp
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
FMT_VECT, TP_D_VP_EVENT, XREGISTERED
CALLED BY:
MK_RASTER
Restrictions: For use with TPLAN
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 12-Jul-94
Modified : Make display only, no settable values. CDP, 4-Apr-95
Cut out display of readout mode and MCP voltage. CDP, 29-Jul-96
Version : Version 3, 29-Jul-96
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_DRAW_MESSAGE
Purpose : To put message in technical planning image area
Explanation : Used to signal user is in HELP mode.
Use : tp_draw_message
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
DISP_TXT
CALLED BY:
MK_RASTER
Common : None
Restrictions: Use only within mk_raster
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 15-Feb-95
Modified :
Version : Version 1, 15-Feb-95
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_DRAW_RASDUR
Purpose : Plot the calculated exposure interval for a raster.
Explanation : Plots the exposure interval and on board packet buffer use
as calculated by the software model of the CDHS behaviour.
Use : IDL> tp_draw_rasdur, obs_str
Inputs : obs_str - a valid TPLAN data structure.
Opt. Inputs : None
Outputs : Just plots the results.
Opt. Outputs: None
Keywords : HARD - for hardcopy plot
Calls : ***
CIRCLE_SYM, EXT_RANGE, PS [1], PS [2], PSPLOT [1], PSPLOT [2], RASTER_DUR, ROUND_OFF
TRIM, XREGISTERED
CALLED BY:
MK_RASTER, TP_RASDUR
Common : None
Restrictions: None
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 04-Mar-96
Modified :
Version : Version 1, 04-Mar-96
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_DRAW_VWIN
Purpose : Plot the data in the extraction windows in a raster.
Explanation : Plots the data extraction windows used in a raster for
illustrative purposes. Works from the observation
definition structure used in MK_RASTER.
Use : IDL> tp_draw_vwin, obs_str
Inputs : obs_str - a valid TPLAN data structure.
Opt. Inputs : None
Outputs : Just plots the results.
Opt. Outputs: None
Keywords : HARD - for hardcopy plot
Calls : ***
PIX2WAVE, PS [1], PS [2], PSPLOT [1], PSPLOT [2], SAME_DATA [1], SAME_DATA [2]
XREGISTERED
CALLED BY:
MK_RASTER, TP_PLOT_VDS
Common : None
Restrictions: None
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 04-Mar-96
Modified : Adjust for slit and exposure time. CDP, 05-May-99
Version : Version 2, 06-May-99
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_DUMP_SETUP
Purpose : Produce hardcopy of TPLAN setup structure.
Explanation : Sets down on paper the details contained within the
TPLAN structure. Can either have shortened versions if
requested.
Use : tp_dump_setup, tp_obs [,/line, /raster, /dwin]
Inputs : tp_obs - the standard internal TPLAN structure.
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : LINE - produces a listing of the line list details only
RASTER - produces details of the raster definition only
DWIN - produces details of the data windows only
Calls : ***
STRPAD, TRIM
CALLED BY:
MK_RASTER
Common : None
Restrictions: None
Side effects: None
Category : Technical, planning
Prev. Hist. : None
Written : C D Pike, RAL, 1-Nov-94
Modified : Fixed typo in output format. CDP, 1-Jul-96
Rework handling of user compression scheme. CDP, 06-Oct-97
Version : Version 3, 06-Oct-97
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_EDIT_LINES
Purpose : Widget to edit the technical planning lines list.
Explanation : later!
Use : Only within TPLAN
Inputs : file_name - the full path name to the lines file
line_structure - the structure containing the current
line/window information.
Opt. Inputs : None
Outputs : TPLAN structure tp_obs is updated.
Opt. Outputs: None
Keywords : None
Calls : tp_edit_table
CALLED BY:
MK_RASTER
Restrictions: None
Side effects: None
Category : Technical planning
Prev. Hist. : None
Written : C D Pike, RAL, 24-May-1993
Modified : Major rewrite. CDP, 22-Sep-94
Add selection from line list. CDP, 3-Apr-95
Put out 'be patient' message on exit and cut arrays
to size actually usable. CDP, 09-Nov-95
Cut out desensitising of buttons when CDS line list
selected. CDP, 10-Oct-96
Version : Version 5, 10-Oct-96
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_EDIT_TABLE()
Purpose : 2-D array screen editor for technical planning.
Explanation : An amended version of the original EDIT_TABLE which caters
specifically for features of the technical planning line-
window editing. For instance, if an entry is inserted in a
column then all the columns are adjusted to make room for
a new entry in all and certain interdependencies of the
columns are catered for eg if a wavelength is specified the
line centre pixel location is automatically calculated and
if the window width is changed then the left hand edge pixel
value is reset. Others can be added later as appropriate.
This compound widget function produces a spreadsheet-type table
of text data which can be edited by the user. The table is defined
in terms of a number of columns and a number of rows and hence
takes data from a 2-D array. Each column in the table can be
given a text header and an integer row index can be optionally
displayed in a column along the edge of the table. The table may
include editable and non-editable columns as defined by the
caller. Optionally the text data which is entered may be
specified as representing integer or float values in which case
any illegal values will be flagged as in error.
The widget consists of an array of single line text widgets.
The user can direct the keyboard input to any text 'Cell' by
clicking on that cell with the mouse. If the user presses the
return key the keyboard input moves to the next cell. The
direction in which the active cell moves, down columns or across
rows, is under the control of the user via the 'Row_skip' and
'Column_skip' toggle buttons. When the end of a column or row
is reached the input moves to the begining of the next column or
row.
The caller can specify two different fonts via the FONTS keyword
to distinguish between editable and non-editable data.
A number of editing features are provided with this edit widget.
These features are listed with toggle buttons along the bottom
of the edit cell array. To use an edit feature position the
keyboard input cursor on the required cell, switch on the edit
facility with its toggle button and then press the return key
to perform the operation. The edit facilities are;
Delete - Set the text cells in the current row to empty.
Remove - Delete all the entries for the current line (row)
Insert - Insert a blank line (row)
Copy - Copy the value from the current CELL into a
buffer.
Paste - Copy the current buffer contents into the
current CELL.
These edit control buttons can be removed from the widget by
specifying the NOCON keyword.
This file includes the event management and SET_VALUE/GET_VALUE
routines. The VALUE of this widget is the 2-D string array of
text from the array of table edit cells.
Use :
IDL> data = make_array(5,6,/float,value=25.0)
IDL> strdata = string(data)
IDL> base = WIDGET_BASE(/COLUMN)
IDL> edid = TP_EDIT_TABLE(base,NCOLS=5,NROWS=6,$
VALUE=strdata,/FLOAT)
Creates a table edit widget for an array of
float values. The keyword /FLOAT instructs the widget to check
all user input to see if it represents a valid floating point
number. This code does not realize the widget.
The value of the widget, the string array, can be set and
read using WIDGET_CONTROL. The following code will reset the
data in the table to new values;
WIDGET_CONTROL,edid,SET_VALUE=strdata2
The following code will read the current string data from the
edit table, perhaps after the user has made modifications;
WIDGET_CONTROL,edid,GET_VALUE=outdata
This code creates an edit table with column headers. Column
headers 1 and 3 have two rows of text. The row index column
which appears to the left of the table by default is switched off.
Of the four columns only the first and second columns are
editable. The data are taken to be text data. The edit control
buttons are switched off.
IDL> strdata = make_array(4,3,value='Text Data')
IDL> base = WIDGET_BASE(/COLUMN)
IDL> edid = TP_EDIT_TABLE(base,NCOLS=4,NROWS=3,VALUE=strdata, $
COLHEAD=[['Column 1','Column 2,'Column 3','Column 4'], $
['Data','','Data','']], $
COLEDIT=[1,1,0,0],/NOINDEX,/NOCON)
The basic widget does not include 'Quit' or 'Done' buttons.
This widget does not generate events itself, all events are
handled internally.
Inputs : PARENT - The ID of the parent widget.
Opt. Inputs : None. See the keywords for additional controls.
Outputs : The return value of this function is the ID of the compound
widget which is of type LONG integer.
Opt. Outputs: None
Keywords :
NCOLS - The number of columns of data. The default is one column.
NROWS - The number of rows of data. The default is one row.
COLEDIT - Flags to indicate which columns are editable, type
INTARR(NCOLS). The default is all columns are editable.
COLHEAD - Column headers, type STRARR(NCOLS,n). Each of the n
rows of header is placed one below another at the top
of each column.
VALUE - Array of initial data values, type STRARR(NCOLS,NROWS).
Elements of the string array may contain empty strings.
The default is blank data fields.
FLOAT - Set this keyword to indicate that the data values must
represent valid floating point numbers.
INTEGER - Set this keyword to indicate that the data values must
represent valid integer numbers.
UVALUE - Supplies the user value for the widget.
NOINDEX - Set this keyword to remove the column of integer index
values at the far left of the table. The default is
for the index column to appear.
NOCON - Set this keyword to remove the edit control buttons
delete, remove, insert etc.
YSIZE - Specifies the ysize of the table in rows of cells.
If ysize is less than the number of rows the columns
are split and placed side-by-side.
CELLSIZE - Specifies the character width of the text widget
cells which make up the table. The default is 8.
In some circumstances the windows toolkit may ignore
this setting depending on the width of the column
header.
NOEDIT - Set this keyword to make all data fields non-editable.
The default is for all data columns specified by COLEDIT
to be editable.
ROWSKIP - By default the cursor skips down columns of cells
when the return key is pressed. Set this keyword to
cause the cursor to skip across rows in the table.
FONTS - Structure of two fonts to use for table,
{font_norm:string, font_input:string}
Calls : ***
CW_LOADSTATE, CW_SAVESTATE, FLASH_MSG, NUM_CHK, PIX2WAVE, TP_EDTAB_EVENT
TP_EDTAB_GETVAL, TP_EDTAB_SETVAL, WAVE2PIX, WHICH_GIS_BAND, WHICH_NIS_BAND
Side effects:
This widget uses a COMMON BLOCK: CW_TP_EDTAB_BLK to hold the
widget state.
Three other routines are included which are used to manage the
widget;
TP_EDTAB_SETVAL
TP_EDTAB_GETVAL()
TP_EDTAB_EVENT()
Category : Technical planning, Util, Widget
Prev. Hist. : Original CW_EDIT_TABLE by Andrew Bowen,
Tessella Support Services plc, 4-Mar-1993
Written : CDS Technical planning version by C D Pike, RAL, 26-May-1993
Modified : Update for new tp_edit_lines. CDP, 22-Sep-94
Got rid of delete line capability (use remove). CDP, 9-Nov-95
Version : Version 3, 9-Nov-95
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_GET_DESC()
Purpose : Composes raster, variation and window descriptions.
Explanation : Composes a meaningful description for the raster, its variation
and the data extraction windows from the information currently
in the planning structure.
Use : tp_get_desc, tp_obs
Inputs : tp_obs - the structure variable.
zone - the current source type
Opt. Inputs : None
Outputs : Descriptions are updated in the structure.
Opt. Outputs: None
Keywords : None
Calls : ***
FMT_VECT, STRPAD
CALLED BY:
MK_RASTER, TP_RECALC_DEW
Common : None
Restrictions: None
Side effects: None
Category : Technical, planning
Prev. Hist. : None
Written : C D Pike, RAL, 21-Mar-95
Modified : Add zone parameter. CDP, 24-Mar-95
Add number of lines to DEW descr. CDP, 3-Apr-95
Add raster coverage to variation descriptor
and make only slit size in fundamental descriptor.
CDP, 21-Apr-95
Limit desc to 50 chars max. and rework fundamental desc.
CDP, 18-May-95
Add Line list and dw IDs to variation desc. CDP, 23-May-95
Fix area calculation in raster description. CDP, 29-Jun-95
Add GIS filaments to zone types. CDP, 7-Sep-95
Handle increased description length of 65 chars. CDP, 17-Oct-95
Do not count detached flag windows in window description.
CDP, 07-Nov-95
Add chksum to datawin description. CDP, 15-Nov-95
Fix label in data windows description. CDP, 12-Dec-95
Cut out area in fundamental description. CDP, 23-Jan-96
Add curr_lheight parameter in call. CDP, 10-Apr-96
Add LL_ID to datawin description. CDP, 17-Oct-96
Add comp_opt to v_descriptor for comp mode 8 CDP, 04-Mar-98
Added extra uniqueness for datawin desc. CDP, 18-May-98
Allow negative zones. CDP, 04-May-99
Version : Version 18, 04-May-99
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_GET_DUMDATA
Purpose : Package to get dummy data for technical planning.
Explanation : Calls either vds_dummy or gis_dummy to return suitable
dummy data for the technical planning program TPLAN. It
can be used outwith TPLAN if a structure of the correct form
(eg as output by TPLAN) is used as the input parameter.
Use : IDL> tp_get_dumdata, struct, data_array
Inputs : struct - technical planning structure.
Opt. Inputs : None
Outputs : data_array - array containing GIS or VDS dummy data.
An integer value -1 is returned on error.
Opt. Outputs: None
Keywords : ZONE - determines model for dummy data calculation
Calls : ***
Bell, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FILE_EXIST [2], GIS_DUMMY
TP_CALC_COMP, VDS_DUMMY, concat_dir [4], file_exist [1], file_exist [3]
CALLED BY:
LOAD_TP_STRUCT, MK_RASTER
Restrictions: None
Side effects: None
Category : Technical planning.
Prev. Hist. : None
Written : C D Pike, RAL, 15-Sep-94
Modified : Add call to compression effects routine. CDP, 21-Oct-94
Added zone keyword. CDP, 24-Mar-95
Add real data option. CDP, 04-May-99
Change destination of error message. CDP, 13-Jul-99
Version : Version 5, 13-Jul-99
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_GWIN_LOGIC
Purpose : Produce Data Extraction Windows for GIS
Explanation : Input Selected Lines and Widths. Routine Calculates
Data Extraction Windows (i.e. data to return to Earth)
for the GIS
Use : tp_gwin_logic, obs_str, curr_lwidth, gis_def_ext, dew
Inputs : obs_str - structure of the defined observation, see tplan
curr_lwidth - current window width specified
gis_def_ext - which bands to extract in toto
Opt. Inputs : None
Outputs : dew - data extraction windows array(n,4) where 2nd dimension
is xstart,ystart,xlength,ylength. The 'y' values are
retained for consistency with the VDS code but are
set to 0 and 1 for all lines.
Opt. Outputs: None
Keywords : None
Calls : ***
ANYNAME2STD, REPCHAR, WAVE2PIX, WHICH_GIS_BAND
CALLED BY:
TP_RECALC_DEW
Restrictions: None
Side effects: None
Category : Planning, technical
Prev. Hist. : Based on original by R A Harrison, RAL.
Written : C D Pike, RAL, 16-Nov-1993
Modified : Major update for changes in observation structure.
CDP, 14-Jul-94
Change specification of default extraction. CDP, 6-Dec-94
Add extraction window names. CDP, 8-Mar-95
Reverse window definitions to allow for reveral of
GIS band data. CDP, 31-May-95
Add flag windows. CDP, 26-Jun-95
Version : Version 5, 26-Jun-95
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_LOAD_VDSBACK()
Purpose : Loads default VDS background windows into structure.
Explanation : Reads the VDS background windows from the state database
into the internal MK_RASTER structure.
Use : status = tp_load_vdsback(str)
Inputs : str - standard MK_RASTER structure
Opt. Inputs : None
Outputs : str - is updated on output
Opt. Outputs: None
Keywords : None
Calls : ***
CP_GET_ENTRY
CALLED BY:
LOAD_TP_STRUCT, MK_RASTER
Common : None
Restrictions: None
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 20-Oct-94
Modified : Pick up values from state database. CDP, 18-Jan-96
Version : Version 2, 18-Jan-96
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_PLOT_DEW
Purpose : Plot the data extraction windows in a raster.
Explanation : Plots the data extraction windows used in a raster for
illustrative purposes. Works from the observation
definition structure used in TPLAN and can be run separately
from the planning tool TPLAN.
Use : IDL> tp_plot_dew, obs_str, /hard, /soft
Inputs : obs_str - a valid TPLAN data structure.
Opt. Inputs : None
Outputs : Just plots the results.
Opt. Outputs: None
Keywords : hard - plot only VDS hardware windows
soft - plot only the true data extraction windows
Calls : ***
FILL_BOX, XREGISTERED
CALLED BY:
MK_RASTER, TP_DISPLAY_DEW, TP_RECALC_DEW
Common : None
Restrictions: None
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 13-Jul-94
Modified : Fix bug for hardcopy plotting. CDP, 20-Oct-94
Changed display of VDS hardware windows. CDP, 4-Jan-95
Incorporate GIS band reversal in window definition.
CDP, 31-May-95
Flip VDS display to reflect real orientation of CCD.
CDP, 16-Oct-95
Version : Version 5, 16-Oct-95
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_PLOT_GIS
Purpose : Plots the spectral data from the CDS GIS detector.
Explanation : Takes the GIS data array and plots the data from the requested
band. If the band specified equals 4 then this is taken as
an indication to plot all four (0-3) bands on a single page.
Use : IDL> tp_plot_GIS, GIS_data, GIS_band
Inputs : data - GIS data array to plot
Opt. Inputs : band - the particular band to plot. Default (or a value
of 5 means plot all 4 bands.
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
Bell, PIX2WAVE
CALLED BY:
LOAD_TP_STRUCT, MK_RASTER, TP_REDISPLAY
Restrictions: None
Side effects: None
Category : Technical planning
Prev. Hist. :
Written : C D Pike, RAL, 9-Jun-93
Modified : Set minimum negative intensity plot range. CDP, 23-Mar-95
Set minimum ymax value to 1. CDP, 15-Nov-95
Version : Version 3, 15-Nov-95
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_PLOT_VDS
Purpose : Defines the window to display data in the NIS windows.
Explanation : Creates the widgets which form the window within which
the windows are displayed.
Use : tp_plot_vds
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
TP_DRAW_VWIN, TP_PLOT_VDS_EVENT, XMENU [1], XMENU [2], XREGISTERED
CALLED BY:
MK_RASTER
Restrictions: For use with MK_RASTER
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 04-Mar-96
Modified :
Version : Version 1, 04-Mar96
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_RASDUR
Purpose : Defines the window to display raster duration info.
Explanation : Creates the widgets which form the window within which
the raster duration information is displayed.
Use : tp_rasdur
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3], STRPAD, TP_DRAW_RASDUR
TP_RASDUR_EVENT, XPDMENU, XREGISTERED
CALLED BY:
MK_RASTER
Restrictions: For use with MK_RASTER
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 10-Mar-97
Modified : Include new LOW++ telemetry rate. CDP, 28-nov-97
Version : Version 2, 28-Nov-97
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_READ_HELP()
Purpose : Read a text help file.
Explanation : Reads a text help file in the same format as WIDG_HELP and
returns the information read as a structure.
Use : IDL> text = tp_read_help(file)
Inputs : file - the text file. If no extension is specified, .hlp will
be assumed, will also search the path if not in the
current directory.
Opt. Inputs : None
Outputs : Function returns a structure such that the headings are in
structure.topic(x) and the text for that topic is in
structure.text(structure.startline(x):structure.stopline(x))
Opt. Outputs: None
Keywords : None
Calls : ***
FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3]
CALLED BY:
MK_RASTER
Common : None
Restrictions: None
Side effects: None
Category : Planning, technical, help
Prev. Hist. : Based on code extracted from WIDG_HELP.
Written : C D Pike, RAL, 20-Feb-95
Modified :
Version : Version 1, 20-Feb-95
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_READ_TEXTW
Purpose : Reads TPLAN editable text widgets.
Explanation : Every event from the main TPLAN widget causes the editable
text widgets (containing the raster step sizes, number of
steps and the raster and line lists descriptions) to be read
and stored. This safeguards against the user not hitting
return after entering new data.
Use : tp_read_textw
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
VALID_NUM [1], VALID_NUM [2], VALID_NUM [3]
CALLED BY:
MK_RASTER
Common : tplan_com.pro
Restrictions: None
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 24-Aug-94
Modified : Make sure texts are limited to 50 chars. CDP, 14-Sep-94
Allow texts up to 64 chars. CDP, 17-Oct-95
Version : Version 3, 17-Oct-94
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_RECALC_DEW
Purpose : Recalculate the data extraction (and VDS) windows.
Explanation : Taking the current lines and detector parameter setup,
recalculate the data extraction windows and the VDS
hardware windows if appropriate.
Use : Only within TPLAN
Inputs : mode - mode of last event in tplan, to check for exits.
all others in common.
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
Bell, FLASH_MSG, RASTER_DUR, SAME_DATA [1], SAME_DATA [2], TP_CLEAR_LINES
TP_GET_DESC, TP_GWIN_LOGIC, TP_PLOT_DEW, TP_UPDATE_LINES, TP_VWIN_LOGIC
XREGISTERED
CALLED BY:
MK_RASTER, TP_DISP_IEF, TP_DISP_LLIST, TP_DISP_RAST
Restrictions: None
Side effects: None
Category : Technical planning.
Prev. Hist. : None
Written : C D Pike, RAL, 26-Sep-94
Modified : Add CCD readout times etc. CDP, 28-Nov-94
Cut out writing ll_desc to text widget. CDP, 24-Mar-95
Transferred duration calculation to calc_ras_dur.
CDP, 10-May-95
Limit possible number of dex windows to 48 (GIS) and 24 (VDS)
and number of VDS hardware windows to 10. CDP, 31-May-95
Cater for flag windows. CDP, 26-Jun-95
Cut out flash message for too many windows. CDP, 20-Jul-95
Allow descriptions to be 64 chars long. CDP, 17-Oct-95
Change call to tp_get_desc. CDP, 07-Nov-95
Include curr_lheight in call to tp_get_desc. CDP, 10-Apr-96
Expand format for raster duration widget. CDP, 28-Apr-96
Cater for new raster duration calculation. CDP, 23-Sep-97
Use RASTER_DUR instead of CALC_RAS_DUR for
time2dump calculation. CDP, 12-Dec-97
Version : Version 12, 12-Dec-97
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_REDISPLAY
Purpose : To redisplay current image/plot.
Explanation : Just redisplays current VDS/GIS data in last recorded state.
Used after widgets which desensitise the draw widget as this
deletes any plot and after a change of display mode.
Use : tp_redisplay
Inputs : None - all done in COMMON
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
DISPLAY_GIS_WIN, DISPLAY_NIS_WIN, FLASH_MSG, TP_BSCALE, TP_COLBAR, TP_PLOT_GIS
TP_VDS_AXES
CALLED BY:
MK_RASTER
Restrictions: None
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 17-Nov-1993
Modified : Change NIS to VDS. CDP, 7-Jul-94
Structure tag name change. CDP, 12-Jul-94
Handle flag windows. CDP, 19-Sep-94
Include colour bar. CDP, 18-Oct-94
Version : Version 5, 18-Oct-94
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_TP2INT
Purpose : Transfer line list structure within TPLAN structure.
Explanation : When the line list is edited within TPLAN, only the
line_list and line_list2 sub-structures are updated.
This routine copies the details in those two stuctures to
the other internal sub-structures used within tp_obs
Use : IDL> tp_tp2int
Inputs : None
Opt. Inputs : None
Outputs : None - internal structure held in common
Opt. Outputs: None
Keywords : None
Calls : ***
COPY_STRUCT [1], COPY_STRUCT [2], COPY_STRUCT [3]
Common : None
Restrictions: None
Side effects: None
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 22-Sep-94
Modified : Use copy_struct for flexibility. CDP, 7-Apr-95
Handle flags CDP, 26-Jun-95
Version : Version 3, 26-Jun-95
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_UPDATE_LINES
Purpose : Update the line_list2 structure in tp_obs.
Explanation : When changes have been made to the line selection (add,
delete etc.) the changes are initially recorded only in
the internal line_window structure. This can and is
copied straight to tp_obs.line_w but the new information
in there needs to be copied to the tp_obs.line_list and
.line_list2 structures which mimic the database structures.
This routine does that transfer.
Use : tp_update_lines, tp_obs
Inputs : tp_obs - the standard tplan observation structure.
Opt. Inputs : None
Outputs : Contents of tp_obs are updated
Opt. Outputs: None
Keywords : None
Calls : ***
WHICH_GIS_BAND
CALLED BY:
MK_RASTER, TP_RECALC_DEW
Restrictions: For internal use of TPLAN
Side effects: None
Category : Technical planning.
Prev. Hist. :
Written : C D Pike, 14-Jul-1994
Modified :
Version : Version 1, 14-Jul-94
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_UPDATE_PIX
Purpose : Updates pixel values from wavelengths
Explanation : In case the wavelength calibration has been updated since
the technical planning structure was created, this routine
can be called to plug into the tp_obs.line_w structure the
latest correspondence between wavelength and pixel position.
Use : tp_update_pix, tp_obs
Inputs : tp_obs - the standard internal mk_raster structure
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
WAVE2PIX, WHICH_GIS_BAND, WHICH_NIS_BAND
CALLED BY:
LOAD_TP_STRUCT
Common : None
Restrictions: None
Side effects: None
Category : Technical, planning
Prev. Hist. : None
Written : C D Pike, RAL, 30-Mar-95
Modified :
Version : Version 1, 30-Mar-95
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_VDS_AXES
Purpose : Label VDS image with wavelength scales.
Explanation : Uses xyouts to put a simple wavelength indications alongside
the VDS image display
Use : tp_vds_axes
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
WAVE2PIX
CALLED BY:
LOAD_TP_STRUCT, MK_RASTER, TP_REDISPLAY
Common : TPLAN_COM
Restrictions: None
Side effects: None
Category : Technical, planning
Prev. Hist. : None
Written : C D Pike, RAL, 21-Oct-94
Modified :
Version : Version 1, 21-Oct-94
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_VWIN_LOGIC
Purpose : Produce Data Extraction and VDS Extraction Windows
Explanation : Input Selected Lines and Widths. Routine Calculates
Data Extraction Windows (i.e. data to return to Earth)
and VDS Extraction Windows (i.e. windows to extract
from VDS). If VDS background windows are required these
are dealt with.
Use : tp_vwin_logic, obs_str, curr_lheight, vds_extension, back,$
dew, vdsew
Inputs : obs_str - structure of the defined observation, see
tplan_com for details.
curr_lheight - current line window height
curr_lwidth - current line window width
vds_extension - include background windows or not
back - intarr(4,4) specifying background windows
(help in tp_obs.vds_back.win_def)
nis_def_ext - flag to indicate what default (no lines)
extraction is
Opt. Inputs : None
Outputs : dew - data extraction windows array(n,4) where 2nd dimension
is xstart,ystart,xlength,ylength.
vdsew - as above for VDS extraction windows.
dew_name - name to be allocated to extraction window
Opt. Outputs: None
Keywords : None
Calls : ***
ANYNAME2STD, Bell, GET_VDS_WIN, REPCHAR, WAVE2PIX
CALLED BY:
TP_RECALC_DEW
Restrictions: None
Side effects: None
Category : Planning, technical
Prev. Hist. : Based on original by R A Harrison, RAL.
Written : C D Pike, RAL, 16-Nov-1993
Modified : Fixed bug when no windows defined. CDP, 21-Dec-93
Fix bug for VDS y positions. CDP, 21-Mar-94
Added vds_extension option. CDP, 21-Mar-94
To handle windows off either edge. CDP, 24-Mar-94
Major update for new logic and
structures. CDP, 13-Jul-94
Introduce new logic for background
windows CDP, 20-Oct-94
Major rewrite to cope with changed
logic of 'all spectrum'. CDP, 28-Nov-94
Include new VDS window calculation. CDP, 04-Jan-95
Add extraction window names. CDP, 8-Mar-95
Add flag indicator. CDP, 26-Jun-95
Fix bug introduced with flags. CDP, 04-Jul-95
Flip of orientation of CCD Y values CDP, 16-Oct-95
Version : Version 13, 16-Oct-95
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_WRT_DWIN()
Purpose : Store the data extraction definition into the database.
Explanation : Transfers from the mk_raster internal database to the one
required by the database access routine and add the
definition to the database if it is new. Returns the ID
of the data extraction window.
Use : id = tp_wrt_dwin(tp_obs, msg_widg)
Inputs : tp_obs - the standard TPLAN structure.
msg_widg - widget ID for messages
flag_state - indicates inclusion or not of flag windows
Opt. Inputs : None
Outputs : Returns ID of data extraction window ( negative if a problem)
Opt. Outputs: None
Keywords : None
Calls : ***
ADD_DATAWIN, Bell, CHK_DATAWIN, GET_DATAWIN, XACK
CALLED BY:
MK_RASTER
Common : None
Restrictions: Only for internal TPLAN use.
Side effects: Data extraction window database could be updated.
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 25-Aug-94
Modified : Update to check database contents first. CDP, 13-Oct-94
Allow Line list ID to be zero. CDP. 22-Feb-95
Added win_flag tag to structure. CDP, 26-Jun-95
Include flag window handling. CDP, 10-Nov-95
Insert xack warning when entry already exists. CDP, 17-Oct-96
Version : Version 6, 17-Oct-96
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_WRT_FRAST()
Purpose : Store the fundamental raster definition into the database.
Explanation : Checks whether the current fundamental raster definition
already exists in the database, if not then create a new
entry and report new ID.
Use : id = tp_wrt_frast(tp_obs, msg_widg)
Inputs : tp_obs - the standard TPLAN structure.
msg_widg - widget ID for messages.
Opt. Inputs : None
Outputs : Function returns ID of fundamental raster (<0 if a problem)
Opt. Outputs: None
Keywords : None
Calls : ***
ADD_F_RASTER, CHK_F_RASTER
CALLED BY:
MK_RASTER
Common : None
Restrictions: Only for internal TPLAN use.
Side effects: Fundamental raster database could be updated.
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 13-Oct-94
Modified : Fix bad status return. CDP, 2-Mar-95
Version : Version 2, 2-Mar-95
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_WRT_IEF()
Purpose : Write IEF definition to the IEF database.
Explanation : Takes the data extraction windows defined as flag windows in
MK_RASTER and writes them out to the IEF data base.
Use : Only within MK_RASTER
status = tp_wrt_ief(tp_obs, info_line)
Inputs : tp_obs - the internal mk_raster structure
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
ANYTIM2CAL, GET_UTC, TAG_EXIST [1], TAG_EXIST [2], XINPUT
CALLED BY:
MK_RASTER
Common : None
Restrictions: Only updates the window definitions (size, position) and
does not define the event generation statistic.
Side effects: None
Category : Technical planning, IEF
Prev. Hist. : None
Written : C D Pike, 8-Nov-95
Modified : Check for existence of ief_id tag to cater for older
structures. CDP, 19-Jan-96
Version : Version 2, 19-Jan-96
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_WRT_LLIST()
Purpose : Store the line list definition into the database.
Explanation : Transfers from the TPLAN internal database to the one
required by the database access routine and add the
definition to the database if it is new. Returns the ID
of the line list.
Use : id = tp_wrt_llist(tp_obs, msg_widg)
Inputs : tp_obs - the standard TPLAN structure.
msg_widg - widget ID for messages
flag_state - says whether flag windows are included or not
base - base widget in which to put error message widget.
Opt. Inputs : None
Outputs : Function returns ID of line list (negative if a problem)
Opt. Outputs: None
Keywords : None
Calls : ***
ADD_LINELIST, Bell, CHK_LINELIST, GET_LINELIST, XACK
CALLED BY:
MK_RASTER
Common : None
Restrictions: Only for internal TPLAN use.
Side effects: Line list database could be updated.
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 25-Aug-94
Modified : Check for existence within database first. CDP, 13-Oct-94
Handle case of no lines according to new definitions.
CDP, 22-Feb-95
Don't force any particular TITLE. CDP, 2-Mar-95
Take account of flag lines. CDP, 10-Nov-95
Change error message if line list exists under another guise.
CDP, 14-nov-95
Version : Version 5, 14-Nov-95
[Previous]
[Next]
Project : SOHO - CDS
Name : TP_WRT_VRAST()
Purpose : Store the raster variation definition into the database.
Explanation : Checks whether the current raster variation definition
already exists in the database, if not then create a new
entry and report new ID.
Use : id = tp_wrt_vrast(tp_obs, msg_widg)
Inputs : tp_obs - the standard TPLAN structure.
msg_widg - widget ID for messages.
Opt. Inputs : None
Outputs : Function returns ID of raster variation (<0 if a problem)
Opt. Outputs: None
Keywords : None
Calls : ***
ADD_V_RASTER, CHK_V_RASTER, RASTER_DUR
CALLED BY:
MK_RASTER
Common : None
Restrictions: Only for internal TPLAN use.
Side effects: Raster variation database could be updated.
Category : Planning, technical
Prev. Hist. : None
Written : C D Pike, RAL, 13-Oct-94
Modified : Allow Line list ID to be zero (ie no spectral lines)
CDP, 22-Feb-95
Fix bad status return, CDP, 2-Mar-95
Add calculation of raster duration before storing. CDP, 16-Oct-97
Add new LOW++ telemetry rate. CDP, 12-Dec-97
Version : Version 5, 12-Dec-97
[Previous]
[Next]
Project : SOHO - CDS
Name : TPLAN_COM
Purpose : The common blocks include file for TP_PAGE1
Explanation : The source code in this file is loaded from the technical
planning codes. It contains the common blocks needed for
passing variables amongst the tp_page1 routines.
It also sets up the maximum number of line and flag windows
allowed.
Use : Only by hardcoding @tplan_com in the source of routines.
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : None
Restrictions: None
Side effects: None
Category : Technical planning
Prev. Hist. : None
Written : C D Pike, RAL, 10-May-1993
Modified : Added flag_state. CDP, 18-Oct-95
Added raster duration variables. CDP, 10-Mar-97
Version : Version 3, 10-Mar-97
[Previous]
[Next]
Project : SOHO - CDS
Name : TPLAN_STRUCT
Purpose : Define the structures used in the technical planning.
Explanation : Sets the static definition of the structures to be compiled
by the technical planning procedure (tplan) for output
to and communication with other routines.
Use : IDL> tplan_struct
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : None
CALLED BY:
MK_RASTER, MK_STUDY
Restrictions: See note re definition differences in DEW and VDS windows.
Side effects: None
Category : Planning, Technical
Prev. Hist. : An update of original tp_def_struct
Written : C D Pike, RAL, 8-Jul-94
Modified : Update to follow database definitions. CDP, 19-Aug-94
Added VDS background window definitions. CDP, 20-Oct-94
Update data_win2 structure to add flags. CDP, 26-Jun-95
Update raster variation with ief_id. CDP, 09-Nov-95
Version : Version 5, 09-Nov-95
[Previous]
[Next]
NAME:
track_h2a
PURPOSE:
Given a heliocentric coordinate and a set of dates, track the
angular position on the sun as it moves with differential rotation.
SAMPLE CALLING SEQUENCE:
ang = track_h2a(times, helio, date_helio)
INPUTS:
times - An array of times in any of the 3 standard formats
helio - The heliocentric coordinates in a 2 element array
(0) = longitude (degrees) W positive
(1) = latitude (degrees) N positive
They can also be strings in the form 'N30W23'.
date_helio - The date for the heliocentric coordinates
OUTPUTS:
ang - Returns the angle as seen from the earth
(0,*) = angle in E/W direction (arcseconds) W positive
(1,*) = angle in N/S direction (arcseconds) N positive
CALLS: ***
CONV_H2A [1], CONV_H2A [2], CONV_HS2H [1], CONV_HS2H [2], DIFF_ROT [1]
DIFF_ROT [2], anytim2ints [1], anytim2ints [2], int2secarr [1], int2secarr [2]
CALLED BY:
align_prep [1], align_prep [2], align_prep [3], get_gbo_pfi, in_fov, mk_coal_movie
rest_low8_cube [1], rest_low8_cube [2], sxt_obs_coord [1], sxt_obs_coord [2]
HISTORY:
Written 20-Jun-93 by M.Morrison using Metcalf ALIGN_AR as starting point
[Previous]
[Next]
NAME:
track_proc
PURPOSE:
To find all processes for a given process name and user. Optionally
kill the process
SAMPLE CALLING SEQUENCE:
pids = track_proc('mdi', 'mdi_sci')
pids = track_proc('mdi', 'mdi_sci', 'bin.sgi/idl')
pids = track_proc('mdi', 'mdi_sci', term0='?', /kill)
RESTRICTION:
Only runs on SGI
CALLS: ***
ARR2STR [1], Arr2Str [2], prstr [1], prstr [2], str2cols [1], str2cols [2]
where_arr [1], where_arr [2]
HISTORY:
Written 30-May-96 by M.Morrison
8-Aug-96 (MDM) - Added TERM0 option
[Previous]
[Next]
Project : SOHO-CDS
Name : TRIM_CAMPAIGN
Purpose : trim all blank strings in Campaign structure
Category : planning
Explanation :
Syntax : TRIM_CAMPAIGN,CMP
CALLED BY:
ADD_CAMPAIGN, GET_CAMPAIGN, MOD_CAMPAIGN, UPDATE_CAMPAIGN
Examples :
Inputs : CMP = campaign structure
Opt. Inputs : None
Outputs : CMP = trimmed campaign structure
Opt. Outputs:
Keywords : None
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], TRIM
Common : None
Restrictions: None
Side effects: CMP string fields are trimmed
History : Written 20 November 1996, D. Zarro, ARC/GSFC
Contact : dzarro@solar.stanford.edu
[Previous]
[Next]
NAME:
TVC
PURPOSE:
Overlay an image and a contour plot. of a second image
CATEGORY:
General graphics.
CALLING SEQUENCE:
tvc, A, overl
INPUTS:
A = 2 dimensional array to display.
overl = 2 dimensional array to contour and overlay.
KEYWORD PARAMETERS:
/WINDOW_SCALE = set to scale the window size to the image size,
otherwise the image size is scaled to the window size.
Ignored when outputting to devices with scalable pixels.
/ASPECT = set to retain image's aspect ratio. Assumes square
pixels. If /WINDOW_SCALE is set, the aspect ratio is
retained.
/INTERP = set to bi-linear interpolate if image is resampled.
title, set the image title
delta, set the distance between contours
subtitle, set the subtitle
OUTPUTS:
No explicit outputs.
COMMON BLOCKS:
none.
SIDE EFFECTS:
The currently selected display is affected.
RESTRICTIONS:
None that are obvious.
PROCEDURE:
If the device has scalable pixels then the image is written over
the plot window.
MODIFICATION HISTORY:
IZ, Jun, 1993. Modified from mytvcont
PNM, May, 1993. Modified further...
PNM, Feb, 1990. Modified image_cont to use second image
DMS, May, 1988.
[Previous]
[Next]
NAME:
TVIMAGE
PURPOSE:
This purpose of TVIMAGE is to enable the TV command in IDL
to be a completely device-independent and color-decomposition-
state independent command. On 24-bit displays color decomposition
is always turned off for 8-bit images and on for 24-bit images.
The color decomposition state is restored for those versions of
IDL that support it (> 5.2). Moreover, TVIMAGE adds features
that TV lacks. For example, images can be positioned in windows
using the POSITION keyword like other IDL graphics commands.
TVIMAGE also supports the !P.MULTI system variable, unlike the
TV command. TVIMAGE was written to work especially well in
resizeable graphics windows. Note that if you wish to preserve
the aspect ratio of images in resizeable windows, you should set
the KEEP_ASPECT_RATIO keyword, described below. TVIMAGE works
equally well on the display, in the PostScript device, and in
the Printer and Z-Graphics Buffer devices. The TRUE keyword is
set automatically to the correct value for 24-bit images, so you
don't need to specify it when using TVIMAGE.
AUTHOR:
FANNING SOFTWARE CONSULTING:
David Fanning, Ph.D.
1645 Sheely Drive
Fort Collins, CO 80526 USA
Phone: 970-221-0438
E-mail: davidf@dfanning.com
Coyote's Guide to IDL Programming: http://www.dfanning.com/
CATEGORY:
Graphics display.
CALLING SEQUENCE:
TVIMAGE, image
INPUTS:
image: A 2D or 3D image array. It should be byte data.
x : The X position of the lower-left corner of the image.
This parameter is only recognized if the TV keyword is set.
y : The Y position of the lower-left corner of the image.
This parameter is only recognized if the TV keyword is set.
KEYWORD PARAMETERS:
BACKGROUND: This keyword specifies the background color. Note that
the keyword ONLY has effect if the ERASE keyword is also
set or !P.MULTI is set to multiple plots and TVIMAGE is
used to place the *first* plot.
ERASE: If this keyword is set an ERASE command is issued
before the image is displayed. Note that the ERASE
command puts the image on a new page in PostScript
output.
_EXTRA: This keyword picks up any TV keywords you wish to use.
HALF_HALF: If set, will tell CONGRID to extrapolate a *half* row
and column on either side, rather than the default of
one full row/column at the ends of the array. If you
are interpolating images with few rows, then the
output will be more consistent with this technique.
This keyword is intended as a replacement for
MINUS_ONE, and both keywords probably should not be
used in the same call to CONGRID.
KEEP_ASPECT_RATIO: Normally, the image will be resized to fit the
specified position in the window. If you prefer, you can
force the image to maintain its aspect ratio in the window
(although not its natural size) by setting this keyword.
The image width is fitted first. If, after setting the
image width, the image height is too big for the window,
then the image height is fitted into the window. The
appropriate values of the POSITION keyword are honored
during this fitting process. Once a fit is made, the
POSITION coordiates are re-calculated to center the image
in the window. You can recover these new position coordinates
as the output from the POSITION keyword.
MARGIN: A single value, expressed as a normalized coordinate, that
can easily be used to calculate a position in the window.
The margin is used to calculate a POSITION that gives
the image an equal margin around the edge of the window.
The margin must be a number in the range 0.0 to 0.333. This
keyword is ignored if the POSITION keyword is used.
MINUS_ONE: The value of this keyword is passed along to the CONGRID
command. It prevents CONGRID from adding an extra row and
column to the resulting array, which can be a problem with
small image arrays.
NOINTERPOLATION: Setting this keyword disables the default bilinear
interpolation done to the image when it is resized. Nearest
neighbor interpolation is done instead. This is preferred
when you do not wish to change the pixel values of the image.
This keyword must be set, for example, when you are displaying
GIF files that come with their own non-IDL color table vectors.
NORMAL: Setting this keyword means image position coordinates x and y
are interpreted as being in normalized coordinates. This keyword
is only valid if the TV keyword is set.
OVERPLOT: Setting this keyword causes the POSITION keyword to be ignored
and the image is positioned in the location established by the
last graphics command. For example:
Plot, Findgen(11), Position=[0.1, 0.3, 0.8, 0.95]
TVImage, image, /Overplot
POSITION: The location of the image in the output window. This is
a four-element floating array of normalized coordinates of
the type given by !P.POSITION or the POSITION keyword to
other IDL graphics commands. The form is [x0, y0, x1, y1].
The default is [0.0, 0.0, 1.0, 1.0]. Note that this can
be an output parameter if the KEEP_ASPECT_RATIO keyword is
used.
TV: Setting this keyword makes the TVIMAGE command work much
like the TV command, although better. That is to say, it
will still set the correct DECOMPOSED state depending upon
the kind of image to be displayed (8-bit or 24-bit). It will
also allow the image to be "positioned" in the window by
specifying the coordinates of the lower-left corner of the
image. The NORMAL keyword is activated when the TV keyword
is set, which will indicate that the position coordinates
are given in normalized coordinates rather than device
coordinates.
Setting this keyword will ensure that the keywords
KEEP_ASPECT_RATIO, MARGIN, MINUS_ONE, MULTI, and POSITION
are ignored.
OUTPUTS:
None.
CALLS: ***
CMCONGRID, FTVIMAGE, LOADCT, STR_SEP, TVIMAGE_ERROR
CALLED BY:
CIndex, XMAP [1], XMAP [2], XZOOM, xwhisker [1], xwhisker [2]
SIDE EFFECTS:
Unless the KEEP_ASPECT_RATIO keyword is set, the displayed image
may not have the same aspect ratio as the input data set.
RESTRICTIONS:
If the POSITION keyword and the KEEP_ASPECT_RATIO keyword are
used together, there is an excellent chance the POSITION
parameters will change. If the POSITION is passed in as a
variable, the new positions will be returned in the same variable
as an output parameter.
If a 24-bit image is displayed on an 8-bit display, the
24-bit image must be converted to an 8-bit image and the
appropriate color table vectors. This is done with the COLOR_QUAN
function. The TVIMAGE command will load the color table vectors
and set the NOINTERPOLATION keyword if this is done. Note that the
resulting color table vectors are normally incompatible with other
IDL-supplied color tables. Hence, other graphics windows open at
the time the image is display are likely to look strange.
EXAMPLE:
To display an image with a contour plot on top of it, type:
filename = FILEPATH(SUBDIR=['examples','data'], 'worldelv.dat')
image = BYTARR(360,360)
OPENR, lun, filename, /GET_LUN
READU, lun, image
FREE_LUN, lun
TVIMAGE, image, POSITION=thisPosition, /KEEP_ASPECT_RATIO
CONTOUR, image, POSITION=thisPosition, /NOERASE, XSTYLE=1, $
YSTYLE=1, XRANGE=[0,360], YRANGE=[0,360], NLEVELS=10
MODIFICATION HISTORY:
Written by: David Fanning, 20 NOV 1996.
Fixed a small bug with the resizing of the image. 17 Feb 1997. DWF.
Removed BOTTOM and NCOLORS keywords. This reflects my growing belief
that this program should act more like TV and less like a "color
aware" application. I leave "color awareness" to the program
using TVIMAGE. Added 24-bit image capability. 15 April 1997. DWF.
Fixed a small bug that prevented this program from working in the
Z-buffer. 17 April 1997. DWF.
Fixed a subtle bug that caused me to think I was going crazy!
Lession learned: Be sure you know the *current* graphics
window! 17 April 1997. DWF.
Added support for the PRINTER device. 25 June 1997. DWF.
Extensive modifications. 27 Oct 1997. DWF
1) Removed PRINTER support, which didn't work as expected.
2) Modified Keep_Aspect_Ratio code to work with POSITION keyword.
3) Added check for window-able devices (!D.Flags AND 256).
4) Modified PostScript color handling.
Craig Markwart points out that Congrid adds an extra row and column
onto an array. When viewing small images (e.g., 20x20) this can be
a problem. Added a Minus_One keyword whose value can be passed
along to the Congrid keyword of the same name. 28 Oct 1997. DWF
Changed default POSITION to fill entire window. 30 July 1998. DWF.
Made sure color decomposition is OFF for 2D images. 6 Aug 1998. DWF.
Added limited PRINTER portrait mode support. The correct aspect ratio
of the image is always maintained when outputting to the
PRINTER device and POSITION coordinates are ignored. 6 Aug 1998. DWF
Removed 6 August 98 fixes (Device, Decomposed=0) after realizing that
they interfere with operation in the Z-graphics buffer. 9 Oct 1998. DWF
Added a MARGIN keyword. 18 Oct 1998. DWF.
Re-established Device, Decomposed=0 keyword for devices that
support it. 18 Oct 1998. DWF.
Added support for the !P.Multi system variable. 3 March 99. DWF
Added DEVICE, DECOMPOSED=1 command for all 24-bit images. 2 April 99. DWF.
Added ability to preserve DECOMPOSED state for IDL 5.2 and higher. 4 April 99. DWF.
Added TV keyword to allow TVIMAGE to work like the TV command. 11 May 99. DWF.
Added the OVERPLOT keyword to allow plotting on POSITION coordinates
estabished by the preceding graphics command. 11 Oct 99. DWF.
Added automatic recognition of !P.Multi. Setting MULTI keyword is no
longer required. 18 Nov 99. DWF.
Added NOINTERPOLATION keyword so that nearest neighbor interpolation
is performed rather than bilinear. 3 Dec 99. DWF
Changed ON_ERROR condition from 1 to 2. 19 Dec 99. DWF.
Added Craig Markwardt's CMCongrid program and removed RSI's. 24 Feb 2000. DWF.
Added HALF_HALF keyword to support CMCONGRID. 24 Feb 2000. DWF.
Fixed a small problem with image start position by adding ROUND function. 19 March 2000. DWF.
Updated the PRINTER device code to take advantage of available keywords. 2 April 2000. DWF.
Reorganized the code to handle 24-bit images on 8-bit displays better. 2 April 2000. DWF.
Added BACKGROUND keyword. 20 April 2000. DWF.
Fixed a small problem in where the ERASE was occuring. 6 May 2000. DWF.
Rearranged the PLOT part of code to occur before decomposition state
is changed to fix Background color bug in multiple plots. 23 Sept 2000. DWF.
Removed MULTI keyword, which is no longer needed. 23 Sept 2000. DWF.
Fixed a small problem with handling images that are slices from 3D image cubes. 5 Oct 2000. DWF.
2/5/04, nbr - Rename for SSW compatability
[Previous]
[Next]
NAME:
TVREAD
PURPOSE:
To get accurate screen dumps with the IDL command TVRD on 24-bit
PC and Macintosh computers, you have to be sure to set color
decomposition on. This program adds that capability automatically.
In addition, the program will optionally write BMP, GIF, JPEG,
PICT, PNG, and TIFF color image files of the screen dump.
AUTHOR:
FANNING SOFTWARE CONSULTING
David Fanning, Ph.D.
1645 Sheely Drive
Fort Collins, CO 80526 USA
Phone: 970-221-0438
E-mail: davidf@dfanning.com
Coyote's Guide to IDL Programming: http://www.dfanning.com
CATEGORY:
Graphics
CALLING SEQUENCE:
image = TVREAD(xstart, ystart, ncols, nrows)
The returned image will be a 2D image on 8-bit systems and
a 24-bit pixel interleaved true-color image on 24-bit systems.
A -1 will be returned if a file output keyword is used (e.g., JPEG, TIFF, etc.)=tvr
OPTIONAL INPUTS:
XSTART -- The starting column index. By default, 0.
YSTART -- The starting row index. By default, 0.
NCOLS -- The number of columns to read. By default, !D.X_Size - XSTART
NROWS -- The number of rows to read. By default, !D.Y_Size - YSTART.
KEYWORD PARAMETERS:
BMP -- Set this keyword to write the screen dump as a color BMP file.
COLORS -- If a 24-bit image has to be quantized, this will set the number
of colors in the output image. Set to 256 by default. Applies to BMP,
GIF, PICT, and PNG formats written from 24-bit displays.(See the
COLOR_QUAN documentation for details.)
CUBE -- If this keyword is set to a value between 2 and 6 the color
quantization will use a cubic method of quantization. Applies to BMP,
GIF, PICT, and PNG formats written from 24-bit displays.(See the
COLOR_QUAN documentation for details.)
DITHER -- If this keyword is set the quantized image will be dithered.
Applies to BMP, GIF, PICT, and PNG formats written from 24-bit displays.
(See the COLOR_QUAN documentation for details.)
FILENAME -- The base name of the output file. (No file extensions;
they will be added automatically.) This name may be changed by the user.
image = TVREAD(Filename='myfile', /JPEG)
GIF -- Set this keyword to write the screen dump as a color GIF file.
JPEG -- Set this keyword to write the screen dump as a color JPEG file.
PICT -- Set this keyword to write the screen dump as a color PICT file.
PNG -- Set this keyword to write the screen dump as a color PNG file.
TIFF -- Set this keyword to write the screen dump as a color TIFF file.
QUALITY -- This keyword sets the amount of compression for JPEG images.
It should be set to a value between 0 and 100. It is set to 75 by default.
(See the WRITE_JPEG documentation for details.)
WID -- The index number of the window to read from. The current graphics window
(!D.Window) is selected by default. An error is issued if no windows are
currently open on a device that supports windows.
_EXTRA -- Any keywords that are appropriate for the WRITE_*** routines are
also accepted via keyword inheritance.
NOPROMPT -- Do not bring up dialog pickfile for output file.
CALLS: ***
ERROR_MESSAGE, FTVREAD, REVERSE, WRITE_BMP, WRITE_GIF, WRITE_PICT
CALLED BY:
CDS_THUMBNAIL, SNAP_MOVIE, TVPRINT, TVZOOM, TVZOOM2
COMMON BLOCKS:
None
RESTRICTIONS: Requires ERROR_MESSAGE from the Coyote Library:
http://www.dfanning.com/programs/error_message.pro
Requires IDL 5.2 and higher.
MODIFICATION HISTORY:
Written by David Fanning, 9 AUG 2000.
Added changes to make the program more device independent. 16 SEP 2000. DWF.
Removed GIF file support for IDL 5.4 and above. 18 JAN 2001. DWF.
04.05.02, nbr - Rename for SSW compatability
04.07.01, nbr - Use PNG not JPEG in case GIF not available
[Previous]
[Next]
NAME:
TVSCALE
PURPOSE:
This purpose of TVSCALE is to enable the TVSCL command in IDL
to be a completely device-independent and color-decomposition-
state independent command. On 24-bit displays color decomposition
is always turned off for 8-bit images and on for 24-bit images.
The color decomposition state is restored for those versions of
IDL that support it (> 5.2). Moreover, TVSCALE adds features
that TVSCL lacks. For example, images can be positioned in windows
using the POSITION keyword like other IDL graphics commands.
TVSCALE also supports the !P.MULTI system variable, unlike the
TVSCL command. TVSCALE was written to work especially well in
resizeable graphics windows. Note that if you wish to preserve
the aspect ratio of images in resizeable windows, you should set
the KEEP_ASPECT_RATIO keyword, described below. TVSCALE works
equally well on the display, in the PostScript device, and in
the Printer and Z-Graphics Buffer devices. The TRUE keyword is
set automatically to the correct value for 24-bit images, so you
don't need to specify it when using TVSCALE. In addition, you can
use the TOP and BOTTOM keywords to define a particular set of
number to scale the data to. The algorithm used is this:
TV. BytScl(image, TOP=top-bottom) + bottom
Note that if you scale the image between 100 and 200, that
there are 101 possible pixel values. So the proper way to
load colors would be like this:
LoadCT, NColors=101, Bottom=100
TVSCALE, image, Top=200, Bottom=100
Alternatively, you could use the NCOLORS keyword:
LoadCT, NColors=100, Bottom=100
TVSCALE, image, NColors=100, Bottom=100
AUTHOR:
FANNING SOFTWARE CONSULTING:
David Fanning, Ph.D.
1645 Sheely Drive
Fort Collins, CO 80526 USA
Phone: 970-221-0438
E-mail: davidf@dfanning.com
Coyote's Guide to IDL Programming: http://www.dfanning.com
CATEGORY:
Graphics display.
CALLING SEQUENCE:
TVSCALE, image
INPUTS:
image: A 2D or 3D image array. It does not have to be byte data.
x : The X position of the lower-left corner of the image.
This parameter is only recognized if the TVSCL keyword is set.
y : The Y position of the lower-left corner of the image.
This parameter is only recognized if the TVSCL keyword is set.
KEYWORD PARAMETERS:
BACKGROUND: This keyword specifies the background color. Note that
the keyword ONLY has effect if the ERASE keyword is also
set or !P.MULTI is set to multiple plots and TVSCALE is
used to place the *first* plot.
BOTTOM: The image is scaled so that all displayed pixels have values
greater than or equal to BOTTOM and less than or equal to TOP.
The value of BOTTOM is 0 by default.
ERASE: If this keyword is set an ERASE command is issued
before the image is displayed. Note that the ERASE
command puts the image on a new page in PostScript
output.
_EXTRA: This keyword picks up any TV keywords you wish to use.
HALF_HALF: If set, will tell CONGRID to extrapolate a *half* row
and column on either side, rather than the default of
one full row/column at the ends of the array. If you
are interpolating images with few rows, then the
output will be more consistent with this technique.
This keyword is intended as a replacement for
MINUS_ONE, and both keywords probably should not be
used in the same call to CONGRID.
KEEP_ASPECT_RATIO: Normally, the image will be resized to fit the
specified position in the window. If you prefer, you can
force the image to maintain its aspect ratio in the window
(although not its natural size) by setting this keyword.
The image width is fitted first. If, after setting the
image width, the image height is too big for the window,
then the image height is fitted into the window. The
appropriate values of the POSITION keyword are honored
during this fitting process. Once a fit is made, the
POSITION coordiates are re-calculated to center the image
in the window. You can recover these new position coordinates
as the output from the POSITION keyword.
MARGIN: A single value, expressed as a normalized coordinate, that
can easily be used to calculate a position in the window.
The margin is used to calculate a POSITION that gives
the image an equal margin around the edge of the window.
The margin must be a number in the range 0.0 to 0.333. This
keyword is ignored if the POSITION keyword is used.
MAXVALUE: The data is linearly scaled between the MIN and MAX values,
if they are provided. MAX is set to MAX(image) by default.
MINVALUE: The data is linearly scaled between the MIN and MAX values,
if they are provided. MIN is set to MIN(image) by default.
MINUS_ONE: The value of this keyword is passed along to the CONGRID
command. It prevents CONGRID from adding an extra row and
column to the resulting array, which can be a problem with
small image arrays.
NCOLORS: If this keyword is supplied, the TOP keyword is ignored and
the TOP keyword is set equal to BOTTOM + NCOLORS - 1. This
keyword is provided to make TVSCALE easier to use with the
color-loading programs such as LOADCT:
LoadCT, 5, NColors=100, Bottom=100
TVScale, image, NColors=100, Bottom=100
NOINTERPOLATION: Setting this keyword disables the default bilinear
interpolation done to the image when it is resized. Nearest
neighbor interpolation is done instead. This is preferred
when you do not wish to change the pixel values of the image.
NORMAL: Setting this keyword means image position coordinates x and y
are interpreted as being in normalized coordinates. This keyword
is only valid if the TVSCL keyword is set.
OVERPLOT: Setting this keyword causes the POSITION keyword to be ignored
and the image is positioned in the location established by the
last graphics command. For example:
Plot, Findgen(11), Position=[0.1, 0.3, 0.8, 0.95]
TVScale, image, /Overplot
POSITION: The location of the image in the output window. This is
a four-element floating array of normalized coordinates of
the type given by !P.POSITION or the POSITION keyword to
other IDL graphics commands. The form is [x0, y0, x1, y1].
The default is [0.0, 0.0, 1.0, 1.0]. Note that this can
be an output parameter if the KEEP_ASPECT_RATIO keyword is
used.
TOP: The image is scaled so that all displayed pixels have values
greater than or equal to BOTTOM and less than or equal to TOP.
The value of TOP is !D.Table_Size by default.
TVSCL: Setting this keyword makes the TVIMAGE command work much
like the TVSCL command, although better. That is to say, it
will still set the correct DECOMPOSED state depending upon
the kind of image to be displayed (8-bit or 24-bit). It will
also allow the image to be "positioned" in the window by
specifying the coordinates of the lower-left corner of the
image. The NORMAL keyword is activated when the TV keyword
is set, which will indicate that the position coordinates
are given in normalized coordinates rather than device
coordinates.
Setting this keyword will ensure that the keywords
KEEP_ASPECT_RATIO, MARGIN, MINUS_ONE, MULTI, and POSITION
are ignored.
OUTPUTS:
None.
CALLS: ***
CMCONGRID, LOADCT, STR_SEP, TVSCALE_ERROR
SIDE EFFECTS:
Unless the KEEP_ASPECT_RATIO keyword is set, the displayed image
may not have the same aspect ratio as the input data set.
RESTRICTIONS:
If the POSITION keyword and the KEEP_ASPECT_RATIO keyword are
used together, there is an excellent chance the POSITION
parameters will change. If the POSITION is passed in as a
variable, the new positions will be returned as an output parameter.
If the image is 2D then color decomposition is turned OFF
for the current graphics device (i.e., DEVICE, DECOMPOSED=0).
If outputting to the PRINTER device, the aspect ratio of the image
is always maintained and the POSITION coordinates are ignored.
The image always printed in portrait mode.
EXAMPLE:
To display an image with a contour plot on top of it, type:
filename = FILEPATH(SUBDIR=['examples','data'], 'worldelv.dat')
image = BYTARR(360,360)
OPENR, lun, filename, /GET_LUN
READU, lun, image
FREE_LUN, lun
thisPosition = [0.1, 0.1, 0.9, 0.9]
TVSCALE, image, POSITION=thisPosition, /KEEP_ASPECT_RATIO
CONTOUR, image, POSITION=thisPosition, /NOERASE, XSTYLE=1, $
YSTYLE=1, XRANGE=[0,360], YRANGE=[0,360], NLEVELS=10
MODIFICATION HISTORY:
Written by: David Fanning, 27 May 1999 from TVIMAGE code.
Added MIN, MAX, and NCOLORS keywords 28 May 1999. DWF.
Added the OVERPLOT keyword to allow plotting on POSITION coordinates
estabished by the preceding graphics command. 11 Oct 99. DWF.
Added NOINTERPOLATION keyword so that nearest neighbor interpolation
is performed rather than bilinear. 3 Dec 99. DWF
Brought the TVSCALE code up to date with TVIMAGE code. 3 April 2000. DWF.
Brought the TVSCALE code up to date with TVIMAGE code. 6 May 2000. DWF.
Change MIN and MAX keywords to MINVALUE and MAXVALUE to prevent
ambiguous keyword errors. 27 July 2000. DWF.
Brought up to date with changes in TVImage. 23 Sept 2000. DWF.
Fixed a small problem with handling images that are slices from 3D image cubes. 19 Oct 2000. DWF
[Previous]
[Next]
Project : SOHO - LASCO
Name :
Purpose :
Category :
Explanation :
Syntax :
CALLED BY:
WCURRENT, WIMG_INFO3, imcalc
Examples :
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], HINFOS, ghandle
Common :
Restrictions:
Side effects: Not known
History : Version 1, 02-Sep-1995, B Podlipnik. Written
Contact : BP, borut@lasco1.mpae.gwdg.de
[Previous]
[Next]
NAME:
TWO2ONE
PURPOSE:
Convert from 2-d indices to 1-d indices.
CATEGORY:
CALLING SEQUENCE:
two2one, ix, iy, arr, in
INPUTS:
ix, iy = 2-d indices. in
arr = array to use (for size only). in
Alternatively, arr can be [nx, ny]
where nx and ny are the image sizes
in x and y (saves space).
KEYWORD PARAMETERS:
OUTPUTS:
in = equivalent 1-d indices. out
COMMON BLOCKS:
NOTES:
MODIFICATION HISTORY:
R. Sterner, 7 May, 1986.
Johns Hopkins Applied Physics Lab.
R. Sterner, 19 Nov, 1989 --- converted to SUN
R. Sterner, 15 Feb, 1993 --- fixed a bug in the [nx,ny] case.
Copyright (C) 1986, 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:
CALLS:
CALLED BY
threeg_afit
[Previous]
[Next]
NAME:
type_conv
PURPOSE:
Perform a variable type conversion. It is used
in conjuction with the "INPUT" routine
INPUT/OUTPUT:
input_output - The value to be converted
INPUT:
sample_type - The variable type that needs to be
matched
OUTPUT:
type - The variable type (IDL convention)
CALLED BY:
input [1], input [2]
HISTORY:
Written 1988 by M.Morrison