emsurfaceio.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Kristofer Tingdahl
 Date:          4-11-2002
________________________________________________________________________


-*/

#include "earthmodelmod.h"
#include "bufstringset.h"
#include "emposid.h"
#include "executor.h"
#include "posinfo2dsurv.h"
#include "ranges.h"
#include "rowcol.h"
#include "stratlevel.h"
#include "od_iosfwd.h"

class StreamConn;
class IOObj;
template <class T> class DataInterpreter;
template <class T> class Array3D;
template <class T> class Array2D;

namespace EM
{
class Surface;
class dgbSurfDataReader;
class RowColSurfaceGeometry;


mExpClass(EarthModel) dgbSurfaceReader : public ExecutorGroup
{ mODTextTranslationClass(dgbSurfaceReader);
public:

    typedef Strat::Level::ID    LevelID;
                        dgbSurfaceReader(const IOObj& ioobj,
                                         const char* filetype);
                        dgbSurfaceReader(const char* fullexp, const char* name,
                                         const char* filetype);
                        ~dgbSurfaceReader();

    void                setOutput(EM::Surface&);
    void                setOutput(Array3D<float>&);
    int                 version() const         { return version_; }

    bool                isOK() const;
    void                setGeometry();

    int                 nrSections() const;
    EM::SectionID       sectionID(int) const;
    BufferString        sectionName(int) const;
    void                selSections(const TypeSet<EM::SectionID>&);
    const char*         dbInfo() const;
    int                 nrAuxVals() const;
    const char*         auxDataName(int) const;
    float               auxDataShift(int) const;
    void                selAuxData(const TypeSet<int>&);
    const StepInterval<int>&    rowInterval() const;
    const StepInterval<int>&    colInterval() const;
    const Interval<float>&      zInterval() const;

    void                setRowInterval(const StepInterval<int>&);
    void                setColInterval(const StepInterval<int>&);
    void                setReadOnlyZ(bool yn=true);
    void                setLineNames(const BufferStringSet&);
    void                setLinesTrcRngs(const TypeSet<StepInterval<int> >&);

    int                 nrLines() const;
    BufferString        lineName(int) const;
    BufferString        lineSet(int) const;
    Pos::GeomID         lineGeomID(int) const;
    StepInterval<int>   lineTrcRanges( int idx ) const;
    LevelID             stratLevelID() const;
    const IOPar*        pars() const;
    int                 getParsOffset() const;

    virtual od_int64    nrDone() const;
    virtual uiString    nrDoneText() const;
    virtual od_int64    totalNr() const;

    virtual int         nextStep();

    virtual uiString    message() const;

    static const char*  sKeyNrSections();
    static const char*  sKeyNrSectionsV1();
    static BufferString sSectionIDKey(int idx);
    static BufferString sSectionNameKey(int idx);
    static BufferString sColStepKey(int rowidx);
    static const char*  sKeyDepthOnly();
    static const char*  sKeyRowRange();
    static const char*  sKeyColRange();
    static const char*  sKeyZRange();
    static const char*  sKeyInt16DataChar();
    static const char*  sKeyInt32DataChar();
    static const char*  sKeyInt64DataChar();
    static const char*  sKeyFloatDataChar();
    static const char*  sKeyDBInfo();
    static const char*  sKeyVersion();
    static const char*  sKeyLineSets();
    static const char*  sKeyLineIDs();
    static const char*  sKeyTraceRange();

    static const char*  sMsgParseError();
    static uiString     sMsgReadError();
    static const char*  sKeyUndefLineSet();
    static const char*  sKeyUndefLine();

protected:

    bool                isBinary() const;

    double              readDouble(od_istream&) const;
    int                 readInt16(od_istream&) const;
    int                 readInt32(od_istream&) const;
    od_int64            readInt64(od_istream&) const;
    int                 int64Size() const;
    void                createAuxDataReader();
    bool                readParData(od_istream&,const IOPar&,const char*);
    void                mergeExternalPar(const char*);
    int                 scanFor2DGeom(TypeSet< StepInterval<int> >&);
    bool                readHeaders(const char*);
    bool                readRowOffsets(od_istream&);
    RowCol              getFileStep() const;
    int                 prepareNewSection(od_istream&);
    bool                shouldSkipCurrentRow() const;
    int                 skipRow(od_istream&);
    bool                prepareRowRead(od_istream&);
    int                 currentRow() const;
    void                goToNextRow();
    void                createSection( const SectionID& );

    StreamConn*         conn_;

    BufferStringSet     sectionnames_;
    BufferStringSet     linenames_;
    BufferStringSet     linesets_;
    TypeSet<Pos::GeomID>        geomids_;
    TypeSet<EM::SectionID> sectionids_;
    TypeSet<EM::SectionID> sectionsel_;
    bool                fullyread_;

    BufferStringSet     auxdatanames_;
    TypeSet<float>      auxdatashifts_;
    ObjectSet<EM::dgbSurfDataReader> auxdataexecs_;
    TypeSet<int>        auxdatasel_;

    const IOPar*        par_;

    uiString            msg_;
    bool                error_;
    int                 nrdone_;

    bool                isinited_;
    bool                setsurfacepar_;

    int                 sectionsread_;
    int                 sectionindex_;
    int                 oldsectionindex_;
    int                 firstrow_;
    int                 nrrows_;
    int                 rowindex_;

    DataInterpreter<int>* int32interpreter_;
    DataInterpreter<double>* floatinterpreter_;
    EM::Surface*        surface_;
    Array3D<float>*     cube_;
    Array2D<float>*     arr_;


    StepInterval<int>   rowrange_;
    StepInterval<int>   colrange_;
    Interval<float>     zrange_;

    StepInterval<int>*  readrowrange_;
    StepInterval<int>*  readcolrange_;

    bool                readonlyz_;
    BufferString        dbinfo_;
    int                 version_;

    bool                getIndices(const RowCol&,int&,int&) const;
    bool                readVersion2Row(od_istream&,int,int);

//Version 3 stuff
    bool                readVersion3Row(od_istream&,int,int,int,
                                                int noofcoltoskip=0);
    DataInterpreter<int>* int16interpreter_;
    DataInterpreter<od_int64>* int64interpreter_;
    TypeSet<od_int64>   rowoffsets_;
    TypeSet<od_int64>   sectionoffsets_;
    int                 parsoffset_;

//Version 1 stuff
    bool                readVersion1Row(od_istream&,int,int);
    RowCol              convertRowCol(int,int) const;
    bool                parseVersion1(const IOPar&);
    static const char*  sKeyTransformX();
    static const char*  sKeyTransformY();

    double              conv11, conv12, conv13, conv21, conv22, conv23;

// for loading horizon based on Lines trace range
   const BufferStringSet* readlinenames_;
   const TypeSet< StepInterval<int> >* linestrcrgs_;
   static const char*   linenamesstr_;
   void                 init(const char* fulluserexp,const char* name);
};


mExpClass(EarthModel) dgbSurfaceWriter : public ExecutorGroup
{ mODTextTranslationClass(dgbSurfaceWriter);
public:
                        dgbSurfaceWriter( const IOObj* ioobj,
                                          const char* filetype,
                                          const EM::Surface& surface,
                                          bool binary );
                        dgbSurfaceWriter( const char* fulluserexpr,
                                          const char* filetype,
                                          const EM::Surface& surface,
                                          bool binary );
                        ~dgbSurfaceWriter();
    int                 nrSections() const;
    EM::SectionID       sectionID( int ) const;
    const char*         sectionName( int ) const;
    void                selSections(const TypeSet<EM::SectionID>&,
                                    bool add=false);
    void                setShift(float);

    int                 nrAuxVals() const;
    const char*         auxDataName(int) const;
    const char*         auxDataInfo(int) const;
    void                selAuxData(const TypeSet<int>&);
    const StepInterval<int>&    rowInterval() const;
    const StepInterval<int>&    colInterval() const;
    void                        setRowInterval( const StepInterval<int>& );
    void                        setColInterval( const StepInterval<int>& );

    bool                        writeOnlyZ() const;
    void                        setWriteOnlyZ(bool yn);
    IOPar*                      pars();

    virtual od_int64            nrDone() const;
    virtual uiString            nrDoneText() const;
    virtual od_int64            totalNr() const;

    virtual int                 nextStep();

    virtual uiString            message() const;

protected:

    bool                        writeNewSection(od_ostream&);
    bool                        writeRow(od_ostream&);

    bool                        writeDouble(od_ostream&,double,
                                           const char*) const;
    bool                        writeInt16(od_ostream&,unsigned short,
                                           const char*) const;
    bool                        writeInt32(od_ostream&,od_int32,
                                           const char*) const;
    bool                        writeInt64(od_ostream&,od_int64,
                                           const char*) const;

    void                        finishWriting();
    bool                        writingfinished_;

    StreamConn*                 conn_;

    TypeSet<EM::SectionID>      sectionsel_;
    TypeSet<od_int64>           sectionoffsets_;
    od_int64                    nrsectionsoffsetoffset_;
    TypeSet<int>                auxdatasel_;
    BufferString                dbinfo_;

    IOPar*                      par_;

    uiString                    msg_;
    BufferString                fulluserexpr_;
    DBKey                       objectmid_;
    int                         nrdone_;

    int                         sectionindex_;
    int                         oldsectionindex_;
    od_int64                    rowoffsettableoffset_;
    TypeSet<od_int64>           rowoffsettable_;
    int                         firstrow_;
    int                         nrrows_;
    int                         rowindex_;

    const EM::Surface&          surface_;
    const EM::RowColSurfaceGeometry* geometry_;

    StepInterval<int>           rowrange_;
    StepInterval<int>           colrange_;
    Interval<float>             zrange_;

    StepInterval<int>*          writerowrange_;
    StepInterval<int>*          writecolrange_;
    Interval<int>               writtenrowrange_;
    Interval<int>               writtencolrange_;
    bool                        writeonlyz_;
    bool                        binary_;
    float                       shift_;
    BufferString                filetype_;

    static const char*          sTab()          { return "\t"; }
    static const char*          sEOL()          { return "\n"; }
    static const char*          sEOLTab()       { return "\n\t\t"; }

    void                        init(const char* fulluserexp);
};

} // namespace EM