w2ltg::LightningDensity Class Reference

Inheritance diagram for w2ltg::LightningDensity:

List of all members.

---

Detailed Description

Creates a real-time lightning density gridded field.

Author:

Lakshman

Version:

Id

w2ltg_LightningDensity.h,v 1.7 2009/06/02 20:17:59 lakshman Exp

Public Member Functions
void	setWindField (const code::WindFieldStruct< code::LatLonGrid > &wf)
	set the windfield
void	update (const code::DataTable &dt)
	convenience function to update using table of lightning flash data.
void	update (const code::Location &loc, float num_flashes=1)
	update information for single or multiple flashes at a location.
void	setLatestTime (const code::Time &updateTime)
	change the latest time.
	LightningDensity (const LightningGrid &ltgGrid, const code::TimeInterval &historyPeriod, const code::Length &influenceRadius)
	Pass in the grid location and resolution.
std::vector< code::LatLonGrid >	compute (const code::TimeInterval &avgPeriod) const
	computes the density and returns it.
const code::Time &	getTime () const
	time of last update.
Protected Member Functions
code::LatLonGrid	createNewGrid (const std::string &typeName, const code::Time &latestTime, int ht_no) const
Protected Attributes
code::Location	nwCorner
const code::LatLonGrid::DimType	spacing
int	num_lat
int	num_lon
float	lat_res
float	lon_res
int	num_hts
code::Length	htspacing
Classes
struct	LightningStrike

---

Constructor & Destructor Documentation

w2ltg::LightningDensity::LightningDensity	(	const LightningGrid &	ltgGrid,
		const code::TimeInterval &	historyPeriod,
		const code::Length &	influenceRadius
	)

Pass in the grid location and resolution.

Parameters:

	historyPeriod	how long to accumulate lightning flashes 10min is a reasonable number.
	influenceRadius	the distance that a lightning flash is spread over -- 1km is a reasonable number.

---

Member Function Documentation

std::vector<code::LatLonGrid> w2ltg::LightningDensity::compute

(

const code::TimeInterval &

avgPeriod

)

const

computes the density and returns it.

Note that using a averagingPeriod greater than the history has no effect.

code::LatLonGrid w2ltg::LightningGrid::createNewGrid	(	const std::string &	typeName,
		const code::Time &	latestTime,
		int	ht_no
	)			const [protected, inherited]

const code::Time& w2ltg::LightningDensity::getTime

(

)

const [inline]

time of last update.

void w2ltg::LightningDensity::setLatestTime

(

const code::Time &

updateTime

)

change the latest time.

Usually paired with a bunch of update() calls.

void w2ltg::LightningDensity::setWindField

(

const code::WindFieldStruct< code::LatLonGrid > &

wf

)

set the windfield

void w2ltg::LightningDensity::update	(	const code::Location &	loc,
		float	num_flashes = 1
	)

update information for single or multiple flashes at a location.

void w2ltg::LightningDensity::update

(

const code::DataTable &

dt

)

convenience function to update using table of lightning flash data.

This function also sets the latest time.

---

Member Data Documentation

code::Length w2ltg::LightningGrid::htspacing [protected, inherited]

float w2ltg::LightningGrid::lat_res [protected, inherited]

float w2ltg::LightningGrid::lon_res [protected, inherited]

int w2ltg::LightningGrid::num_hts [protected, inherited]

int w2ltg::LightningGrid::num_lat [protected, inherited]

int w2ltg::LightningGrid::num_lon [protected, inherited]

code::Location w2ltg::LightningGrid::nwCorner [protected, inherited]

const code::LatLonGrid::DimType w2ltg::LightningGrid::spacing [protected, inherited]

---