pydarn.plotting.rti¶
Module: pydarn.plotting.rti¶
- Functions:
- pydarn.plotting.rti.drawAxes(myFig, times, rad, cpid, bmnum, nrang, frang, rsep, bottom, yrng=-1, coords='gate', pos=[0.1, 0.05, 0.76, 0.72])[source]¶
draws empty axes for an rti plot
- Args:
- myFig: the MPL figure we are plotting to
- times: a list of datetime objects referencing the beam soundings
- rad: 3 letter radar code
- cpid: list of the cpids or the beam soundings
- bmnum: beam number being plotted
- nrang: list of nrang for the beam soundings
- frang: list of frang of the beam soundings
- rsep: list of rsep of the beam soundings
- bottom: flag indicating if we are at the bottom of the page
- [yrng]: range of y axis, -1=autoscale (default)
- [coords]: y axis coordinate system, acceptable values are ‘geo’, ‘mag’, ‘gate’, ‘rng’
- [pos]: position of the plot
- Returns:
- ax: an axes object
- **Example:
ax = drawAxes(aFig,times,rad,cpid,beam,nrang,frang,rsep,0)
Written by AJ 20121002
- pydarn.plotting.rti.plotCpid(myFig, times, cpid, mode, pos=[0.1, 0.77, 0.76, 0.05])[source]¶
plots cpid panel at position pos
- Args:
- myFig: the MPL figure we are plotting on
- times: a list of the times of the beam soundings
- cpid: a lsit of the cpids of th beam soundings
- mode: a list of the ifmode param
- [pos]: position of the panel
- Returns:
- Nothing.
- Example:
plotCpid(rtiFig,times,cpid,mode)
Written by AJ 20121002
- pydarn.plotting.rti.plotFreq(myFig, times, freq, nave, pos=[0.1, 0.82, 0.76, 0.06])[source]¶
plots a frequency panel at position pos
- Args:
- myFig: the MPL figure we are plotting on
- times: a list of the times of the beam soundings
- freq: a lsit of the tfreq of the beam soundings
- search: a list of the nave param
- [pos]: position of the panel
- Returns:
- *Nothing.
- Example:
plotNoise(rtiFig,times,tfreq,nave)
Written by AJ 20121002
- pydarn.plotting.rti.plotNoise(myFig, times, sky, search, pos=[0.1, 0.88, 0.76, 0.06])[source]¶
plots a noise panel at position pos
- Args:
- myFig: the MPL figure we are plotting on
- times: a list of the times of the beam soundings
- sky: a lsit of the noise.sky of the beam soundings
- search: a list of the noise.search param
- [pos]: position of the panel
- Returns:
- Nothing
- Example:
plotNoise(rtiFig,times,nsky,nsch)
Written by AJ 20121002
- pydarn.plotting.rti.plotRti(sTime, rad, eTime=None, bmnum=7, fileType='fitex', params=['velocity', 'power', 'width'], scales=[], channel='a', coords='gate', colors='lasse', yrng=-1, gsct=False, lowGray=False, pdf=False, png=False, dpi=500, show=True, retfig=False, filtered=False, fileName=None, custType='fitex')[source]¶
create an rti plot for a secified radar and time period
- Args:
- sTime (datetime): a datetime object indicating the start time which you would like to plot
- rad (str): the 3 letter radar code, e.g. ‘bks’
- [eTime] (datetime): a datetime object indicating th end time you would like plotted. If this is None, 24 hours will be plotted. default = None.
- [bmnum] (int): The beam to plot. default: 7
- [fileType] (str): The file type to be plotted, one of [‘fitex’,’fitacf’,’lmfit’]. default = ‘fitex’.
- [params] (list): a list of the fit parameters to plot, allowable values are: [‘velocity’, ‘power’, ‘width’, ‘elevation’, ‘phi0’]. default: [‘velocity’, ‘power’, ‘width’]
- [scales] (list): a list of the min/max values for the color scale for each param. If omitted, default scales will be used. If present, the list should be n x 2 where n is the number of elements in the params list. Use an empty list for default range, e.g. [[-250,300],[],[]]. default: [[-200,200],[0,30],[0,150]]
- [channel] (char): the channel you wish to plot, e.g. ‘a’, ‘b’, ‘c’, ... default: ‘a’
- [coords] (str): the coordinates to use for the y axis. The allowable values are ‘gate’, ‘rng’, ‘geo’, ‘mag’ default: ‘gate’
- [colors] (str): a string indicating what color bar to use, valid inputs are [‘lasse’,’aj’]. default: ‘lasse’
- [yrng] (list or -1): a list indicating the min and max values for the y axis in the chosen coordinate system, or a -1 indicating to plot everything. default: -1.
- [gsct] (boolean): a flag indicating whether to plot ground scatter as gray. default: False (ground scatter plotted normally)
- [lowGray] (boolean): a flag indicating whether to plot low velocity scatter as gray. default: False (low velocity scatter plotted normally)
- [pdf] (boolean): a flag indicating whether to output to a pdf file. default = False. WARNING: saving as pdf is slow.
- [png] (boolean): a flag indicating whether to output to a png file. default = False
- [dpi] (int): dots per inch if saving as png. default = 300
- [show] (boolean): a flag indicating whether to display the figure on the screen. This can cause problems over ssh. default = True
- [retfig] (boolean): a flag indicating that you want the figure to be returned from the function. default = False
- [filtered] (boolean): a flag indicating whether to boxcar filter the data. default = False (no filter)
- [fileName] (string): If you want to plot for a specific file, indicate the name of the file as fileName. Include the type of the file in custType.
- [custType] (string): the type (fitacf, lmfit, fitex) of file indicated by fileName
- Returns:
- Possibly a figure, depending on the retfig keyword
- Example:
import datetime as dt pydarn.plotting.rti.plotRti(dt.datetime(2013,3,16), 'bks', eTime=dt.datetime(2013,3,16,14,30), bmnum=12, fileType='fitacf', scales=[[-500,500],[],[]], coords='geo',colors='aj', filtered=True, show=True)
Written by AJ 20121002
- pydarn.plotting.rti.rtiTitle(fig, d, rad, fileType, beam, xmin=0.1, xmax=0.86)[source]¶
draws title for an rti plot
- Args:
- d: the date being plotted as a datetime object
- rad: the 3 letter radar code
- fileType: the file type being plotted
- beam: the beam number being plotted
- [xmin]: minimum x value o the plot in page coords
- [xmax]: maximum x value o the plot in page coords
- Returns: *Nothing.
- Example:
import datetime as dt rtiTitle(dt.datetime(2011,1,1),'bks','fitex',7)
Written by AJ 20121002
- pydarn.plotting.rti¶
alias of pydarn.plotting.rti
