Ulysses HISCALE Data Analysis Handbook
Appendix 11. HISCALE IDL Display System (IDL_HS)
A11.2 Part Two - Reference (continued)
A11.2.2 Procedures (continued)
CLOSE_LANFILE
Close a file.
CLOSE_LANFILE | findex code |
DEFINE_LANFILE
Define entry points, etc., for HSIO.
DEFINE_LANFILE
ERR_LANFILE
Print the most recent C run time library error message, prefixed by an identifying tag.
ERR_LANFILE | tag |
GET_MFS_MFSS
Extract a summed spectral record and convert.
GET_MFS_MFSS | data dds |
GET_PHA_PSUM
Extract a chunk of a PSUM record from a data block.
GET_PHA_PSUM | data dds rindex |
GET_TRK_PTRK
Convert a track record (PTRK).
GET_TRK_PTRK | data dds |
GET_ULA_HEAD
Extract a ULA header block from the data. Called by ULA_STRUCT.
GET_ULA_HEAD | data hds |
GET_ULA_MFSA
Get a MFSA data structure from the raw data record, called by ULA_STRUCT.
GET_ULA_MFSA | data dds |
GET_ULA_PHAR
Get a PHA data structure (ula_phar) from a raw data record. Called by ULA_STRUCT.
GET_ULA_PHAR | data dds |
GET_ULA_RATE
Gets a RATE data block from the input data and returns it as a structure of type "ula_rb". Called by ULA_STRUCT.
GET_ULA_RATE | data dds |
MAP_LANFILE
Associate a map file with an HSIO file.
MAP_LANFILE | index mapfile error |
OPEN_LANFILE
Open a file for use by HSIO.
OPEN_LANFILE | file mode findex lrecl |
READ_LANFILE
Read data from a file.
READ_LANFILE | findex data nread nact nfile |
RENAME_LANFILE
Rename a file.
RENAME_LANFILE | oldname newname code |
SEEK_LANFILE
Move to location in file immediately before requested time.
SEEK_LANFILE | findex year day hour position |
ULA_STRUCT
Will take a byte array of data (read by READ_LANFILE or other suitable means) and load it into a pair of structures, firstly a header and then the appropriate type for the body of the data.
ULA_STRUCT | data hds dds "ONLY" |
VERS_LANFILE
Return the version number of the current version of HSIO.
VERS_LANFILE | version |
WRITE_LANFILE
Write data to a file.
WRITE_LANFILE | findex data nwrite nact nfile |
ACQUIRE_MOV_UAV
Reads in the data from the file and stores the appropriate parts of it in the arrays rates and times.
ACQUIRE_MOV_UAV
ACQUIRE_MOVIE
Reads in the data from the file and stores the appropriate parts of it in the arrays rates and times.
ACQUIRE_MOVIE
ADD_PITCH
Add contours of pitch angles to the current movie frame.
ADD_PITCH | index "NOCOMMENT" |
ANIM_ONE
Advance one frame in MOVIE
ANIM_ONE | id "BACKWARD" "FORWARD" |
ANIMATE
Animates the movie by changing the colour indices.
ANIMATE
CREATE_MOV_ARR
Create the arrays needed to read the data and store them for plotting.
CREATE_MOV_ARR | nvals |
DELAY_MENU
Set value for spectral delay.
DELAY_EVENT | event |
DELAY_MENU | "GROUP" |
DRAW_FRAME
Draws out a single frame from a movie.
DRAW_FRAME | ifn |
DRAW_MOVIE
Draws out the initial layout for the movie, puts titles, etc., on it.
DRAW_MOVIE | "REDRAW" |
FIND_FRAME
Locate the frame number containing the requested time.
FIND_FRAME | ftime |
FOIL_MENU
Set value for foil factor or deflection factor.
FOIL_EVENT | event |
FOIL_MENU | "GROUP" |
FRAME_MENU
Widget interface for single_frame.
FRAME_EVENT | event |
FRAME_MENU | "GROUP" |
INDEX_MENU
Set value for spectral index.
INDEX_EVENT | event |
INDEX_MENU | "GROUP" |
M_BGREM
Minimal MOVIE background removal procedure.
M_BGREM
M_CHAN_MENU
Widget interface for m_chan selection in plot_rates.
COMB_M_CHANS | ch1 ch2 |
M_CHAN_EVENT | event |
M_CHAN_MENU | "GROUP" |
M_CHAN_OPTS
Allows the user to select which of the possible sets of channels to display as a movie.
M_CHAN_OPTS | names cdescr |
M_COLOUR_BAR
Add a colour bar to a movie (on the RH side).
M_COLOUR_BAR | xlf yt |
M_COLOUR_MENU
Set colour tables for MOVIE.
M_COLOUR_EVENT | event |
M_COLOUR_MENU | "GROUP" |
M_SCALE_MENU
Scaling for movies by menu.
M_SCALE_EVENT | event |
M_SCALE_MENU | "GROUP" |
MOV_WID_MAKE
The system of controls for the draw-widget version of movie.
MOV_WID_EVENT | event |
MOV_WID_MAN | |
MOV_WID_MAKE |
MOVIE
Make and display a movie from the ion channels available in all heads.
MOVIE | "PROMPT" "REREAD" |
MOVIE_CHAN
Allows the user to select which of the possible sets of channels to display as a movie.
MOVIE_CHAN | chname |
MOVIE_COL
Switch between Colour and Greyscale Movies.
MOVIE_COL | "COLOUR" "GREY" |
MOVIE_EFILL
Switch the filling in of LEMS120 electrons on or off.
MOVIE_EFILL | "OFF" "ON" |
MOVIE_HEADER
Plots an overall heading for the rate plots.
MOVIE_HEADER
MOVIE_LOG
Switch between log and linear plots for movie colour maps and for movie trace time-series.
MOVIE_LOG | "LINEAR" "LOGARITHM" "TLINEAR" "TLOGARITHM" |
MOVIE_MENU
Widget based interface for movie.
MOVIE_EVENT | event |
MOVIE_MENU | "GROUP" |
MOVIE_PITCH
Switch the plotting of pitch angle contours on all frames on and off.
MOVIE_PITCH | "OFF" "ON" |
MOVIE_SCALE
Set the scaling of the movie display. If the mapping is linear then the range will be from (2-scale) to scale, and if logarithmic, then from 1/scale to scale.
MOVIE_SCALE | scale |
MOVIE_TS
Switch the plotting of a trace time-series on or off.
MOVIE_TS | "OFF" "ON" |
PLOT_MTRACE
Plot single plot, single colour.
PLOT_MTRACE | xrt yt |
PLOTSET_MOVIE
Sets up the device according to the choices made in PLOPEN. Sets suitable colour table for line plots (PGPLOT default table).
PLOTSET_MOVIE
SET_DEFLECT
Sets the "deflection factor" for matching the geometry factors of the LEFS and LEMS detectors for electrons.
SET_DEFLECT | factor |
SET_DELAY
Sets the delay between frames of the movie.
SET_DELAY | interval |
SET_FOIL
Sets the "foil factor" for matching the geometry factors of the LEFS and LEMS detectors.
SET_FOIL | factor |
SET_INDEX
Sets the spectral index to be used in matching the fluxes in MOVIE.
SET_INDEX | index |
SINGLE_FRAME
Plots a single frame from a movie on any device (user's responsibility to ensure that it will cope).
SINGLE_FRAME | ftime "FILL_ELECTRONS" "INDEX" "NOFILL_ELECTRON" "NOPITCH" "NOTRACE" "PITCH" "TRACE" |
TRACE_BAR
Moves the bar on a trace plot by one time step.
TRACE_BAR | i "ERASE_ONLY" "SINGLE" |
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