UNIVERS  15.3
UNIVERS base processing software API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Types | Public Member Functions | List of all members
ZdSeismicSet Class Referenceabstract

#include <zd_seismic_set.hpp>

Inheritance diagram for ZdSeismicSet:
ZdSeismicFile ZdSeismicFile ZdCoordObjStream ZdCoordObjStream ZdCoordObjStream ZdCoordObjStream ZdDocument ZdDocument ZdDocument ZdDocument ZdDocument ZdDocument ZdDocument ZdDocument hds::db::ZdSeismic hds::ZdLdbSeismic ZdUSeismic

Public Types

typedef std::vector< int > TraceIdsV
 
typedef std::vector< double > CoordsV
 
typedef std::vector< int > TraceIdsV
 
typedef std::vector< double > CoordsV
 
- Public Types inherited from ZdCoordObjStream
typedef std::vector
< CoordSelection
CoordSelectionVec
 

Public Member Functions

 ZdSeismicSet (const char *szDocName=NULL)
 
virtual int traceCount () const =0
 
virtual void getAllTraceIds (TraceIdsV &viTraceIds) const =0
 
virtual int coordCount () const =0
 
virtual void setCoordPrecision (double fPrec)
 
virtual double getCoordPrecision () const
 
virtual int coordToTraceId (double fCoord, int iEnsIndex=0)=0
 
virtual void coordToTraceIds (double fCoord, TraceIdsV &viTraceIds)=0
 
virtual void getCoords (CoordsV &vfCoords)=0
 
virtual double traceIdToCoord (int iTraceId, int *piEnsIndex=NULL)=0
 
virtual bool setHeader (int id, const ZqbHeader &hdr)=0
 
virtual bool setTrace (int id, const ZqbRealTrace &rtr)=0
 
virtual bool setSamples (int id, const float *pSamples)=0
 
virtual const ZqbHeaderheaderById (int id)=0
 
virtual bool headerById (int id, ZqbHeader &hdr)
 
virtual const float * samplesById (int id)=0
 
virtual bool samplesById (int id, float *pSamples)
 
virtual const ZqbRealTracetraceById (int id)=0
 
virtual bool traceById (int id, ZqbRealTrace &rtr)
 
virtual bool compatibleType (const char *szType) const
 
 ZdSeismicSet (const char *szDocName=NULL)
 
virtual int traceCount () const =0
 
virtual void getAllTraceIds (TraceIdsV &viTraceIds) const =0
 
virtual int coordCount () const =0
 
virtual void setCoordPrecision (double fPrec)
 
virtual double getCoordPrecision () const
 
virtual int coordToTraceId (double fCoord, int iEnsIndex=0)=0
 
virtual void coordToTraceIds (double fCoord, TraceIdsV &viTraceIds)=0
 
virtual void getCoords (CoordsV &vfCoords)=0
 
virtual double traceIdToCoord (int iTraceId, int *piEnsIndex=NULL)=0
 
virtual void resetOrder ()
 
virtual void applyOrder ()
 
virtual bool setHeader (int id, const ZqbHeader &hdr)=0
 
virtual bool setTrace (int id, const ZqbRealTrace &rtr)=0
 
virtual bool setSamples (int id, const float *pSamples)=0
 
virtual bool removeTrace (int)
 
virtual bool appendTrace (int, const ZqbRealTrace &)
 
virtual const ZqbHeaderheaderById (int id)=0
 
virtual bool headerById (int id, ZqbHeader &hdr)
 
virtual const float * samplesById (int id)=0
 
virtual bool samplesById (int id, float *pSamples)
 
virtual const ZqbRealTracetraceById (int id)=0
 
virtual bool traceById (int id, ZqbRealTrace &rtr)
 
virtual bool compatibleType (const char *szType) const
 
virtual const char * coordMeaning () const
 
virtual const char * coordUnit () const
 
virtual const char * timeMeaning () const
 
virtual const char * timeUnit () const
 
- Public Member Functions inherited from ZdSeismicFile
 ZdSeismicFile (const char *szDocName=NULL)
 
virtual const ZqbAbstrTracetracePar () const =0
 
virtual bool modify ()
 
virtual bool isModifiable () const
 
virtual const ZqbRealTracetrace (int ens_index=0)=0
 
virtual const ZqbHeaderheader (int ens_index=0)
 
virtual bool setSamples (const float *pSamples, int ens_index=0)
 
virtual bool setHeader (const ZqbHeader &hdr, int ens_index=0)
 
virtual bool setTrace (const ZqbRealTrace &rtr, int ens_index=0)
 
virtual int traceId (int ens_index=0)=0
 
virtual void globalAmplInfo (double pfAmm[2])
 
 ZdSeismicFile (const char *szDocName=NULL)
 
virtual const ZqbAbstrTracetracePar () const =0
 
virtual const ZqbHeaderdefHeaderPar () const
 
virtual bool modify ()
 
virtual bool isModifiable () const
 
virtual const ZqbRealTracetrace (int ens_index=0)=0
 
virtual const ZqbHeaderheader (int ens_index=0)
 
virtual int getFieldsCount () const =0
 
virtual const ZqbHdrFieldheaderWordInfo (int hwId) const
 
virtual bool setSamples (const float *pSamples, int ens_index=0)
 
virtual bool setHeader (const ZqbHeader &hdr, int ens_index=0)
 
virtual bool setTrace (const ZqbRealTrace &rtr, int ens_index=0)
 
virtual int traceId (int ens_index=0)=0
 
virtual double customCoord ()
 
virtual void globalAmplInfo (double pfAmm[2])
 
- Public Member Functions inherited from ZdCoordObjStream
 ZdCoordObjStream (const char *szDocName=NULL)
 
virtual void setCustomCoord (int iCoordId, ZqbOrder eOrder=Z_O_ASCENT)
 
virtual void setSecondaryOrder (int iSecondaryId, ZqbOrder eOrder=Z_O_ASCENT)
 
virtual void setTertiaryOrder (int iTertiaryId, ZqbOrder eOrder=Z_O_ASCENT)
 
virtual bool getCoordRange (double c[2])=0
 
virtual double averageCoordStep ()=0
 
virtual int maxEnsembleLength ()=0
 
virtual bool goFirstCoord ()=0
 
virtual bool goNextCoord ()=0
 
virtual double coord ()=0
 
virtual int ensembleLength ()=0
 
virtual void * custom (int ens_index=0, ZqbType *pRetType=NULL)
 
 ZdCoordObjStream (const char *szDocName=NULL)
 
virtual void setCustomCoord (int iCoordId)
 
virtual int getCustomCoord () const
 
virtual void setFirstOrder (int iCoordId, ZqbOrder eOrder=Z_O_ASCENT)
 
virtual bool getFirstOrder (int &iCoordId, ZqbOrder &eOrder) const
 
virtual void setSecondaryOrder (int iSecondaryId, ZqbOrder eOrder=Z_O_ASCENT)
 
virtual bool getSecondaryOrder (int &iCoordId, ZqbOrder &eOrder) const
 
virtual void setTertiaryOrder (int iTertiaryId, ZqbOrder eOrder=Z_O_ASCENT)
 
virtual bool getTertiaryOrder (int &iCoordId, ZqbOrder &eOrder) const
 
virtual void setCoordsSelection (const CoordSelectionVec &selCoords)
 
virtual const CoordSelectionVecgetCoordsSelection () const
 
virtual void setInvisibleCoordinates (const CoordSelectionVec &unvisibleCoords)
 
virtual const CoordSelectionVecgetInvisibleCoordinates () const
 
virtual bool getCoordRange (double c[2])=0
 
virtual double averageCoordStep ()=0
 
virtual int maxEnsembleLength ()=0
 
virtual bool goFirstCoord ()=0
 
virtual bool goNextCoord ()=0
 
virtual double coord ()=0
 
virtual bool visibleCoord ()
 
virtual int ensembleLength ()=0
 
virtual void * custom (int ens_index=0, ZqbType *pRetType=NULL)
 
virtual ZqbType coordTypeFromId (int coordId) const
 
- Public Member Functions inherited from ZdDocument
 ZdDocument (const char *szName=NULL)
 
virtual ~ZdDocument ()
 
virtual void updateViews ()
 
virtual bool isChanged ()
 
virtual void setChanges ()
 
virtual void resetChanges ()
 
 ZdDocument (const char *szName=NULL)
 
virtual ~ZdDocument ()
 
virtual void updateViews ()
 
virtual bool isChanged ()
 
virtual void setChanges ()
 
virtual void resetChanges ()
 
- Public Member Functions inherited from ZqbAutoName
 ZqbAutoName (int *pCounter, const char *szRoot, const char *szCustomName=NULL)
 
virtual ~ZqbAutoName ()
 
 ZqbAutoName (int *pCounter, const char *szRoot, const char *szCustomName=NULL)
 
virtual ~ZqbAutoName ()
 
- Public Member Functions inherited from ZqbName
 ZqbName (const char *szRoot, const char *szCustomName=NULL)
 
 ZqbName (const ZqbName &name)
 
virtual ~ZqbName ()
 
ZqbNameoperator= (const ZqbName &name)
 
virtual const char * getName () const
 
virtual const char * getType () const
 
bool hasName (const char *szString) const
 
 ZqbName (const char *szRoot, const char *szCustomName=NULL)
 
 ZqbName (const ZqbName &name)
 
virtual ~ZqbName ()
 
ZqbNameoperator= (const ZqbName &name)
 
virtual const char * getName () const
 
virtual const char * getType () const
 
bool hasName (const char *szString) const
 

Additional Inherited Members

- Protected Attributes inherited from ZdDocument
ZqbViewVector m_Views
 
- Protected Attributes inherited from ZqbName
char * m_szName
 
char * m_szRoot
 

Detailed Description

Class for accessing seismic set both in read-only and read-write modes. Accessibility is provided by association mapping from trace id to trace.

Member Typedef Documentation

typedef std::vector<double> ZdSeismicSet::CoordsV

Vector of trace coordinates.

typedef std::vector<double> ZdSeismicSet::CoordsV

Vector of trace coordinates.

typedef std::vector<int> ZdSeismicSet::TraceIdsV

Vector of trace indeces.

typedef std::vector<int> ZdSeismicSet::TraceIdsV

Vector of trace indeces.

Constructor & Destructor Documentation

ZdSeismicSet::ZdSeismicSet ( const char *  szDocName = NULL)

Create seismic set access document with given name. This is the name for ZdDocument object, not for seismic file itself!

ZdSeismicSet::ZdSeismicSet ( const char *  szDocName = NULL)

Create seismic set access document with given name. This is the name for ZdDocument object, not for seismic file itself!

Member Function Documentation

virtual bool ZdSeismicSet::appendTrace ( int  ,
const ZqbRealTrace  
)
inlinevirtual

Append new trace at the place with provided id. Trace appended at the bottom if id < 0 or id is out of range. Failure may be if seismic set is not modifiable just now.

Returns
false on error.
virtual void ZdSeismicSet::applyOrder ( )
inlinevirtual

Called to apply order changes but before iterations started.

Reimplemented in hds::ZdLdbSeismic, ZdUSeismic, and hds::db::ZdSeismic.

virtual bool ZdSeismicSet::compatibleType ( const char *  szType) const
virtual

Return true if given type is compatible with this document.

Reimplemented from ZdSeismicFile.

virtual bool ZdSeismicSet::compatibleType ( const char *  szType) const
virtual

Return true if given type is compatible with this document.

Reimplemented from ZdSeismicFile.

virtual int ZdSeismicSet::coordCount ( ) const
pure virtual

Returns number of different coordinates.

Implemented in hds::ZdLdbSeismic, ZdUSeismic, and hds::db::ZdSeismic.

virtual int ZdSeismicSet::coordCount ( ) const
pure virtual

Returns number of different coordinates.

Implemented in hds::ZdLdbSeismic, ZdUSeismic, and hds::db::ZdSeismic.

virtual const char* ZdSeismicSet::coordMeaning ( ) const
inlinevirtual

Physical meaning of custom coordinate value. "Coord" by default.

Reimplemented from ZdSeismicFile.

Reimplemented in hds::ZdLdbSeismic, ZdUSeismic, and hds::db::ZdSeismic.

virtual int ZdSeismicSet::coordToTraceId ( double  fCoord,
int  iEnsIndex = 0 
)
pure virtual

Try to find coordinate in the seismic set and return id of the trace found. Ensemble index is taken into account too.

Implemented in hds::ZdLdbSeismic, ZdUSeismic, and hds::db::ZdSeismic.

virtual int ZdSeismicSet::coordToTraceId ( double  fCoord,
int  iEnsIndex = 0 
)
pure virtual

Try to find coordinate in the seismic set and return id of the trace found. Ensemble index is taken into account too.

Implemented in hds::ZdLdbSeismic, ZdUSeismic, and hds::db::ZdSeismic.

virtual void ZdSeismicSet::coordToTraceIds ( double  fCoord,
TraceIdsV viTraceIds 
)
pure virtual

Return all trace ids which match given coordinate with known precision.

Implemented in hds::ZdLdbSeismic, ZdUSeismic, and hds::db::ZdSeismic.

virtual void ZdSeismicSet::coordToTraceIds ( double  fCoord,
TraceIdsV viTraceIds 
)
pure virtual

Return all trace ids which match given coordinate with known precision.

Implemented in hds::ZdLdbSeismic, ZdUSeismic, and hds::db::ZdSeismic.

virtual const char* ZdSeismicSet::coordUnit ( ) const
inlinevirtual

Unit of measure for custom coordinate. "" by default.

Reimplemented from ZdSeismicFile.

Reimplemented in hds::ZdLdbSeismic, ZdUSeismic, and hds::db::ZdSeismic.

virtual void ZdSeismicSet::getAllTraceIds ( TraceIdsV viTraceIds) const
pure virtual

Returns all trace ids.

Implemented in ZdUSeismic, hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual void ZdSeismicSet::getAllTraceIds ( TraceIdsV viTraceIds) const
pure virtual

Returns all trace ids.

Implemented in ZdUSeismic, hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual double ZdSeismicSet::getCoordPrecision ( ) const
virtual

Return precision used to find coordinate.

virtual double ZdSeismicSet::getCoordPrecision ( ) const
virtual

Return precision used to find coordinate.

virtual void ZdSeismicSet::getCoords ( CoordsV vfCoords)
pure virtual

Return all different coordinates.

Implemented in hds::ZdLdbSeismic, ZdUSeismic, and hds::db::ZdSeismic.

virtual void ZdSeismicSet::getCoords ( CoordsV vfCoords)
pure virtual

Return all different coordinates.

Implemented in hds::ZdLdbSeismic, ZdUSeismic, and hds::db::ZdSeismic.

virtual const ZqbHeader* ZdSeismicSet::headerById ( int  id)
pure virtual

Returns pointer to the header of the trace with given id. Returns NULL if there is no such id in seismic set now.

Implemented in ZdUSeismic, hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual bool ZdSeismicSet::headerById ( int  id,
ZqbHeader hdr 
)
virtual

Returns true and fills the header if id is found in seismic set. Returns false if id is not found in seismic set. It is implemented by default using headerById(int id) method.

virtual const ZqbHeader* ZdSeismicSet::headerById ( int  id)
pure virtual

Returns pointer to the header of the trace with given id. Returns NULL if there is no such id in seismic set now.

Implemented in ZdUSeismic, hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual bool ZdSeismicSet::headerById ( int  id,
ZqbHeader hdr 
)
virtual

Returns true and fills the header if id is found in seismic set. Returns false if id is not found in seismic set. It is implemented by default using headerById(int id) method.

virtual bool ZdSeismicSet::removeTrace ( int  )
inlinevirtual

Remove trace with provided id. Failure may be if id is not found and if seismic set is not modifiable just now.

Returns
false on error.
virtual void ZdSeismicSet::resetOrder ( )
inlinevirtual

Reset seismic coordinates order.

Reimplemented in hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual const float* ZdSeismicSet::samplesById ( int  id)
pure virtual

Returns pointer to the samples of the trace with given id. Returns NULL if there is no such id in seismic set now.

Implemented in ZdUSeismic, hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual bool ZdSeismicSet::samplesById ( int  id,
float *  pSamples 
)
virtual

Returns true and fills vector of samples if id is found in seismic set. Returns false if id is not found in seismic set. It is implemented by default using samplesById(int id) method.

virtual const float* ZdSeismicSet::samplesById ( int  id)
pure virtual

Returns pointer to the samples of the trace with given id. Returns NULL if there is no such id in seismic set now.

Implemented in ZdUSeismic, hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual bool ZdSeismicSet::samplesById ( int  id,
float *  pSamples 
)
virtual

Returns true and fills vector of samples if id is found in seismic set. Returns false if id is not found in seismic set. It is implemented by default using samplesById(int id) method.

virtual void ZdSeismicSet::setCoordPrecision ( double  fPrec)
virtual

Setup precision which is used to find coordinate.

virtual void ZdSeismicSet::setCoordPrecision ( double  fPrec)
virtual

Setup precision which is used to find coordinate.

virtual bool ZdSeismicSet::setHeader ( int  id,
const ZqbHeader hdr 
)
pure virtual

Set the header of trace with given id to the hdr contents and return true if succeeded and false otherwise. Failure may be if id is not found and if seismic set is not modifiable just now.

Implemented in ZdUSeismic, hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual bool ZdSeismicSet::setHeader ( int  id,
const ZqbHeader hdr 
)
pure virtual

Set the header of trace with given id to the hdr contents and return true if succeeded and false otherwise. Failure may be if id is not found and if seismic set is not modifiable just now.

Implemented in ZdUSeismic, hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual bool ZdSeismicSet::setSamples ( int  id,
const float *  pSamples 
)
pure virtual

Set the trace samples with given id to the pSamples contents and return true if succeeded and false otherwise. Failure may be if id is not found and if seismic set is not modifiable just now.

Implemented in ZdUSeismic, hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual bool ZdSeismicSet::setSamples ( int  id,
const float *  pSamples 
)
pure virtual

Set the trace samples with given id to the pSamples contents and return true if succeeded and false otherwise. Failure may be if id is not found and if seismic set is not modifiable just now.

Implemented in ZdUSeismic, hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual bool ZdSeismicSet::setTrace ( int  id,
const ZqbRealTrace rtr 
)
pure virtual

Set the trace with given id to the rtr contents and return true if succeeded and false otherwise. Failure may be if id is not found and if seismic set is not modifiable just now.

Implemented in ZdUSeismic, hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual bool ZdSeismicSet::setTrace ( int  id,
const ZqbRealTrace rtr 
)
pure virtual

Set the trace with given id to the rtr contents and return true if succeeded and false otherwise. Failure may be if id is not found and if seismic set is not modifiable just now.

Implemented in ZdUSeismic, hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual const char* ZdSeismicSet::timeMeaning ( ) const
inlinevirtual

Physical meaning of sample time. "Time" by default.

Reimplemented from ZdSeismicFile.

Reimplemented in hds::ZdLdbSeismic, and ZdUSeismic.

virtual const char* ZdSeismicSet::timeUnit ( ) const
inlinevirtual

Unit of measure for sample time. "ms" by default.

Reimplemented from ZdSeismicFile.

Reimplemented in hds::ZdLdbSeismic, and ZdUSeismic.

virtual const ZqbRealTrace* ZdSeismicSet::traceById ( int  id)
pure virtual

Returns pointer to the trace with given id. Returns NULL if there is no such id in seismic set now.

Implemented in ZdUSeismic, hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual bool ZdSeismicSet::traceById ( int  id,
ZqbRealTrace rtr 
)
virtual

Returns true and fills the trace if id is found in seismic set. Returns false if id is not found in seismic set. It is implemented by default using traceById(int id) method.

virtual const ZqbRealTrace* ZdSeismicSet::traceById ( int  id)
pure virtual

Returns pointer to the trace with given id. Returns NULL if there is no such id in seismic set now.

Implemented in ZdUSeismic, hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual bool ZdSeismicSet::traceById ( int  id,
ZqbRealTrace rtr 
)
virtual

Returns true and fills the trace if id is found in seismic set. Returns false if id is not found in seismic set. It is implemented by default using traceById(int id) method.

virtual int ZdSeismicSet::traceCount ( ) const
pure virtual

Returns number of traces.

Implemented in ZdUSeismic, hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual int ZdSeismicSet::traceCount ( ) const
pure virtual

Returns number of traces.

Implemented in ZdUSeismic, hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual double ZdSeismicSet::traceIdToCoord ( int  iTraceId,
int *  piEnsIndex = NULL 
)
pure virtual

Return coordinate of given trace and optionally returns its ensemble index.

Implemented in hds::ZdLdbSeismic, ZdUSeismic, and hds::db::ZdSeismic.

virtual double ZdSeismicSet::traceIdToCoord ( int  iTraceId,
int *  piEnsIndex = NULL 
)
pure virtual

Return coordinate of given trace and optionally returns its ensemble index.

Implemented in hds::ZdLdbSeismic, ZdUSeismic, and hds::db::ZdSeismic.


The documentation for this class was generated from the following files: