This page was created by the IDL library routine
mk_html_help2.
Last modified: Wed Dec 6 12:50:16 2017.
NAME: DSC_DYPLOT
DESCRIPTION:
Plot a shaded area showing confidence range where avaialable.
Will look for tplot variable options tags
dsc_dy: 0 - do not show dy interval
1 - show dy interval if available
dsc_dycolor: (int) Colortable reference for dy fill color
INPUT:
KEYWORDS: (Optional)
COLOR=: Set to desired fill color. (int or int array) Will override any options set in the dlimits/limits
structures. If not set will reference the 'dsc_dycolor' variable option or
choose a reasonable default.
FORCE: Set to ignore the 'dsc_dy' tag setting and show the DY for all requested panels if DY available
PANEL=: Array of indices describing which panels for which to draw confidence. (1 indexed like TPLOT)
If this is not set the routine will attempt to draw confidence for all panels.
POS=: 4xn array describing the positions of each of the n panels in the plot of interest.
Defaults to the positions found in the 'tplot_vars' structure.
TVINFO=: Structure containing TPLOT variables information - as returned
from the 'new_tvar' keyword to tplot.
If not set uses that found in common 'tplot_vars'
VERBOSE=: Integer indicating the desired verbosity level. Defaults to !dsc.verbose
WINDOW=: Which direct graphics window to target for this polyfill. (int)
This is gererally not needed if plotting on an existing tplot window. Will default
to whatever is set by the TVINFO structure being used.
CREATED BY: Ayris Narock (ADNET/GSFC) 2017
$LastChangedBy: nikos $
$LastChangedDate: 2017-11-20 12:45:47 -0800 (Mon, 20 Nov 2017) $
$LastChangedRevision: 24321 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_1/projects/dscovr/plot/dsc_dyplot.pro $
(See projects/dscovr/plot/dsc_dyplot.pro)
NAME: DSC_GET_YLIMITS
DESCRIPTION:
Calculates appropriate ylimits for a string array of TPLOT variables
to be plotted in the same panel.
INPUT:
DATASTR: String array of TPLOT variables
LIMITS: Limits structure to be modified (usually the limits
structure of the TPLOT variable whose data
field is a string array of TPLOT variables)
TRG: Time range over which to calculate the limits (double[2])
KEYWORDS: (Optional)
BUFF: Set to add a 10% buffer to yrange. Default is exact to data min/max.
COMP=: Indicate with vector component to range over. (int) Ignored for scalar variables.
INCLUDE_ERROR: Set to include the data.dy in the range calculation
VERBOSE=: Integer indicating the desired verbosity level. Defaults to !dsc.verbose
OUTPUTS:
LIMITS.yrange is created or modified.
EXAMPLES:
dsc_get_ylimits,'dsc_h0_mag_B1F1',limstr,trg
dsc_get_ylimits,'dsc_h1_fc_V_GSE_x',limstr,trg,/inc,/buff
tn = dsc_ezname(['vx','vy','b','temp'])
dsc_get_ylimits,tn,limstr,trg,/buff ;All variables set to the same yrange
NOTES:
Adapted from TPLOT 'get_ylimits' procedure.
-Added support for limit based on single component of a vector
-Added /BUFF flag for 10% buffer in y-range
-Added /INCLUDE_ERROR flag to include any 'dy' in the min/max calculations
ADAPTED BY: Ayris Narock (ADNET/GSFC) 2017
$LastChangedBy: nikos $
$LastChangedDate: 2017-11-20 12:45:47 -0800 (Mon, 20 Nov 2017) $
$LastChangedRevision: 24321 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_1/projects/dscovr/plot/dsc_get_ylimits.pro $
(See projects/dscovr/plot/dsc_get_ylimits.pro)
NAME: DSC_OVERVIEW
DESCRIPTION:
Multi-panel plot of DSCOVR data using TPLOT calls (direct graphics.) Vector
components are shown in GSE coordinates.
INPUTS:
DATE: Date of interest. String, in the form 'YYYY-MM-DD/HH:MM:SS' (as accepted by 'timespan')
Will plot 1 full day.
If this argument is not passed it will look for the TRANGE keyword.
KEYWORDS: (Optional)
IMPORT_ONLY: Set when replaying GUI overviews. We only want it to import data since the window/panel
structure is already a serialized xml tgd document
GUI: Set to create the plot inside the SPD_GUI (uses TPLOT_GUI calls)
SAVE: Set to save a .png copy of the generated plot(s) in the !dsc.save_plots_dir/gen/ directory
SPLITS: Set to split the time range into quarters and create 4 consecutive
plots in addition to the overview of the whole time range.
TRANGE=: Set this to the time range of interest. This keyword will be ignored if
DATE argument is passed. The routine will return without plotting if neither
DATE nor TRANGE is set. (2-element array of doubles (as output by timerange())
or strings (as accepted by timerange()))
VERBOSE=: Integer indicating the desired verbosity level. Defaults to !dsc.verbose
KEYWORD OUTPUTS:
ERROR=: Returns 1 on error
WREF=: Array of integer id(s) of direct graphics window(s) created with this call. (long)
EXAMPLES:
dsc_overview,'2017-02-13',/splits,wref=wr
dsc_overview,trange=timerange(),/save
trg = timerange(['2017-05-21/13:00:00','2017-05-21/18:30:00'])
dsc_overview,trange=trg,/splits,/save
dsc_overview,trange=['2017-01-01','2017-01-02/06:00:00']
CREATED BY: Ayris Narock (ADNET/GSFC) 2017
$LastChangedBy: nikos $
$LastChangedDate: 2017-11-20 12:45:47 -0800 (Mon, 20 Nov 2017) $
$LastChangedRevision: 24321 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_1/projects/dscovr/plot/dsc_overview.pro $
(See projects/dscovr/plot/dsc_overview.pro)
NAME: DSC_OVERVIEW_FC
DESCRIPTION:
Multi-panel plot of DSCOVR Solar Wind data using TPLOT calls (direct graphics). Vector
components are shown in GSE coordinates.
INPUTS:
DATE: Date of interest. String, in the form 'YYYY-MM-DD/HH:MM:SS' (as accepted by 'timespan')
Will plot 1 full day.
If this argument is not passed it will look for the TRANGE keyword.
KEYWORDS: (Optional)
IMPORT_ONLY: Set when replaying GUI overviews. We only want it to import data since the window/panel
structure is already a serialized xml tgd document
GUI: Set to create the plot inside the SPD_GUI (uses TPLOT_GUI calls)
SAVE: Set to save a .png copy of the generated plot(s) in the !dsc.save_plots_dir/fc/ directory
SPLITS: Set to split the time range into quarters and create 4 consecutive
plots in addition to the overview of the whole time range.
TRANGE=: Set this to the time range of interest. This keyword will be ignored if
DATE argument is passed. The routine will return without plotting if neither
DATE nor TRANGE is set. (2-element array of doubles (as output by timerange())
or strings (as accepted by timerange()))
VERBOSE=: Integer indicating the desired verbosity level. Defaults to !dsc.verbose
KEYWORD OUTPUTS:
ERROR=: Returns 1 on error
WREF=: Array of integer id(s) of direct graphics window(s) created with this call. (long)
EXAMPLES:
dsc_overview_fc,'2017-02-13',/splits,wref=wr
dsc_overview_fc,trange=timerange(),/save
trg = timerange(['2017-05-21/13:00:00','2017-05-21/18:30:00'])
dsc_overview_fc,trange=trg,/splits,/save
dsc_overview_fc,trange=['2017-01-01','2017-01-02/06:00:00']
CREATED BY: Ayris Narock (ADNET/GSFC) 2017
$LastChangedBy: nikos $
$LastChangedDate: 2017-11-20 12:45:47 -0800 (Mon, 20 Nov 2017) $
$LastChangedRevision: 24321 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_1/projects/dscovr/plot/dsc_overview_fc.pro $
(See projects/dscovr/plot/dsc_overview_fc.pro)
NAME: DSC_OVERVIEW_MAG
DESCRIPTION:
Multi-panel plot of DSCOVR Magnetic Field data using TPLOT calls (direct graphics).
Vector components are shown in GSE coordinates.
INPUTS:
DATE: Date of interest. String, in the form 'YYYY-MM-DD/HH:MM:SS' (as accepted by 'timespan')
Will plot 1 full day.
If this argument is not passed it will look for the TRANGE keyword.
KEYWORDS: (Optional)
IMPORT_ONLY: Set when replaying GUI overviews. We only want it to import data since the window/panel
structure is already a serialized xml tgd document
GUI: Set to create the plot inside the SPD_GUI (uses TPLOT_GUI calls)
SAVE: Set to save a .png copy of the generated plot(s) in the !dsc.save_plots_dir/mag/ directory
SPLITS: Set to split the time range into quarters and create 4 consecutive
plots in addition to the overview of the whole time range.
TRANGE=: Set this to the time range of interest. This keyword will be ignored if
DATE argument is passed. The routine will return without plotting if neither
DATE nor TRANGE is set. (2-element array of doubles (as output by timerange())
or strings (as accepted by timerange()))
VERBOSE=: Integer indicating the desired verbosity level. Defaults to !dsc.verbose
KEYWORD OUTPUTS:
ERROR=: Returns 1 on error
WREF=: Array of integer id(s) of direct graphics window(s) created with this call. (long)
EXAMPLES:
dsc_overview_mag,'2017-02-13',/splits,wref=wr
dsc_overview_mag,trange=timerange(),/save
trg = timerange(['2017-05-21/13:00:00','2017-05-21/18:30:00'])
dsc_overview_mag,trange=trg,/splits,/save
dsc_overview_mag,trange=['2017-01-01','2017-01-02/06:00:00']
CREATED BY: Ayris Narock (ADNET/GSFC) 2017
$LastChangedBy: nikos $
$LastChangedDate: 2017-11-20 12:45:47 -0800 (Mon, 20 Nov 2017) $
$LastChangedRevision: 24321 $
$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_2_1/projects/dscovr/plot/dsc_overview_mag.pro $
(See projects/dscovr/plot/dsc_overview_mag.pro)