code::NexradVCP Class Reference

List of all members.

---

Detailed Description

Information on the volume coverage patterns in NEXRAD.

Given a VCP number, it tells you the Angles present.

To obtain the VCP number, you might query the DataType that you have:

            SmartPtr<DataCell> dc = dt.getAttributeValue("vcp");
            if ( dc.is_ptr_valid() ){
              int vcp = atoi( dc->str().c_str() );
              ...
            }
       

There are two terms here:

1. tilt number refers to the elevation number . For example, if there are two scans at 0.5 degrees, they are considered the same tilt, since the elevation angle has not changed.
2. scan number refers to the number of physical scans and so two scans can produce products at the same tilt.

The data usually specify scans, but algorithms are usually interested in tilts. The name "sweep number" for "tilt number" is unfortunate; to avoid confusion, we won't use the word sweep.

Author:

Lakshman

Version:

Id

code_NexradVCP.h,v 1.20 2009/06/02 20:17:39 lakshman Exp

Public Member Functions
	NexradVCP (int vcp_in)
bool	isValid () const
Angle	elevation (int tiltno) const
	The tilts are numbered 1,2.
bool	isNexrad () const
	Does this VCP correspond to the WSR-88D system?
bool	isMultiPRF () const
	Does this VCP correspond to multiple-PRF scanning mode?
bool	isClearAir () const
	Is this VCP used typically in clear-air or to precipitation events?
int	tilt (const Angle &elev) const
	Given the elevation angle, this returns the tilt number of the closest matching scan angle.
int	getCorrectedTiltNo (int level2_scanno) const
int	getLastTilt () const
	Returns the maximum tilt number (remember tilts are numbered 1,2 .
int	numScans (int tilt_no) const
	The radar may scan reflectivity and velocity separately and may do multiple PRFs at a particular tilt.
code::TimeInterval	getTotalTime () const
	How long is this VCP expected to last? If that information is not known (from the configuration file), we will return a negative time.
const VCPInfo &	getVCPInfo () const
Classes
class	VCPInfo

---

Constructor & Destructor Documentation

code::NexradVCP::NexradVCP

(

int

vcp_in

)

---

Member Function Documentation

Angle code::NexradVCP::elevation

(

int

tiltno

)

const

The tilts are numbered 1,2.

.. Note that these tilt numbers are corrected, such that the tilt 1 refers to WSR-88D Level-II scans 1 _and_ 2 (the reflectivity-only and velocity-only scans.)

int code::NexradVCP::getCorrectedTiltNo

(

int

level2_scanno

)

const

Returns:

tilt number given the scan number.

Return the corrected tilt number, so that, for example, the tilt 1 refers to WSR-88D Level-II scans 1 _and_ 2 (the reflectivity-only and velocity-only scans.)

int code::NexradVCP::getLastTilt

(

)

const

Returns the maximum tilt number (remember tilts are numbered 1,2 .

.. N

code::TimeInterval code::NexradVCP::getTotalTime

(

)

const

How long is this VCP expected to last? If that information is not known (from the configuration file), we will return a negative time.

const VCPInfo& code::NexradVCP::getVCPInfo

(

)

const [inline]

bool code::NexradVCP::isClearAir

(

)

const

Is this VCP used typically in clear-air or to precipitation events?

bool code::NexradVCP::isMultiPRF

(

)

const

Does this VCP correspond to multiple-PRF scanning mode?

bool code::NexradVCP::isNexrad

(

)

const

Does this VCP correspond to the WSR-88D system?

bool code::NexradVCP::isValid

(

)

const [inline]

int code::NexradVCP::numScans

(

int

tilt_no

)

const

The radar may scan reflectivity and velocity separately and may do multiple PRFs at a particular tilt.

Return the number of scans at a particular tilt number.

int code::NexradVCP::tilt

(

const Angle &

elev

)

const

Given the elevation angle, this returns the tilt number of the closest matching scan angle.

For example, if the tilts are at 0.5, 1.5 degrees, etc. The tilt number returned for a parameter of 0.7 degrees is the tilt of the 0.5 scan. The tilts are numbered 1,2...

Note that these tilt numbers are corrected, such that the tilt 1 refers to WSR-88D Level-II scans 1 _and_ 2 (the reflectivity-only and velocity-only scans.) There is, for obvious reasons, no way to get the scan number since there can be multiple scans at the same elevation angle.

Returns:

0 on error (such as invalid vcp)

---