w2img::PolarGridAlgorithm< PolarType > Class Template Reference

Inheritance diagram for w2img::PolarGridAlgorithm< PolarType >:

List of all members.

---

Detailed Description

template<class PolarType>
class w2img::PolarGridAlgorithm< PolarType >

An algorithm base class to efficiently process normalized volumes of radial sets.

Author:

Lakshman, Claire Thomas

Version:

Id

w2img_PolarGridAlgorithm.h,v 1.6 2009/06/02 20:18:00 lakshman Exp

Public Member Functions
	PolarGridAlgorithm (const code::Angle &angular_resolution, const code::Length &gate_width, const code::Length &total_range)
	specify the dimensions and resolution of the output polar grid.
virtual	~PolarGridAlgorithm ()
virtual PolarType	preprocess (const code::RadialSet &rs)
	maps the given radial set onto the normalized grid.
virtual void	setVirtualVolumeFlag (bool flag)
	By default, rapid update should be on.
virtual bool	atLastTilt () const
void	setElevationTimeCorrection (bool flag)
void	setTimeOfEarliest (bool flag)
void	setRoundOffPrecision (float p)
float	shouldUseTimeOfEarliest () const
void	roundOff (code::PolarGrid &p)
std::vector< code::SmartPtr< code::DataType > >	processRecord (const code::Index::Record &inputRecord)
	process the input record, and return data corresponding to input.
std::vector< code::SmartPtr< code::DataType > >	processElevation (const PolarType &inputData)
	process the input data, and return data corresponding to input.
virtual std::vector< code::SmartPtr< code::DataType > >	process (const std::vector< PolarType > &elevations, int index_of_latest)=0
	helper method to the processRecord method.
const code::Angle &	getCurrentElevation () const
	Returns the most current elevation scan seen.
Protected Attributes
code::Angle	myAngularResolution
code::Length	myRadialResolution
int	numAngles
int	numGates

---

Constructor & Destructor Documentation

template<class PolarType>

w2img::PolarGridAlgorithm< PolarType >::PolarGridAlgorithm	(	const code::Angle &	angular_resolution,
		const code::Length &	gate_width,
		const code::Length &	total_range
	)

specify the dimensions and resolution of the output polar grid.

template<class PolarType>

virtual w2img::PolarGridAlgorithm< PolarType >::~PolarGridAlgorithm

(

)

[virtual]

---

Member Function Documentation

template<class PolarType>

virtual bool w2img::VolumeAlgorithm< PolarType >::atLastTilt

(

)

const [virtual, inherited]

Implements w2img::VolumeAlgorithmInterface.

template<class PolarType>

const code::Angle& w2img::VolumeAlgorithm< PolarType >::getCurrentElevation

(

)

const [inline, virtual, inherited]

Returns the most current elevation scan seen.

If for some reason the data are not available, may return the zero angle.

Implements w2img::VolumeAlgorithmInterface.

template<class PolarType>

virtual PolarType w2img::PolarGridAlgorithm< PolarType >::preprocess

(

const code::RadialSet &

rs

)

[virtual]

maps the given radial set onto the normalized grid.

Reimplemented from w2img::VolumeAlgorithm< PolarType >.

Reimplemented in w2img::PolarLLSD, and w2img::CleanRef.

template<class PolarType>

virtual std::vector< code::SmartPtr< code::DataType > > w2img::VolumeAlgorithm< PolarType >::process	(	const std::vector< PolarType > &	elevations,
		int	index_of_latest
	)			[pure virtual, inherited]

helper method to the processRecord method.

The input elevations are all preprocessed.

Implemented in w2img::PolarCAPPI, w2img::PolarHail, w2img::PolarLLSD, w2img::PolarVAD, and w2img::PolarVIL.

template<class PolarType>

std::vector< code::SmartPtr< code::DataType > > w2img::VolumeAlgorithm< PolarType >::processElevation

(

const PolarType &

inputData

)

[inherited]

process the input data, and return data corresponding to input.

template<class PolarType>

std::vector< code::SmartPtr< code::DataType > > w2img::VolumeAlgorithm< PolarType >::processRecord

(

const code::Index::Record &

inputRecord

)

[virtual, inherited]

process the input record, and return data corresponding to input.

Implements w2img::VolumeAlgorithmInterface.

template<class PolarType>

void w2img::VolumeAlgorithm< PolarType >::roundOff

(

code::PolarGrid &

p

)

[inherited]

template<class PolarType>

void w2img::VolumeAlgorithm< PolarType >::setElevationTimeCorrection

(

bool

flag

)

[inline, inherited]

template<class PolarType>

void w2img::VolumeAlgorithm< PolarType >::setRoundOffPrecision

(

float

p

)

[inline, inherited]

template<class PolarType>

void w2img::VolumeAlgorithm< PolarType >::setTimeOfEarliest

(

bool

flag

)

[inline, inherited]

template<class PolarType>

virtual void w2img::VolumeAlgorithm< PolarType >::setVirtualVolumeFlag

(

bool

flag

)

[inline, virtual, inherited]

By default, rapid update should be on.

Implements w2img::VolumeAlgorithmInterface.

Reimplemented in w2img::CleanRef.

template<class PolarType>

float w2img::VolumeAlgorithm< PolarType >::shouldUseTimeOfEarliest

(

)

const [inline, inherited]

---

Member Data Documentation

template<class PolarType>

code::Angle w2img::PolarGridAlgorithm< PolarType >::myAngularResolution [protected]

template<class PolarType>

code::Length w2img::PolarGridAlgorithm< PolarType >::myRadialResolution [protected]

template<class PolarType>

int w2img::PolarGridAlgorithm< PolarType >::numAngles [protected]

template<class PolarType>

int w2img::PolarGridAlgorithm< PolarType >::numGates [protected]

---