suheaderstruct.h

Go to the documentation of this file.

/*! \file suheaderstruct.h
 * \brief SU and SEG-Y trace header struct (prototypes)
 * 
 * ----------------------------------------------------------------------------
 * 
 * \author Thomas Forbriger
 * \date 19/11/2010
 * 
 * Copyright (C) 2007, Colorado School of Mines,
 * All rights reserved.
 *
 * SEG-Y and SU trace header as taken from segy.h coming with SeismicUnix
 * The SeismicUnix LEGAL_STATEMENT is appended at the end of this file.
 * 
 * SU and SEG-Y trace header struct (prototypes)
 * 
 * REVISIONS and CHANGES 
 *  - 19/11/2010   V1.0   Thomas Forbriger
 * 
 * ============================================================================
 */

// include guard
#ifndef DATRW_SUHEADERSTRUCT_H_VERSION

#define DATRW_SUHEADERSTRUCT_H_VERSION \
  "DATRW_SUHEADERSTRUCT_H   V1.0"

namespace datrw  {

  namespace su {

    //SEG-Y and SU trace header as taken from segy.h coming with SeismicUnix

    /*! \brief SEG-Y and SU trace header as taken from segy.h coming with
     * SeismicUnix
     * \ingroup group_su
     *
     * segy - trace identification header
     *
     * Only brief descriptions are available in the list.
     * Some fields are described in detail in the detailed section of the
     * field.
     * 
     * Copyright (C) 2007, Colorado School of Mines,
     * All rights reserved.
     *
     * This struct is copied from segy.h in the SeismicUnix distribution.
     * The author of the code is simply called john there.
     * The code of SeismicUnix is copyright by the Colorado School of Mines.
     * The legal statement coming along with SeismicUnix is reproduced at the
     * end of the source file.
     */
    struct TraceHeaderStruct { 

      int tracl;  /**< Trace sequence number within line.

                       Numbers continue to increase if the
                       same line continues across multiple
                       SEG Y files.
                       */

      int tracr;  /**< Trace sequence number within SEG Y file.

                        Each file starts with trace sequence one.
                        */

      int fldr;   /**< Original field record number */

      int tracf;  /**< Trace number within original field record. */

      int ep;     /**< Energy source point number.
                       Used when more than one record occurs
                       at the same effective surface location.
                       */

      int cdp;    /**< Ensemble number (i.e. CDP, CMP, CRP,...) */

      int cdpt;   /**< Trace number within the ensemble.

                       each ensemble starts with trace number one.
                       */

      short trid; /**< Trace identification code (see details).
                       Trace identification code:
                         - -1 = Other
                         - 0 = Unknown
                         - 1 = Seismic data
                         - 2 = Dead
                         - 3 = Dummy
                         - 4 = Time break
                         - 5 = Uphole
                         - 6 = Sweep
                         - 7 = Timing
                         - 8 = Water break
                         - 9 = Near-field gun signature
                         - 10 = Far-field gun signature
                         - 11 = Seismic pressure sensor
                         - 12 = Multicomponent seismic sensor,
                                Vertical component
                         - 13 = Multicomponent seismic sensor,
                                Cross-line component 
                         - 14 = Multicomponent seismic sensor,
                                in-line component 
                         - 15 = Rotated multicomponent seismic sensor,
                                Vertical component
                         - 16 = Rotated multicomponent seismic sensor,
                                Transverse component
                         - 17 = Rotated multicomponent seismic sensor,
                                Radial component
                         - 18 = Vibrator reaction mass
                         - 19 = Vibrator baseplate
                         - 20 = Vibrator estimated ground force
                         - 21 = Vibrator reference
                         - 22 = Time-velocity pairs
                         - 23 ... N = optional use, (maximum N = 32,767)

                       Following are CWP id flags:

                         - 109 = autocorrelation
                         - 110 = Fourier transformed - no packing
                                 xr[0],xi[0], ..., xr[N-1],xi[N-1]
                         - 111 = Fourier transformed - unpacked Nyquist
                                 xr[0],xi[0],...,xr[N/2],xi[N/2]
                         - 112 = Fourier transformed - packed Nyquist
                               - even N:
                                 xr[0],xr[N/2],xr[1],xi[1], ...,
                                 xr[N/2 -1],xi[N/2 -1]
                                 (note the exceptional second entry)
                               - odd N:
                                 xr[0],xr[(N-1)/2],xr[1],xi[1], ...,
                                 xr[(N-1)/2 -1],xi[(N-1)/2 -1],xi[(N-1)/2]
                                 (note the exceptional second & last entries)
                         - 113 = Complex signal in the time domain
                                 xr[0],xi[0], ..., xr[N-1],xi[N-1]
                         - 114 = Fourier transformed - amplitude/phase
                                 a[0],p[0], ..., a[N-1],p[N-1]
                         - 115 = Complex time signal - amplitude/phase
                                 a[0],p[0], ..., a[N-1],p[N-1]
                         - 116 = Real part of complex trace from 0 to Nyquist
                         - 117 = Imag part of complex trace from 0 to Nyquist
                         - 118 = Amplitude of complex trace from 0 to Nyquist
                         - 119 = Phase of complex trace from 0 to Nyquist
                         - 121 = Wavenumber time domain (k-t)
                         - 122 = Wavenumber frequency (k-omega)
                         - 123 = Envelope of the complex time trace
                         - 124 = Phase of the complex time trace
                         - 125 = Frequency of the complex time trace
                         - 130 = Depth-Range (z-x) traces
                         - 201 = Seismic data packed to bytes (by supack1)
                         - 202 = Seismic data packed to 2 bytes (by supack2)
                       */

      short nvs;  /**< Number of vertically summed traces yielding
                       this trace: 1 is one trace, 2 is two summed traces, etc.
                       */

      short nhs;  /**< Number of horizontally summed traces yielding
                       this trace: 1 is one trace 2 is two summed traces, etc.
                       */

      short duse; /**< Data use: 1 = Production 2 = Test */

      int offset; /**< Distance from the center of the source point 
                       to the center of the receiver group 
                       (negative if opposite to direction in which 
                       the line was shot).
                       */

      int gelev;  /**< Receiver group elevation from sea level
                       (all elevations above the Vertical datum are 
                       positive and below are negative).
                       */

      int selev;  /**< Surface elevation at source. */

      int sdepth; /**< Source depth below surface (a positive number). */

      int gdel;   /**< Datum elevation at receiver group. */

      int sdel;   /**< Datum elevation at source. */

      int swdep;  /**< Water depth at source. */

      int gwdep;  /**< Water depth at receiver group. */

      short scalel;     /**< Scalar to be applied to the previous 7 entries
                             to give the real value (see details). 
  
                             Scalar = 1, +10, +100, +1000, +10000.
                             If positive, scalar is used as a multiplier,
                             if negative, scalar is used as a divisor.
                             */

      short scalco;     /**< Scalar to be applied to the next 4 entries
                             to give the real value (see details). 

                             Scalar = 1, +10, +100, +1000, +10000.
                             If positive, scalar is used as a multiplier,
                             if negative, scalar is used as a divisor.
                             */

      int  sx; /**< Source coordinate - X */

      int  sy; /**< Source coordinate - Y */

      int  gx; /**< Group coordinate - X */

      int  gy; /**< Group coordinate - Y */

      short counit;     /**< Coordinate units (see details).
                          
                             Coordinate units: (for previous 4 entries and
                             for the 7 entries before scalel).

                                - 1 = Length (meters or feet)
                                - 2 = Seconds of arc
                                - 3 = Decimal degrees
                                - 4 = Degrees, minutes, seconds (DMS)

                               In case 2, the X values are longitude and the Y
                               values are latitude, a positive value designates
                               the number of seconds east of Greenwich
                               or north of the equator.

                               In case 4, 
                                 - to encode +-DDDMMSS:
                                   counit = +-DDD*10^4 + MM*10^2 + SS,
                                   with scalco = 1.
                                 - To encode +-DDDMMSS.ss:
                                   counit = +-DDD*10^6 + MM*10^4 + SS*10^2 
                                   with scalco = -100.
                               */

      short wevel;      /**< Weathering velocity. */

      short swevel;     /**< Subweathering velocity. */

      short sut;  /**< Uphole time at source in milliseconds. */

      short gut;  /**< Uphole time at receiver group in milliseconds. */

      short sstat;      /**< Source static correction in milliseconds. */

      short gstat;      /**< Group static correction  in milliseconds.*/

      short tstat;      /**< Total static applied  in milliseconds
                             (zero if no static has been applied).
                             */

      short laga; /**< Lag time A (see details).

                       Time in ms between end of 240-byte trace
                       identification header and time
                       break, positive if time break occurs after
                       end of header, time break is defined as
                       the initiation pulse which maybe recorded
                       on an auxiliary trace or as otherwise
                       specified by the recording system 
                       */

      short lagb; /**< Lag time B (see details).
                    
                     Time in ms between the time break
                     and the initiation time of the energy source,
                     may be positive or negative.
                     */

      short delrt; /**< Delay recording time (see details).
                     
                        Time in ms between
                        initiation time of energy source and time
                        when recording of data samples begins
                        (for deep water work if recording does not
                         start at zero time) 
                         */

      short muts; /**< mute time--start */

      short mute; /**< mute time--end */

      unsigned short ns; /**< number of samples in this trace */

      unsigned short dt; /**< sample interval; in micro-seconds */

      short gain; /**< Gain type of field instruments code (see dateils).
                     
                        - 1 = fixed
                        - 2 = binary
                        - 3 = floating point
                        - 4 ---- N = optional use 
                       */

      short igc; /**< instrument gain constant */

      short igi; /**< instrument early or initial gain */

      short corr; /**< correlated: 1 = no, 2 = yes */

      short sfs; /**< sweep frequency at start */

      short sfe; /**< sweep frequency at end */

      short slen; /**< sweep length in ms */

      short styp; /**< sweep type code:
                     1 = linear,
                     2 = cos-squared,
                     3 = other */

      short stas; /**< sweep trace length at start in ms */

      short stae; /**< sweep trace length at end in ms */

      short tatyp; /**< taper type: 1=linear, 2=cos^2, 3=other */

      short afilf; /**< alias filter frequency if used */

      short afils; /**< alias filter slope */

      short nofilf; /**< notch filter frequency if used */

      short nofils; /**< notch filter slope */

      short lcf; /**< low cut frequency if used */

      short hcf; /**< high cut frequncy if used */

      short lcs; /**< low cut slope */

      short hcs; /**< high cut slope */

      short year; /**< year data recorded */

      short day; /**< day of year */

      short hour; /**< hour of day (24 hour clock) */

      short minute; /**< minute of hour */

      short sec; /**< second of minute */

      short timbas; /**< time basis code:
                           1 = local,
                           2 = GMT,
                           3 = other */

      short trwf; /**< trace weighting factor, defined as 1/2^N
                     volts for the least sigificant bit */

      short grnors; /**< geophone group number of roll switch
                           position one */

      short grnofr; /**< geophone group number of trace one within
                           original field record */

      short grnlof; /**< geophone group number of last trace within
                           original field record */

      short gaps; /**< gap size (total number of groups dropped) */

      short otrav; /**< overtravel taper code:
                           1 = down (or behind),
                           2 = up (or ahead) */


      /* cwp local assignments */
      float d1; /**< sample spacing for non-seismic data */

      float f1; /**< first sample location for non-seismic data */

      float d2; /**< sample spacing between traces */

      float f2; /**< first trace location */

      float ungpow; /**< negative of power used for dynamic
                           range compression */

      float unscale; /**< reciprocal of scaling factor to normalize
                           range */

      int ntr;    /**< number of traces */

      short mark; /**< mark selected traces */

      short shortpad; /**< alignment padding */


      short unass[14]; /**< unassigned (see details).
                         
                            \note last entry causes 
                            a break in the word alignment, if we REALLY
                            want to maintain 240 bytes, the following
                            entry should be an odd number of short/UINT2
                            OR do the insertion above the "mark" keyword
                            entry 
                            */

    }; // struct TraceHeaderStruct

  } // namespace su

} // namespace datrw

/*
 * copy of LEGAL_STATEMENT coming along with SeismicUnix source code
 * -----------------------------------------------------------------
 *
 * This file is property of the Colorado School of Mines.
 * 
 * Copyright (C) 2007, Colorado School of Mines,
 * All rights reserved.
 * 
 * 
 * Redistribution and use in source and binary forms, with or 
 * without modification, are permitted provided that the following 
 * conditions are met:
 * 
 *     *  Redistributions of source code must retain the above copyright 
 *        notice, this list of conditions and the following disclaimer.
 *     *  Redistributions in binary form must reproduce the above 
 *        copyright notice, this list of conditions and the following 
 *        disclaimer in the documentation and/or other materials provided 
 *        with the distribution.
 *     *  Neither the name of the Colorado School of Mines nor the names of
 *        its contributors may be used to endorse or promote products 
 *        derived from this software without specific prior written permission.
 * 
 * Warranty Disclaimer:
 * THIS SOFTWARE IS PROVIDED BY THE COLORADO SCHOOL OF MINES AND CONTRIBUTORS 
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
 * COLORADO SCHOOL OF MINES OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * 
 * Export Restriction Disclaimer:
 * We believe that CWP/SU: Seismic Un*x is a low technology product that does
 * not appear on the Department of Commerce CCL list of restricted exports.
 * Accordingly, we believe that our product meets the qualifications of
 * an ECCN (export control classification number) of EAR99 and we believe
 * it fits the qualifications of NRR (no restrictions required), and
 * is thus not subject to export restrictions of any variety.
 * 
 * Approved Reference Format:
 * In publications, please refer to SU as per the following example:
 * Cohen, J. K. and Stockwell, Jr. J. W., (200_), CWP/SU: Seismic Un*x 
 * Release No. __: an open source software  package for seismic 
 * research and processing, 
 * Center for Wave Phenomena, Colorado School of Mines.
 * 
 * Articles about SU in peer-reviewed journals:
 * Saeki, T., (1999), A guide to Seismic Un*x (SU)(2)---examples of data processing (part 1), data input and preparation of headers, Butsuri-Tansa (Geophysical Exploration), vol. 52, no. 5, 465-477.
 * Stockwell, Jr. J. W. (1999), The CWP/SU: Seismic Un*x Package, Computers and Geosciences, May 1999.
 * Stockwell, Jr. J. W. (1997), Free Software in Education: A case study of CWP/SU: Seismic Un*x, The Leading Edge, July 1997.
 * Templeton, M. E., Gough, C.A., (1998), Web Seismic Un*x: Making seismic reflection processing more accessible, Computers and Geosciences.
 * 
 * Acknowledgements:
 * SU stands for CWP/SU:Seismic Un*x, a processing line developed at Colorado 
 * School of Mines, partially based on Stanford Exploration Project (SEP) 
 * software.
 */

#endif // DATRW_SUHEADERSTRUCT_H_VERSION (includeguard)

/* ----- END OF suheaderstruct.h ----- */