ossimNitfRpcBase.h

Go to the documentation of this file.

//*******************************************************************
//
// License:  MIT
// 
// See LICENSE.txt file in the top level directory for more details.
// 
// Author: Garrett Potts
//
// Description: Nitf base support data class for RPC tags.
// 
// Rational Polynomial Coefficient extension.
//
// See: http://164.214.2.51/ntb/baseline/docs/stdi0002/final.pdf
//
//********************************************************************
// $Id: ossimNitfRpcBase.h 22013 2012-12-19 17:37:20Z dburken $
#ifndef ossimNitfRpcBase_HEADER
#define ossimNitfRpcBase_HEADER 1
#include <ossim/support_data/ossimNitfRegisteredTag.h>
#include <ossim/projection/ossimRpcModel.h>

class OSSIM_DLL ossimNitfRpcBase : public ossimNitfRegisteredTag
{
 public:
  enum 
  {
    SUCCESS_SIZE                         = 1,
    ERROR_BIAS_SIZE                      = 7,
    ERR_RAND_SIZE                        = 7,
    LINE_OFFSET_SIZE                     = 6,
    SAMPLE_OFFSET_SIZE                   = 5,
    GEODETIC_LAT_OFFSET_SIZE             = 8,
    GEODETIC_LON_OFFSET_SIZE             = 9,
    GEODETIC_HEIGHT_OFFSET_SIZE          = 5,
    LINE_SCALE_SIZE                      = 6,
    SAMPLE_SCALE_SIZE                    = 5,
    GEODETIC_LAT_SCALE_SIZE              = 8,
    GEODETIC_LON_SCALE_SIZE              = 9,
    GEODETIC_HEIGHT_SCALE_SIZE           = 5,
    LINE_NUMERATOR_COEFFICIENT_SIZE      = 12,
    LINE_NUMERATOR_COEFFICIENT_COUNT     = 20,
    LINE_DENOMINATOR_COEFFICIENT_SIZE    = 12,
    LINE_DENOMINATOR_COEFFICIENT_COUNT   = 20,
    SAMPLE_NUMERATOR_COEFFICIENT_SIZE    = 12,
    SAMPLE_NUMERATOR_COEFFICIENT_COUNT   = 20,
    SAMPLE_DENOMINATOR_COEFFICIENT_SIZE  = 12,
    SAMPLE_DENOMINATOR_COEFFICIENT_COUNT = 20
    //                                  -----
    //                                   1041
  };

  ossimNitfRpcBase();

  virtual void parseStream(std::istream& in);

  virtual void writeStream(std::ostream& out);

  virtual void clearFields();

  virtual void setRpcModelParams(ossimRefPtr<ossimRpcModel> rpc);

  bool getSuccess()const;

  void setSuccess(bool success);

  ossimString getErrorBias()const;

  //---
  // The set methods below taking ossimString args will truncate and
  // pad with spaces, as necessary, to match enumed size.
  //---

  void setErrorBias(const ossim_float64& errorBias);

  void setErrorBias(const ossimString& errorBias);

  ossimString getErrorRand()const;

  void setErrorRand(const ossim_float64& errorRand);

  
  void setErrorRand(const ossimString& errorRand);

  ossimString getLineOffset()const;

  void setLineOffset(ossim_uint32 lineOffset);

  void setLineOffset(const ossimString& lineOffset);

  ossimString getSampleOffset()const;

  void setSampleOffset(ossim_uint32 sampleOffset);

  void setSampleOffset(const ossimString& sampleOffset);

  ossimString getGeodeticLatOffset()const;

  void setGeodeticLatOffset(const ossim_float64& geodeticLatOffset);

  void setGeodeticLatOffset(const ossimString& geodeticLatOffset);

  ossimString getGeodeticLonOffset()const;

  void setGeodeticLonOffset(const ossim_float64& geodeticLonOffset);

  void setGeodeticLonOffset(const ossimString& geodeticLonOffset);

  ossimString getGeodeticHeightOffset()const;

  void setGeodeticHeightOffset(ossim_int32 geodeticHeightOffset);
  
  void setGeodeticHeightOffset(const ossimString& geodeticHeightOffset);

  ossimString getLineScale()const;
  
  void setLineScale(ossim_uint32 lineScale);

  void setLineScale(const ossimString& lineScale);

  ossimString getSampleScale()const;

  void setSampleScale(ossim_uint32 sampleScale);

  void setSampleScale(const ossimString& sampleScale);

  ossimString getGeodeticLatScale()const;

  void setGeodeticLatScale(const ossim_float64& geodeticLatScale);

  void setGeodeticLatScale(const ossimString& geodeticLatScale);

  ossimString getGeodeticLonScale()const;

  void setGeodeticLonScale(const ossim_float64& geodeticLonScale);

  void setGeodeticLonScale(const ossimString& geodeticLonScale);

  ossimString getGeodeticHeightScale()const;

  void setGeodeticHeightScale(ossim_int32 geodeticHeightScale);
  
  void setGeodeticHeightScale(const ossimString& geodeticHeightScale);

  ossimString getLineNumeratorCoeff(ossim_uint32 idx)const;

  void setLineNumeratorCoeff(const std::vector<ossim_float64>& coeff);
  
  void setLineNumeratorCoeff(ossim_uint32 idx,
                             const ossimString& coeff);

  ossimString getLineDenominatorCoeff(ossim_uint32 idx)const;
  
  void setLineDenominatorCoeff(const std::vector<ossim_float64>& coeff);
  
  void setLineDenominatorCoeff(ossim_uint32 idx,
                               const ossimString& coeff);

  ossimString getSampleNumeratorCoeff(ossim_uint32 idx)const;

  void setSampleNumeratorCoeff(const std::vector<ossim_float64>& coeff);
  
  void setSampleNumeratorCoeff(ossim_uint32 idx,
                             const ossimString& coeff);

  ossimString getSampleDenominatorCoeff(ossim_uint32 idx)const;
  
  void setSampleDenominatorCoeff(const std::vector<ossim_float64>& coeff);
  
  void setSampleDenominatorCoeff(ossim_uint32 idx,
                               const ossimString& coeff);

   virtual std::ostream& print(std::ostream& out,
                               const std::string& prefix=std::string()) const;

  virtual void setProperty(ossimRefPtr<ossimProperty> property);
  virtual ossimRefPtr<ossimProperty> getProperty(const ossimString& name)const;
  virtual void getPropertyNames(std::vector<ossimString>& propertyNames)const;

  bool loadState(const ossimKeywordlist& kwl, const char* prefix);

protected:

  char theSuccess[SUCCESS_SIZE+1];
   
  char theErrorBias[ERROR_BIAS_SIZE+1];

  char theErrRand[ERR_RAND_SIZE+1];

  char theLineOffset[LINE_OFFSET_SIZE+1];

  char theSampleOffset[SAMPLE_OFFSET_SIZE+1];

  char theGeodeticLatOffset[GEODETIC_LAT_OFFSET_SIZE+1];

  char theGeodeticLonOffset[GEODETIC_LON_OFFSET_SIZE+1];

  char theGeodeticHeightOffset[GEODETIC_HEIGHT_OFFSET_SIZE+1];

  char theLineScale[LINE_SCALE_SIZE+1];

  char theSampleScale[SAMPLE_SCALE_SIZE+1];

  char theGeodeticLatScale[GEODETIC_LAT_SCALE_SIZE+1];

  char theGeodeticLonScale[GEODETIC_LON_SCALE_SIZE+1];

  char theGeodeticHeightScale[GEODETIC_HEIGHT_SCALE_SIZE+1];

  std::vector<ossimString> theLineNumeratorCoefficient;

  std::vector<ossimString> theLineDenominatorCoefficient;

  std::vector<ossimString> theSampleNumeratorCoefficient;

  std::vector<ossimString> theSampleDenominatorCoefficient;

TYPE_DATA   
};

#endif