code::DataConverter::RadialSetLookup Class Reference

List of all members.

---

Detailed Description

This class provides an efficient way to get the radial number and gate number corresponding to an azimuth-range pair.

Author:

Lakshman

Version:

Id

code_DataConverter.h,v 1.16 2010/09/24 17:23:58 lakshman Exp

Public Member Functions
	RadialSetLookup (int accuracy, const RadialSet &)
	Will pre-compute the radial number within this radial set that corresponds to every azimuth and provide access to this information.
bool	getRadialGate (const Angle &az, const Length &rn, int *radialNo, int *gateNo) const
	Fills in the radial number and gatenumber that correspond to the azimuth and range passed in.
bool	getRadialNum (int az_no, int gate_no, int *radial_no) const
	Fills in the radial number given the azimuth.
bool	getRadialNum (int az_no, int *radial_no) const
	Fills in the radial number given the azimuth number.
bool	getRadialNum_noboundscheck (int az_no, int *radial_no) const
	faster, inlined version for courageous clients.
int	getAzimuthNumber (const Angle &az) const
	Returns the azimuth number that corresponds to an Angle.

---

Constructor & Destructor Documentation

code::DataConverter::RadialSetLookup::RadialSetLookup	(	int	accuracy,
		const RadialSet &
	)

Will pre-compute the radial number within this radial set that corresponds to every azimuth and provide access to this information.

Parameters:

accuracy

How accurate do you want the conversion to be? Larger numbers denote greater accuracy. Use at least 5. This is the accuracy of the radial lookup.

---

Member Function Documentation

int code::DataConverter::RadialSetLookup::getAzimuthNumber

(

const Angle &

az

)

const

Returns the azimuth number that corresponds to an Angle.

bool code::DataConverter::RadialSetLookup::getRadialGate	(	const Angle &	az,
		const Length &	rn,
		int *	radialNo,
		int *	gateNo
	)			const

Fills in the radial number and gatenumber that correspond to the azimuth and range passed in.

The returned information is valid only for the input radial set (input via the constructor).

Returns:

true if the returned values are valid. The returned values will be invalid if the input az-ran is outside the range of the radial set.

bool code::DataConverter::RadialSetLookup::getRadialNum	(	int	az_no,
		int *	radial_no
	)			const

Fills in the radial number given the azimuth number.

bool code::DataConverter::RadialSetLookup::getRadialNum	(	int	az_no,
		int	gate_no,
		int *	radial_no
	)			const

Fills in the radial number given the azimuth.

only if the gate number is valid.

bool code::DataConverter::RadialSetLookup::getRadialNum_noboundscheck	(	int	az_no,
		int *	radial_no
	)			const [inline]

faster, inlined version for courageous clients.

---