Fundamental Technologies Ulysses HISCALE Pages

A11.2 Part Two - Reference

A11.2.1 Introduction

This document is a reference summary for the IDL_HS package. It simply contains lists of procedures and common blocks, etc.

• A11.2.2 Procedures (below)
• A11.2.3 Common Blocks
• A11.2.4 Structure Tags
• A11.2.5 The Xmanager Names

A11.2.2 Procedures

This section is simply a list of the procedures in the package, ordered by directories and alphabetically within the directory. Note that the material has been extracted mindlessly from the comments in the routines (actually from the 00_summary_dir procedure used by HS_HELP to provide the same information and from a HELP, /ROUTINES call after compiling everything).

List of procedures:

idl

CDF_DEFINE

Define structures for CDF.

CDF_DEFINE

HS_DEFINE

Define HISCALE data structures.

HS_DEFINE

HS_MENU

Controller for menu generator and handler for HISCALE Widget interface.

HS_MENU_TOP

Maker and event handler for the top-level HISCALE menu.

IDF

Get the rate channel energies, etc., from IDF.DAT.

IDF_MENU

Create and control a menu for reading an IDF file.

SET_DEFAULT_DIR

Sets initial values for the directories.

SET_DEFAULT_DIR

idl/cdf

ACQUIRE_CDF

Reads in the data from the CDF file and stores the appropriate parts of it in the arrays rates and times.

ACQUIRE_CDF

ACQUIRE_CDF_HED

Reads in the data from the HED CDF file and stores the appropriate parts of it in the arrays rates and times.

ACQUIRE_CDF_HED

CDF_CH_NAMES

Return names and descriptions of the CDF channels for menus.

CDF_CHAN

Select the CDF channel or channels to plot.

CDF_CHAN_MENU

Menu interface for CDF_CHAN.

CDF_DOFILTER

Applies a simplified version of the SPIKE & DROPOUT removal algorithm of plot_rates to CDF data.

CDF_DOFILTER

CDF_FILTER

Select whether to attempt to "filter" CDF plots.

CDF_FILTER "OFF" "ON"

CDF_HEADER

Plots an overall heading for the CDF plots.

CDF_HEADER

CDF_MENU

Widget based interface for cdf.

CDF_PLOT

CDF_PLOT

CONV_CDF

Converts a CDF record of any type into a usable structure.

CRE_CDF_ARRAYS

Create the arrays needed to read the data and store them for plotting.

EXT_CDF_ARRAYS

Extends the data arrays as requested by ACQUIRE_DATA, etc. Extension is by 20% of current length.

GET_BAM

Convert a BAM CDF record to a useful structure with native-mode values.

GET_GLG

Convert a GLG CDF record to usable form.

GET_HED

Convert a HED CDF record to usable form.

GET_KEP

Convert a KEP CDF record to usable form.

GET_LAN

Convert a LAN CDF record to usable form.

GET_SIM_HET

Convert a SIM_HET CDF record to usable form.

GET_SIM_KET

Convert a SIM_KET CDF record to usable form.

GET_SIM_LET

Convert a SIM_LET CDF record to usable form.

GET_STO

Convert a STO CDF record to usable form.

IBM_FIX

Converts one or more IBM short integer values to native mode. Works by using the fact that IBM's are big endian as network.

IBM_FLOAT

Takes a byte array containing one or more IBM floating point values, and returns native mode floating point values.

IBM_LONG

Converts one or more IBM long integer values to native mode. Works by using the fact that IBM's are big endian as network.

INVSEC

This function converts seconds since 1950.0 into year,day,hour,min, and sec.

PLOT_CDF

Make a plot of selected channels from the ULYSSES CDF.

REC_TYPE

Returns a code for the type of CDF record.

SCTIME

Converts a spacecraft 6-byte time field (I*4 seconds since 1950.0, I*2 fractional second) to a double precision floating point value.

idl/etc/acf

ACF

Compute autocorrelation function of PLOT_RATES data.

EXCISE

Set to zero, or other given value a given time-range of rates data.

EXTRACTCF

Extracts a segment of autocorrelation function (or structure function).

FOLD

Period folding function program.

PAD_GAPS

Pads out data gaps in uav or cmp data, for acf, etc.

SF

Compute structure function of PLOT_RATES data.

XCF

Compute cross correlation function of PLOT_RATES data.

idl/etc/oddments

CHECK_MAG

Checks the times in a magnetic field file for sequentiality.

DELAYS

Compute delays along a specified path for all HISCALE channels.

DRAWORIENT

Draw the magfield directions relative to the S/C.

HS_EDIT

Select and extract records from an HSIO file.

PHACHK

Check number of events in PHAR records.

RATE_INDEX

Compute spectral index from rates array.

SSPECT

Plot a spectrum/time-series as a 3-D surface.

idl/etc/padlan

ANORM

Calculates sector-ave'd normal area.

LANCOSINE

Calculates angular response for stationary heads.

PADLAN3

Simulates convected expl pad for LAN heads.

POLAR_PLOT

Simple program to plot polar diagram of particle distributions.

VDIR

Convert SWOOPS RTN Velocity components to s/c directions.

Continue

Return to HISCALE Data Analysis Handbook Table of Contents.
Return to HISCALE Data Production Center Main Page.