w2img::SingleData2DFilter Class Reference

Inheritance diagram for w2img::SingleData2DFilter:

w2img::Data2DFilter w2img::ContourFilter w2img::ImageFilter w2img::Multiplexer w2kmeans::DefaultGridFilter w2img::DespeckleFilter w2img::DistanceFilter w2img::GMMFilter w2img::HoughLineFinder w2img::KernelFilter w2img::LocalizedEllipseFilter w2img::LRBFForecaster w2img::MaxThresholdFilter w2img::MorphEdgeFilter w2img::MorphFilter w2img::OrientedFilter w2img::OutlierFilter w2img::PercentFilter w2img::ResizeFilter w2img::ScalingFilter w2img::Skeletonizer w2img::SteeredGaussianFilterBank w2img::ThresholdFilter w2img::VarianceFilter w2img::WaveletTransform w2kmeans::HistogramEqualizer w2kmeans::InversionFilter w2kmeans::AdvectionFilter< GridType > w2kmeans::MotionEstimator< GridType > List of all members.

Detailed Description

Abstract base of individual filters.


Public Member Functions

 SingleData2DFilter ()
virtual ~SingleData2DFilter ()
void process (code::PolarGrid &)
 Note that you need to call getResult() to get the result.
void process (code::RadialSet &)
 Note that you need to call getResult() to get the result.
void process (code::CartesianGrid2D &)
 Note that you need to call getResult() to get the result.
void process (code::LatLonGrid &)
 Note that you need to call getResult() to get the result.
void process (code::WindFieldStruct< code::LatLonGrid > &)
 Note that you need to call getResult() to get the result.
void process (code::WindFieldStruct< code::CartesianGrid2D > &)
 Note that you need to call getResult() to get the result.
void allowChangingMissingData (bool in)
 Should we filter at missing data values also, or not process missing values? By default, smoothing around a missing value might produce a value at that point in the result i.e.
bool canChangeMissing () const
void setToHandleRadialData (bool in)
 Pass in true if radial data should be filtered directly instead, of as is default, to convert to CartesianGrid before contouring.
void setCartesianGridResolutionRatio (double inres)
 changes the grid resolution of CartesianGrids created from RadialSets from that of the gate width.
void setCartesianGridDimension (const code::Length &indim)
 clips cartesian grids to this extent in the horizontal and vertical directions.
void setWrapAroundRadials (size_t numWrapAroundRadials)
 Normally, the RadialSet processing is done with no radial "wrapping".
size_t getWrapAroundRadials () const
virtual code::SmartPtr< code::DataType > filter (const code::RadialSet &)=0
virtual code::SmartPtr< code::DataType > filter (const code::CartesianGrid2D &)=0
virtual code::SmartPtr< code::DataType > filter (const code::LatLonGrid &)=0
code::SmartPtr< code::DataType > getResult ()
 get the result of the filtering -- returns 0 on error.
void reset ()

Protected Attributes

code::SmartPtr< code::DataType > myResult


Constructor & Destructor Documentation

w2img::SingleData2DFilter::SingleData2DFilter (  ) 

virtual w2img::SingleData2DFilter::~SingleData2DFilter (  )  [virtual]


Member Function Documentation

void w2img::SingleData2DFilter::allowChangingMissingData ( bool  in  )  [inline, virtual]

Should we filter at missing data values also, or not process missing values? By default, smoothing around a missing value might produce a value at that point in the result i.e.

the bool is true.

Implements w2img::Data2DFilter.

bool w2img::SingleData2DFilter::canChangeMissing (  )  const [inline, virtual]

Implements w2img::Data2DFilter.

virtual code::SmartPtr<code::DataType> w2img::SingleData2DFilter::filter ( const code::LatLonGrid &   )  [pure virtual]

Implemented in w2img::ContourFilter, w2img::DistanceFilter, w2img::ImageFilter, w2img::Multiplexer, and w2kmeans::DefaultGridFilter.

virtual code::SmartPtr<code::DataType> w2img::SingleData2DFilter::filter ( const code::CartesianGrid2D &   )  [pure virtual]

Implemented in w2img::ContourFilter, w2img::DistanceFilter, w2img::ImageFilter, w2img::Multiplexer, and w2kmeans::DefaultGridFilter.

virtual code::SmartPtr<code::DataType> w2img::SingleData2DFilter::filter ( const code::RadialSet &   )  [pure virtual]

Implemented in w2img::ContourFilter, w2img::DistanceFilter, w2img::ImageFilter, w2img::Multiplexer, and w2kmeans::DefaultGridFilter.

code::SmartPtr<code::DataType> w2img::Data2DFilter::getResult (  )  [inline, inherited]

get the result of the filtering -- returns 0 on error.

This may or may not be the same data as passed in, for example process(RadialSet) may return a CartesianGrid.

size_t w2img::SingleData2DFilter::getWrapAroundRadials (  )  const [inline, virtual]

Implements w2img::Data2DFilter.

void w2img::SingleData2DFilter::process ( code::WindFieldStruct< code::CartesianGrid2D > &   ) 

Note that you need to call getResult() to get the result.

The input data is not changed.

void w2img::SingleData2DFilter::process ( code::WindFieldStruct< code::LatLonGrid > &   ) 

Note that you need to call getResult() to get the result.

The input data is not changed.

void w2img::SingleData2DFilter::process ( code::LatLonGrid &   ) 

Note that you need to call getResult() to get the result.

The input data is not changed.

void w2img::SingleData2DFilter::process ( code::CartesianGrid2D &   ) 

Note that you need to call getResult() to get the result.

The input data is not changed.

void w2img::SingleData2DFilter::process ( code::RadialSet &   ) 

Note that you need to call getResult() to get the result.

The input data is not changed.

void w2img::SingleData2DFilter::process ( code::PolarGrid &   ) 

Note that you need to call getResult() to get the result.

The input data is not changed.

void w2img::Data2DFilter::reset (  )  [inline, inherited]

void w2img::SingleData2DFilter::setCartesianGridDimension ( const code::Length &  indim  )  [inline, virtual]

clips cartesian grids to this extent in the horizontal and vertical directions.

(Removes the boundaries, keeping the image centered at the same spot).

by default, no such clipping is done. Pass in Length() to turn off clipping.

Implements w2img::Data2DFilter.

void w2img::SingleData2DFilter::setCartesianGridResolutionRatio ( double  inres  )  [inline, virtual]

changes the grid resolution of CartesianGrids created from RadialSets from that of the gate width.

For example, if the RadialSet's gate width is 1km, then if the ratio is 3, the CartesianGrid's resolution is 0.33km. If the input ratio is 0.33 then the grid resolution will be 3km.

Implements w2img::Data2DFilter.

void w2img::SingleData2DFilter::setToHandleRadialData ( bool  in  )  [inline, virtual]

Pass in true if radial data should be filtered directly instead, of as is default, to convert to CartesianGrid before contouring.

Implements w2img::Data2DFilter.

void w2img::SingleData2DFilter::setWrapAroundRadials ( size_t  numWrapAroundRadials  )  [inline, virtual]

Normally, the RadialSet processing is done with no radial "wrapping".

You can remove boundary effects in the azimuthal direction by calling this function with a value greater than zero.

When filtering with a 5x5 kernel, this class will automatically add 5 radials, do the filtering and then remove the extra five radials. In that case, the number of wraparound radials should be set to 5.

Implements w2img::Data2DFilter.


Member Data Documentation

code::SmartPtr<code::DataType> w2img::Data2DFilter::myResult [protected, inherited]


Generated on Fri May 4 13:40:23 2012 for WDSS-IIw2algs by  doxygen 1.4.7