Algo: Pos::Filter Class Reference

decideds whether a given position should be included More...

Inheritance diagram for Pos::Filter:

List of all members.

Public Member Functions
virtual Filter *	clone () const =0
virtual	~Filter ()
virtual const char *	type () const =0
virtual bool	is2D () const =0
virtual bool	isProvider () const
virtual bool	initialize (TaskRunner *tr=0)
virtual void	reset ()=0
virtual bool	includes (const Coord &, float z=mUdf(float)) const =0
virtual bool	hasZAdjustment () const
virtual float	adjustedZ (const Coord &, float z) const
virtual void	usePar (const IOPar &)=0
virtual void	fillPar (IOPar &) const =0
virtual void	getSummary (BufferString &) const =0
virtual float	estRatio (const Provider &) const =0
Static Public Member Functions
static Filter *	make (const IOPar &, bool is2d)

Detailed Description

decideds whether a given position should be included

Some Filters require initialization. There are two levels of initialization:

After 'usePar' the object may be in an intermediate state. You should be able to ask all kinds of global questions, but not toNextPos(), toNextZ(), curCoord(), curZ(), or includes(). To be able to fully use all functions, you have to initialize() the object.

Filter2D and Filter3D have factories. Providers too. Standard providers are not added to the Filter factory. Non-standard should in general be added to both.

Constructor & Destructor Documentation

virtual Pos::Filter::~Filter ( ) [inline, virtual]

Member Function Documentation

virtual float Pos::Filter::adjustedZ	(	const Coord &	,
		float	z
	)			const `[inline, virtual]`

Reimplemented in Pos::FilterSet.

virtual Filter* Pos::Filter::clone ( ) const [pure virtual]

Implemented in Pos::FilterSet3D, Pos::FilterSet2D, Pos::RandomFilter3D, Pos::RandomFilter2D, Pos::SubsampFilter3D, Pos::SubsampFilter2D, and Pos::Provider.

virtual float Pos::Filter::estRatio ( const Provider & ) const [pure virtual]

Implemented in Pos::FilterSet, Pos::RandomFilter, Pos::SubsampFilter, and Pos::Provider.

virtual void Pos::Filter::fillPar ( IOPar & ) const [pure virtual]

Implemented in Pos::FilterSet, Pos::RandomFilter, and Pos::SubsampFilter.

virtual void Pos::Filter::getSummary ( BufferString & ) const [pure virtual]

Implemented in Pos::FilterSet, Pos::RandomFilter, and Pos::SubsampFilter.

virtual bool Pos::Filter::hasZAdjustment ( ) const [inline, virtual]

Reimplemented in Pos::FilterSet.

virtual bool Pos::Filter::includes	(	const Coord &	,
		float	z = `mUdf(float)`
	)			const `[pure virtual]`

Implemented in Pos::Filter3D, Pos::FilterSet, Pos::FilterSet3D, Pos::FilterSet2D, Pos::RandomFilter3D, Pos::RandomFilter2D, Pos::SubsampFilter3D, Pos::SubsampFilter2D, and Pos::Provider3D.

virtual bool Pos::Filter::initialize ( TaskRunner * tr = 0 ) [inline, virtual]

Reimplemented in Pos::FilterSet, and Pos::RandomFilter.

virtual bool Pos::Filter::is2D ( ) const [pure virtual]

Implemented in Pos::Filter3D, Pos::Filter2D, Pos::FilterSet3D, Pos::FilterSet2D, Pos::RandomFilter3D, Pos::RandomFilter2D, Pos::SubsampFilter3D, Pos::SubsampFilter2D, Pos::Provider3D, and Pos::Provider2D.

virtual bool Pos::Filter::isProvider ( ) const [inline, virtual]

Reimplemented in Pos::Provider.

static Filter* Pos::Filter::make	(	const IOPar &	,
		bool	is2d
	)			`[static]`

Reimplemented in Pos::Provider.

virtual void Pos::Filter::reset ( ) [pure virtual]

Implemented in Pos::FilterSet, Pos::RandomFilter, and Pos::SubsampFilter.

virtual const char* Pos::Filter::type ( ) const [pure virtual]

Implemented in Pos::FilterSet3D, Pos::FilterSet2D, Pos::RandomFilter3D, Pos::RandomFilter2D, Pos::SubsampFilter3D, and Pos::SubsampFilter2D.

virtual void Pos::Filter::usePar ( const IOPar & ) [pure virtual]

Implemented in Pos::FilterSet, Pos::RandomFilter, and Pos::SubsampFilter.