Ulysses HISCALE Data Analysis Handbook
Appendix 11. HISCALE IDL Display System (IDL_HS)
A11.2 Part Two - Reference (continued)
A11.2.2 Procedures (continued)
BAMPLOT
Plot SWOOPS CDF data.
ADD_STACK
Add the current plot transform to the stack.
| ADD_STACK | timeplot "NEW" |
ARCHIVE_MENU
Select archive type from menu.
| ARCHIVE_EVENT | event |
| ARCHIVE_MENU | "GROUP" |
BACK_MENU
Widget interface to set backgrounds.
| BG_SUBUNIT | base label labela labelb "UV1" "UV2" "V1" "V2" |
| BACK_EVENT | event |
| BACK_MENU | "GROUP" |
BACK_THR_MENU
| BACK_THR_EVENT | event |
| BACK_THR_MENU | "GROUP" |
CLOSE_PLOT
Closes plot device, in a sensible way and offers chance to plot hardcopy.
CLOSE_PLOT
COLOUR_MENU
Widget based colour editor for IDL_HS.
| COLOUR_EVENT | event |
| COLOUR_MENU | GROUP |
COMPARE_TIMES
Compare two times given in the form y, d, h, m, (s). Making the comparison mod 100 for the year, and in such a way as to avoid problems with leap years.
| COMPARE_TIMES | t1 t2 |
COMPARE_VERSION
Compares the version number of the file with that of the initial file, or stores the information for the first file.
| COMPARE_VERSION | hds first |
CONT_PROMPT
A prompt to continue, or quit in suitable mode.
| CONT_EVENT | event |
| CONT_PROMPT |
CONV\TIME\_STR
Convert a time string into a 4 (or 5) element time array.
| CONV_TIME_STR | st "SECONDS" |
CURSOR_WITHIN
Select the plot transform, within whose region the cursor lies.
| CURSOR_WITHIN | x y |
DF_PAL_COL
Loads a colour table from an HDF style palette (i.e., RGBRGB....), or from 3 separate arrays of red, green & blue.
| DF_PAL_COL | a1 a2 a3 a4 "WHITE" |
DIR_MENU
Choose the directories to be used (a) to read the data and (b) to put any hard copy plots.
| DIR_EVENT | event |
| DIR_MENU | "GROUP" "MODAL" |
DISPLAY_LANFILE
Display fields from an HSIO file.
| DISP_TAGS | |
| DSP_RD_RECORD | |
| FIELD_DISPL | |
| LANF_EVENT | event |
| DISPLAY_LANFILE | "GROUP" |
EXPAND_COMMAND
Expand/compress the filename in a plot spooling command.
| EXPAND_COMMAND | com "COMPRESS" |
FIND_MATCHES
Find files matching the specified pattern, including compressed & incomplete versions as appropriate.
| FIND_MATCHES | pattern |
FORM_FNAME
Forms a full filename from a name and a directory.
| FORM_FNAME | name dir |
FRILLS
Control whether to put overall headers on plots.
| FRILLS | ON OFF |
G_ALL_MENU
Widget interface for GET_ALL/OPTIONS.
| G_ALL_EVENT | event |
| G_ALL_MENU | "GROUP" "OPTIONS" |
GET_ALL
Restores the complete PLOT_RATES and PLOT_CDF environment as saved by SAVE_ALL.
| GET_ALL | file "VERBOSE" |
GET_LAN_RECORD
Read the next record from a HISCALE data file, opening a new file if needed.
GET_LAN_RECORD hds dds tzero icontinue "MFSS" "ONLY" "PHA" "PSUM" "TRK"
GET_OPTIONS
Restores the defined variables from the setting common blocks for PLOT_RATES and PLOT_CDF.
| GET_OPTIONS | file "VERBOSE" |
HDF_BG
Get background action for Greyscale display of HDF file.
| HDFBG_EVENT | event |
| HDF_BG | file im_min |
HS_ERR_MSG
Display an error message, in a suitable manner.
| HS_ERR_EVENT | event |
| HS_ERR_MSG | message "NOSTAR" |
HS_ERRPLOT
Overplot error bars over a previously drawn plot.
| HS_ERRPLOT | x low high "HORIZONTAL" |
HS_HELP
Provides on line documentation on the use of the HISCALE software and the IDL user libraries.
| HS_HELP | routine "CHANGES" |
HS_HELP_MENU
Make and process a widget interface for HS_HELP.
| HELP_EVENT | event |
| HS_HELP_MENU | "GROUP" |
LOGTICKS
Return a set of ticks to produce decade logarithmic plots at all times.
| LOGTICKS | range ticks tickv |
MAKE_FNAME
Produce the filename of a LAN archive file given the year and the day.
| MAKE_FNAME | year day oldname "BACKWARDS" "CDFDATA" "CDFMAG" "FILE_TIME" "MFSS" "PHA" "PSUM" "TRK" "UDS" |
MARKPOS
Mark one or more positions on a single plot.
| MARKPOS | date rate ipanel |
MATCH_NAMES
Matches a specified name to list of available names, with due priorities for compressed, incomplete and QEDR files.
| MATCH_NAMES | wanted |
MISMATCH
Set the action to be taken on finding a file version mismatch while reading data.
| MISMATCH | "ABORT" "CONTINUE" "IGNORE" "PROMPT" "TRUNCATE" |
MISMATCH_MENU
| MISMATCH_EVENT | event |
| MISMATCH_MENU | "GROUP" |
MK_FN_MENU
Widget interface for manual file selection.
| MK_FN_EVENT | event |
| MK_FN_MENU | p1 p2 p3 p4 |
MK_PLNAME
Make a suitable filename for a plot to a given device.
| MK_PLNAME | device |
PLCL_MENU
Menu interface for CLOSE_PLOT
| PLCL_EVENT | event |
| PLCL_MENU | "GROUP" |
PLOPEN
Selects plot device, and if 'tek' then waits for terminal to be switched into TEK mode. Allows choice of background colour and for hardcopy devices orientation and filename.
| PLOPEN | device filename "AUTO_CHARS" "BACKGROUND" "BIG_CHARS" "COLOUR" "LANDSCAPE" "LITTLE_CHARS" "PAGE" "PORTRAIT" "SET" "TEX" "WINDOW" "WNUMBER" |
PLOT_MENU
Selects plot device, via a widget interface.
| PLOT_EVENT | event |
| PLOT_MENU | "GROUP" "MODAL" |
PLOTSET
Sets up the device according to the choices made in PLOPEN. Sets suitable colour table for line plots (PGPLOT default table).
| PLOTSET | "NOWINDOW" |
READ_SCALE_WID
Read a scaling limit from a text widget.
| READ_SCALE_WID | wid have_value ABSTIME LOWER UPPER |
REGION_MENU
Set plotting region.
| REGION_EVENT | event |
| REGION_MENU | "GROUP" |
S_ALL_MENU
Widget interface for SAVE_ALL/OPTIONS.
| S_ALL_EVENT | event |
| S_ALL_MENU | "GROUP" "OPTIONS" |
S_HDF_MENU
Widget interface for SHOW_HDF.
| S_HDF_EVENT | event |
| S_HDF_MENU | "GROUP" |
S_PLOT_MENU
Widget interface for SAVE_PLOT.
| S_PLOT_EVENT | event |
| S_PLOT_MENU | "GROUP" |
SAVE_ALL
Save complete PLOT_RATES and PLOT_CDF environment, so that it can be restored later by using GET_ALL.
| SAVE_ALL | file "VERBOSE" "XDR" |
SAVE_OPTIONS
Saves the defined variables from the setting common blocks for PLOT_RATES and PLOT_CDF.
| SAVE_OPTIONS | file "VERBOSE" "XDR" |
SAVE_PLOT
| SAVE_PLOT | file "CURSOR" GIF |
SET_ARCHIVE
Select whether to plot from the raw ULA archive files or from the averaged UAV files.
| SET_ARCHIVE | prefix suffix "CMP1D" "CMP6H" "COMPRESSED" "CUAF" "DAYS" "DURATION" "HOURS" "MINUTES" "RESOLUTION" "SECOND" "SPARSE" "UAF" "UAV" "ULA" "USER_DEFINED" |
SET_BACK
Modify the instrument background levels.
| SET_BACK | "CA60" "CHANGEOVER" "LEFS150" "LEFS60" "LEMS120" "LEMS30" "POST_SWITCH" "PRE_SWITCH" "RESTORE" "SINGLES" "WARTB" |
SET_BG_THRESH
Set cut off level for background subtracted plots.
| SET_BG_THRESH | thresh |
SET_DIR
Choose the directories to be used (a) to read the data and (b) to put any hard copy plots.
| SET_DIR | data_dir "PLOT_DIR" |
SET_REGION
Sets a region to plot. The region is defined in Normalized coordinates and is used to define a reduced region for rates plots. This is designed as a "stand-alone" procedure to be called prior to running MFSA_RATES.
| SET_REGION | x1 y1 x2 y2 |
SHOW_HDF
Display the image or images in an HDF file (called by show_hdf)
| SHOW_HDF | file "PROGRAM" |
SQPAGE
Find best approximation to a square page for a given # of plots.
| SQPAGE | nplots cdef rdef |
TIME
Select start and stop times for plotting data.
| TIME | start_time stop_time |
TIME_MENU
Select start and stop times for plotting data.
| TIME_EVENT | event |
| TIME_MENU | "GROUP" |
VERSION_MM
Widget interface for the version mismatch action.
| VERS_EVENT | event |
| VERSION_MM | message |
Return to Appendix 11 Table of Contents
Return to HISCALE List of Appendices
Return to Ulysses HISCALE Data Analysis Handbook Table of Contents
Updated 8/8/19, Cameron Crane
QUICK FACTS
Mission End Date: June 30, 2009
Destination: The inner heliosphere of the sun away from the ecliptic plane
Orbit: Elliptical orbit transversing the polar regions of the sun outside of the ecliptic plane