Univeristy of Alabama in Huntsville

UAH LTG IDL Library

IDL Routines from Phillip Bitzer and UAH Lightning Group

summary     class     fields     routine details     file attributes

lis/

pmb_plot_lis.pro

LIS


Go ahead and plot LIS data

VF wrote a good portion of the nuts and bolts used to do the actual plotting

Examples

Provide an example

Author information

Author

Phillip M. Bitzer, University of Alabama in Huntsville, pm.bitzer "AT" uah.edu

History

Modification History:

Built from Legacy Code: Feb 10, 2013 PMB Sometimes, the wrong colors would be plotted for radiance. Fixed this. 201401024 PMB There were quite a few places I was requesting the colors inefficiently. Not any more. 20140124 PMB Added an option to *only* plot the outline of events 20140227 PMB Updated code to use "new" cgScaleVector (instead od deprecated SCALE_VECTOR) 20140518 PMB

Other file information

Uses:

LIS_GET_VECTOR_POINTING_VECTOR, LIS_GET_VECTOR_EARTH_INTERSECTIONPMB_LLA2XYZ CGPOLYGON, cgCOLOR, cgScaleVector

Routines

Routines from pmb_plot_lis.pro

result = pmb_plot_lis_get_colors(radiance, eventColor)

Define a color scale for the radiance.

pmb_plot_lis, lisData [, GroupInd=long array] [, /XY] [, CenterLLA=numeric array] [, /PlotEvents] [, /plotFOV] [, /plotGroupCenter] [, maxGroupsHatch=number] [, maxGroupsEvent=number] [, groupAreaColor=string/long] [, eventColor=string/long] [, /Over] [, /SolidEvent] [, XRange=numeric array] [, YRange=numeric array], GroupLeader=GroupLeader, EventOutlineOnly=EventOutlineOnly

This is a routine that can be used to plot LIS data.

Routine details

top pmb_plot_lis_get_colors

result = pmb_plot_lis_get_colors(radiance, eventColor)

Define a color scale for the radiance. This is currently a helper routine.

Return value

For n elements in radiance, an array of nx3 RGB values.

Parameters

radiance in required type=numeric array

The n radiances you wish to color.

eventColor in required type=string

The name of the color used for the scaling. Currently, you can select either a grayscale (with eventColor='gray'), a yellow->red scale (eventColor = 'red'), or a blue color scale ('blue')

Other attributes

Uses:

cgScaleVector

top pmb_plot_lis

pmb_plot_lis, lisData [, GroupInd=long array] [, /XY] [, CenterLLA=numeric array] [, /PlotEvents] [, /plotFOV] [, /plotGroupCenter] [, maxGroupsHatch=number] [, maxGroupsEvent=number] [, groupAreaColor=string/long] [, eventColor=string/long] [, /Over] [, /SolidEvent] [, XRange=numeric array] [, YRange=numeric array], GroupLeader=GroupLeader, EventOutlineOnly=EventOutlineOnly

This is a routine that can be used to plot LIS data. It's specifically designed to plot groups, but can be used to plot indivudual events and/or the LIS FOV using the pertient keywords.

Parameters

lisData in required type=structure

This can either be a structure containing at least a tag with the name "Group" or the "full" structure. The "full" structure contains "all" the tags for a LIS file. This is done by setting \all in the call to read_lis. You must also use the UTC keyword in read_lis in this case. See the output of read_lis for more information, as this routine is written to handle the output of said routine.

Keywords

GroupInd in optional type=long array

The indices of the groups to be plotted. If not set, then all groups are plotted.

XY in optional type=boolean default= 0B

Plotting is done in XY space instead of lon/lat. Also see centerLLA.

CenterLLA in optional type=numeric array

A three element array specifing the [lat, lon, alt] center of the Cartesian plotting space. If this is not provided and XY is set, the center of Cartesian coordinate system is the location of the first group.

PlotEvents in optional type=boolean default= 0B

If set, individual events will be plotted. If lisData does not contain the "full" struct, then no events will be plotted (but this keyword will remain unchanged). Also see maxGroupsEvent.

plotFOV in optional type=boolean default= 0B

If set, the field of view will be plotted. If lisData does not contain the "full" struct, then no events will be plotted (but this keyword will remain unchanged).

plotGroupCenter in optional type=boolean default= 0B

If set, then the radiance-weighted center of the LIS group is plotted.

maxGroupsHatch in optional type=number default= 5000

If there more groups than the specified number, the group footprint will not be plotted. This is to save time when plotting. The group footprint is also not plotted if we are plotting individual events. See plotEvents and maxGroupsEvent.

maxGroupsEvent in optional type=number default= 200

If there more groups than the specified number, the individual events will not be plotted. This is to save time when plotting. In this case, plotEvents is quietly ignored.

groupAreaColor in optional type=string/long default= 'gray'

The color of the LIS group area hatch. This is passed to cgCOLOR, so anything that cgCOLOR can handle is acceptable.

eventColor in optional type=string/long default= 'gray'

The color of the LIS events to be plotted. This is passed to cgCOLOR, so anything that cgCOLOR can handle is acceptable.

Over in optional type=boolean default= 0B

If set, the data will be plotted in the current plotting space.

SolidEvent in optional type=boolean default= 0B

If set, then events are colored as a solid polygon

XRange in optional type=numeric array

Set this to a two element array to define the xrange of the plotting space. Only used if over is not set.

YRange in optional type=numeric array

Set this to a two element array to define the yrange of the plotting space. Only used if over is not set.

GroupLeader
EventOutlineOnly

File attributes

Modification date: Tue Oct 17 17:31:36 2017
Lines: 187
Docformat: rst rst