SoVRSegyReader.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : T. DUFOUR (MMM yyyy)
**=======================================================================*/
 
#ifndef  _SO_VRSEGY_READER_
#define  _SO_VRSEGY_READER_
 
#include <VolumeViz/readers/SoVolumeReader.h>
 
struct SoVRSegyTraceIdHeader;
 
class  SoVRSegyTraceHeaderBytePosition
{
 public:
  SoVRSegyTraceHeaderBytePosition();
 
  enum TraceAttribute {
    SEGY_TRACL,  // Trace sequence number within line
    SEGY_TRACR,  // Trace sequence number within reel
    SEGY_FLDR,   // Field record number
    SEGY_TRACF,  // Trace number within field record
    SEGY_EP,     // Energy source point number
    SEGY_CDP,    // CDP ensemble number
    SEGY_CDPT,   // Trace number within CDP ensemble
    SEGY_TRID,   // Trace identification code
    SEGY_NVS,    // Number of vertically summed traces
    SEGY_NHS,    // Number of horizontally summed traces
    SEGY_DUSE,   // Data use
    SEGY_OFFSET, // Distance from source point to receiver group
    SEGY_GELEV,  // Receiver group elevation from sea level
    SEGY_SELEV,  // Source elevation from sea level
    SEGY_SDEPTH, // Source depth (positive)
    SEGY_GDEL,   // Datum elevation at receiver group
    SEGY_SDEL,   // Datum elevation at source
    SEGY_SWDEP,  // Water depth at source
    SEGY_GWDEP,  // Water depth at receiver group
    SEGY_SCALEL, // Scale factor for previous 7 entries
    SEGY_SCALCO, // Scale factor for next 4 entries
    SEGY_SX,     // X source coordinate
    SEGY_SY,     // Y source coordinate
    SEGY_GX,     // X group coordinate
    SEGY_GY,     // Y group coordinate
    SEGY_COUNIT, // Coordinate units code
    SEGY_WEVEL,  // Weathering velocity
    SEGY_SWEVEL, // Subweathering velocity
    SEGY_SUT,    // Uphole time at source
    SEGY_GUT,    // Uphole time at receiver group
    SEGY_SSTAT,  // Source static correction
    SEGY_GSTAT,  // Group static correction
    SEGY_TSTAT,  // Total static applied
    SEGY_LAGA,   // Lag time A
    SEGY_LAGB,   // Lag time B
    SEGY_DELRT,  // Delay Record Time
    SEGY_MUTS,   // Mute time--start
    SEGY_MUTE,   // Mute time--end
    SEGY_NS,     // Number of samples in this trace
    SEGY_DT,     // Sample interval, in micro-seconds
    SEGY_GAIN,   // Gain type of field instruments code
    SEGY_IGC,    // Instrument gain constant
    SEGY_IGI,    // Instrument early or initial gain
    SEGY_CORR,   // Correlated
    SEGY_SFS,    // Sweep frequency at start
    SEGY_SFE,    // Sweep frequency at end
    SEGY_SLEN,   // Sweep length in ms
    SEGY_STYP,   // Sweep type code
    SEGY_STAS,   // Sweep trace length at start
    SEGY_STAE,   // Sweep trace length at end
    SEGY_TATYP,  // Taper type
    SEGY_AFILF,  // Alias filter frequency
    SEGY_AFILS,  // Alias filter slope
    SEGY_NOFILF, // Notch filter frequency 
    SEGY_NOFILS, // Notch filter slope
    SEGY_LCF,    // Low cut frequency
    SEGY_HCF,    // High cut frequncy
    SEGY_LCS,    // Low cut slope
    SEGY_HCS,    // High cut slope
    SEGY_YEAR,   // Year data recorded
    SEGY_DAY,    // Day of year
    SEGY_HOUR,   // Hour of day
    SEGY_MINUTE, // Minute of hour
    SEGY_SEC,    // Second of minute
    SEGY_TIMBAS, // Time basis code
    SEGY_TRWF,   // Trace weighting factor
    SEGY_GRNORS, // Geophone group number of roll switch position one
    SEGY_GRNOFR, // Geophone group number of trace one within original field record
    SEGY_GRNLOF, // Geophone group number of last trace within original field record
    SEGY_GAPS,   // Gap size
    SEGY_OTRAV,  // Overtravel taper code
    SEGY_CDPX,
    SEGY_CDPY,
    SEGY_INLINENUMBER,
    SEGY_CROSSLINENUMBER,
    SEGY_SHOTPOINTNUMBER,
    SEGY_SHOTPOINTSCALE,
    SEGY_TVMU,   // Trace value measurement unit
    SEGY_TRANSDUCTIONCONSTANTM,  // Transduction Constant Mantissa
    SEGY_TRANSDUCTIONCONSTANTP,  // Transduction Constant Power of ten
    SEGY_TRANSDUCTIONUNITS,
    SEGY_DTID,   // Device/Trace Identifier
    SEGY_TSCALE,
 
    SEGY_NUM_FIELDS,           // To count the number of fields
    SEGY_CROSSLINE = SEGY_CDP, // Synonym for the crossline position
    SEGY_INLINE = SEGY_TRACR   // Synonym for the inline position
  };
 
  enum TraceByteFormat {
      SEGY_INTEGER8_FORMAT,  
      SEGY_INTEGER16_FORMAT,
      SEGY_INTEGER32_FORMAT,
      SEGY_IBM_FLOAT_FORMAT,
      SEGY_IEEE_FLOAT_FORMAT
  };
 
  void    setBytePosition( TraceAttribute attr, uint8_t position );
  uint8_t getBytePosition( TraceAttribute attr ) const;
 
  uint8_t getByteLength( TraceAttribute attr ) const;
 
  void            setByteFormat( TraceAttribute attr, TraceByteFormat format );
  TraceByteFormat getByteFormat( TraceAttribute attr ) const;
 
  int getFieldValue( TraceAttribute attr, const SoVRSegyTraceIdHeader &trHdr ) const;
 
 private:
  void resetObject();
 
 private:
  uint8_t         m_BytePos[SEGY_NUM_FIELDS];
  TraceByteFormat m_ByteFmt[SEGY_NUM_FIELDS];
};
 
struct SoVRSegyFileHeader 
{
 
 public:
  int jobid;
  int lino;
  int reno;
  short ntrpr;
  short nart;
  unsigned short hdt;
  unsigned short dto;
  unsigned short hns;
  unsigned short nso;
  short format;
  short fold;
  short tsort;
  short vscode;
  short hsfs;
  short hsfe;
  short hslen;
  short hstyp;
  short schn;
  short hstas;
  short hstae;
  short htatyp;
  short hcorr;
  short bgrcv;
  short rcvm;
  short mfeet;
  short polyt;
  short vpol;
  short hunass1[120];
  unsigned short formatRevisionNumber;
  short fixedLengthTraceFlag;
  short numTextHeaderExt;
  short hunass2[47];
};
 
 
struct SoVRSegyTraceIdHeader
{
 
 public:
  int tracl;
  int tracr;
  int fldr;
  int tracf;
  int ep;
  int cdp;
  int cdpt;
  short trid;
  short nvs;
  short nhs;
  short duse;
  int offset;
  int gelev;
  int selev;
  int sdepth;
  int gdel;
  int sdel;
  int swdep;
  int gwdep;
  short scalel;
  short scalco;
  int  sx;
  int  sy;
  int  gx;
  int  gy;
  short counit;
  short wevel;
  short swevel;
  short sut;
  short gut;
  short sstat;
  short gstat;
  short tstat;
  short laga;
  short lagb;
  short delrt;
  short muts;
  short mute;
  unsigned short ns;
  unsigned short dt;
  short gain;
  short igc;
  short igi;
  short corr;
  short sfs;
  short sfe;
  short slen;
  short styp;
  short stas;
  short stae;
  short tatyp;
  short afilf;
  short afils;
  short nofilf;
  short nofils;
  short lcf;
  short hcf;
  short lcs;
  short hcs;
  short year;
  short day;
  short hour;
  short minute;
  short sec;
  short timbas;
  short trwf;
  short grnors;
  short grnofr;
  short grnlof;
  short gaps;
  short otrav;
  int cdpX;
  int cdpY;
  int inlineNumber;
  int crosslineNumber;
  int shotPointNumber;
  short shotPointScale;
  short tvmu;
  int transductionConstantM;
  short transductionConstantP;
  short transductionUnits;
  short dtid;
  short tscale;
  short unass[12];
};
 
#endif // _SO_VRSEGY_READER_