code::Radial Class Reference

Inheritance diagram for code::Radial:

List of all members.

---

Detailed Description

Store a radial's worth of gate information along with bookkeeping info.

Author:

Lakshman

Version:

Author

lakshman

Date

2009/06/02 20:17:37

RCSfile

code_RadialSet.h,v

Public Types
typedef size_t	Coord
	A coordinate for Data1D, always size_t.
typedef T4	DimType
	A Dimension type for Data1D, e.g.
typedef std::map< std::string, SmartPtr< DataColumn > >	AttrMap
	key-value pairs that describe the data.
	RadialSet
	LatLonGrid
	LatLonHeightGrid
	CartesianGrid2D
	Grid2D
	DataTable
	WindField
	WindFieldLLGVolume
	ElevationVolume
	ContourData
	Other
enum	Type {   RadialSet, LatLonGrid, LatLonHeightGrid, CartesianGrid2D,   Grid2D, DataTable, WindField, WindFieldLLGVolume,   ElevationVolume, ContourData, Other }
Public Member Functions
virtual void	invoke (Algorithm &alg)
	Use this to invoke any algorithm.
	Radial (const Angle &starting_azimuth, const Angle &azimuthal_spacing, const Angle &elevation_of_sweep, const SpaceTimeRef &location_of_first_gate, const Length &width_of_gate, const Angle &physical_beamwidth)
	We need all this information.
	Radial (const Angle &starting_azimuth, const Angle &azimuthal_spacing, const Angle &elevation_of_sweep, const SpaceTimeRef &location_of_first_gate, const Length &width_of_gate, const Angle &physical_beamwidth, Data1D< Length, float > data_values)
	We need all this information; if you don't have the data handy, use the other constructor.
Radial	clone () const
	Returns a completely separate copy of this data.
SpaceTimeRef	reference (size_t i=0) const
	Obtain the reference of ith gate.
SpaceTimeRef	reference (size_t i=0, Length distToFirstGate=Length::Meters(0.0)) const
	Obtain the reference of ith gate.
Radial::DimType	coord_value (size_t i) const
	Obtain the distance of the ith gate from the 0th.
float	getValue (const Length &range, const Length &dist_to_first_gate, bool throwOnError=false) const throw (std::string)
	Get the value that corresponds to a particular range from the center of the RadialSet.
const Length &	getGateWidth () const
	The average width of a gate within this radial.
const Angle &	getAzimuth () const
	The constant (starting) azimuth of this radial.
const Angle &	getPhysicalBeamWidth () const
	The constant beamwidth of this radial.
const Angle &	getAzimuthalSpacing () const
	The azimuthal spacing.
const Angle &	getElevation () const
	The elevation (of the sweep) containing this radial.
const SpaceTimeRef &	getStartPoint () const
	The starting location and time of this radial.
void	setGateWidth (const Length &len)
	The average width of a gate within this radial.
void	setAzimuth (const Angle &ang)
	The constant (starting) azimuth of this radial.
void	setPhysicalBeamWidth (const Angle &ang)
	The constant beamwidth of this radial.
void	setAzimuthalSpacing (const Angle &ang)
	The constant beamwidth of this radial.
void	setElevation (const Angle &ang)
	The elevation (of the sweep) containing this radial.
void	setStartPoint (const SpaceTimeRef &st)
	The starting location and time of this radial.
void	rotateRadial (const Angle &ang)
	Changes the angle of the radials (adds this quantity) to the radial's azimuth.
	Radial ()
	This constructor is there only to facilitate use of the standard containers.
virtual	~Radial ()
	Inherits virtually -- needs virtual destructor.
const X &	operator[] (size_t i) const
	Return the ith member of the array.
X &	operator[] (size_t i)
	Return the ith member of the array.
void	set_1d (const X *begin, const X *end)
	Initialize a row of elements.
void	set_1d (const std::vector< X > &v)
	Initialize a row of elements.
void	replace_1d (const X *first, const X *last)
	Overwrite a 'row' of elements.
void	replace_1d (const std::vector< X > &v)
	Overwrite a 'row' of elements.
const std::vector< X > &	data () const
	Return the internal vector<X>.
std::vector< X > &	data ()
	Return the internal vector<X>.
Coord	size () const
	Return the size of this object.
void	replace (const X &old_value, const X &new_value)
	Replace any instance of old_value with new_value.
virtual SpaceTimeRef	getSpaceTimeRef () const
	Return the reference of the first element.
std::string	getTypeClassName () const
	returns a string such as RadialSet, LatLonGrid, etc.
void	copyDataType (const DataType &dt)
	A convenience function provided for subclasses that implement clone() -- will copy into this data type all the attributes in the type dt.
const std::string &	getTypeName () const
	Return the TypeName of this DataType.
virtual short	getType () const
	Get enum type of this class.
void	setTypeName (const std::string &)
	Set the TypeName of this DataType.
SmartPtr< DataCell >	getAttributeValue (const std::string &key) const
	Return a single value associated with an attribute key corresponding to the function's argument.
bool	getAttributeValue (const std::string &key, std::string &setme) const
	Assign `setme' with the attribute corresponding to `key'.
bool	getAttributeValue (const std::string &key, double &setme) const
	Assign `setme' with the attribute corresponding to `key'.
void	setAttributeValue (const std::string &key, const std::string &value, const std::string &unit="dimensionless")
	Set a single-valued attribute that describes this DataType.
void	setAttributeValue (const std::string &key, double value, const std::string &unit="dimensionless", const std::string &format="%g")
	Set a single-valued attribute that describes this DataType.
void	setAttribute (const std::string &key, SmartPtr< DataColumn > value)
	Set a multiple-valued attribute that describes this DataType.
SmartPtr< DataColumn >	getAttribute (const std::string &key) const
	Get the attribute value for a particular key.
const AttrMap &	getAttributes () const
	Get the entire map of attributes available for this data type.
virtual double	getRawValue (const Location &, bool=false) const
	Gets raw value from data set.
virtual TimeInterval	getExpiryInterval () const
	Return 15 minutes as the length of time for which this DataType is valid.
bool	hasQuality () const
const DataType &	getQuality () const
void	setQuality (SmartPtr< DataType > dt)
void	clearAttributes ()
Static Public Attributes
static const std::string	IsTableData
static const std::string	Unit
static const std::string	ColorMap
static const std::string	ExpiryInterval
Protected Member Functions
virtual void	deep_copy (const DataType &source)

---

Member Typedef Documentation

typedef std::map< std::string, SmartPtr<DataColumn> > code::DataType::AttrMap [inherited]

key-value pairs that describe the data.

template<class T4, class X>

typedef size_t code::Data1D< T4, X >::Coord [inherited]

A coordinate for Data1D, always size_t.

template<class T4, class X>

typedef T4 code::Data1D< T4, X >::DimType [inherited]

A Dimension type for Data1D, e.g.

Time for trends.

---

Member Enumeration Documentation

enum code::DataType::Type [inherited]

Enumerator:

RadialSet
LatLonGrid
LatLonHeightGrid
CartesianGrid2D
Grid2D
DataTable
WindField
WindFieldLLGVolume
ElevationVolume
ContourData
Other

---

Constructor & Destructor Documentation

code::Radial::Radial	(	const Angle &	starting_azimuth,
		const Angle &	azimuthal_spacing,
		const Angle &	elevation_of_sweep,
		const SpaceTimeRef &	location_of_first_gate,
		const Length &	width_of_gate,
		const Angle &	physical_beamwidth
	)

We need all this information.

You may push the data into the array by invoking data().push_back(...)

code::Radial::Radial	(	const Angle &	starting_azimuth,
		const Angle &	azimuthal_spacing,
		const Angle &	elevation_of_sweep,
		const SpaceTimeRef &	location_of_first_gate,
		const Length &	width_of_gate,
		const Angle &	physical_beamwidth,
		Data1D< Length, float >	data_values
	)

We need all this information; if you don't have the data handy, use the other constructor.

code::Radial::Radial

(

)

[inline]

This constructor is there only to facilitate use of the standard containers.

It should not be used otherwise.

virtual code::Radial::~Radial

(

)

[inline, virtual]

Inherits virtually -- needs virtual destructor.

---

Member Function Documentation

void code::DataType::clearAttributes

(

)

[inline, inherited]

Radial code::Radial::clone

(

)

const

Returns a completely separate copy of this data.

Reimplemented from code::Data1D< T4, X >.

Radial::DimType code::Radial::coord_value

(

size_t

i

)

const [inline]

Obtain the distance of the ith gate from the 0th.

Implementation of virtual function in Data1D.

void code::DataType::copyDataType

(

const DataType &

dt

)

[inherited]

A convenience function provided for subclasses that implement clone() -- will copy into this data type all the attributes in the type dt.

Attributes with the same name will be over-written, other attributes will remain unchanged.

template<class T4, class X>

std::vector<X>& code::Data1D< T4, X >::data

(

)

[inline, inherited]

Return the internal vector<X>.

template<class T4, class X>

const std::vector<X>& code::Data1D< T4, X >::data

(

)

const [inline, inherited]

Return the internal vector<X>.

virtual void code::DataType::deep_copy

(

const DataType &

source

)

[inline, protected, virtual, inherited]

SmartPtr< DataColumn > code::DataType::getAttribute

(

const std::string &

key

)

const [inherited]

Get the attribute value for a particular key.

Parameters:

key

attribute key

Returns:

value attribute value in unit-safe manner, or an invalid SmartPtr on error.

See also:

getAttributeValue()

getAttributes() if you don't know the attribute key.

const AttrMap& code::DataType::getAttributes

(

)

const [inline, inherited]

Get the entire map of attributes available for this data type.

See also:

getAttribute for a more selective get.

getAttributeValue for a convenient get.

bool code::DataType::getAttributeValue	(	const std::string &	key,
		double &	setme
	)			const [inherited]

Assign `setme' with the attribute corresponding to `key'.

Returns:

true on success; false if no such attribute exists

bool code::DataType::getAttributeValue	(	const std::string &	key,
		std::string &	setme
	)			const [inherited]

Assign `setme' with the attribute corresponding to `key'.

Returns:

true on success; false if no such attribute exists

SmartPtr< DataCell > code::DataType::getAttributeValue

(

const std::string &

key

)

const [inherited]

Return a single value associated with an attribute key corresponding to the function's argument.

If no such attribute key exists, then return the NULL SmartPtr. In case multiple values are associated with the key, only the first item is returned.

See also:

getAttribute() to get all values.

const Angle& code::Radial::getAzimuth

(

)

const [inline]

The constant (starting) azimuth of this radial.

const Angle& code::Radial::getAzimuthalSpacing

(

)

const [inline]

The azimuthal spacing.

const Angle& code::Radial::getElevation

(

)

const [inline]

The elevation (of the sweep) containing this radial.

virtual TimeInterval code::DataType::getExpiryInterval

(

)

const [virtual, inherited]

Return 15 minutes as the length of time for which this DataType is valid.

Override this function in the descendant of DataType as appropriate.

Reimplemented in code::DEM.

const Length& code::Radial::getGateWidth

(

)

const [inline]

The average width of a gate within this radial.

const Angle& code::Radial::getPhysicalBeamWidth

(

)

const [inline]

The constant beamwidth of this radial.

Not necessarily the azimuthal spacing ...

const DataType& code::DataType::getQuality

(

)

const [inline, inherited]

virtual double code::DataType::getRawValue	(	const Location &	,
		bool	= false
	)			const [inline, virtual, inherited]

Gets raw value from data set.

Reimplemented in code::CartesianGrid2D, code::CartesianGrid3D, code::ElevationVolume, code::LatLonGrid, code::LatLonHeightGrid, code::RadialSet, code::SparseGrid, and code::WindFieldLLGVolume.

template<class T4, class X>

virtual SpaceTimeRef code::Data1D< T4, X >::getSpaceTimeRef

(

)

const [inline, virtual, inherited]

Return the reference of the first element.

Implements code::DataType.

Reimplemented in code::ElevationVolume.

const SpaceTimeRef& code::Radial::getStartPoint

(

)

const [inline]

The starting location and time of this radial.

virtual short code::DataType::getType

(

)

const [inline, virtual, inherited]

Get enum type of this class.

Reimplemented in code::CartesianGrid2D, code::ContourData, code::DataTable, code::ElevationVolume, code::Grid2D, code::LatLonGrid, code::LatLonHeightGrid, code::PolarGrid, code::RadialSet, code::WindFieldLLGVolume, and code::WindFieldStruct< T >.

std::string code::DataType::getTypeClassName

(

)

const [inherited]

returns a string such as RadialSet, LatLonGrid, etc.

See the enum Type for all the possible options. Subclasses need only to over-ride getType()

const std::string& code::DataType::getTypeName

(

)

const [inherited]

Return the TypeName of this DataType.

float code::Radial::getValue	(	const Length &	range,
		const Length &	dist_to_first_gate,
		bool	throwOnError = false
	)			const throw (std::string)

Get the value that corresponds to a particular range from the center of the RadialSet.

optional param: throwOnError throws a std::string instead of (as is the default) returning Constants::MISSING_DATA

bool code::DataType::hasQuality

(

)

const [inline, inherited]

virtual void code::Radial::invoke

(

Algorithm &

alg

)

[inline, virtual]

Use this to invoke any algorithm.

Reimplemented from code::DataType.

template<class T4, class X>

X& code::Data1D< T4, X >::operator[]

(

size_t

i

)

[inline, inherited]

Return the ith member of the array.

No bounds check is done.

template<class T4, class X>

const X& code::Data1D< T4, X >::operator[]

(

size_t

i

)

const [inline, inherited]

Return the ith member of the array.

No bounds check is done.

SpaceTimeRef code::Radial::reference	(	size_t	i = 0,
		Length	distToFirstGate = Length::Meters(0.0)
	)			const

Obtain the reference of ith gate.

To get the value, use operator [] (Implementation of virtual function in Data1D)

Parameters:

distToFirstGate

[optional]: pass the distanceToFirstGate for accurate location in a RadialSet

SpaceTimeRef code::Radial::reference

(

size_t

i = 0

)

const [virtual]

Obtain the reference of ith gate.

To get the value, use operator [] (Implementation of virtual function in Data1D) Fulfills virtual method assertion

Reimplemented from code::Data1D< T4, X >.

template<class T4, class X>

void code::Data1D< T4, X >::replace	(	const X &	old_value,
		const X &	new_value
	)			[inline, inherited]

Replace any instance of old_value with new_value.

template<class T4, class X>

void code::Data1D< T4, X >::replace_1d

(

const std::vector< X > &

v

)

[inline, inherited]

Overwrite a 'row' of elements.

The number of new and old elements must match.

template<class T4, class X>

void code::Data1D< T4, X >::replace_1d	(	const X *	first,
		const X *	last
	)			[inline, inherited]

Overwrite a 'row' of elements.

The number of new and old elements must match.

void code::Radial::rotateRadial

(

const Angle &

ang

)

Changes the angle of the radials (adds this quantity) to the radial's azimuth.

template<class T4, class X>

void code::Data1D< T4, X >::set_1d

(

const std::vector< X > &

v

)

[inline, inherited]

Initialize a row of elements.

Elements already in this row will be erased.

template<class T4, class X>

void code::Data1D< T4, X >::set_1d	(	const X *	begin,
		const X *	end
	)			[inline, inherited]

Initialize a row of elements.

Elements already in this row will be erased.

void code::DataType::setAttribute	(	const std::string &	key,
		SmartPtr< DataColumn >	value
	)			[inherited]

Set a multiple-valued attribute that describes this DataType.

If value is 0 (i.e. invalid), this attribute will be removed from the map.

void code::DataType::setAttributeValue	(	const std::string &	key,
		double	value,
		const std::string &	unit = "dimensionless",
		const std::string &	format = "%g"
	)			[inherited]

Set a single-valued attribute that describes this DataType.

This is a convenience function that allows you to set a dimensionless number as the value of an attribute.

If the attribute key does not already exist, then it will be constructed.

See also:

setAttribute() to set multiple values for an attribute.

void code::DataType::setAttributeValue	(	const std::string &	key,
		const std::string &	value,
		const std::string &	unit = "dimensionless"
	)			[inherited]

Set a single-valued attribute that describes this DataType.

This is a convenience function that allows you to set a text string as the value of an attribute.

If the attribute key does not already exist, then it will be constructed. The empty string may NOT be used as a value for the attribute; this function will return immediately if the value is the empty string.

See also:

setAttribute() to set multiple values for an attribute.

void code::Radial::setAzimuth

(

const Angle &

ang

)

[inline]

The constant (starting) azimuth of this radial.

void code::Radial::setAzimuthalSpacing

(

const Angle &

ang

)

[inline]

The constant beamwidth of this radial.

void code::Radial::setElevation

(

const Angle &

ang

)

[inline]

The elevation (of the sweep) containing this radial.

void code::Radial::setGateWidth

(

const Length &

len

)

[inline]

The average width of a gate within this radial.

void code::Radial::setPhysicalBeamWidth

(

const Angle &

ang

)

[inline]

The constant beamwidth of this radial.

void code::DataType::setQuality

(

SmartPtr< DataType >

dt

)

[inline, inherited]

void code::Radial::setStartPoint

(

const SpaceTimeRef &

st

)

[inline]

The starting location and time of this radial.

void code::DataType::setTypeName

(

const std::string &

)

[inherited]

Set the TypeName of this DataType.

template<class T4, class X>

Coord code::Data1D< T4, X >::size

(

)

const [inline, inherited]

Return the size of this object.

---

Member Data Documentation

const std::string code::DataType::ColorMap [static, inherited]

const std::string code::DataType::ExpiryInterval [static, inherited]

const std::string code::DataType::IsTableData [static, inherited]

const std::string code::DataType::Unit [static, inherited]

---