README 2 KB
Newer Older
 thomas.forbriger committed Apr 11, 2006 1 2 3 4 5 /*! \file libdatwritexx/README * \brief A library to write different seismic data formats through the same interface * * ---------------------------------------------------------------------------- *  thomas.forbriger committed Mar 24, 2010 6  * $Id: README,v 1.6 2010-03-24 07:42:32 tforb Exp$  thomas.forbriger committed Apr 11, 2006 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38  * \author Thomas Forbriger * \date 11/04/2006 * * A library to write different seismic data formats through the same interface * * This file contains: * - documentation of namespace datwrite * - mainpage text * * Copyright (c) 2006 by Thomas Forbriger (BFO Schiltach) * * REVISIONS and CHANGES * - 11/04/2006 V1.0 Thomas Forbriger * * ============================================================================ */ /*! \brief Root namespace of library This namespace contains the generic interface to the library. It contains several subnamespaces with interfaces to format specific data reading modules. */ namespace datwrite { } // namespace datwrite /*======================================================================*/ /*! \mainpage \author Thomas Forbriger \since April 2006  thomas.forbriger committed Feb 17, 2010 39 \date February 2010 2006  thomas.forbriger committed Apr 11, 2006 40 \version V1.0  thomas.forbriger committed Mar 24, 2010 41 $Id: README,v 1.6 2010-03-24 07:42:32 tforb Exp$  thomas.forbriger committed Apr 11, 2006 42 43 44 45 46  Contents of this page: - \ref sec_concept - \ref sec_howto  thomas.forbriger committed Mar 24, 2010 47 48 49 50 51 52 53 Other libraries that are required to compile libdatwritexx: libaff, libtfxx, libgsexx, libtime, libsffxx, libdatreadxx The library libdatwritexx is a supplement to libdatreadxx. Most of the data structures and formats are defined in libdatreadxx. libdatwritexx supplements these with file writing modules.  thomas.forbriger committed Apr 11, 2006 54 55 56 57 58 59 60 \section sec_concept Concept of the library The library defines a generic interface for modules that write seismic data. The data must be available in SFF structures defined by libsffxx. Comparable with libdatreadxx a generic module will be provided that supports writing of any data format supported by the library.  thomas.forbriger committed Feb 28, 2007 61 \section sec_howto HOWTO write data of any supported format  thomas.forbriger committed Apr 11, 2006 62 63  An example will be provided as soon as the code is written ;-)  thomas.forbriger committed Feb 17, 2010 64   thomas.forbriger committed Apr 11, 2006 65 66 67 68  */ // ----- END OF README -----