vsp_trace.h

/* vsp_trace.h      $Revision: 1.29 $   $Date: 2008/10/06 12:35:22 $ */

/*************************************************************
 *
 * Interlanguage  definitions that correlated with trace, its
 * header, and symbolic names etc.
 *
 *************************************************************/

#ifndef __vsp_trace_h

#define __vsp_trace_h

#include <mix/Types.h>
#include <mix/General.h>

#ifdef __cplusplus
extern "C"
{
#endif

typedef AtomType    SampleFormat;

#define REAL4   REAL_4
#define INT4    INT_4
#define INT2    INT_2


typedef enum    /* offset - remark, unit of measure (data type) */
{
  TA_NMGL = 0,  
#define TALogicalNo TA_NMGL

  TA_NTR,   
#define TAChannelNo TA_NTR

  TA_SIZE,  
#define TAHdrSize   TA_SIZE

  TA_ACT,   
#define TAActuality TA_ACT

  TA_NMGF,  
#define TAFieldNo   TA_NMGF
 
  TA_XSP,   
  TA_XDP,   
  TA_XOP,   
  TA_L,     
  TA_FTR,   
#define TAFormat    TA_FTR

  TA_TBC,   
  TA_TEC,   
  TA_TBA,   
#define TAStartTime TA_TBA

  TA_TEA,   
#define TAEndTime   TA_TEA

  TA_DT,    
#define TASamplingRate  TA_DT

  TA_P,     
#define TAWeight    TA_P

  TA_VER,   
#define TAVersion   TA_VER

  TA_NCF,   
#define TACoef      TA_NCF

  TA_NSP,   
  TA_YSP,   
  TA_YDP,   
  TA_YOP,   
  TA_NXBN,  
  TA_NYBN,  
  TA_XMC,   
  TA_YMC,   
  TA_PNAME, 
  TA_PVAL,  
  TA_PPGM,  
  TA_TRFR,  
#define TAFieldChannelNo    TA_TRFR

  /* Coordinats for VSP-application, m */
  TA_XSPV,  
  TA_YSPV,  
  TA_ZSPV,  
  TA_XOPV,  
  TA_YOPV,  
  TA_ZOPV,  
  TA_XDPV,  
  TA_YDPV,  
  TA_ZDPV,  
  TA_HCAB,  
#define TAProbeDepth    TA_HCAB

  TA_TYPE,  
#define TADeviceType    TA_TYPE

  TA_COMP,  
#define TAComponent TA_COMP

  TA_WCODE, 
  TA_DHSP,  
  TA_DELAY, 
  TA_NDP,   
  TA_AZIMUTH,   
  TA_DIP,   
  TA_TFB,   
  TA_AMAX,  
  TA_AMIN,  
  TA_NSL,   
  TA_NSS,   
  TA_NRP,   
  TA_NRL,   
  TA_NRS,   
  TA_REZ,   
  TA_EXTRA_0    
}  TraceAttrId;

#define TA_EXTRA(x) (TA_EXTRA_0 + (x))


/*************************************************************
 * Service and general purpose functions
 *************************************************************/

unsigned    HeaderSize (const sds_trace_header *pHeader);

unsigned    BodySize (const sds_trace_header *pHeader);

Int4        GetInt4DT (Real4 dt);
Real4       GetReal4DT (Int4 dt);

unsigned    SizeOfSample (SampleFormat format);

void        CvtSample (void* dst, SampleFormat dst_format,
               const void* src, SampleFormat src_format);

void        CvtArray (void* dst, SampleFormat dst_format,
              const void* src, SampleFormat src_format,
              unsigned scnt);

/*************************************************************
 * Field of header <--> Real4, Int4 attributes
 * Returns OK or ERROR__BAD_TAID, ERROR__NULL,
 * ERROR__SHORT_HEADER
 *************************************************************/
ErrCode GetIntAttr (const sds_trace_header* pHdr,
            TraceAttrId taid,
            Int4* pValue);
ErrCode GetRealAttr (const sds_trace_header* pHdr,
             TraceAttrId taid,
             Real4* pValue);
ErrCode SetIntAttr (sds_trace_header* pHdr,
            TraceAttrId taid,
            Int4 value);
ErrCode SetRealAttr (sds_trace_header* pHdr,
             TraceAttrId taid,
             Real4 value);


/*************************************************************
 * Some high-level operation on trace.  When time is not in
 * permitted range [Tb..Te] then 0.0 is returned.
 *************************************************************/

void    ProcARU (int iCount,        
         const Real4* pSrc, 
         Real4* pDst,       
         int iGapWidth,     
         Real4 fStartThd,   
         Real4 fZeroThd,    
         Real4* pfAmaxSrc,  
         Real4* pfAmaxDst,  
         Real4* pfAavgmax   
         );


typedef AtomType    TaidType;
#define taREAL_4    REAL_4
#define taINTEGER_4 INT_4
#define taCHAR_1    CHAR_1


typedef struct
{
  char      name[10];   
  TraceAttrId   taid;       
  TaidType  type;       
}   IndexMapItem;


typedef struct
{
  char      name[20];   
  TraceAttrId   taid;       
  unsigned  offset;     
  TaidType  type;       
  unsigned  dim;        
}   TaidMapItem;


int FindTaidName (const char* szName);


#ifndef __vsp_trace_vars

extern TaidMapItem  aTaid2Index[];
extern int      nTaid2IndexVolume;
extern IndexMapItem aIndex2Taid[];
extern int      nIndex2TaidVolume;
#endif /* __vsp_trace_vars */


#ifdef __cplusplus
};
#endif

#endif  /* vsp_trace.h */