pydarn.plotting.fan

Module: pydarn.plotting.fan

Functions:

• pydarn.plotting.fan.plotFan()
• pydarn.plotting.fan.overlayFan()

pydarn.plotting.fan.overlayFan(myData, myMap, myFig, param, coords='geo', gsct=0, site=None, fov=None, gs_flg=[], fill=True, velscl=1000.0, dist=1000.0, cmap=None, norm=None, alpha=1)

A function of overlay radar scan data on a map

Args:

• myData (:class:`pydarn.sdio.radDataTypes.scanData` or :class:`pydarn.sdio.radDataTypes.beamData` or list of :class:`pydarn.sdio.radDataTypes.beamData` objects): a radar beam object, a radar scanData object, or simply a list of radar beams
• myMap: the map we are plotting on
• [param]: the parameter we are plotting
• [coords]: the coordinates we are plotting in
• [param]: the parameter to be plotted, valid inputs are ‘velocity’, ‘power’, ‘width’, ‘elevation’, ‘phi0’. default = ‘velocity
• [gsct]: a flag indicating whether we are distinguishing ground scatter. default = 0
• [intensities]: a list of intensities (used for colorbar)
• [fov]: a radar fov object
• [gs_flg]: a list of gs flags, 1 per range gate
• [fill]: a flag indicating whether to plot filled or point RB cells. default = True
• [velscl]: the velocity to use as baseline for velocity vector length, only applicable if fill = 0. default = 1000
• [lines]: an array to have the endpoints of velocity vectors. only applicable if fill = 0. default = []
• [dist]: the length in map projection coords of a velscl length velocity vector. default = 1000. km

OUTPUTS:

NONE

EXAMPLE:

overlayFan(aBeam,myMap,param,coords,gsct=gsct,site=sites[i],fov=fovs[i],                            verts=verts,intensities=intensities,gs_flg=gs_flg)

Written by AJ 20121004

pydarn.plotting.fan.plotFan(sTime, rad, interval=60, fileType='fitex', param='velocity', filtered=False, scale=[], channel='a', coords='geo', colors='lasse', gsct=False, fov=True, edgeColors='face', lowGray=False, fill=True, velscl=1000.0, legend=True, overlayPoes=False, poesparam='ted', poesMin=-3.0, poesMax=0.5, poesLabel='Total Log Energy Flux [ergs cm$^{-2}$ s$^{-1}$]', overlayBnd=False, show=True, png=False, pdf=False, dpi=500)

A function to make a fan plot

Args:

• sTime (datetime): the start time you want to plot
• rad (list): a list of 3 letter radar codes, e.g. [‘bks’], e.g. [‘bks’,’wal’,’gbr’]
• [interval] (int): the the time period to be plotted, in seconds. default = 60
• [fileType] (str): the file type to plot, valid inputs are ‘fitex’,’fitacf’, ‘lmfit’. default = ‘fitex’
• [param] (str): the parameter to be plotted, valid inputs are ‘velocity’, ‘power’, ‘width’, ‘elevation’, ‘phi0’. default = ‘velocity’
• [filtered] (boolean): a flag indicating whether the data should be boxcar filtered. default = False
• [scale] (list): the min and max values of the color scale, i.e. [min,max]. If this is set to [], then default values will be used
• [channel] (char): the channel for which to plot data. default = ‘a’
• [coords] (str): the coordinate system to use, valid inputs are ‘geo’, ‘mag’. default = ‘geo’
• [colors] (str): the color map to use, valid inputs are ‘lasse’, ‘aj’. default = ‘lasse’
• [gsct] (boolean): a flag indicating whether to plot ground scatter as gray. default = False
• [fov] (boolean): a flag indicating whether to overplot the radar fields of view. default = True
• [edgeColors] (str): edge colors of the polygons, default = ‘face’
• [lowGray] (boolean): a flag indicating whether to plot low velocities in gray. default = False
• [fill] (boolean): a flag indicating whether to plot filled or point RB cells. default = True
• [velscl] (float): the velocity to use as baseline for velocity vector length, only applicable if fill = 0. default = 1000
• [legend] (boolean): a flag indicating whether to plot the legend, only applicable if fill = 0. default = True
• [overlayPoes] (boolean): a flag indicating whether to overlay poes data. default = False
• [poesparam] (str): the poes parameter to plot. default = ‘ted’. available params can be found in gme.sat.poes.poesRec
• [poesMin] (float): the min value for the poes data color scale. default = -3.
• [poesMax] (float): the max value for the poes data color scale. default = 0.5
• [poesLabel] (str): the label for the poes color bar. default = r”Total Log Energy Flux [ergs cm$^{-2}$ s$^{-1}$]”
• [overlayBnd] (boolean): a flag indicating whether to plot an auroral boundary determined from fitting poes data. default = False
• [show] (boolean): a flag indicating whether to display the figure on the screen. This can cause problems over ssh. default = True
• [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

Returns:

• Nothing

Example:

import datetime as dt
pydarn.plotting.fan.plotFan(dt.datetime(2013,3,16,16,30),['fhe','fhw'],param='power',gsct=True)

Written by AJ 20121004

pydarn.plotting.fan

alias of pydarn.plotting.fan