Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends

VolProc::Step Class Reference

Inheritance diagram for VolProc::Step:
VolProc::BodyFiller VolProc::HorInterFiller VolProc::LateralSmoother VolProc::Smoother VolProc::VelGriddingStep VolProc::VolumeReader

List of all members.

Public Member Functions

 Step (Chain &)
virtual ~Step ()
const Chain & getChain () const
virtual const char * type () const =0
virtual const char * userName () const
virtual void setUserName (const char *nm)
void enable (bool yn)
bool enabled () const
virtual bool needsInput (const HorSampling &) const =0
virtual HorSampling getInputHRg (const HorSampling &) const
virtual StepInterval< int > getInputZRg (const StepInterval< int > &) const
virtual bool setInput (const Attrib::DataCubes *)
virtual void setOutput (Attrib::DataCubes *, const StepInterval< int > &inlrg, const StepInterval< int > &crlrg, const StepInterval< int > &zrg)
virtual bool canInputAndOutputBeSame () const
virtual bool needsFullVolume () const
const Attrib::DataCubes * getOutput () const
Attrib::DataCubes * getOutput ()
virtual const VelocityDesc * getVelDesc () const
virtual bool areSamplesIndependent () const
virtual Task * createTask ()
virtual void fillPar (IOPar &) const
virtual bool usePar (const IOPar &)
virtual void releaseData ()
virtual const char * errMsg () const

Protected Member Functions

virtual bool prefersBinIDWise () const
virtual bool computeBinID (const BinID &, int threadid)
virtual bool prepareComp (int nrthreads)

Static Protected Member Functions

static const char * sKeyEnabled ()

Protected Attributes

Chain & chain_
bool enabled_
Attrib::DataCubes * output_
const Attrib::DataCubes * input_
BufferString username_
HorSampling hrg_
StepInterval< int > zrg_

Friends

class BinIDWiseTask

Detailed Description

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

Constructor & Destructor Documentation

VolProc::Step::Step ( Chain &   ) 
virtual VolProc::Step::~Step (  )  [virtual]

Member Function Documentation

virtual bool VolProc::Step::areSamplesIndependent (  )  const [inline, virtual]
Returns:
wether samples in the output are independent from each other

Reimplemented in VolProc::BodyFiller.

virtual bool VolProc::Step::canInputAndOutputBeSame (  )  const [inline, virtual]

Reimplemented in VolProc::VelGriddingStep, VolProc::BodyFiller, VolProc::HorInterFiller, VolProc::LateralSmoother, VolProc::Smoother, and VolProc::VolumeReader.

virtual bool VolProc::Step::computeBinID ( const BinID &  ,
int  threadid 
) [inline, protected, virtual]

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

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

Reimplemented in VolProc::VelGriddingStep, VolProc::BodyFiller, VolProc::LateralSmoother, and VolProc::Smoother.

void VolProc::Step::enable ( bool  yn  ) 
bool VolProc::Step::enabled (  )  const
virtual const char* VolProc::Step::errMsg (  )  const [inline, virtual]

Reimplemented in VolProc::VelGriddingStep.

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

Reimplemented in VolProc::VelGriddingStep, VolProc::BodyFiller, VolProc::HorInterFiller, VolProc::LateralSmoother, VolProc::Smoother, and VolProc::VolumeReader.

const Chain& VolProc::Step::getChain (  )  const [inline]
virtual HorSampling VolProc::Step::getInputHRg ( const HorSampling &   )  const [virtual]

When computing HorSampling, how big input is needed?

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

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

When computing HorSampling, how big input is needed?

Reimplemented in VolProc::Smoother.

const Attrib::DataCubes* VolProc::Step::getOutput (  )  const [inline]
Attrib::DataCubes* VolProc::Step::getOutput (  )  [inline]
virtual const VelocityDesc* VolProc::Step::getVelDesc (  )  const [inline, virtual]

Reimplemented in VolProc::VelGriddingStep.

virtual bool VolProc::Step::needsFullVolume (  )  const [inline, virtual]

Reimplemented in VolProc::VelGriddingStep, VolProc::BodyFiller, VolProc::HorInterFiller, VolProc::LateralSmoother, VolProc::Smoother, and VolProc::VolumeReader.

virtual bool VolProc::Step::needsInput ( const HorSampling &   )  const [pure virtual]

When computing HorSampling, do I need the input?

Implemented in VolProc::VelGriddingStep, VolProc::BodyFiller, VolProc::HorInterFiller, VolProc::LateralSmoother, VolProc::Smoother, and VolProc::VolumeReader.

virtual bool VolProc::Step::prefersBinIDWise (  )  const [inline, protected, virtual]

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

virtual bool VolProc::Step::prepareComp ( int  nrthreads  )  [inline, protected, virtual]

Reimplemented in VolProc::BodyFiller, VolProc::HorInterFiller, VolProc::Smoother, and VolProc::VolumeReader.

virtual void VolProc::Step::releaseData (  )  [virtual]

Reimplemented in VolProc::VelGriddingStep, VolProc::BodyFiller, VolProc::HorInterFiller, VolProc::Smoother, and VolProc::VolumeReader.

virtual bool VolProc::Step::setInput ( const Attrib::DataCubes *   )  [virtual]
Returns:
true if it wants to keep the data.
virtual void VolProc::Step::setOutput ( Attrib::DataCubes *  ,
const StepInterval< int > &  inlrg,
const StepInterval< int > &  crlrg,
const StepInterval< int > &  zrg 
) [virtual]
virtual void VolProc::Step::setUserName ( const char *  nm  )  [virtual]
static const char* VolProc::Step::sKeyEnabled (  )  [inline, static, protected]
virtual const char* VolProc::Step::type (  )  const [pure virtual]

Implemented in VolProc::VelGriddingStep, VolProc::BodyFiller, VolProc::HorInterFiller, VolProc::LateralSmoother, VolProc::Smoother, and VolProc::VolumeReader.

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

Reimplemented in VolProc::VelGriddingStep, VolProc::BodyFiller, VolProc::HorInterFiller, VolProc::LateralSmoother, VolProc::Smoother, and VolProc::VolumeReader.

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

Friends And Related Function Documentation

friend class BinIDWiseTask [friend]

Member Data Documentation

Chain& VolProc::Step::chain_ [protected]
bool VolProc::Step::enabled_ [protected]
HorSampling VolProc::Step::hrg_ [protected]
const Attrib::DataCubes* VolProc::Step::input_ [protected]
Attrib::DataCubes* VolProc::Step::output_ [protected]
BufferString VolProc::Step::username_ [protected]
StepInterval<int> VolProc::Step::zrg_ [protected]
Generated on Tue Nov 30 2010 for VolumeProcessing by  doxygen 1.7.1