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

#include <zd_seismic_file.hpp>

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

Public Member Functions

 ZdSeismicFile (const char *szDocName=NULL)
 
virtual const ZqbAbstrTrace & tracePar () const =0
 
virtual bool modify ()
 
virtual bool isModifiable () const
 
virtual const ZqbRealTrace & trace (int ens_index=0)=0
 
virtual const ZqbHeader & header (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])
 
virtual const char * coordMeaning () const
 
virtual const char * coordUnit () const
 
virtual const char * timeMeaning () const
 
virtual const char * timeUnit () const
 
virtual bool compatibleType (const char *szType) const
 
 ZdSeismicFile (const char *szDocName=NULL)
 
virtual const ZqbAbstrTrace & tracePar () const =0
 
virtual const ZqbHeader * defHeaderPar () const
 
virtual bool modify ()
 
virtual bool isModifiable () const
 
virtual const ZqbRealTrace & trace (int ens_index=0)=0
 
virtual const ZqbHeader & header (int ens_index=0)
 
virtual int getFieldsCount () const =0
 
virtual const ZqbHdrField * headerWordInfo (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])
 
virtual const char * coordMeaning () const
 
virtual const char * coordUnit () const
 
virtual const char * timeMeaning () const
 
virtual const char * timeUnit () const
 
virtual bool compatibleType (const char *szType) const
 
- 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 CoordSelectionVec & getCoordsSelection () const
 
virtual void setInvisibleCoordinates (const CoordSelectionVec &unvisibleCoords)
 
virtual const CoordSelectionVec & getInvisibleCoordinates () 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 ()
 
ZqbName & operator= (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 ()
 
ZqbName & operator= (const ZqbName &name)
 
virtual const char * getName () const
 
virtual const char * getType () const
 
bool hasName (const char *szString) const
 

Additional Inherited Members

- Public Types inherited from ZdCoordObjStream
typedef std::vector
< CoordSelection > 		CoordSelectionVec
 
- Protected Attributes inherited from ZdDocument
ZqbViewVector m_Views
 
- Protected Attributes inherited from ZqbName
char * m_szName
 
char * m_szRoot
 

Detailed Description

Composition of Doc/View model with abstract method of accessing traces. The class is abstract so one needs to implement both ZdCoordObjStream and ZdSeismicFile methods.

Constructor & Destructor Documentation

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

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

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

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

Member Function Documentation

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

Return true if given type is compatible with this document.

Reimplemented from ZdDocument.

Reimplemented in ZdSeismicSet, and ZdSeismicSet.

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

Return true if given type is compatible with this document.

Reimplemented from ZdDocument.

Reimplemented in ZdSeismicSet, and ZdSeismicSet.

virtual const char* ZdSeismicFile::coordMeaning ( ) const
virtual

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

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

virtual const char* ZdSeismicFile::coordMeaning ( ) const
virtual

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

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

virtual const char* ZdSeismicFile::coordUnit ( ) const
virtual

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

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

virtual const char* ZdSeismicFile::coordUnit ( ) const
virtual

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

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

virtual double ZdSeismicFile::customCoord ( )
inlinevirtual

Get current custom coord of the trace.

virtual const ZqbHeader* ZdSeismicFile::defHeaderPar ( ) const
inlinevirtual

Get default header.

virtual int ZdSeismicFile::getFieldsCount ( ) const
pure virtual

Get number of fields in trace header.

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

virtual void ZdSeismicFile::globalAmplInfo ( double  pfAmm[2])
virtual

Iterations through all traces to gather information about global amplitudes distribution. pfAmm[0] - maximum amplitude, pfAmm[1]

  • minimum amplitude. NULL==pfAmm means min and max are not requested.

Reimplemented in hds::ZdLdbSeismic, and ZdUSeismic.

virtual void ZdSeismicFile::globalAmplInfo ( double  pfAmm[2])
virtual

Iterations through all traces to gather information about global amplitudes distribution. pfAmm[0] - maximum amplitude, pfAmm[1]

  • minimum amplitude. NULL==pfAmm means min and max are not requested.

Reimplemented in hds::ZdLdbSeismic, and ZdUSeismic.

virtual const ZqbHeader& ZdSeismicFile::header ( int  ens_index = 0)
virtual

Return header of the current trace of the stream with given index inside the ensemble.

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

virtual const ZqbHeader& ZdSeismicFile::header ( int  ens_index = 0)
virtual

Return header of the current trace of the stream with given index inside the ensemble.

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

virtual const ZqbHdrField* ZdSeismicFile::headerWordInfo ( int  hwId) const
virtual

Return full description of given header word. (Return NULL by default.)

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

virtual bool ZdSeismicFile::isModifiable ( ) const
virtual

Return true if the container allows to change its content. By default returns false.

Reimplemented in ZdUSeismic, and hds::ZdLdbSeismic.

virtual bool ZdSeismicFile::isModifiable ( ) const
virtual

Return true if the container allows to change its content. By default returns false.

Reimplemented in ZdUSeismic, and hds::ZdLdbSeismic.

virtual bool ZdSeismicFile::modify ( )
virtual

Change the mode of seismic set from read-only (default) to modifiable. Return true if succeeded and false otherwise. By default returns false.

Reimplemented in ZdUSeismic, and hds::ZdLdbSeismic.

virtual bool ZdSeismicFile::modify ( )
virtual

Change the mode of seismic set from read-only (default) to modifiable. Return true if succeeded and false otherwise. By default returns false.

Reimplemented in ZdUSeismic, and hds::ZdLdbSeismic.

virtual bool ZdSeismicFile::setHeader ( const ZqbHeader &  hdr,
int  ens_index = 0 
)
virtual

Change header of the given trace of the current coordinate. Return true if the operation was successful and false otherwise. By default returns false.

virtual bool ZdSeismicFile::setHeader ( const ZqbHeader &  hdr,
int  ens_index = 0 
)
virtual

Change header of the given trace of the current coordinate. Return true if the operation was successful and false otherwise. By default returns false.

virtual bool ZdSeismicFile::setSamples ( const float *  pSamples,
int  ens_index = 0 
)
virtual

Change samples in the given trace of the current coordinate. Return true if the operation was successful and false otherwise. By default returns false.

virtual bool ZdSeismicFile::setSamples ( const float *  pSamples,
int  ens_index = 0 
)
virtual

Change samples in the given trac of the current coordinate. Return true if the operation was successful and false otherwise. By default returns false.

virtual bool ZdSeismicFile::setTrace ( const ZqbRealTrace &  rtr,
int  ens_index = 0 
)
virtual

Change the whole trace of the current coordinate. If abstract trace is not compatible with this common trace parameters then false is returned. Then setSamples() and setHeader() calls are performed in this order. setHeader() is called if setSamples() returned true.

virtual bool ZdSeismicFile::setTrace ( const ZqbRealTrace &  rtr,
int  ens_index = 0 
)
virtual

Change the whole trace of the current coordinate. If abstract trace is not compatible with this common trace parameters then false is returned. Then setSamples() and setHeader() calls are performed in this order. setHeader() is called if setSamples() returned true.

virtual const char* ZdSeismicFile::timeMeaning ( ) const
virtual

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

Reimplemented in hds::ZdLdbSeismic, ZdUSeismic, and ZdSeismicSet.

virtual const char* ZdSeismicFile::timeMeaning ( ) const
virtual

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

Reimplemented in hds::ZdLdbSeismic, ZdUSeismic, and ZdSeismicSet.

virtual const char* ZdSeismicFile::timeUnit ( ) const
virtual

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

Reimplemented in hds::ZdLdbSeismic, ZdUSeismic, and ZdSeismicSet.

virtual const char* ZdSeismicFile::timeUnit ( ) const
virtual

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

Reimplemented in hds::ZdLdbSeismic, ZdUSeismic, and ZdSeismicSet.

virtual const ZqbRealTrace& ZdSeismicFile::trace ( int  ens_index = 0)
pure virtual

Return current trace of the stream with given index inside the ensemble.

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

virtual const ZqbRealTrace& ZdSeismicFile::trace ( int  ens_index = 0)
pure virtual

Return current trace of the stream with given index inside the ensemble.

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

virtual int ZdSeismicFile::traceId ( int  ens_index = 0)
pure virtual

Get unique trace index which can be associated with underlying trace db or trace file. It's guaranteed the the index is unique among traces of the same seismic stream.

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

virtual int ZdSeismicFile::traceId ( int  ens_index = 0)
pure virtual

Get unique trace index which can be associated with underlying trace db or trace file. It's guaranteed the the index is unique among traces of the same seismic stream.

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

virtual const ZqbAbstrTrace& ZdSeismicFile::tracePar ( ) const
pure virtual

Get common trace parameters.

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

virtual const ZqbAbstrTrace& ZdSeismicFile::tracePar ( ) const
pure virtual

Get common trace parameters.

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

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.5