This page was created by the IDL library routine
mk_html_help2.
Last modified: Sun Nov 11 12:37:48 2007.
PROJECT:
SOHO - CDS/SUMER
THEMIS
NAME:
DPRINT
PURPOSE:
Diagnostic PRINT (activated only when DEBUG reaches DLEVEL)
EXPLANATION:
This routine acts similarly to the PRINT command, except that
it is activated only when the common block variable DEBUG is
set to be equal to or greater than the debugging level set by
DLEVEL (default to 1). It is useful for debugging.
CALLING SEQUENCE (typically written into code):
DPRINT, v1 [,v2 [,v3...]]] [,format=format] [,dlevel=dlevel] [,verbose=verbose]
Calling sequence to change options (typically typed from command line)
DPRINT, setdebug=d ; defined persistent debug level
DPRINT, print_trace=[0,1,2, or 3] ; Display program trace info in subsequent calls to DPRINT
DPRINT, /print_dtime ; Display delta time between DPRINT statements.
INPUTS:
V1, V2, ... - List of variables to be printed out (20 max).
OPTIONAL INPUTS:
None.
OUTPUTS:
All input variables are printed out on the screen (or the
given unit)
OPTIONAL Keywords:
FORMAT - Output format to be used
UNIT - Output unit through which the variables are printed. If
missing, the standard output (i.e., your terminal) is used.
KEYWORD PARAMETERS:
DLEVEL - An integer indicating the debugging level; defaults to 1
SETDEBUG=value - Set debug level to value
GETDEBUG=named variable - Get current debug level
DWAIT = NSECONDS ; provides an additional constraint on printing.
It will only print if more than NSECONDS has elapsed since last dprint.
CALLS:
PTRACE()
COMMON BLOCKS:
DPRINT_COM.
RESTRICTIONS:
- Changed see SETDEBUG above
Can print out a maximum of 12 variables (depending on how many
is listed in the code)
SIDE EFFECTS:
None.
CATEGORY:
Utility, miscellaneous
PREVIOUS HISTORY:
Written March 18, 1995, Liyun Wang, GSFC/ARC
MODIFICATION HISTORY:
Version 1, Liyun Wang, GSFC/ARC, March 18, 1995
Version 2, Zarro, SM&A, 30 November 1998 - added error checking
Version 3, Zarro, (EIT/GSFC), 23 Aug 2000 - removed DATATYPE calls
Version 4, Larson (2007) stripped out calls to "execute" so that it can be called from IDL VM
Fixed bug that allows format keyword to be used.
Added PTRACE() call
Added SETDEBUG keyword and GETDEBUG keyword
Added DWAIT keyword
(See ssl_general/misc/SSW/dprint.pro)
Project : HESSI
Name : IS_STRING
Purpose : return true is input is a non-blank string
Category : string utility
Syntax : IDL> a=is_string(input)
Inputs : INPUT_STR = input variable to check
Outputs : 0/1 if blank/nonblank
Keywords : return true (1), even if string is blank
Opt. Outputs: NONBLANK = noblank copies of input
(if input is array, then nonblanks are filtered out)
History : 17-Nov-1999, Zarro (SM&A/GSFC)
5-Feb-2003, Zarro (EER/GSFC) - added /BLANK
Contact : dzarro@solar.stanford.edu
(See ssl_general/misc/SSW/is_string.pro)
Project : HESSI Name : is_struct Purpose : returns, 1/0 if valid/invalid input structure Category : Structure handling Syntax : IDL> output=is_struct(input) Inputs : INPUT = input structure array Outputs : OUTPUT = 1/0 Written : Zarro (EITI/GSFC), 17 Sept 2001 Contact : dzarro@solar.stanford.edu
(See ssl_general/misc/SSW/is_struct.pro)
NAME:
sswhere_arr
CALLING SEQUENCE:
ss=sswhere_arr(arr1, arr2)
PURPOSE:
gives the subscripts in the array arr1 that are for elements
of arr2
INPUT:
arr1, arr2 = twp arrays
OUTPUT:
ss = the subscripts of arr1 that are also in arr2
KEYWORD:
notequal = if set, return the array elements of arr1 that are
not in arr2
HISTORY
Spring '92 JMcT
Added notequal, extra, jun 2007, jmm
(See ssl_general/misc/SSW/sswhere_arr.pro)
Project : SOHO - CDS
Name : TAG_EXIST()
Purpose : To test whether a tag name exists in a structure.
Explanation : Routine obtains a list of tagnames and tests whether the
requested one exists or not. The search is recursive so
if any tag names in the structure are themselves structures
the search drops down to that level. (However, see the keyword
TOP_LEVEL).
Use : IDL> status = tag_exist(str, tag)
Inputs : str - structure variable to search
tag - tag name to search for
Opt. Inputs : None
Outputs : Function returns 1 if tag name exists or 0 if it does not.
Opt. Outputs: None
Keywords : INDEX = Index of matching tag
TOP_LEVEL = If set, then only the top level of the structure is
searched.
RECURSE = set to recurse on nested structures
Category : Util, structure
Written : C D Pike, RAL, 18-May-94
Modified : Version 1.1, D Zarro, ARC/GSFC, 27-Jan-95
Passed out index of matching tag
Version 2, William Thompson, GSFC, 6 March 1996
Added keyword TOP_LEVEL
Version 2.1, Zarro, GSFC, 1 August 1996
Added call to help
Version 3, Zarro, EIT/GSFC, 3 June 2000
added check for input array structure
Version 4, Zarro, EIT/GSFC, 23 Aug 2000
removed calls to DATATYPE
Version 5, Zarro, EIT/GSFC, 29 Sept 2000
added /quiet
Version 6, Zarro (EER/GSC), 22 Dec 2002
made recursion NOT the default
Removed datatype calls, jmm, 4-jun-2007
(See ssl_general/misc/SSW/tag_exist.pro)
Project : Solar-B Name : widget_valid Purpose : check if variable is a valid widget id Category : utility widgets Syntax : IDL> s=widget_valid(id) Inputs : ID = id to check Outputs : 1/0 if it is or isn't Keywords : None History : 12-Jan-2006, Zarro (L-3Com/GSFC) - written Contact : DZARRO@SOLAR.STANFORD.EDU
(See ssl_general/misc/SSW/widget_valid.pro)