readtsdata.h

/*! \file readtsdata.h
 * \brief read waveform data through the interface provided by libdatreadxx 
 * (prototypes)
 * 
 * ----------------------------------------------------------------------------
 * 
 * $Id: readtsdata.h,v 1.4 2007-02-12 10:27:04 tforb Exp $
 * \author Thomas Forbriger
 * \date 31/01/2007
 * 
 * read waveform data through the interface provided by libdatreadxx 
 * (prototypes)
 *
 * ----
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version. 
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 * ----
 * 
 * Copyright (c) 2007 by Thomas Forbriger (BFO Schiltach) 
 * 
 * REVISIONS and CHANGES 
 *  - 31/01/2007   V1.0   Thomas Forbriger
 * 
 * ============================================================================
 */

// include guard
#ifndef TF_READTSDATA_H_VERSION

#define TF_READTSDATA_H_VERSION \
  "TF_READTSDATA_H   V1.0   "
#define TF_READTSDATA_H_CVSID \
  "$Id: readtsdata.h,v 1.4 2007-02-12 10:27:04 tforb Exp $"

#include<tfxx/rangelist.h>
#include<tfxx/xcmdline.h>
#include<tfxx/rangestring.h>
#include<datreadxx/readany.h>
#include<tsxx/sffheaders.h>
#include<iostream>
#include<fstream>

/*! \defgroup group_readtsdata Reading of time series data.
 * \brief Read a complete set of time series including the selection of
 *   traces.
 *
 * The module is presented in namespace tfxx::tsio.
 *
 */

/*! \brief Interface provided through readtsdata.h
 *
 * \defgroup readtsdata_h Interface provided through readtsdata.h
 * 
 * \ingroup group_readtsdata
 */
namespace tfxx {

/*! \namespace tfxx::tsio
 * \brief Namespace containing all components of module readtsdata.
 * \ingroup group_readtsdata, readtsdata_h
 */
  namespace tsio {

    //! type of trace selection list
    typedef tfxx::RangeList<int> Ttracelist;

    //! type of trace selection key
    typedef const char* Ttracelistkey;

    //! structure to contain file data together with command line arguments
    struct DFile {
      // provides reading into doubles
      typedef double Tvalue;
      // container to be used
      typedef aff::Series<Tvalue> Tseries;
      // file container
      typedef ts::sff::File<Tseries> Tfile;
      //! rangelist
      typedef Tfile::Trangelist Trangelist;
      // command line arguments
      tfxx::cmdline::Filename arguments;
      // container to hold samples
      ts::sff::File<Tseries> data;
    }; // struct File

    //! complete list of files
    typedef std::list<DFile> TDFileList;
    
    //! read complete SFF file
    DFile readDSFF(const std::string& filename);

    //! read complete SFF file with trace selection
    DFile readDSFF(const std::string& filename,
                   const DFile::Trangelist& selection,
                   const bool& verbose=false,
                   const datread::Eformat& format=datread::Fsff);

    //! read complete SFF file with trace selection
    DFile readDSFF(const tfxx::cmdline::Filename& filename,
                   const bool& verbose=false,
                   Ttracelistkey="t",
                   const datread::Eformat& format=datread::Fsff);

    //! read complete list of SFF files with trace selection
    TDFileList readDSFF(const tfxx::cmdline::Tparsed& flist,
                        const bool& verbose=false,
                        Ttracelistkey="t",
                        const datread::Eformat& format=datread::Fsff);


  } // namespace tsio

} // namespace tfxx

#endif // TF_READTSDATA_H_VERSION (includeguard)

/* ----- END OF readtsdata.h ----- */