******************************************************************************* cluster_peace module, version 0.2, 28 Aug 2002 ******************************************************************************* Use this window to add new cluster_peace panels to the Panel Composer or to edit existing cluster_peace panels. This is a generic module that can read and plot all ISTP cdf files. This module is built using the CDAWlib idl library. DATA AVAILABILITY ------------------------------------------------------------------------------- Data can be obtained from the CDAWeb site: http://cdaweb.gsfc.nasa.gov/ and the CLUSTER PRIME PARAMETR (non-public) site at http://rumba.gsfc.nasa.gov/cdaweb/cluster/ FORM OF PLOTS ------------------------------------------------------------------------------- This module plots single line plots for one dimensional data, and multiple line plots pr color spectra for multi-dimensional data. CONFIGURE OPTIONS ------------------------------------------------------------------------------- Pressing the Configure button calls up this module's configure widget. This sets a series of environmental variables which are needed for this module to function: CLUSTER_PEACE_DATA directory for cluster_peace data. In this directory the user should maintain a set of links, appropriately named, that point to the location of various cdf data directories for different missions/instrumens. The names of these links will appear as data choices in this module's panel editor. The module expects all cdf files in a given data directory to be of the same kind, with the filenames containing the date in the form "yyyymmdd" somewhere in the filename, and extension ".cdf". Data can either be all in one directory or in subdirectories per year, of form "/yyyy". ADDING NEW CDF FILES ------------------------------------------------------------------------------- Simply add a link pointing to the new cdf data directory to the location pointed at by CLUSTER_PEACE_DATA. This new directory is automatically available to the module. PAPCO SUPPORT ------------------------------------------------------------------------------- %%% ADD A DESCRIPTION OF HOW MUCH PAPCO FUNCTIONALITY YOUR PLOTS %%% %%% SUPPORT. IN PARTICULAR: %%% Y-SCALING SUPPORT yes Z-SCALING SUPPORT yes PAPCO COLOR SCHEME SUPPORT yes ZOOMING SUPPORT yes NO DATA FOUND SUPPORT yes PLOT BY ORBIT AVAILABLE? no OVERPLOT POSSIBLE? yes (no for spectra) PLOT OVER FILE BOUNDARIES POSSIBLE? yes REMOTE DATA GET? no OUTPUT DATA TO FILE? no SLICE SUPPORT no Slices supported: =============================================================================== DESCRIPTION OF PANEL EDITOR FUNCTIONS =============================================================================== HEIGHT OF THE PLOT ------------------------------------------------------------------------------- Use this slider to modify the plot's height. Effectively, this slider is the third element of the panel-vector which is displayed in the plot list-box in PAPCO's main window. You may as well change the plot's height by using the buttons to the right of the plot-description list-box in PAPCO's main-window. ------------------------------------------------------------------------------- ************************************************** ****************** Begin Module Specific Section Widgets ********************** ************************************************** Select CDF directory ------------------------------------------------------------------------------- A set of choices of CDF directories to be used - based on the list of directories found under CLUSTER_PEACE_DATA. The button labels are the same as the directory names. As a button is clicked, the list below is updated with the variables found in the CDF files. This may take time. Variable name - variable type - decription ------------------------------------------------------------------------------- A list of all variables found in the cdf files found in the CDF directory. All variables are given, dat and meta-data. Only the data type variables are plottable by this module. Double-clicking on a data varibale line causes the module to read one of the data files, and to display all the attributes of the variable. Spacecraft ------------------------------------------------------------------------------- If the cdf file chosen is from the CLUSTER mission, a choice of spacecraft can be made here. Coords ------------------------------------------------------------------------------ ************************************************** ******************* End Module Specific Section Widgets *********************** ************************************************** ------------------------------------------------------------------------------- SYMBOL / COLOR ------------------------------------------------------------------------------- Choose a line style and color for your line plots THIS FUNCTION NEEDS TO BE SUPPORTED BY THE PLOT ROUTINE TO WORK. IT IS ONLY MEANINGFUL FOR LINE PLOTS. If SYMBOL is clicked use the slider below to set your symbol type for each data point. Default (0) is no symbols (connect data with line). The graphics window to the right shows an example of the symbol chosen. Positive SYMBOL numbers are for symbols not connected with lines. Negative SYMBOL numbers are for symbols connected with lines. If COLOR is clicked a color for your lines and symbols can be chosen. COLORBAR ------------------------------------------------------------------------------- Choose a PAPCO color subtable. THIS FUNCTION NEEDS TO BE SUPPORTED BY THE PLOT ROUTINE TO WORK. IT IS ONLY MEANINGFUL FOR COLOR PLOTS. PAPCO provides the user with four internal color tables. These can be used in several plots at the same time as PAPCO subdivides the IDL color-table into four. The buttons choose the color sub-table to be used, the names given are those for the color tables loaded at startup. The first one is the default PAPCO color table (GSFC rainbow) and cannot be changed. The other three can be user defined. The colorbars indicate the current status of the loaded color sub-tables. YSCALING ------------------------------------------------------------------------------- Choose automatic or manual Y-scaling. THIS FUNCTION NEEDS TO BE SUPPORTED BY THE PLOT ROUTINE TO WORK. For Use automatic y-scaling, the common block vector yscl has it's first element set to zero, which tells the plot routine to use it's own yscaling - which is either hard-wired or employs some auto-scaling routines (autoscale, ylim). For Use manual y-scaling the entry fields below are activated: enter your own y-range values. These are stored in the 2nd and 3rd elements of the common block vector yscl. Once a plot has been done, the automatic values chosen are displayed in the entry field to guide the user if he wants to change them. The lin/log buttons set the 4th element in the common block vector yscl and can be used directly to set the ylog keyword to the IDL plot routine. ZSCALING ------------------------------------------------------------------------------- Choose automatic or manual Z-scaling. THIS FUNCTION NEEDS TO BE SUPPORTED BY THE PLOT ROUTINE TO WORK. IT IS ONLY MEANINGFUL FOR COLOR OR 3-D PLOTS. For Use automatic z-scaling, the common block vector zscl has it's first element set to zero, which tells the plot routine to use it's own yscaling - which is either hard-wired or employs some auto-scaling routines (autoscale, ylim). For Use manual z-scaling the entry fields below are activated: enter your own y-range values. These are stored in the 2nd and 3rd elements of the common block vector zscl. Once a plot has been done, the automatic values chosen are displayed in the entry field to guide the user if he wants to change them. The lin/log buttons set the 4th element in the common block vector zscl and can be used directly to set the zlog keyword to the IDL plot routine. HELP ------------------------------------------------------------------------------- Displays this help widget. THE EXIT BUTTONS ------------------------------------------------------------------------------- CANCEL closes the window and does nothing. ADD and CONTINUE closes the current window, adds the plot to the composer, and re-enters the panel editor where it left off and allows you to add a further panel with possibly another choice of parameters. ADD and CLOSE adds the plot to the composer and closes the window. ADD and CONTINUE and ADD and CLOSE are replaced by UPDATE when the editor is called to edit an existing panel.