Pos::Filter Class Reference

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

Inheritance diagram for Pos::Filter:

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

Decides 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 ( )

inlinevirtual

Member Function Documentation

virtual float Pos::Filter::adjustedZ ( const Coord &  , float  z  ) const

inlinevirtual

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

virtual Filter* Pos::Filter::clone ( ) const

pure virtual

Implemented in Pos::EMRegion3DProvider, Pos::EMImplicitBodyProvider, Pos::EMSurface2DProvider3D, Pos::EMSurfaceProvider2D, Pos::SubsampFilter2D, Pos::SubsampFilter3D, Pos::EMSurfaceProvider3D, Pos::FilterSet2D, Pos::RandomFilter2D, Pos::RangeProvider2D, Pos::FilterSet3D, Pos::RandomFilter3D, Pos::WellProvider3D, Pos::TableProvider3D, Pos::RangeProvider3D, Pos::SeisProvider3D, and Pos::PolyProvider3D.

virtual float Pos::Filter::estRatio ( const Provider &  ) const

pure virtual

Implemented in Pos::EMSurface2DProvider3D, Pos::EMSurfaceProvider2D, Pos::EMSurfaceProvider3D, Pos::SubsampFilter, Pos::Provider, Pos::FilterSet, and Pos::RandomFilter.

virtual void Pos::Filter::fillPar ( IOPar &  ) const

pure virtual

Implemented in Pos::EMRegion3DProvider, Pos::EMImplicitBodyProvider, Pos::SubsampFilter, Pos::RangeProvider2D, Pos::WellProvider3D, Pos::EMSurfaceProvider, Pos::SeisProvider3D, Pos::TableProvider3D, Pos::RangeProvider3D, Pos::PolyProvider3D, Pos::FilterSet, and Pos::RandomFilter.

virtual void Pos::Filter::getSummary ( BufferString &  ) const

pure virtual

Implemented in Pos::EMRegion3DProvider, Pos::EMImplicitBodyProvider, Pos::SubsampFilter, Pos::RangeProvider2D, Pos::EMSurfaceProvider, Pos::WellProvider3D, Pos::SeisProvider3D, Pos::TableProvider3D, Pos::RangeProvider3D, Pos::PolyProvider3D, Pos::FilterSet, and Pos::RandomFilter.

virtual bool Pos::Filter::hasZAdjustment ( ) const

inlinevirtual

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

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

pure virtual

Implemented in Pos::EMRegion3DProvider, Pos::EMImplicitBodyProvider, Pos::EMSurface2DProvider3D, Pos::EMSurfaceProvider2D, Pos::SubsampFilter2D, Pos::SubsampFilter3D, Pos::EMSurfaceProvider3D, Pos::RangeProvider2D, Pos::FilterSet2D, Pos::Filter2D, Pos::Provider2D, Pos::RandomFilter2D, Pos::FilterSet3D, Pos::Filter3D, Pos::RandomFilter3D, Pos::Provider3D, Pos::PolyProvider3D, Pos::SeisProvider3D, Pos::RangeProvider3D, Pos::TableProvider3D, Pos::WellProvider3D, and Pos::FilterSet.

virtual bool Pos::Filter::initialize ( TaskRunner *  tr = 0 )

inlinevirtual

Reimplemented in Pos::EMRegion3DProvider, Pos::EMImplicitBodyProvider, Pos::EMSurface2DProvider3D, Pos::EMSurfaceProvider, Pos::WellProvider3D, Pos::FilterSet, Pos::PolyProvider3D, and Pos::RandomFilter.

virtual bool Pos::Filter::is2D ( ) const

pure virtual

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

virtual bool Pos::Filter::isProvider ( ) const

inlinevirtual

Reimplemented in Pos::EMSurface2DProvider3D, Pos::EMSurfaceProvider2D, Pos::EMSurfaceProvider3D, and Pos::Provider.

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

static

virtual void Pos::Filter::reset ( )

pure virtual

Implemented in Pos::EMRegion3DProvider, Pos::EMImplicitBodyProvider, Pos::SubsampFilter, Pos::RangeProvider2D, Pos::EMSurfaceProvider, Pos::WellProvider3D, Pos::SeisProvider3D, Pos::TableProvider3D, Pos::FilterSet, Pos::RangeProvider3D, Pos::PolyProvider3D, and Pos::RandomFilter.

virtual const char* Pos::Filter::type ( ) const

pure virtual

Implemented in Pos::EMRegion3DProvider, Pos::EMImplicitBodyProvider, Pos::SubsampFilter2D, Pos::SubsampFilter3D, Pos::FilterSet2D, Pos::RandomFilter2D, Pos::RangeProvider2D, Pos::FilterSet3D, Pos::RandomFilter3D, Pos::EMSurfaceProvider, Pos::WellProvider3D, Pos::TableProvider3D, Pos::RangeProvider3D, Pos::SeisProvider3D, and Pos::PolyProvider3D.

virtual void Pos::Filter::usePar ( const IOPar &  )

pure virtual

Implemented in Pos::EMRegion3DProvider, Pos::EMImplicitBodyProvider, Pos::SubsampFilter, Pos::RangeProvider2D, Pos::WellProvider3D, Pos::EMSurfaceProvider, Pos::SeisProvider3D, Pos::TableProvider3D, Pos::RangeProvider3D, Pos::PolyProvider3D, Pos::FilterSet, and Pos::RandomFilter.