LibCorr3DModel.h

Go to the documentation of this file.

//- ****************************************************************************
//- 
//- Copyright 2009 Sandia Corporation. Under the terms of Contract
//- DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government
//- retains certain rights in this software.
//- 
//- BSD Open Source License.
//- 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 Sandia National Laboratories nor the names of its
//-      contributors may be used to endorse or promote products derived from
//-      this software without specific prior written permission.
//- 
//- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT HOLDER 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.
//-
//- ****************************************************************************
 
#ifndef LIBCORR3DMODEL_OBJECT_H
#define LIBCORR3DMODEL_OBJECT_H
 
// **** _SYSTEM INCLUDES_ ******************************************************
 
#include <iostream>
#include <string>
#include <fstream>
#include <vector>
#include <map>
 
// use standard library objects
using namespace std;
 
// **** _LOCAL INCLUDES_ *******************************************************
 
#include "CPPUtils.h"
#include "GeoTessUtils.h"
#include "GeoTessException.h"
#include "GeoTessModel.h"
 
// **** _BEGIN GEOTESS NAMESPACE_ **********************************************
 
namespace geotess
{
 
// **** _FORWARD REFERENCES_ ***************************************************
 
class GeoTessPosition;
class GeoTessGrid;
class GeoTessMetaData;
class IFStreamBinary;
class GeoTessInterpolatorType;
 
// **** _CLASS DEFINITION_ *****************************************************
 
class GEOTESS_EXP_IMP LibCorr3DModel: public GeoTessModel
{
private:
 
        // assigned by LibCorr3D
        int handle;
 
        string sta;
 
        double staOnTime;
 
        double staOffTime;
 
        double staLat;
 
        double staLon;
 
        double staDepth;
 
        string staName;
 
        string staType;
 
        string staRefsta;
 
        double staDnorth;
 
        double staDeast;
 
        double staPosition[3];
 
        string phase;
        string supportedPhases;
        string parameters;
        string comments;
        string baseModel;
        string baseModelVersion;
 
        int formatVersion;
 
        vector<float> bmUncDist;
        vector<float> bmUncValu;
 
        void loadExtraData(IFStreamBinary& input);
 
        void loadModelBinaryLibCorr2D(IFStreamBinary& input,
                        const string& inputDirectory, const string& relGridFilePath);
 
        virtual void loadModelBinary(IFStreamBinary& input,
                        const string& inputDirectory, const string& relGridFilePath);
 
        virtual void writeModelBinary(IFStreamBinary& output, const string& gridFileName);
 
        virtual void loadModelAscii(IFStreamAscii& input, const string& inputDirectory,
                        const string& relGridFilePath);
 
        virtual void writeModelAscii(IFStreamAscii& output, const string& gridFileName);
 
public:
 
        LibCorr3DModel(const string& filename, const string& relGridFilePath = "",
                        int handle=-1);
 
        LibCorr3DModel(const string& filename, const string& relGridFilePath,
                        vector<int>& attributeFilter,
                        int handle);
 
        virtual ~LibCorr3DModel();
 
        bool operator ==(const GeoTessModel& m) const;
 
        bool operator != (const GeoTessModel& other) const { return !(*this == other); } ;
 
        virtual  string                         class_name() { return "LibCorr3DModel"; };
 
        virtual string toString();
 
        virtual LONG_INT getMemory()
        {
                LONG_INT memory = (LONG_INT)(sizeof(LibCorr3DModel)-sizeof(GeoTessModel));
 
                memory += GeoTessModel::getMemory();
 
                memory += (LONG_INT) (sta.length() + staRefsta.length() + phase.length() + parameters.length()
                                + comments.length() + baseModel.length() + baseModelVersion.length()
                                + supportedPhases.length() + staName.length() + staType.length());
 
                memory += (LONG_INT)(7 * sizeof(double));
 
                memory += (LONG_INT)(2 * sizeof(int));
 
                memory += (LONG_INT)((bmUncDist.capacity() + bmUncValu.capacity()) * sizeof(float));
 
                return memory;
        }
 
 
        int getHandle() const
        {
                return handle;
        }
 
        bool is3DModel()
        {
                return bmUncDist.size() == 0;
        }
 
        double interpolate2DModelUncertainty(const double* pos);
 
        const string& getFileName() const
        {
                return metaData->getInputModelFile();
        }
 
        void setStationInfo(const string& name,
                        const double& ontime, const double& offtime,
                        const double& lat, const double& lon, const double& depth,
                        const string& staname, const string& statype,
                        const string& refsta,
                        const double& dnorth, const double& deast
                        )
        {
                sta = name;
                staOnTime = ontime;
                staOffTime = offtime;
                staLat = lat;
                staLon = lon;
                staDepth = depth;
                staName = staname;
                staType = statype;
                staRefsta = refsta;
                staDnorth = dnorth;
                staDeast = deast;
                GeoTessUtils::getVectorDegrees(staLat, staLon, staPosition);
        }
 
        const string& getStationName() const { return sta; }
 
        double getStationStartTime() const { return staOnTime; }
 
        double getStationEndTime() const { return staOffTime; }
 
        double getStationLatitude() const { return staLat; }
 
        double getStationLongitude() const { return staLon; }
 
        double getStationDepth() const { return staDepth; }
 
        double getStationElevation() const { return -staDepth; }
 
        const double* getStationPosition() const { return staPosition; }
 
        const string& getStaName() const { return staName; }
 
        const string& getStaType() const { return staType; }
 
        const string& getRefsta() const { return staRefsta; }
 
        double getDnorth() const { return staDnorth; }
 
        double getDeasts() const { return staDeast; }
 
        const string& getPhase() const { return phase; }
 
        void setPhase(const string& ph) { phase = ph; }
 
        const string& getSupportedPhaseList() const { return supportedPhases; }
 
        void setSupportedPhaseList(const string& ph) { supportedPhases = ph; }
 
        const string& getParameters() const { return parameters; }
 
        void setParameters(const string& par) { parameters = par; }
 
        const string& getComments() const { return comments; }
 
        void setComments(const string& com) { comments = com; }
 
        const string& getBaseModel() const { return baseModel; }
 
        void setBaseModel(const string& bm) { baseModel = bm; }
 
        const string& getBaseModelVersion() const { return baseModelVersion; }
 
        void setBaseModelVersion(const string& bmv) { baseModelVersion = bmv; }
 
        string getVmodel() const {
                map<string, string>::const_iterator it = metaData->getProperties().find("vmodel");
                if (it == metaData->getProperties().end())
                    return "libcorr3d";
                return it->second;
        }
 
};
// end class LibCorr3DModel
 
}// end namespace geotess
 
#endif // LIBCORR3DMODEL_OBJECT_H