georefer.h

Go to the documentation of this file.

/**
 * \file rvc/georefer.h 
 * \brief interface for the RVC::GEOREFERENCE class.
 *
 * \if NODOC
 * $Id: georefer.h_v 1.23 2004/06/21 17:19:21 scowan Exp $
 *
 * $Log: georefer.h_v $
 * Revision 1.23  2004/06/21 17:19:21  scowan
 * Added coord ref sys methods.
 *
 * Revision 1.22  2004/05/12 21:45:09  scowan
 * Fixed docs for added methods.
 *
 * Revision 1.21  2004/05/12 17:08:46  scowan
 * Added method.
 *
 * Revision 1.20  2004/05/11 23:07:40  scowan
 * Added boundary methods.
 *
 * Revision 1.19  2004/01/28 23:02:36  scowan
 * Change 3d sheet to mani fold.
 *
 * Revision 1.18  2004/01/20 23:22:02  scowan
 * Updated 3dsheet.
 *
 * Revision 1.17  2003/12/19 21:07:45  scowan
 * Finialized (for now) the new georefernce interface.
 *
 * Revision 1.16  2003/12/12 22:34:23  scowan
 * Added more methods.
 *
 * Revision 1.15  2003/12/12 18:05:06  scowan
 * Updated some items.
 *
 * Revision 1.14  2003/12/12 17:13:23  scowan
 * Added new set of API's.
 *
 * Revision 1.13  2003/10/07 17:32:49  scowan
 * Object virtual method changes.
 *
 * Revision 1.12  2003/09/30 16:52:06  dwilliss
 * Doxygen
 *
 * Revision 1.11  2003/09/25 21:20:04  dwilliss
 * Fixed doxygen comment
 *
 * Revision 1.10  2003/09/15 13:49:45  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.9  2003/07/23 20:11:48  mju
 * Add GEOREFTYPE_AffineMatrix so meaning clearer.
 *
 * Revision 1.8  2002/04/26 22:44:27  scowan
 * Added more methods.
 *
 * Revision 1.7  2001/09/05 21:05:33  scowan
 * Added conversion methods on the source coordinates.
 *
 * Revision 1.6  2001/06/13 21:45:32  scowan
 * Added to RVC namespace.
 *
 * Revision 1.5  2001/06/13 14:55:09  scowan
 * Changed objtype enum.
 *
 * Revision 1.3  2001/05/25 14:55:33  scowan
 * Fixed const errors.
 *
 * Revision 1.2  2000/10/19 17:55:52  scowan
 * Checked in for vacation.
 *
 * Revision 1.1  2000/09/29 16:25:29  scowan
 * Initial revision
 *
 * \endif
**/

//!   \class RVC::GEOREFERENCE rvc/georefer.h
//!   \brief Manages RVC::OBJTYPE_Georeference RVC objects.  
//!
//!   The interface currently wraps the MfGeoref functions.
//!
//!   RVC Object Types that this class supports: RVC::OBJTYPE_Georeference.
//!
//!   Default RVC Object Type for this class: RVC::OBJTYPE_Georeference.
//!
//!   Valid parents for this class:
//!      - RVC::OBJTYPE_Vector
//!      - RVC::OBJTYPE_TIN
//!      - RVC::OBJTYPE_CAD
//!      - RVC::OBJTYPE_Raster
//!      - RVC::OBJTYPE_RasterSet
//!      - RVC::OBJTYPE_Hyperspectral
//!
//!   Read() and Write() methods inherited from RVC::SIMPLE class.  View RVC::SIMPLE docs for inherited methods

#ifndef INC_RVC_GEOREFER_H
#define INC_RVC_GEOREFER_H

#ifndef INC_RVC_SIMPLE_H
   #include <rvc/simple.h>
#endif

#ifndef INC_MI32_TRANS2DC_H
   #include <mi32/trans2dc.h>
#endif

#ifndef INC_MI32_TRANSMOD_H
   #include <mi32/transmod.h>
#endif

#ifndef INC_MI32_SIMPLEAR_H
   #include <mi32/simplear.h>
#endif

#ifndef INC_MI32_SPATREF_H
   #include <mi32/spatref.h>
#endif

namespace RVC {

#ifndef GENERATING_DOXYGEN_OUTPUT
class GEOREFHANDLE;
#endif

class GEOREFERENCE : public SIMPLE {  
   public:

      //! Type of georeference
      enum GEOREFTYPE {
         GEOREFTYPE_Implied =       5,       //!< Georeference information is implied in the data
         GEOREFTYPE_AffineMatrix =  6,       //!< Affine transformation matrix
         GEOREFTYPE_Matrix =  GEOREFTYPE_AffineMatrix,
         GEOREFTYPE_CtrlPoint =     7,       //!< List of CTRLPOINT3's
         GEOREFTYPE_Manifold =      8        //!< Set of CTRLPOINT3's to create a Manifold on
         };

      struct CTRLPTEDGE {
         INT32 m_StartCtrlPtID;
         INT32 m_EndCtrlPtID;
         };
   
      //! Default Constructor
      GEOREFERENCE (
         );

      //! Copy Constructor
      GEOREFERENCE (
         const RVC::GEOREFERENCE& rhs              
         );                            

      //! Destructor
      virtual ~GEOREFERENCE (
         );                            

      //! Assignment
      RVC::GEOREFERENCE& operator= (
         const RVC::GEOREFERENCE& rhs
         );

      //! Add a georeference boundary control point array to the list of boundary control point arrays
      //! Only works for extented georeference objects
      //! @return Number of the added boundary control point array
      INT32 AddBoundary (
         const SIMPLE_ARRAY<INT32>& Boundary
         );
         
      //! Add a georeference control point to the list of control points
      //! Works for either basic or extented georeference objects
      //! @return Number of the added control point
      INT32 AddCtrlPoint (
         const CTRLPOINT3& CtrlPoint
         );
         
      //! Add a georeference control point edge entry to the list of control points edge entries
      //! Only works for extented georeference objects
      //! @return Number of the added control point edge entry
      INT32 AddCtrlPointEdge (
         const CTRLPTEDGE& CtrlPtEdge
         );

      //! Clear out all georeference control point array entries
      //! Only works for extented georeference objects
      ERRVALUE ClearBoundaries (
         );
         
      //! Clear out all georeference control point entries
      //! Works for either basic or extented georeference objects.
      ERRVALUE ClearCtrlPoints (
         );
         
      //! Clear out all georeference control point edge entries
      //! Only works for extented georeference objects
      ERRVALUE ClearCtrlPointEdges (
         );
         
      //! Convert control point list 'source' coordinates using an affine transformation
      //! Only works for internally stored ctrl point lists, does not affect disabled ctrl points
      ERRVALUE ConvertForward (
         const TRANS2D_AFFINE& Affine
         );
      
      //! Convert control point list 'source' coordinates using an affine transformation
      //! Only works for internally stored ctrl point lists, does not affect disabled ctrl points
      ERRVALUE ConvertInverse (
         const TRANS2D_AFFINE& Affine
         );
      
      //! Convert control point list 'source' coordinates using an TRANS2D_MAPGEN transformation
      //! Only works for internally stored ctrl point lists, does not affect disabled ctrl points
      ERRVALUE ConvertForward (
         const TRANS2D_MAPGEN& tmg
         );
      
      //! Convert control point list 'source' coordinates using an TRANS2D_MAPGEN transformation
      //! Only works for internally stored ctrl point lists, does not affect disabled ctrl points
      ERRVALUE ConvertInverse (
         const TRANS2D_MAPGEN& tmg
         );

      //! Convert a basic georeference object to an extented georeference object    
      //! Only works for basic georeference objects
      ERRVALUE ConvertToExtended (
         );
         
      //! Delete a control point at the location specified
      //! Maintains the order of the control point list
      //! Works for either basic or extented georeference objects.
      ERRVALUE DeleteCtrlPoint (
         INT32 CtrlPointNum
         );
         
      //! Delete a control point edge entry at the location specified
      //! Maintains the order of the control point edge list
      //! Only works for extented georeference objects
      ERRVALUE DeleteCtrlPointEdge (
         INT32 CtrlPointEdgeNum
         );
         
      //! Obtain the calibration / translation model from the rvc georeference object
      //! @return calibration / translation model class instance
      TRANSMODEL GetCalibModel (
         ) const;

      //! Get georeference Coordinate reference system parameters
      //! @return Coordinate reference system parameters to use
      const SPATREF::COORDREFSYS& GetCoordRefSys (
         ) const;

      //! Obtain the georeference type
      //! @return Georeference Type
      GEOREFTYPE GetGeorefType (
         ) const;

      //! Generate a TRANS2D_MAPGEN from the georeference instance
      ERRVALUE GetMapTrans (
         TRANS2D_MAPGEN& tmg,                   //!< Generic transformation generated and RETURNED
         bool DoOutput = false,                 //!< Place transformation on output side if true
         TRANSMODEL model = 0                   //!< Translation model, zero sets up the default model
         ) const;

      //! Get the number of boundary control point array items
      //! Only works for extented georeference objects
      //! @return Number of boundary control point array entries
      INT32 GetNumBoundaries (
         );
         
      //! Get the number of control points
      //! Works for either basic or extented georeference objects
      //! @return Number of control points
      INT32 GetNumCtrlPoints (
         );
         
      //! Get the number of control points edge entries
      //! Only works for extented georeference objects
      //! @return Number of control point edge entries
      INT32 GetNumCtrlPointEdges (
         );
         
      //! Obtain map projection parameters from instance
      //! @return Georeference MAPPROJPARM information
      const MAPPROJPARM& GetProjParm (
         ) const;

      //! Generate a control point list from the georeference
      //! This method will generate control points if the georeference is not a control point georeference
      ERRVALUE GetPointList (
         SIMPLE_ARRAY<CTRLPOINT3>& CtrlList     //!< Control point list allocated and returned
         ) const;

      //! Insert a control point at the location specified
      //! Maintains the order of the control point list
      //! Works for either basic or extented georeference objects.
      ERRVALUE InsertCtrlPoint (
         INT32 CtrlPointNum,
         const CTRLPOINT3& CtrlPoint
         );
         
      //! Insert a control point edge entry at the location specified
      //! Maintains the order of the control point edge list
      //! Works for extented georeference objects only.
      ERRVALUE InsertCtrlPointEdge (
         INT32 CtrlPointEdgeNum,
         const CTRLPTEDGE& CtrlPtEdge
         );
         
      //! Determine if the georeference object is basic or extented
      //! @return 'True' if the georeference object is basic, 'false' if extented
      bool IsBasicFormat (
         );
         
      //! Determine if the referenced control point is enabled
      //! Works for either basic or extented georeference objects.  Standard georeference objects always return 'true'
      //! @return 'True' if the control point is enabled, 'false' if not
      bool IsCtrlPointEnabled (
         INT32 CtrlPointIndex
         );

      //! Determine if the two georeference objects are equivalent
      //! @return 'True' if the georeference information is equivalent, 'false' if not
      bool IsEquivalentTo (
         const RVC::GEOREFERENCE& GeorefObj
         ) const;
         
      //! Read a specific georeference boundary control point array entry
      //! Only works for extented georeference objects
      ERRVALUE ReadBoundary (
         INT32 BoundaryIndex,
         SIMPLE_ARRAY<INT32>& Boundary
         );
         
      //! Read a specific georeference control point
      //! Works for either basic or extented georeference objects.
      ERRVALUE ReadCtrlPoint (
         INT32 CtrlPointIndex,
         CTRLPOINT3& CtrlPoint
         );
         
      //! Read a specific georeference control point edge entry
      //! Only works for extented georeference objects
      ERRVALUE ReadCtrlPointEdge (
         INT32 CtrlPointEdgeIndex,
         CTRLPTEDGE& CtrlPtEdge
         );
         
      //! Read a specific georeference control point ID entry
      //! Enhanced georeference objects can store an ID value associated with the control point
      //! Only works for extented georeference objects
      INT32 ReadCtrlPointID (
         INT32 CtrlPointIndex
         );
         
      //! Read a specific georeference control point name entry
      //! Enhanced georeference objects can store a name value associated with the control point
      //! Only works for extented georeference objects
      ERRVALUE ReadCtrlPointName (
         INT32 CtrlPointIndex,
         MISTRING& CtrlPointName
         );
         
      //! Set the number of control point edge entries 
      //! Only works for extented georeference objects
      ERRVALUE ResizeCtrlPointEdges (
         INT32 NumCtrlPointEdges
         );
         
      //! Set the number of control points 
      //! Works for either basic or extented georeference objects.
      ERRVALUE ResizeCtrlPoints (
         INT32 NumCtrlPoints
         );
         
      //! Set georeference to be a Manifold georeference
      void SetManifold (
         );

      //! Set georeference to be an affine transformation
      void SetAffine (
         const TRANS2D_AFFINE& taf              //!< Affine transformation to set in georeference
         );

      //! Set calibration model
      void SetCalibModel (                
         const TRANSMODEL& model                //!< Calibration / translation model to use
         );

      //! Set georeference Coordinate reference system parameters
      void SetCoordRefSys (
         const SPATREF::COORDREFSYS& CoordRefSys               //!< Coordinate reference system parameters to use
         );

      //! Set the specified control point to be enabled or disabled
      //! Only works for extented georeference objects
      ERRVALUE SetCtrlPointEnabled (
         INT32 CtrlPointIndex,
         bool IsEnabled
         );
         
      //! Set georeference to be an implied transformation
      void SetImplied (
         );

      //! Set georeference map projection parameters
      void SetProjParm (
         const MAPPROJPARM& mapparm             //!< Map projection parameters to use
         );

      //! Set georeference to be an control point transformation
      ERRVALUE SetPointList (
         const SIMPLE_ARRAY<CTRLPOINT3>& CtrlList  //!< Control point list to use
         );
         
      //! Write a specific georeference boundary control point array entry
      //! Only works for extented georeference objects
      ERRVALUE WriteBoundary (
         INT32 BoundaryIndex,
         const SIMPLE_ARRAY<INT32>& Boundary
         );
         
      //! Write a specific georeference control point.  Use AddCtrlPoint() to add control points to the list
      //! Works for either basic or extented georeference objects.
      ERRVALUE WriteCtrlPoint (
         INT32 CtrlPointIndex,
         const CTRLPOINT3& CtrlPoint
         );
         
      //! Write a specific georeference control point edge entry
      //! Only works for extented georeference objects
      ERRVALUE WriteCtrlPointEdge (
         INT32 CtrlPointEdgeIndex,
         const CTRLPTEDGE& CtrlPtEdge
         );
         
      //! Write a specific georeference control point name entry
      //! Enhanced georeference objects can store an ID value associated with the control point
      //! Only works for extented georeference objects
      ERRVALUE WriteCtrlPointID (
         INT32 CtrlPointIndex,
         INT32 CtrlPointID
         );
         
      //! Write a specific georeference control point name entry
      //! Enhanced georeference objects can store a name value associated with the control point
      //! Only works for extented georeference objects
      ERRVALUE WriteCtrlPointName (
         INT32 CtrlPointIndex,
         const MISTRING& CtrlPointName
         );
         
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      //! Implementation of RVC::OBJECT virtual methods
      virtual ERRVALUE v_CloseObject ();
      virtual RVC::OBJTYPE v_GetDftObjectType () const;
      virtual bool v_IsObjectOpen () const;              
      virtual ERRVALUE v_OpenObject (OPENMODE OpenMode, MDLGPARENT parent);

      //! Implementation of RVC::SIMPLE virtual methods
      virtual ERRVALUE v_GetDftNameDesc (const OBJECT& parent, OBJECTNAME& name, OBJECTDESC& desc);
      virtual ERRVALUE v_ReadData ();
      virtual ERRVALUE v_WriteData (const RVCGENINFO& ginfo);
      
      ERRVALUE ReadStandardGeorefData ();
      ERRVALUE UpdateHeader ();

      GEOREFTYPE m_GeorefType;               //!< Type of georeference used
      TRANSMODEL m_CalibModel;               //!< Calibration model using TRANS2DMODEL values defined in <mi32/transmod.h>
      mutable MAPPROJPARM m_MapParm;                  //!< Map projection parameters of the georeference
      SPATREF::COORDREFSYS m_CoordRefSys;    //!< Coordinate reference system of the georeference
      SIMPLE_ARRAY<CTRLPOINT3> m_CtrlList;   //!< Control point list if georeference has one
      TRANS2D_AFFINE m_Affine;               //!< Affine transformation if georeference has one
      bool m_ChangedType;                    //!< Type of projection (Affine, Implied, Ctrl Point) and or projection name has changed
      GEOREFHANDLE* m_GeorefHandle;

      #endif // GENERATING_DOXYGEN_OUTPUT
   };
   
}     //! End of RVC namespace

#endif      //!< INC_RVC_GEOREFER_H

---