******************************************************************************* cluster_rapid module, version 1.2, 24 Jan 2003 ******************************************************************************* Use this window to add new cluster_rapid panels to the Panel Composer or to edit existing cluster_rapid panels. This module is for energetic ion composition and electron data from the RAPID instrument on CLUSTER. This module is compatible with PAPCO version 10.2 Author: Reiner Friedel, friedel@lanl.gov =============================================================================== CONTENTS: DATA AVAILABILITY Data used by the module and where to get it. FORM OF PLOTS Type of output plots produced. CONFIGURE OPTIONS Environmental variables needed by the module. Set by using the Config option of the module. PAPCO SUPPORT Which of the papco features are supported by the module. DESCRIPTION OF PANEL EDITOR FUNCTIONS Describes what each widget in the panel editor does. Explains both the papco-build-in options and those options specific to this module. PAPCO/MODULE RESOURCES/DOCUMENTATION List of sites for further documentation on papco and this module =============================================================================== DATA AVAILABILITY ------------------------------------------------------------------------------- A full set of RAPID data is available at LANL, but not all on-line. This includes all the data from the cdroms, the msf files, the RAL IF fiels and LINDAU BIN "zong" files. SCIENCE files are computed on demand and converted to idl savesets, since these read faster and take up less space. From the CCR web page you can currently download the complete set of IF files for a day: http://leadbelly.lanl.gov/ccr/level2-data/cgi-bin/get_ccr_digital.cgi A full set of summary plots of RAPID data made with this module is available on the CCR site: http://leadbelly.lanl.gov/ccr/CCR_summary_plots.html NOTE: This module will eventually use the SCIENCE files as primary input for IIMS and the RAL IF files as primary input for IES. To ontain any of these files in larger quantitiy contact Reiner Friedel, friedel@lanl.gov. FORM OF PLOTS ------------------------------------------------------------------------------- Primarily color plots of energy spectrograms or roll plots. 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. $DATA is the root of the data tree, and the settings below are the suggested data tree (optional, these environmental variables can point at ANY directory). CLUSTER_RAPID_SCI $DATA/cluster/rapid/science CLUSTER_RAPID_PITCH $DATA/cluster/rapid/pitch CLUSTER_RAPID_BINARY $DATA/cluster/rapid/binary CLUSTER_RAPID_IF $DATA/cluster/rapid/ifdata CLUSTER_RAPID_RDDA $DATA/cluster/rapid/rdda CLUSTER_RAPID_L0 $DATA/cluster/rapid/l0 CLUSTER_RAPID_DATA_FTP_ARCHIVE ftp://user:psw@some.host/data/cluster_rapid CLUSTER_RAPID_SCI LINDAU ASCII .SCI Science files. Needs to contain a directory "savesets" for IDL saveset copies of the files (made automatically if absent). CLUSTER_RAPID_PITCH Pitch angle files. Not used yet. CLUSTER_RAPID_BINARY LINDAU BIN "Zong" files. Needs to contain a directory "savesets" for IDL saveset copies of the files (made automatically if absent). CLUSTER_RAPID_IF RAL intermediate files "IF files". Otput of RAL software. These are already in idl saveset format. Note: for correct time taging, these files need to be made from the LINDAU BIN files, not the cdroms. CLUSTER_RAPID_RDDA Root of the the directory tree structure needed for the Daly/Kettmann software. At LANL, this contains a copy of all of the data from the cdroms plus the master science file (msf) directories. CLUSTER_RAPID_L0 Used to be for the level zero cdf files. No longer supported, but module will plot selected data from early trial cdf files. CLUSTER_RAPID_DATA_FTP_ARCHIVE the url string needed to access data remotely of the form ftp://user:password@remote.host.name/data/dir/ This utility used the unix shareware "wget" to get data ***not yet active for this module*** PAPCO SUPPORT ------------------------------------------------------------------------------- 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? no PLOT OVER FILE BOUNDARIES POSSIBLE? yes REMOTE DATA GET? no OUTPUT DATA TO FILE? no SLICE SUPPORT yes (limited) Slices supported: zoom hair cursor =============================================================================== 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 ********************** ************************************************** NOTE: Not all of the functions described are active in the public distributed version of this module Spacecraft Choice ----------------- Select which Cluster spacecraft to plot. For four SC products, this sets the spacecraft that will be used as time reference (data from other SC will be folded in this spacecraft's time series). Data Source Files ----------------- Select what files to use as input. depeneding on this setting the data product to choose from will change. MPAe Bin - Lindau BIN "ZONG" files. CDF - level zero cdf files, no longer supported For this option you can choose the CDF surce, as oth Lindau and Kiruna were providing software for this option. Moot, no longer supported. RAL-IF - RAL intermadiate files MPAe Sci - Pat Daly's ascii science files. Data choice for these sources is still limited! Don't expect all of the to work! CDF Source ---------- See "CDF" above under "Data Source Files". Input ----- This module inputs all data from the read routine to the plot rutine via the same common block. Use the "adopt" option when plotting several plots in consecutive panels from the same input (e.g. several detectors from RAL-IF IES_CLEAn data) to avoid re-reading the data repeadetly. use with caution... Force Make ---------- At LANL, this module invokes the external programs needed to make data files that are not present. If a RAL IF file is not found, the RAL rutines are called to produce the file. If Bin, Science fiels are not found, the Lindau software is called. Leave this setting at "no" unless you have integrated your data production into PAPCO. For details of how to do this, contact Reiner Friedel. Data Choice ----------- The next part of the widget changes depending on what data source is selected (see "Data Source Files" above). "Particle Species" for Bin and CDF. Spin averaged spectra for the basic species of RAPID. All uncalibrated, counts only "RAL IF data choice" for RAL IF files. A selection of the RAL IF files can be plotted. IES is calibrated, IIMS is not. refer to Martin Carters documentation for a description of these data products. "MPAe Sci data choice" for Pat Daly's SCIENCE files. refer to the Lindau Web site for documentation on these files and how to install software to produce them (based on the msf files). calibrated for IIMS, not IES. IIMS calibration is preliminary!! Data choice for these sources is still limited! Don't expect all of the to work! (Some are made incactive). Plot type: --------- Spectrum: plots energy spectra. Depending on the product you choose (you'll have to know!) these are spin averaged and /or detector averaged, or by sector. Use the sliders below to choose detector / sector whn applicable. Roll: for the 3D product that have sectro resultion: plots the sectors at a given energy / detector. Energy @ pitch Coming Soon! Energy spectra at a given pitch angle range. Use the sliders below to choose pitch angle range. Pitch @ energy Coming Soon! Pitch angle distribution at given energy range. Use the sliders below to choose energy channel. Four SC products: ----------------- use with care, very much under development. Works only for some products, notably RAL-IF IES ESPCT. Standard deviation: plots a single value indicating how "different" data are from the four spacecraft, line plot Spacecraft Intercal: For test purposes. Plots selected energy channel from all spacecraft, line plot. Sliders ------- These change depending on what Plot type is chosen. Typicallt avaliable are energy, detector #, sectror#, pitch angle range Data units: ----------- Select plot uints / calibration. Only working for RAL-IF IES plots. Smooth Data ----------- Interpolate spectra to make better looking plots. Otherwise actural channel widths are plotted for spectra. Currently inactive. Make Batch ---------- Only for the LANL version of module. Makes a batch file of dates of available data, used for running papco in batch mode to make plots for CCR page. ************************************************** ******************* End Module Specific Section Widgets *********************** ************************************************** USER PANEL DESCRIPTION ------------------------------------------------------------------------------- Choose how to label panels THIS FUNCTION NEEDS TO BE SUPPORTED BY THE PLOT ROUTINE TO WORK. Used to overwrite the automatic panel labeling on the right hand side of the panel. Works only if the panel uses the papco utility "right_side_label" to do this labeling. Auto: Use labeling as set in plot routine Inhibit: Don't plot label Manual: Use label defined here as label (can include all IDL formatting) Extend: Used to extend the label over several panels. Enter integer number of panels above current panle to extend labeling across. usefull for right_side_label, /rot90 option, labeling for spectrograms. New value needs to be confirmed by "enter". 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. The label # can be used to control the number of labels. This works only if the plot routine used the papco utility "papco_y_label" is used to set y-axis labels. 0 : use idl internal automatic labeling -1 : inactive, behaviour controlled by plot routine +ve : use this as the umber of labels to plot. 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. PAPCO/MODULE RESOURCES/DOCUMENTATION ------------------------------------------------------------------------------- Check for updates of this module on the LANL PAPCO module website: http://leadbelly.lanl.gov/ccr/software/papco/cluster_rapid/ Other RAPID websites including summary plots and documentation are at: Lindau DALY/Kettman software and documentation: http://www.linmpi.mpg.de/english/projekte/cluster/rapid.html RAL RAPID site: http://sspg1.bnsc.rl.ac.uk/Share/Cluster/Rapid/rapid.htm PAPCO resources can be found at the PAPCO website: http://leadbelly.lanl.gov/ccr/software/papco/papco.html PAPCO user manual (currently at Version 9, all still valid, however some of the latest papco features are not documented there) http://leadbelly.lanl.gov/ccr/software/papco/papco/papco.html Pre-release site for the latest PAPCo version: http://nis-www.lanl.gov/~friedel/papco_source/