OpendTect-6_4  6.4
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
Seis::SequentialReader Class Reference
Inheritance diagram for Seis::SequentialReader:
[legend]

Public Member Functions

 SequentialReader (const IOObj &, const TrcKeyZSampling *=0, const TypeSet< int > *components=0)
 
 ~SequentialReader ()
 
void setComponents (const TypeSet< int > &compnrs)
 
mDeprecated bool setOutputComponents (const TypeSet< int > &)
 
void setComponentScaler (const Scaler &, int compidx)
 
void setDataChar (DataCharacteristics::UserType)
 
void setScaler (Scaler *)
 
bool setDataPack (RegularSeisDataPack &, od_ostream *strm=0)
 
RegularSeisDataPackgetDataPack ()
 
uiString uiMessage () const
 will be message() again in 7.x More...
 
uiString uiNrDoneText () const
 will be nrDoneText() in 7.x More...
 
od_int64 nrDone () const
 
od_int64 totalNr () const
 
bool init ()
 
- Public Member Functions inherited from Executor
 Executor (const char *nm)
 
virtual ~Executor ()
 
virtual int doStep ()
 
bool go (od_ostream *s=0, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
 
bool go (od_ostream &s, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
 
virtual bool execute ()
 
- Public Member Functions inherited from SequentialTask
 SequentialTask (const char *nm=0)
 
virtual ~SequentialTask ()
 
void setProgressMeter (ProgressMeter *)
 Must be called before execute() More...
 
ProgressMeterprogressMeter ()
 
const ProgressMeterprogressMeter () const
 
bool execute ()
 
- Public Member Functions inherited from Task
virtual ~Task ()
 
virtual void enableWorkControl (bool=true)
 Must be called before execute() More...
 
bool workControlEnabled () const
 
virtual void controlWork (Control)
 
virtual Control getState () const
 
- Public Member Functions inherited from NamedObject
 NamedObject (const char *nm=0)
 
 NamedObject (const NamedObject *linkedto)
 
 NamedObject (const NamedObject &)
 
virtual ~NamedObject ()
 
void setLinkedTo (NamedObject *)
 
bool operator== (const NamedObject &oth) const
 
virtual const OD::Stringname () const
 
virtual const OD::StringannotName () const
 
virtual void setName (const char *)
 
void setCleanName (const char *)
 cleans string first More...
 
void deleteNotify (const CallBack &)
 
- Public Member Functions inherited from CallBacker
 CallBacker ()
 
 CallBacker (const CallBacker &)
 
virtual ~CallBacker ()
 
bool attachCB (NotifierAccess &, const CallBack &, bool onlyifnew=false)
 
bool attachCB (NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false)
 
void detachCB (NotifierAccess &, const CallBack &)
 
void detachCB (NotifierAccess *notif, const CallBack &cb)
 
bool isNotifierAttached (NotifierAccess *) const
 Only for debugging purposes, don't use. More...
 

Protected Member Functions

bool setOutputComponents ()
 
virtual int nextStep ()
 
virtual bool goImpl (od_ostream *, bool, bool, int)
 
- Protected Member Functions inherited from Task
 Task (const char *nm=0)
 
virtual bool shouldContinue ()
 
- Protected Member Functions inherited from CallBacker
void detachAllNotifiers ()
 Call from the destructor of your inherited object. More...
 

Private Member Functions

 mODTextTranslationClass (SequentialReader)
 
void adjustDPDescToScalers (const BinDataDesc &trcdesc)
 
bool getTrcsPosForRead (int &desirednrpos, TypeSet< TrcKey > &) const
 
void submitUdfWriterTasks ()
 

Private Attributes

IOObjioobj_
 
bool is2d_
 
SeisTrcReaderrdr_
 
SelDatasd_
 
RegularSeisDataPackdp_
 
TrcKeyZSampling tkzs_
 
TypeSet< int > components_
 
Interval< int > samprg_
 
PosInfo::CubeDatatrcssampling_
 
PosInfo::CubeDataIteratortrcsiterator3d_
 
bool samedatachar_
 
StepInterval< float > dpzsamp_
 
bool needresampling_
 
DataCharacteristics dc_
 
Scalerscaler_
 
ObjectSummaryseissummary_
 
int queueid_
 
od_int64 totalnr_
 
od_int64 nrdone_
 
uiString msg_
 
bool initialized_
 
TypeSet< int > outcomponents_
 
ObjectSet< Scalercompscalers_
 

Additional Inherited Members

- Public Types inherited from Task
enum  Control { Run, Pause, Stop }
 
- Static Public Member Functions inherited from SequentialTask
static int ErrorOccurred ()
 
static int Finished ()
 
static int MoreToDo ()
 
static int WarningAvailable ()
 
- Static Public Member Functions inherited from Task
static uiString stdNrDoneText ()
 
static uiString uiStdNrDoneText ()
 
- Public Attributes inherited from Executor
Notifier< Executorprestep
 
Notifier< Executorpoststep
 Only when MoreToDo will be returned. More...
 
- Protected Attributes inherited from SequentialTask
ProgressMeterprogressmeter_
 
int lastupdate_
 
- Protected Attributes inherited from Task
Control control_
 
Threads::ConditionVarworkcontrolcondvar_
 
- Protected Attributes inherited from NamedObject
BufferStringname_
 
NamedObjectlinkedto_
 
CallBackSetdelnotify_
 

Detailed Description

Reads a 3D Seismic volume in parallel into a RegularSeisDataPack

Usage example: SequentialReader rdr( myiioobj ); // I want to read all rdr.setDataChar( DataCharacteristics:: ); // read in another format rdr.setScaler( myscaler ); // scale data to fit in required format if ( rdr.init() ) // something is not right rdr.execute();

Constructor & Destructor Documentation

Seis::SequentialReader::SequentialReader ( const IOObj ,
const TrcKeyZSampling = 0,
const TypeSet< int > *  components = 0 
)

For 2D data, pass line GeomID as lineNr in TrcKeySampling

Seis::SequentialReader::~SequentialReader ( )

Member Function Documentation

void Seis::SequentialReader::adjustDPDescToScalers ( const BinDataDesc trcdesc)
private
RegularSeisDataPack* Seis::SequentialReader::getDataPack ( )
bool Seis::SequentialReader::getTrcsPosForRead ( int &  desirednrpos,
TypeSet< TrcKey > &   
) const
private
virtual bool Seis::SequentialReader::goImpl ( od_ostream ,
bool  ,
bool  ,
int   
)
protectedvirtual

Reimplemented from Executor.

bool Seis::SequentialReader::init ( )
Seis::SequentialReader::mODTextTranslationClass ( SequentialReader  )
private
virtual int Seis::SequentialReader::nextStep ( )
protectedvirtual
Return values
MoreToDo()Not finished. Call me again.
Finished()Nothing more to do.
ErrorOccurred()Something went wrong.
Note
if function returns a value greater than cMoreToDo(), it should be interpreted as cMoreToDo().

Implements SequentialTask.

od_int64 Seis::SequentialReader::nrDone ( ) const
inlinevirtual
Note
nrDone is only used for displaying progress and will be compared to totalNr to show user how large part of the task that is finished.

Reimplemented from Task.

void Seis::SequentialReader::setComponents ( const TypeSet< int > &  compnrs)
inline
void Seis::SequentialReader::setComponentScaler ( const Scaler ,
int  compidx 
)

Will force the datapack to float

void Seis::SequentialReader::setDataChar ( DataCharacteristics::UserType  )
bool Seis::SequentialReader::setDataPack ( RegularSeisDataPack ,
od_ostream strm = 0 
)

No need for init if setDataPack is called Will allocate memory if not done already Scaler and sampling get forwarded to the reader DataChar is not forwarded

mDeprecated bool Seis::SequentialReader::setOutputComponents ( const TypeSet< int > &  )

Will be removed after 6.2

bool Seis::SequentialReader::setOutputComponents ( )
protected
void Seis::SequentialReader::setScaler ( Scaler )
void Seis::SequentialReader::submitUdfWriterTasks ( )
private
od_int64 Seis::SequentialReader::totalNr ( ) const
inlinevirtual

Reimplemented from Task.

uiString Seis::SequentialReader::uiMessage ( ) const
inlinevirtual

will be message() again in 7.x

Note
totalNr is only used for displaying progress.

Reimplemented from Task.

uiString Seis::SequentialReader::uiNrDoneText ( ) const
virtual

will be nrDoneText() in 7.x

Reimplemented from Task.

Member Data Documentation

TypeSet<int> Seis::SequentialReader::components_
private
ObjectSet<Scaler> Seis::SequentialReader::compscalers_
private
DataCharacteristics Seis::SequentialReader::dc_
private
RegularSeisDataPack* Seis::SequentialReader::dp_
private
StepInterval<float> Seis::SequentialReader::dpzsamp_
private
bool Seis::SequentialReader::initialized_
private
IOObj* Seis::SequentialReader::ioobj_
private
bool Seis::SequentialReader::is2d_
private
uiString Seis::SequentialReader::msg_
private
bool Seis::SequentialReader::needresampling_
private
od_int64 Seis::SequentialReader::nrdone_
private
TypeSet<int> Seis::SequentialReader::outcomponents_
private
int Seis::SequentialReader::queueid_
private
SeisTrcReader& Seis::SequentialReader::rdr_
private
bool Seis::SequentialReader::samedatachar_
private
Interval<int> Seis::SequentialReader::samprg_
private
Scaler* Seis::SequentialReader::scaler_
private
SelData* Seis::SequentialReader::sd_
private
ObjectSummary* Seis::SequentialReader::seissummary_
private
TrcKeyZSampling Seis::SequentialReader::tkzs_
private
od_int64 Seis::SequentialReader::totalnr_
private
PosInfo::CubeDataIterator* Seis::SequentialReader::trcsiterator3d_
private
PosInfo::CubeData* Seis::SequentialReader::trcssampling_
private

Generated at for the OpendTect seismic interpretation project. Copyright (C): dGB Beheer B. V. 2019