w2img::VolumeAlgorithm< PolarType > Class Template Reference

Inheritance diagram for w2img::VolumeAlgorithm< PolarType >:

List of all members.

---

Detailed Description

template<class PolarType>
class w2img::VolumeAlgorithm< PolarType >

An algorithm base class to efficiently process volumes of RadialSets or PolarGrids.

Author:

Lakshman

Version:

Id

w2img_VolumeAlgorithm.h,v 1.9 2009/11/10 00:05:38 lakshman Exp

Public Member Functions
	VolumeAlgorithm ()
virtual	~VolumeAlgorithm ()
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.
virtual PolarType	preprocess (const code::RadialSet &rs)
	does any preprocessing on the record.
const code::Angle &	getCurrentElevation () const
	Returns the most current elevation scan seen.

---

Constructor & Destructor Documentation

template<class PolarType>

w2img::VolumeAlgorithm< PolarType >::VolumeAlgorithm

(

)

template<class PolarType>

virtual w2img::VolumeAlgorithm< PolarType >::~VolumeAlgorithm

(

)

[virtual]

---

Member Function Documentation

template<class PolarType>

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

(

)

const [virtual]

Implements w2img::VolumeAlgorithmInterface.

template<class PolarType>

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

(

)

const [inline, virtual]

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::VolumeAlgorithm< PolarType >::preprocess

(

const code::RadialSet &

rs

)

[virtual]

does any preprocessing on the record.

The default implementation is to return the original.

Reimplemented in w2img::PolarGridAlgorithm< PolarType >, w2img::PolarLLSD, w2img::CleanRef, w2img::PolarGridAlgorithm< code::PolarGrid >, and w2img::PolarGridAlgorithm< code::RadialSet >.

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]

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

)

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]

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

Implements w2img::VolumeAlgorithmInterface.

template<class PolarType>

void w2img::VolumeAlgorithm< PolarType >::roundOff

(

code::PolarGrid &

p

)

template<class PolarType>

void w2img::VolumeAlgorithm< PolarType >::setElevationTimeCorrection

(

bool

flag

)

[inline]

template<class PolarType>

void w2img::VolumeAlgorithm< PolarType >::setRoundOffPrecision

(

float

p

)

[inline]

template<class PolarType>

void w2img::VolumeAlgorithm< PolarType >::setTimeOfEarliest

(

bool

flag

)

[inline]

template<class PolarType>

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

(

bool

flag

)

[inline, virtual]

By default, rapid update should be on.

Implements w2img::VolumeAlgorithmInterface.

Reimplemented in w2img::CleanRef.

template<class PolarType>

float w2img::VolumeAlgorithm< PolarType >::shouldUseTimeOfEarliest

(

)

const [inline]

---