rvcgref.h

Go to the documentation of this file.

/**
 * \file rvcgref.h <mi32/rvcgref.h>
 * \brief Definitions for georeference objects and functions
 *
 * \if NODOC
 * $Id: rvcgref.h_v 1.48 2004/07/29 21:55:43 scowan Exp $
 *
 * $Log: rvcgref.h_v $
 * Revision 1.48  2004/07/29 21:55:43  scowan
 * Moved read trans parm out of dll.
 *
 * Revision 1.47  2004/07/08 21:57:49  scowan
 * Fixed inline prtototype.
 *
 * Revision 1.46  2004/07/08 21:46:41  scowan
 * Removed unused prototype function.
 * Changed macro's into inlines.
 *
 * Revision 1.45  2004/03/24 18:48:25  scowan
 * Deprecated more modules.
 *
 * Revision 1.44  2004/03/10 21:34:02  mju
 * Remove mdlgGetGeorefObject.
 *
 * Revision 1.43  2004/02/06 14:16:12  scowan
 * *** empty log message ***
 *
 * Revision 1.42  2004/02/05 20:45:09  vdronov
 * GEOREF_MANIFOLD is added
 *
 * Revision 1.41  2004/01/23 16:31:43  scowan
 * Removed legacy tie point items.
 *
 * Revision 1.40  2003/12/19 21:07:30  scowan
 * Something.
 *
 * Revision 1.39  2003/12/09 22:16:18  scowan
 * Removed unused inline.
 *
 * Revision 1.38  2003/10/20 23:38:29  scowan
 * Removed unused inlines and functions.
 *
 * Revision 1.37  2003/10/15 17:39:16  mju
 * Deprecate groupkey.
 *
 * Revision 1.36  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.35  2002/09/09 13:54:46  mju
 * Always prevent_memfunc.
 *
 * Revision 1.34  2002/08/20 15:15:50  mju
 * Remove old dialog #defines.
 * Use prevent_memfunc macro, still checks no_deprecated.
 *
 * Revision 1.33  2002/03/28 20:02:18  scowan
 * Fixed again.
 *
 * Revision 1.32  2002/03/28 18:59:03  scowan
 * Make read georef header call georef read header.
 *
 * Revision 1.31  2002/03/08 18:32:34  scowan
 * Added clear methods.
 * deprecated mem... functions for info structs.
 *
 * Revision 1.30  2001/09/14 14:49:29  mju
 * Don't define Mdlg stuff for win32native.
 *
 * Revision 1.29  2001/07/18 23:10:28  scowan
 * Added projection conversion routine.
 *
 * Revision 1.28  2001/05/21 21:01:33  mju
 * Remove redundant macro.
 *
 * Revision 1.27  2000/12/13 21:47:19  scowan
 * Added filepath type get sub object functions.
 *
 * Revision 1.26  2000/07/19 17:56:38  sparsons
 * Genitor documentation.
 *
 * Revision 1.25  2000/07/13 21:30:54  mju
 * Deprecate old MfGet...UC #defines.
 *
 * Revision 1.24  2000/07/13 17:40:58  mju
 * Add default for flags in MfGeorefGet...
 *
 * Revision 1.23  2000/03/27 17:45:28  scowan
 * More assignment operators.
 *
 * Revision 1.22  2000/03/24 23:35:41  scowan
 * Added operator =.
 *
 * Revision 1.21  2000/03/13 21:38:12  scowan
 * More const.
 *
 * Revision 1.20  2000/02/17 14:44:26  mju
 * Add MfGeorefChkDefault.
 *
 * Revision 1.19  1999/11/19 14:21:43  mju
 * MdlgGet... prompt const.
 *
 * Revision 1.18  1999/10/21  21:07:27  scowan
 * Made more const.
 *
 * Revision 1.17  1999/10/21 15:08:10  scowan
 * More const updates.
 *
 * Revision 1.16  1999/10/06 15:07:30  scowan
 * Added write georef header inline function.
 *
 * Revision 1.15  1999/10/05 22:46:23  scowan
 * *** empty log message ***
 *
 * Revision 1.14  1999/10/05 22:45:52  scowan
 * Changed headers to inheritance.
 *
 * Revision 1.13  1999/06/11 14:49:01  mju
 * In obj sel dlg provide defaults for filter + filtdata.
 *
 * Revision 1.12  1999/06/10  22:11:05  mju
 * Object selection dialog update.
 *
 * Revision 1.11  1999/05/07  21:22:44  mju
 * Header restruct.
 *
 * Revision 1.10  1999/04/28  17:40:11  mju
 * Include ctrlpt.h and tiepoint.h.
 *
 * Revision 1.9  1999/01/05  19:12:28  scowan
 * Swapped multiple keywords
 *
 * Revision 1.8  1998/10/05 17:46:44  scowan
 * *** empty log message ***
 *
 * Revision 1.7  1998/09/30  21:54:02  scowan
 * Setup DLL.
 *
 * Revision 1.6  1998/09/18  22:55:09  scowan
 * Changed functions for DLL.
 *
 * Revision 1.5  1998/08/24  20:39:46  scowan
 * Changed function calls to take a size parm.
 *
 * Revision 1.4  1998/01/30  22:15:34  scowan
 * Added prototypes.
 *
 * Revision 1.3  1996/06/04  16:35:49  scowan
 * Parameter change for MfReadGeorefTransParm.
 * Added flag to read transparm into output side.
 *
 * Revision 1.2  1996/05/15  23:54:06  mju
 * Change prototype for MfReadGeorefTransParm().
 *
 * Revision 1.1  1996/05/14  15:47:36  mju
 * Initial revision
 *
 * \endif
**/

#ifndef INC_MI32_RVCGREF_H
#define INC_MI32_RVCGREF_H

#ifndef INC_MI32_RVCDEFNS_H
#include <mi32/rvcdefns.h>
#endif

#ifndef INC_MI32_CTRLPT_H
#include <mi32/ctrlpt.h>
#endif
#ifndef INC_MI32_TIEPOINT_H
#include <mi32/tiepoint.h>
#endif

/*----------------------------------------------------------------------------*/
/*    Define georeference data structures, flags, types, etc...               */
/*----------------------------------------------------------------------------*/

struct GEOREFMATRIX {                  /* Georeference data for GEOREF_MATRIX type */
   Mat3x3 forward;                     //!<  Translation from file coords to map coords 
   Mat3x3 inverse;                     //!<  Translation from map coords to file coords 
   };

struct RVCGEOREFINFO : public RVCGENINFO {   /* Georeference information structure */
   DOUBLE tparm[15];                   //!<  Projection-dependent transformation parameters 
   UINT16 georeftype;                  //!<  Type of georeference used 
   INT16 mapproj;                      //!<  Map projection registered to 
   UINT16 numctrlpts;                  //!<  Number of registration points (not incl center) 
   UINT16 CalibModel;                  //!<  Calibration model using TRANS2DMODEL values defined in <mi32/trans2d.h> 
   UINT16 zone[4];                     //!<  Zone numbers 
   UNICODE projname[32];               //!<  Map projection text name 
   INT32 m_CtrlPtSize;                 //!<  Size of internal ctrl point structure
   INT32 m_EdgeSize;                   //!<  Size of internal ctrl point edge structure
   
   RVCGEOREFINFO (
      ) {Clear();}
   
   RVCGEOREFINFO (
      const RVCGENINFO& ginfo
      ) {Clear();*static_cast<RVCGENINFO*>(this) = ginfo;}
   
   RVCGEOREFINFO& operator= (
      const RVCGENINFO& ginfo
      ) {*static_cast<RVCGENINFO*>(this) = ginfo; return (*this);}

   void Clear (
      ) {memset(static_cast<void*>(this), 0, sizeof(*this));}
   
   };

#define  GEOREF_IMPLIED    5           //!<  Georeference information is implied in the data 
#define  GEOREF_MATRIX     6           //!<  Uses 2-D transformation matrix 
#define  GEOREF_CTRLPOINT  7           //!<  List of CTRLPOINT3's 
//#define   GEOREF_MANIFOLD   8           //!<  Not to be defined here

#define  RVCGREF_FlagMask        0xFFFF0000
#define  RVCGREF_TransGenOutput  0x00010000     //!<  MfReadGeorefTransParm - Setup output side of TRANSPARM 
#define  RVCGREF_IncludeArb      0x00020000     //!<  MfGeorefGetDeafult - Include PROJ_Arbitrary in default check 

struct RVCCAMERAINFO : public RVCGENINFO {   /* Camera position information structure */
   DPOINT2D PrincPoint;                //!<  Principle point 
   DPOINT3D CameraPosition;            //!<  Position of camera relative to raster 
   DOUBLE EpipolarAngle;               //!<  Angle to epipolar line for stereo analysis 
   DOUBLE TiltAngle;                   //!<  Angle measured in principle plane from optical axis of camera 
   DOUBLE SwingAngle;                  //!<  Direction of tilt with respect to photographic axes 
   DOUBLE FocalLength;                 //!<  Focal length of camera converted to cells 
   DOUBLE ImageScale;                  //!<  Size of pixel in camera image plane 
   
   RVCCAMERAINFO (
      ) {Clear();}
   
   RVCCAMERAINFO (
      const RVCGENINFO& ginfo
      ) {Clear();*static_cast<RVCGENINFO*>(this) = ginfo;}
   
   RVCCAMERAINFO& operator= (
      const RVCGENINFO& ginfo
      ) {*static_cast<RVCGENINFO*>(this) = ginfo; return (*this);}
   
   void Clear (
      ) {memset(static_cast<void*>(this), 0, sizeof(*this));}
   
   };


//! Disallow memset/memcpy
PREVENT_MEMFUNC(RVCGEOREFINFO)
PREVENT_MEMFUNC(RVCCAMERAINFO)

/*-------------------------------------------------------------------------*/
/*    Object Selection Dialogs                                             */
/*-------------------------------------------------------------------------*/

//! Write the header information for the georef object.
DEPRECATED inline int MfWriteGeorefHeader (
   int fhandle, 
   RVCINODENUM inode, 
   RVCGEOREFINFO* info
   ) {
   return (_MfWriteHeader(fhandle,inode,info,sizeof(RVCGEOREFINFO),RVCCONV_GEOREF));
   }

class IMapInfoFile;
RVCAPPLIBEXPORT ERRVALUE ProjSetMapInfoTAB (MAPPROJPARM& ProjParm, IMapInfoFile* pFile, double& scale);

/*----------------------------------------------------------------------------*/
/*    Function prototypes                                                     */
/*----------------------------------------------------------------------------*/

#define MfCameraCalibRead(_f,_oi,_info)                  _MfCameraCalibRead((_f),(_oi),(_info),sizeof(RVCCAMERAINFO))
#define MfCameraCalibWrite(_f,_oi,_info)                 _MfCameraCalibWrite((_f),(_oi),(_info),sizeof(RVCCAMERAINFO))

extern "C" {

   #ifndef GENERATING_DOXYGEN_OUTPUT
   RVCAPPLIBEXPORT   int _MfCameraCalibRead (int fhandle, INT32 objinode, RVCCAMERAINFO*, int);
   RVCAPPLIBEXPORT   int _MfCameraCalibWrite (int fhandle, INT32 objinode, RVCCAMERAINFO*, int);

   RVCAPPLIBEXPORT   int _MfGeorefRead (int fhandle, INT32 grinode, RVCGEOREFINFO*, int, void**);
   RVCAPPLIBEXPORT   int _MfGeorefReadHeader (int fhandle, INT32 grinode, RVCGEOREFINFO*, int);
   RVCAPPLIBEXPORT   int _MfGeorefReadMatrix (int fhandle, INT32 grinode, RVCGEOREFINFO*, int, Mat3x3, Mat3x3, MAPPROJPARM*);
   RVCAPPLIBEXPORT   int _MfGeorefWrite (int fhandle, INT32 grinode, RVCGEOREFINFO*, int, const void*);
   #endif //!< GENERATING_DOXYGEN_OUTPUT
   
   //! Compute object scale / cell size from specified georeference object.
   //! \deprecated Replaced by RVC::GEOSPATIAL::ComputeScaleFromGeoref()
   DEPRECATED RVCAPPLIBEXPORT int MfComputeScaleFromGeoref (
      int fhandle,                     //!< Handle for open RVC file
      INT32 georefinode,               //!< Georeference object to use
      double *xscale,                  //!< X scale or raster cell size returned
      double *yscale                   //!< Y scale or raster cell size returned
      );

   //! Get default georeference under an object.
   //!
   //! @return Inode of default georef object or -1 if no georef object or < 0 Error.
   //!
   //! This function determines the default georeference to use based on time / date stamps.
   //! Arbitrary georeference objects are not considered unless there are no other georeferences or 
   //! the RVCGREF_IncludeArb flag is passed.  For Raster Set objects, the georeference under the 
   //! raster set is first considered then the georeferences under the raster object, if the raster 
   //! object inode is passed as the parent inode.
   DEPRECATED RVCAPPLIBEXPORT INT32 MfGeorefGetDefault (
      int findex,                      //!< File handle returned by MfMakeFile or MfOpenFile
      INT32 parent,                    //!< Inode of parent object to search for georeference under
      UINT32 flags = 0                 //!< Flags
      );

   //! Set X/Y scale fields in object header based on specified georeference object.
   //! \deprecated Replaced by RVC::GEOSPATIAL::SetScaleFromGeoref()
   DEPRECATED RVCAPPLIBEXPORT int MfSetScaleFromGeoref (
      int fhandle,                     //!< RVC file handle
      INT32 objinode,                  //!< Inode for object
      INT32 georefinode,               //!< Inode for georeference object
      int OnlyIfZero                   //!< Flag - only change scale values if they are currently zero
      );

   //! Copy fields from RVCGEOREFINFO structure to MAPPROJPARM structure.
   DEPRECATED RVCAPPLIBEXPORT void CopyGEOREFINFOtoMAPPROJPARM (
      MAPPROJPARM *projparm, 
      const RVCGEOREFINFO *georefinfo
      );

   //! Copy fields from MAPPROJPARM structure to RVCGEOREFINFO structure.
   DEPRECATED RVCAPPLIBEXPORT void CopyMAPPROJPARMtoGEOREFINFO (
      RVCGEOREFINFO *georefinfo, 
      const MAPPROJPARM *projparm
      );

   //! Set default name, desc from a MAPPROJPARM.
   DEPRECATED RVCAPPLIBEXPORT int SetDftGeorefNameDesc (
      RVCGEOREFINFO *ginfo,            //!< The header
      const MAPPROJPARM *projparm      //!< Projection parameters
      );
}

DEPRECATED inline ERRVALUE MfReadGeoref (
   int fhandle, 
   RVCINODENUM inode, 
   RVCGEOREFINFO* info,
   void** data
   ) { return (_MfGeorefRead(fhandle, inode, info, sizeof(RVCGEOREFINFO), data)); }

//! Read the header information for the georef object.
DEPRECATED inline int MfReadGeorefHeader (
   int fhandle, 
   RVCINODENUM inode, 
   RVCGEOREFINFO* info
   ) { return (_MfGeorefReadHeader(fhandle,inode,info,sizeof(RVCGEOREFINFO))); }

DEPRECATED inline ERRVALUE MfReadGeorefMatrix (
   int fhandle, 
   INT32 grinode, 
   RVCGEOREFINFO* info, 
   Mat3x3 fwd, 
   Mat3x3 inv, 
   MAPPROJPARM* pp
   ) { return (_MfGeorefReadMatrix(fhandle, grinode, info, sizeof(RVCGEOREFINFO), fwd, inv, pp)); }

ERRVALUE MfReadGeorefTransParm (
   int fhandle, 
   RVCINODENUM inode, 
   RVCGEOREFINFO* info,
   TRANSPARM *transparm, 
   UINT32 flags
   );
   
DEPRECATED inline ERRVALUE MfWriteGeoref (
   int fhandle, 
   RVCINODENUM inode, 
   RVCGEOREFINFO* info,
   const void* data
   ) { return (_MfGeorefWrite(fhandle, inode, info, sizeof(RVCGEOREFINFO), data)); }

#endif   //!<  #ifndef INC_MI32_RVCGREF_H 

---