WDSS-IIw2algs: w2img::MorphFilter Class Reference

For example, this filter will work on radar reflectivity and infrared temperature, but will not work for such things as Doppler velocity since it is not possibly specify a direction of interest.


Public Types
	Erode
	This is useful for removing things like speckle, i.e.
	Dilate
	This is useful for filling gaps and optimistic smoothing i.e.
	LargeIsInteresting
	Data like rain rate, radar reflectivity, etc.
	SmallIsInteresting
	Data like infrared temperature where colder values correspond to thunderstorms.
enum	Operation { Erode, Dilate }
	For specifying which morphological operation to perform. More...
enum	DataDirection { LargeIsInteresting, SmallIsInteresting }
	Specify the direction of interest in your data. More...
Public Member Functions
	MorphFilter (Operation morphologicalOperation, DataDirection howDataIsOrganized=LargeIsInteresting)
	Construct a morphological filter.
void	setNeighborhoodSize (size_t kernel_xsize, size_t kernel_ysize)
	Changes the neighborhood size from 3 (half-size of 1).
void	setMinFill (float min_fill)
	How much of the neighborhood should be filled before we do dilation/erosion? By default, this is 0 for erosion and 0.33 for dilation.
virtual	~MorphFilter ()
virtual code::Image< float >	filterImage (const code::Image< float > &data)
	the work-horse function that does the actual morphological operations.
virtual code::SmartPtr< code::DataType >	filter (const code::RadialSet &)
virtual code::SmartPtr< code::DataType >	filter (const code::CartesianGrid2D &)
virtual code::SmartPtr< code::DataType >	filter (const code::LatLonGrid &)
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
code::SmartPtr< code::DataType >	getResult ()
	get the result of the filtering -- returns 0 on error.
void	reset ()
Protected Attributes
code::SmartPtr< code::DataType >	myResult

Member Enumeration Documentation

enum w2img::MorphFilter::DataDirection

Specify the direction of interest in your data.

Enumerator:

LargeIsInteresting	Data like rain rate, radar reflectivity, etc. where large data tends to be of interest.
SmallIsInteresting	Data like infrared temperature where colder values correspond to thunderstorms.

enum w2img::MorphFilter::Operation

For specifying which morphological operation to perform.

Enumerator:

Erode	This is useful for removing things like speckle, i.e. it erodes the area of interest.
Dilate	This is useful for filling gaps and optimistic smoothing i.e. it dilates the area of interest.

Constructor & Destructor Documentation

w2img::MorphFilter::MorphFilter	(	Operation	morphologicalOperation,
		DataDirection	howDataIsOrganized = `LargeIsInteresting`
	)

Construct a morphological filter.

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

Member Function Documentation

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

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, inherited]

Implements w2img::Data2DFilter.

virtual code::SmartPtr<code::DataType> w2img::ImageFilter::filter ( const code::LatLonGrid & ) [virtual, inherited]

Implements w2img::SingleData2DFilter.

Reimplemented in w2img::DistanceFilter.

virtual code::SmartPtr<code::DataType> w2img::ImageFilter::filter ( const code::CartesianGrid2D & ) [virtual, inherited]

Implements w2img::SingleData2DFilter.

Reimplemented in w2img::DistanceFilter.

virtual code::SmartPtr<code::DataType> w2img::ImageFilter::filter ( const code::RadialSet & ) [virtual, inherited]

Implements w2img::SingleData2DFilter.

Reimplemented in w2img::DistanceFilter.

virtual code::Image<float> w2img::MorphFilter::filterImage ( const code::Image< float > & data ) [virtual]

the work-horse function that does the actual morphological operations.

Implements w2img::ImageFilter.

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, inherited]

Implements w2img::Data2DFilter.

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

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