
|

|

|
Full list of tools
Importing data
Plotting data
Plotting plasmagrams in 3D
rpi3DPlot
If you want to convert a plasmagram to 3D, all that is needed is the corresponding bin file for that plasmagram. Save the bin file to the folder (see naming conventions in rpiDataReader) and call:
rpi3DPlot(input);
The string parameter 'input' is the full folder path.

rpi3DMovie
To show a set of 3D plasmagrams in an animation, use this script as follows:
rpi3DMovie(folderPath);
The string parameter 'folderPath' specifies where the bin files are found and where the movie file will be saved.
.............................................................................................
Plotting meridian cross section view
rpiPlotEarthFigure
Written by a previous student, plots locations of a set of events in space. All that is needed is the L-shell value and magnetic latitude of each event. Invoke as:
rpiPlotEarthFigure(L_outer, L_inner, Lvec, mlatVec, ...
format_outer, format_inner, format_marker, color_earth);
L_outer and L-inner are arbitrary reference L-shell bounds. Lvec is the vector of L-shell values for the events. mlatVec is the vector of magnetic latitude values. The last three arguments are just format markers using for plotting.

.............................................................................................
Plotting general histograms
rpiHistPlot
GUI for generating multiple histograms for a PGH data set. To invoke, call:
rpiHistPlot(histData);
The parameter 'histData' is the data structure created by rpiHistogram and rpiHistSupplement.

.............................................................................................
Plotting resonance histograms
rpiResPlot
This GUI is identical to rpiHistPlot, except the input structure has to be created by rpiResRead.
rpiResPlot(resData);
rpiResContrastPlot
This GUI plots two sets of histograms simultaneously, which is useful for comparing two periods of time or two contrasting conditions.
rpiResContrastPlot(resDataI, resDataII);
.............................................................................................
Plotting spacecraft spin data
rpiSpinVsFreq
Enables plotting of spacecraft spin info against sounding frequency. Invoke as:
rpiSpinVsFreq(input);
String parameter 'input' identifies the folder holding the plasmagrams and corresponding spin files.

.............................................................................................
Formatting plasmagram plots
rpiPlasmagramPlot
Designed to produce plasmagrams that can be inserted into writings and presentations.
result = rpiPlasmagramPlot(imageFile, startFreq, endFreq,...
property,value,...)
Creates a scaled and labeled plasmagram. Most inputs described below are optional. You can choose to manually add your own markings. The most important detail is that the image must be 1000x600 (pixels) in size. When saving the plasmagram in BinBrowser, go to Options > Picture Format and make sure width = 1000, height = 600. Using this standard size ensures that all the axes are scaled correctly.

Inputs:
-----------------------------------------------------------------------
required inputs
-----------------------------------------------------------------------
imageFile -- location of JPEG or PNG plasmagram file, which must be of size 1000x600 (pixels)
startFreq -- the starting frequency (kHz)
endFreq -- the ending frequency (kHz)
Example: filename = 'C:\REU-5.EE275-8\Desktop\20040804.jpg';
rpiPlasmagramPlot(filename, 6, 63);
-----------------------------------------------------------------------
optional properties
-----------------------------------------------------------------------
rangeLimits -- set starting and ending virtual ranges in RE;
value is two-number vector [start end];
default value is [0.0-Re 4.2-Re]
Example: rpiPlasmagramPlot(filename, 6, 63, ...
'rangeLimits', [0.3 4.2]);
-----------------------------------------------------------------------
fce -- electron gyrofrequency (kHz);
value is scalar
fpe -- electron plasma frequency (kHz)
value is scalar
Example: rpiPlasmagramPlot(filename, 6, 63, ...
'fce', 20, 'fpe', 240);
-----------------------------------------------------------------------
markCutoffs -- mark cutoff frequencies related to fce and fpe, such as fuh, fz, fx;
value is string response 'on' or 'off';
default value is 'off'
Example: rpiPlasmagramPlot(filename, 6, 63, ...
'fce', 20, 'fpe', 240, ...
'markCutoffs', 'on');
-----------------------------------------------------------------------
markTp -- mark multiples of the proton gyroperiod on vertical axis;
value is string response 'on' or 'off';
default value is 'off'
Example: rpiPlasmagramPlot(filename, 6, 63, ...
'fce', 20, 'fpe', 240, ...
'markTp', 'on');
-----------------------------------------------------------------------
freqLabel -- label a particular frequency (horizontal axis);
two subsequent values are needed, a scalar frequency (kHz) and a string label
Example: rpiPlasmagramPlot(filename, 6, 63, ...
'freqLabel', 30, 'resonance');
-----------------------------------------------------------------------
timeLabel -- label a particular time (vertical axis);
two subsequent values are needed, a scalar time (ms) and a string label
Example: rpiPlasmagramPlot(filename, 6, 63, ...
'timeLabel', 100, 'gyroperiod');
-----------------------------------------------------------------------
rangeLabel -- label a particular time (vertical axis) by providing the equivalent virtual range in RE;
two subsequent values are needed, a scalar range (RE) and a string label
Example: rpiPlasmagramPlot(filename, 6, 63, ...
'rangeLabel', 1.4, 'Whistler echo');
-----------------------------------------------------------------------
Output:
result -- handle to figure in which plasmagram is plotted
|

|
|

|

|