An algorithm/calculation/transformation that takes one scalar volume as input, processes it, and puts the output in another volume. More...

Inheritance diagram for VolProc::Step:

[legend]

Public Types
typedef int	ID

typedef int	InputSlotID

typedef int	OutputSlotID

Public Member Functions
	mDefineFactoryInClass (Step, factory)

virtual	~Step ()

ID	getID () const

Chain &	getChain ()

const Chain &	getChain () const

virtual const char *	userName () const

virtual void	setUserName (const char *nm)

void	resetInput ()

virtual bool	needsInput () const =0

virtual int	getNrInputs () const

virtual InputSlotID	getInputSlotID (int idx) const

virtual void	getInputSlotName (InputSlotID, BufferString &) const

virtual bool	isInputPrevStep () const

virtual int	getNrOutputs () const

virtual OutputSlotID	getOutputSlotID (int idx) const

bool	validInputSlotID (InputSlotID) const

bool	validOutputSlotID (OutputSlotID) const

virtual TrcKeySampling	getInputHRg (const TrcKeySampling &) const

virtual StepInterval< int >	getInputZRg (const StepInterval< int > &) const

virtual StepInterval< int >	getInputZRgWithGeom (const StepInterval< int > &, Survey::Geometry::ID) const

virtual void	setInput (InputSlotID, const RegularSeisDataPack *)

const RegularSeisDataPack *	getInput (InputSlotID) const

virtual void	setOutput (OutputSlotID, RegularSeisDataPack *, const TrcKeySampling &, const StepInterval< int > &)

const RegularSeisDataPack *	getOutput (OutputSlotID) const

RegularSeisDataPack *	getOutput (OutputSlotID)

int	getOutputIdx (OutputSlotID) const

void	enableOutput (OutputSlotID)

virtual bool	canInputAndOutputBeSame () const

virtual bool	needsFullVolume () const

virtual bool	canHandle2D () const

const RegularSeisDataPack *	getOutput () const

RegularSeisDataPack *	getOutput ()

virtual const VelocityDesc *	getVelDesc () const

virtual bool	areSamplesIndependent () const

virtual Task *	createTask ()

virtual Task *	createTaskWithProgMeter (ProgressMeter *)

virtual bool	needReportProgress ()

virtual void	fillPar (IOPar &) const

virtual bool	usePar (const IOPar &)

virtual void	releaseData ()

TrcKeyZSampling	getInputSampling (const TrcKeyZSampling &) const

virtual uiString	errMsg () const

virtual mDeprecated od_int64	getOuputMemSize (int) const

virtual mDeprecated od_int64	getProcTimeExtraMemory () const

Static Public Member Functions
static ID	cUndefID ()

static int	cUndefSlotID ()

static mDeprecated od_int64	getBaseMemoryUsage (const TrcKeySampling &, const StepInterval< int > &)

Protected Member Functions
	Step ()

virtual bool	prefersBinIDWise () const

virtual bool	computeBinID (const BinID &, int threadid)

virtual bool	prepareComp (int nrthreads)

virtual od_int64	extraMemoryUsage (OutputSlotID, const TrcKeySampling &, const StepInterval< int > &) const

const StepInterval< float > &	getZSampling () const

void	setHStep (const BinID &)

void	setVStep (int)

void	setInpNrComps (InputSlotID, int)

void	setOutputNrComps (int)

int	getNrInputComponents (InputSlotID) const

int	getNrOutComponents () const

od_uint64	getComponentMemory (const TrcKeySampling &, bool input) const

Protected Attributes
Chain *	chain_

ObjectSet< const RegularSeisDataPack >	inputs_

TypeSet< InputSlotID >	inputslotids_

BufferString	username_

ID	id_

uiString	errmsg_

TypeSet< OutputSlotID >	outputslotids_

TrcKeySampling	tks_

StepInterval< int >	zrg_

Private Member Functions
void	setChain (Chain &)

StepInterval< float >	getInputZSamp (const StepInterval< float > &) const

od_uint64	extraMemoryUsage (OutputSlotID, const TrcKeyZSampling &) const

od_uint64	getComponentMemory (const TrcKeyZSampling &, bool input) const

Static Private Member Functions
static od_uint64	getBaseMemoryUsage (const TrcKeyZSampling &)

Private Attributes
RegularSeisDataPack *	output_

Friends
class	Chain

class	ChainExecutor

class	BinIDWiseTask

Detailed Description

An algorithm/calculation/transformation that takes one scalar volume as input, processes it, and puts the output in another volume.

Every step will be part of a Chain, which will give the step its ID.

Member Typedef Documentation

typedef int VolProc::Step::ID

typedef int VolProc::Step::InputSlotID

typedef int VolProc::Step::OutputSlotID

Constructor & Destructor Documentation

virtual VolProc::Step::~Step ( )

virtual

VolProc::Step::Step ( )

protected

Member Function Documentation

virtual bool VolProc::Step::areSamplesIndependent ( ) const

inlinevirtual

returns whether samples in the output are independent from each other.

Reimplemented in VolProc::SurfaceLimitedFiller, VolProc::HorInterFiller, VolProc::LateralSmoother, and VolProc::BodyFiller.

virtual bool VolProc::Step::canHandle2D ( ) const

inlinevirtual

Reimplemented in VolProc::SurfaceLimitedFiller, VolProc::HorInterFiller, VolProc::Smoother, VolProc::LateralSmoother, and VolProc::VolumeReader.

virtual bool VolProc::Step::canInputAndOutputBeSame ( ) const

inlinevirtual

Reimplemented in VolProc::SurfaceLimitedFiller, VolProc::HorInterFiller, VolProc::WellLogInterpolator, VolProc::VelocityGridder, VolProc::Smoother, VolProc::LateralSmoother, VolProc::BodyFiller, and VolProc::VolumeReader.

virtual bool VolProc::Step::computeBinID	(	const BinID &	,
		int	threadid
	)

inlineprotectedvirtual

Reimplemented in VolProc::SurfaceLimitedFiller, VolProc::HorInterFiller, VolProc::WellLogInterpolator, and VolProc::BodyFiller.

virtual Task* VolProc::Step::createTask ( )

virtual

Reimplemented in VolProc::VelocityGridder, VolProc::BodyFiller, VolProc::Smoother, VolProc::LateralSmoother, VolProc::VolumeReader, and VolProc::StatsCalculator.

virtual Task* VolProc::Step::createTaskWithProgMeter ( ProgressMeter * )

virtual

static ID VolProc::Step::cUndefID ( )

inlinestatic

static int VolProc::Step::cUndefSlotID ( )

inlinestatic

void VolProc::Step::enableOutput ( OutputSlotID )

virtual uiString VolProc::Step::errMsg ( ) const

inlinevirtual

Reimplemented in VolProc::SurfaceLimitedFiller, VolProc::WellLogInterpolator, and VolProc::VelocityGridder.

virtual od_int64 VolProc::Step::extraMemoryUsage	(	OutputSlotID	,
		const TrcKeySampling &	,
		const StepInterval< int > &
	)		const

inlineprotectedvirtual

Reimplemented in VolProc::SurfaceLimitedFiller, VolProc::HorInterFiller, VolProc::WellLogInterpolator, VolProc::VelocityGridder, VolProc::BodyFiller, VolProc::Smoother, VolProc::LateralSmoother, VolProc::StatsCalculator, and VolProc::VolumeReader.

od_uint64 VolProc::Step::extraMemoryUsage	(	OutputSlotID	,
		const TrcKeyZSampling &
	)		const

private

virtual void VolProc::Step::fillPar ( IOPar & ) const

virtual

Reimplemented in VolProc::SurfaceLimitedFiller, VolProc::HorInterFiller, VolProc::WellLogInterpolator, VolProc::VelocityGridder, VolProc::Smoother, VolProc::LateralSmoother, VolProc::StatsCalculator, VolProc::BodyFiller, and VolProc::VolumeReader.

static od_uint64 VolProc::Step::getBaseMemoryUsage ( const TrcKeyZSampling & )

staticprivate

static mDeprecated od_int64 VolProc::Step::getBaseMemoryUsage	(	const TrcKeySampling &	,
		const StepInterval< int > &
	)

static

Chain& VolProc::Step::getChain ( )

const Chain& VolProc::Step::getChain ( ) const

od_uint64 VolProc::Step::getComponentMemory	(	const TrcKeySampling &	,
		bool	input
	)		const

protected

od_uint64 VolProc::Step::getComponentMemory	(	const TrcKeyZSampling &	,
		bool	input
	)		const

private

ID VolProc::Step::getID ( ) const

inline

const RegularSeisDataPack* VolProc::Step::getInput ( InputSlotID ) const

virtual TrcKeySampling VolProc::Step::getInputHRg ( const TrcKeySampling & ) const

virtual

When computing TrcKeySampling, how big input is needed?

Reimplemented in VolProc::StatsCalculator, VolProc::LateralSmoother, and VolProc::Smoother.

TrcKeyZSampling VolProc::Step::getInputSampling ( const TrcKeyZSampling & ) const

virtual InputSlotID VolProc::Step::getInputSlotID ( int idx ) const

virtual

virtual void VolProc::Step::getInputSlotName	(	InputSlotID	,
		BufferString &
	)		const

virtual

virtual StepInterval<int> VolProc::Step::getInputZRg ( const StepInterval< int > & ) const

virtual

Reimplemented in VolProc::Smoother.

virtual StepInterval<int> VolProc::Step::getInputZRgWithGeom	(	const StepInterval< int > &	,
		Survey::Geometry::ID
	)		const

virtual

When computing Z Sampling, how big input is needed?

Reimplemented in VolProc::Smoother.

StepInterval<float> VolProc::Step::getInputZSamp ( const StepInterval< float > & ) const

private

int VolProc::Step::getNrInputComponents ( InputSlotID ) const

protected

virtual int VolProc::Step::getNrInputs ( ) const

virtual

int VolProc::Step::getNrOutComponents ( ) const

protected

virtual int VolProc::Step::getNrOutputs ( ) const

inlinevirtual

virtual mDeprecated od_int64 VolProc::Step::getOuputMemSize ( int ) const

virtual

const RegularSeisDataPack* VolProc::Step::getOutput ( OutputSlotID ) const

RegularSeisDataPack* VolProc::Step::getOutput ( OutputSlotID )

const RegularSeisDataPack* VolProc::Step::getOutput ( ) const

inline

RegularSeisDataPack* VolProc::Step::getOutput ( )

inline

int VolProc::Step::getOutputIdx ( OutputSlotID ) const

virtual OutputSlotID VolProc::Step::getOutputSlotID ( int idx ) const

virtual

virtual mDeprecated od_int64 VolProc::Step::getProcTimeExtraMemory ( ) const

inlinevirtual

virtual const VelocityDesc* VolProc::Step::getVelDesc ( ) const

inlinevirtual

Reimplemented in VolProc::VelocityGridder.

const StepInterval<float>& VolProc::Step::getZSampling ( ) const

protected

virtual bool VolProc::Step::isInputPrevStep ( ) const

inlinevirtual

Reimplemented in VolProc::SurfaceLimitedFiller, VolProc::HorInterFiller, and VolProc::BodyFiller.

VolProc::Step::mDefineFactoryInClass	(	Step	,
		factory
	)

virtual bool VolProc::Step::needReportProgress ( )

inlinevirtual

virtual bool VolProc::Step::needsFullVolume ( ) const

inlinevirtual

Reimplemented in VolProc::SurfaceLimitedFiller, VolProc::HorInterFiller, VolProc::WellLogInterpolator, VolProc::VelocityGridder, VolProc::Smoother, VolProc::LateralSmoother, VolProc::StatsCalculator, VolProc::BodyFiller, and VolProc::VolumeReader.

virtual bool VolProc::Step::needsInput ( ) const

pure virtual

Implemented in VolProc::WellLogInterpolator, VolProc::VelocityGridder, VolProc::SurfaceLimitedFiller, VolProc::HorInterFiller, VolProc::StatsCalculator, VolProc::BodyFiller, VolProc::VolumeReader, VolProc::LateralSmoother, and VolProc::Smoother.

virtual bool VolProc::Step::prefersBinIDWise ( ) const

inlineprotectedvirtual

Reimplemented in VolProc::SurfaceLimitedFiller, VolProc::HorInterFiller, VolProc::WellLogInterpolator, VolProc::BodyFiller, and VolProc::VolumeReader.

virtual bool VolProc::Step::prepareComp ( int nrthreads )

inlineprotectedvirtual

Reimplemented in VolProc::SurfaceLimitedFiller, VolProc::HorInterFiller, VolProc::WellLogInterpolator, VolProc::BodyFiller, and VolProc::Smoother.

virtual void VolProc::Step::releaseData ( )

virtual

Reimplemented in VolProc::SurfaceLimitedFiller, VolProc::HorInterFiller, VolProc::VelocityGridder, VolProc::Smoother, VolProc::BodyFiller, and VolProc::WellLogInterpolator.

void VolProc::Step::resetInput ( )

void VolProc::Step::setChain ( Chain & )

private

void VolProc::Step::setHStep ( const BinID & )

protected

void VolProc::Step::setInpNrComps	(	InputSlotID	,
		int
	)

protected

virtual void VolProc::Step::setInput	(	InputSlotID	,
		const RegularSeisDataPack *
	)

virtual

virtual void VolProc::Step::setOutput	(	OutputSlotID	,
		RegularSeisDataPack *	,
		const TrcKeySampling &	,
		const StepInterval< int > &
	)

virtual

void VolProc::Step::setOutputNrComps ( int )

protected

virtual void VolProc::Step::setUserName ( const char * nm )

virtual

void VolProc::Step::setVStep ( int )

protected

virtual bool VolProc::Step::usePar ( const IOPar & )

virtual

Reimplemented in VolProc::SurfaceLimitedFiller, VolProc::HorInterFiller, VolProc::WellLogInterpolator, VolProc::VelocityGridder, VolProc::Smoother, VolProc::LateralSmoother, VolProc::StatsCalculator, VolProc::BodyFiller, and VolProc::VolumeReader.

virtual const char* VolProc::Step::userName ( ) const

virtual

bool VolProc::Step::validInputSlotID ( InputSlotID ) const

bool VolProc::Step::validOutputSlotID ( OutputSlotID ) const

Friends And Related Function Documentation

friend class BinIDWiseTask

friend

friend class Chain

friend

friend class ChainExecutor

friend

Member Data Documentation

Chain* VolProc::Step::chain_

protected

uiString VolProc::Step::errmsg_

protected

ID VolProc::Step::id_

protected

ObjectSet<const RegularSeisDataPack> VolProc::Step::inputs_

protected

TypeSet<InputSlotID> VolProc::Step::inputslotids_

protected

RegularSeisDataPack* VolProc::Step::output_

private

TypeSet<OutputSlotID> VolProc::Step::outputslotids_

protected

TrcKeySampling VolProc::Step::tks_

protected

BufferString VolProc::Step::username_

protected

StepInterval<int> VolProc::Step::zrg_

protected

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation