Wind 3D Plasma Library

This page was created by the IDL library routine mk_html_help2.

Last modified: Thu Nov 21 16:35:54 2002.

Directories Searched:

• general/key_param/
• general/misc/
• general/science/
• general/tplot/
• wind/

Alphabetical List of Routines

• 3D_STRUCTURE
  Documentation for the 3d structure.
• ADD_BDIR
  Adds magnetic field direction [theta,phi] to a 3d structure
• APPEND_ARRAY
  Append an array to another array. Can also copy an array into a
• AVERAGE_STR
  Average data in res second time segments.
• BITPLOT
  Plots 'ON' bits for housekeeping type data.
• BYTESCALE
• CAL_BSN2
  Function returns a structure that describes the interaction of a B-field
• CART_TO_SPHERE
  transform from cartesian to spherical coordinates
• CART_TO_SPHERE2
• CDF_ATTR_EXISTS
  determines if a specified CDF file has an attribute with a specified name
• CDF_FILE_NAMES
  Returns an array of filenames within a timerange.
• CDF_INFO
  Returns a structure with useful information about a CDF file.
• CDF_VAR_ATTS
  Returns a structure that contains the attributes of a variable within
• CDF_VAR_EXISTS
  determines if a specified CDF file has a variable with a specified name
• CHANGE_PKQUALITY
  Change the level of packet quality used when filtering packets through
• COLORS_COM
• CONVERT_PH_UNITS
  Converts the units of the data array of ph data structures.
• CONVERT_SST_UNITS
• CONVERT_VFRAME
• CONV_UNITS
• COPY_DATA
• CROSSHAIRS
  Display crosshairs on the plot window, display the data coordinates of the
• CTIME
  Interactively uses the cursor to select a time (or times)
• CTIME_GET_EXACT_DATA
• CUTS
• C_3D
  Returns the sum of the counts in temp.data
• DATA_CUT
• DATA_TO_NORMAL
• DATA_TYPE
  Returns the variable type (ignores dimension).
• DAY_TO_YEAR_DOY
  determines year and day of year given day since 0000 AD
• DEL_DATA
  obsolete procedure! use "STORE_DATA" instead
• DIAG_P
  Returns the temperature: [Tpara,Tperp,Tperp], and
• DIMEN
  Returns the dimensions of an array as an array of integers.
• DIMEN1
• DIMEN2
• DIMEN_SHIFT
  Rotate dimensions of a multidimensional array.
• DIVIDE_DATA
• DOY_TO_MONTH_DATE
  Determines month and date given the year and day of year.
• DRAW_COLOR_SCALE
  Procedure to draw a color scale.
• EDIT3DBINS
• ENLARGE_PERIODIC
• EXTRACT_TAGS
• FIND_HANDLE
  Returns the index associated with a string name.
• FIND_STR_ELEMENT
• FNAME_TO_TIME
  To translate the name of a standard WIND data file into the starting
• GETTIME
• GET_3DT
  To generate time series data for "tplot"
• GET_3D_STRUCT
• GET_BKG3D
• GET_BSN2
  Generates tplot structures for intersection of Bow Shock and s/c B-field line.
• GET_COLORS
• GET_DATA
  Retrieves the data and or limit structure associated with a name handle.
• GET_EATOD
  Gets analog to digital data for EESA
• GET_ECFG
• GET_EH
• GET_EHB
• GET_EHS
• GET_EL
• GET_EL2
• GET_ELB
• GET_ELC
• GET_ELM
• GET_EMOM
• GET_EMOM2
  Gets eesa moment structure.
• GET_EXCFG
• GET_FILE_NAMES
  Gets an array of filenames within a time range
• GET_FILE_NAMES_IND
  Gets an array of filenames within a masterfile within a time range
• GET_FPC
• GET_FRAME_INFO
  Gets frame info data for WIND data files.
• GET_FSPB
• GET_FSPC
• GET_FT6T
  for omniazimuuth average flux if electrons, for survey plots
• GET_HKP
  Gets housekeeping data for eesa and pesa;
• GET_LATEST_DATES
• GET_MCFG
• GET_OSPB
• GET_OSPC
• GET_OT6T
  for omniazimuuth average flux if electrons, for survey plots
• GET_PADFLUX
• GET_PCFG
• GET_PH
  Returns a 3d structure containing all data pertinent to a single pesa high 3d sample.
• GET_PH2
  Returns a 3d structure containing all data pertinent to a single pesa high
• GET_PH30
  Get a 30 energy step ph structure containing the center (sunward) bins.
• GET_PHB
  Returns a 3d structure containing all data pertinent to a single pesa high
• GET_PHB_MAPCODE
  get the current mapcode for phb
• GET_PH_MAPCODE
  get the current mapcode for ph
• GET_PL
• GET_PL2
• GET_PLB
• GET_PMOM
• GET_PMOM2
  Gets pesa moment structure.
• GET_SDOTB
  INPUT: none
• GET_SF
• GET_SFB
• GET_SFT
• GET_SO
• GET_SOB
• GET_SOT
• GET_SPEC
  Creates "TPLOT" variable by summing 3D data over selected angle bins.
• GET_SYMM
• GET_TIMESPAN
• GET_TSPC
• GET_WIND_TIMES
• GET_YLIMITS
  Calculates appropriate ylimits for a string array of "TPLOT" variables
• HEATFLUX
• HELP_3DP
• INIT_WIND_LIB
  Initializes common block variables for the WIND 3DP library.
• INTERP
  Linearly Interpolates vectors with an irregular grid.
• ITON
  Convert an index or array of indicies to data names.
• JE_3D
  Returns the energy flux, [Je_x,Je_y,Je_z], ergs/(cm^2-s)
• J_3D
  Returns the flux, [Jx,Jy,Jz], 1/(cm^2-s)
• LIBS
• LOADALLCDF
  Loads selected CDF file variables into a data structure.
• LOADALLHDF
  Loads selected HDF file variables into a data structure.
• LOADCDF2
  Loads one type of data from specified cdf file.
• LOADCDFSTR
  loads data from specified cdf file into a structure.
• LOADCT2
• LOAD_3DP_DATA
  Opens and loads into memory the 3DP LZ data file(s) within the given time
• LOAD_ACE_CRIS
  loads ACE CRIS Experiment key parameter data for "tplot".
• LOAD_ACE_EPAM
  loads ACE EPAM Experiment key parameter data for "tplot".
• LOAD_ACE_MAG
  loads ACE MAG Experiment key parameter data for "tplot".
• LOAD_ACE_SEPICA
  loads ACE SEPICA Experiment key parameter data for "tplot".
• LOAD_ACE_SIS
  loads ACE SIS Experiment key parameter data for "tplot".
• LOAD_ACE_SWEPAM
  loads ACE SWEPAM (Ion) Experiment key parameter data for "tplot".
• LOAD_ACE_ULEIS
  loads ACE ULEIS Experiment key parameter data for "tplot".
• LOAD_DST
  loads DST data from a DST text file
• LOAD_GE_MGF
  loads GEOTAIL MAGNETOMETER Experiment key parameter data for "tplot".
• LOAD_HKP_MFI
  Creates TPLOT magnetic field variables from 3DP housekeeping data.
• LOAD_I8_MAG
  loads IMP-8 magnetometer key parameter data for "tplot".
• LOAD_I8_PLA
  loads IMP-8 Plasma Experiment key parameter data for "tplot".
• LOAD_IG_PCI
  loads INTERBALL Ground key parameter data for "tplot".
• LOAD_KP
  Loads Kp and ap data from a text file
• LOAD_PO_PWI
  Loads Polar Plasma Wave Instrument key parameter data into "tplot" variables.
• LOAD_SO_CEL
  loads SOHO CEL key parameter data for "tplot".
• LOAD_SO_CST
  loads SOHO CST key parameter data for "tplot".
• LOAD_SO_ERN
  loads SOHO ERN key parameter data for "tplot".
• LOAD_WI_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_EHPD
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_EHSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_ELM2
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_ELPD2
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_ELPD_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_ELSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_EM_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_EPA
  loads WIND Energetic Particle Analyser key parameter data for "tplot".
• LOAD_WI_FRM_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_H0_MFI
  loads WIND MAGNETOMETER high resolution data for "tplot".
• LOAD_WI_HKP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_MFI
  loads WIND MAGNETOMETER Experiment key parameter data for "tplot".
• LOAD_WI_OR
  loads WIND 3D Plasma Experiment orbit data for "tplot".
• LOAD_WI_PHSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_PLSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_PM_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_SFPD
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_SFSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_SOPD
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_SOSP_3DP
  loads WIND 3D Plasma Experiment key parameter data for "tplot".
• LOAD_WI_SP_MFI
  loads WIND MAGNETOMETER 3 second data for "tplot".
• LOAD_WI_SWE
  loads WIND Solar Wind Experiment key parameter data for "tplot".
• LOAD_WI_WAV
  loads WIND WAVES Experiment key parameter data for "tplot".
• MAKECDF
  Creates a CDF file given an array of structures
• MAKECDF2
  Creates a CDF file from a structure of arrays
• MAKEGAP
  Creates data gaps (by inserting NaN) when the time between data points is
• MAKEGIF
  Creates a GIF file from the currently displayed image.
• MAKEHELP
  Uses "mk_html_help2" to create an html help file
• MAKE_3DMAP
  Returns a 3d map using the theta's and phi's of a 3d structure.
• MAKE_CDF_INDEX
  Creates an index file for CDF files.
• MAKE_PLOT
• MAT_DIAG
  Diagonalize a 3x3 symmetric matrix
• MINMAX
• MK_HTML_HELP2
  Creates a html document from a list of IDL procedures.
• MPLOT
  General purpose procedure used to make multi-line plots.
• NDIMEN
  Returns the number of dimensions in an array.
• NN
• NORMAL_TO_DATA
• N_3D
  Returns the density, n, 1/cm^3
• OMNI3D
• OPLOT_ERR
  Plot error bars over a previously drawn plot.
• OPTIONS
  Add (or change) an element of a structure.
• PAD
• PADPLOT
• PANGLE
  Computes pitch angle given two sets of theta and phi
• PB5_TO_TIME
• PCLOSE
• PLOT3D
  Draws a series of 3d color plots, one plot per energy step.
• PLOT3D_COM
• PLOT3D_OPTIONS
• PLOT_MAP
• PLOT_ORBIT
• PLOT_POSITIONS
  Procedure that will compute plot positions for multiple plots per page.
• PMPLOT
• POPEN
  Change plot device to postscript.
• POPEN_COM
• PRESTENS
• PRINTDAT
  Displays information and contents of a data variable.
• PRINT_CDF_INFO
• PRINT_OPTIONS
• P_3D
  Returns the pressure tensor, [Pxx,Pyy,Pzz,Pxy,Pxz,Pyz], eV/cm^3
• REDUCE_DIMEN
• SCAT_PLOT
  Produces a scatter plot of selected tplot variables.
• SETFILEENV
  Sets up environment variables giving information on the location
• SHARE_COLORS
  Procedure that allows multiple IDL sessions to share the same color table.
• SMOOTH_PERIODIC
• SPEC3D
• SPECPLOT
  Creates a spectrogram plot.
• SPHERE_TO_CART
• START3DP
• STORE_DATA
  Store time series structures in static memory for later retrieval
• STRFILTER
  Returns the subset of stringarray that matchs filterstring
• STRPLOT
  Procedure used to print strings in a "TPLOT" style plot.
• STR_ELEMENT
  Find (or add) an element of a structure.
• SUB3D
• SUM3D
• SYMM3D
• SYMMETRY_DIR
• TIMEBAR
  plot vertical lines on tplots at specified times
• TIMERANGE
• TIMESPAN
  Define a time span for the "tplot" routine.
• TIME_DOUBLE
  A fast, vectorized routine that returns the number of seconds since 1970.
• TIME_EPOCH
  Returns the EPOCH time required by CDF files.
• TIME_PB5
  Returns the PB5 time required by CDF files.
• TIME_STAMP
  Prints a time stamp along the lower right edge of the current plot box
• TIME_STRING
  Converts time to a date string.
• TIME_STRUCT
  A fast, vectorized routine that returns a time structure.
• TIME_TICKS
  Returns a structure that can be used to create time ticks for a plot.
• TLIMIT
• TNAMES
  Returns an array of "TPLOT" names
• TPLOT
  Creates a time series plot of user defined quantities.
• TPLOT_COM
• TPLOT_FILE
  OBSOLETE PROCEDURE! Use "TPLOT_SAVE" and "TPLOT_RESTORE" instead.
• TPLOT_KEYS
  Sets up function keys on user keyboard to perform frequent "tplot"
• TPLOT_NAMES
  Lists current stored data names that can be plotted with the TPLOT routines.
• TPLOT_OPTIONS
  Sets global options for the "tplot" routine.
• TPLOT_PANEL
  Sets the graphics parameters to the specified tplot panel.
• TPLOT_POSITIONS
  Return a set of plot positions for tplot.
• TPLOT_QUANT__DEFINE
• TPLOT_RESTORE
  Restores tplot data, limits, name handles, options, and settings.
• TPLOT_SAVE
  Store tplot data in a file.
• TPLOT_SORT
  Sorts tplot data by time (or x).
• TRANGE_STR
• TRANSFORM_VELOCITY
• T_3D
  Returns the temperature, [Tx,Ty,Tz,Tavg], eV
• UNITS
• VTH_3D
  Returns the thermal velocity, [Vthx,Vthy,Vthz,Vthavg], km/s
• V_3D
  Returns the velocity, [Vx,Vy,Vz], km/s
• WI
• WIND_COM
• XLIM
  To set plotting limits for plotting routines.
• XYZ_TO_POLAR
• YLIM
  Sets y-axis limits for plotting routines.
• YLIMIT
• ZLIM
  To set plotting limits for plotting routines.
• _GET_EXAMPLE_DAT
  A procedure that generates sample data for "TPLOT".
• _TPLOT_DEMO
  A sample crib sheet that explains how to use the "TPLOT" procedure.
• _TPLOT_EXAMPLE
  A sample crib sheet that explains how to use the "TPLOT" procedure.