RVC::GEOREFERENCE Class Reference

Manages RVC::OBJTYPE_Georeference RVC objects. More...

#include <rvc/georefer.h>

Inheritance diagram for RVC::GEOREFERENCE:

[legend]

List of all members.

Classes
struct	CTRLPTEDGE
Public Types
enum	GEOREFTYPE {   GEOREFTYPE_Implied = 5, GEOREFTYPE_AffineMatrix = 6, GEOREFTYPE_Matrix = GEOREFTYPE_AffineMatrix, GEOREFTYPE_CtrlPoint = 7,   GEOREFTYPE_Manifold = 8 }
Public Member Functions
	GEOREFERENCE (const RVC::GEOREFERENCE &rhs)
	GEOREFERENCE ()
virtual	~GEOREFERENCE ()
INT32	AddBoundary (const SIMPLE_ARRAY< INT32 > &Boundary)
INT32	AddCtrlPoint (const CTRLPOINT3 &CtrlPoint)
INT32	AddCtrlPointEdge (const CTRLPTEDGE &CtrlPtEdge)
ERRVALUE	ClearBoundaries ()
ERRVALUE	ClearCtrlPointEdges ()
ERRVALUE	ClearCtrlPoints ()
ERRVALUE	ConvertForward (const TRANS2D_MAPGEN &tmg)
ERRVALUE	ConvertForward (const TRANS2D_AFFINE &Affine)
ERRVALUE	ConvertInverse (const TRANS2D_MAPGEN &tmg)
ERRVALUE	ConvertInverse (const TRANS2D_AFFINE &Affine)
ERRVALUE	ConvertToExtended ()
ERRVALUE	DeleteCtrlPoint (INT32 CtrlPointNum)
ERRVALUE	DeleteCtrlPointEdge (INT32 CtrlPointEdgeNum)
const TRANS2D_AFFINE &	GetAffineMatrix () const
TRANSMODEL	GetCalibModel () const
const SPATREF::COORDREFSYS &	GetCoordRefSys () const
GEOREFTYPE	GetGeorefType () const
ERRVALUE	GetMapTrans (TRANS2D_MAPGEN &tmg, bool DoOutput=false, TRANSMODEL model=0) const
INT32	GetNumBoundaries ()
INT32	GetNumCtrlPointEdges ()
INT32	GetNumCtrlPoints ()
ERRVALUE	GetPointList (SIMPLE_ARRAY< CTRLPOINT3 > &CtrlList) const
ERRVALUE	InsertCtrlPoint (INT32 CtrlPointNum, const CTRLPOINT3 &CtrlPoint)
ERRVALUE	InsertCtrlPointEdge (INT32 CtrlPointEdgeNum, const CTRLPTEDGE &CtrlPtEdge)
bool	IsBasicFormat ()
bool	IsCtrlPointEnabled (INT32 CtrlPointIndex)
bool	IsEquivalentTo (const RVC::GEOREFERENCE &GeorefObj) const
RVC::GEOREFERENCE &	operator= (const RVC::GEOREFERENCE &rhs)
ERRVALUE	ReadBoundary (INT32 BoundaryIndex, SIMPLE_ARRAY< INT32 > &Boundary)
ERRVALUE	ReadCtrlPoint (INT32 CtrlPointIndex, CTRLPOINT3 &CtrlPoint)
ERRVALUE	ReadCtrlPointEdge (INT32 CtrlPointEdgeIndex, CTRLPTEDGE &CtrlPtEdge)
INT32	ReadCtrlPointID (INT32 CtrlPointIndex)
ERRVALUE	ReadCtrlPointName (INT32 CtrlPointIndex, MISTRING &CtrlPointName)
ERRVALUE	ResizeCtrlPointEdges (INT32 NumCtrlPointEdges)
ERRVALUE	ResizeCtrlPoints (INT32 NumCtrlPoints)
void	SetAffine (const TRANS2D_AFFINE &taf)
void	SetCalibModel (const TRANSMODEL &model)
ERRVALUE	SetCoordRefSys (const SPATREF::COORDREFSYS &CoordRefSys)
ERRVALUE	SetCtrlPointEnabled (INT32 CtrlPointIndex, bool IsEnabled)
void	SetImplied ()
void	SetManifold ()
ERRVALUE	SetPointList (const CTRLPOINT3 *CtrlPtList, int NumCtrlPts)
ERRVALUE	SetPointList (const SIMPLE_ARRAY< CTRLPOINT3 > &CtrlList)
ERRVALUE	WriteBoundary (INT32 BoundaryIndex, const SIMPLE_ARRAY< INT32 > &Boundary)
ERRVALUE	WriteCtrlPoint (INT32 CtrlPointIndex, const CTRLPOINT3 &CtrlPoint)
ERRVALUE	WriteCtrlPointEdge (INT32 CtrlPointEdgeIndex, const CTRLPTEDGE &CtrlPtEdge)
ERRVALUE	WriteCtrlPointID (INT32 CtrlPointIndex, INT32 CtrlPointID)
ERRVALUE	WriteCtrlPointName (INT32 CtrlPointIndex, const MISTRING &CtrlPointName)

---

Detailed Description

Manages RVC::OBJTYPE_Georeference RVC objects.

RVC Object Types that this class supports: 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

---

Member Enumeration Documentation

enum RVC::GEOREFERENCE::GEOREFTYPE

Type of georeference.

Enumerator:

GEOREFTYPE_Implied	Georeference information is implied in the data.
GEOREFTYPE_AffineMatrix	Affine transformation matrix.
GEOREFTYPE_Matrix
GEOREFTYPE_CtrlPoint	List of CTRLPOINT3's.
GEOREFTYPE_Manifold	Set of CTRLPOINT3's to create a Manifold on.

---

Constructor & Destructor Documentation

RVC::GEOREFERENCE::GEOREFERENCE

(

)

Default Constructor.

RVC::GEOREFERENCE::GEOREFERENCE

(

const RVC::GEOREFERENCE &

rhs

)

Copy Constructor.

virtual RVC::GEOREFERENCE::~GEOREFERENCE

(

)

[virtual]

Destructor.

---

Member Function Documentation

INT32 RVC::GEOREFERENCE::AddBoundary

(

const SIMPLE_ARRAY< INT32 > &

Boundary

)

Add a georeference boundary control point array to the list of boundary control point arrays Only works for extented georeference objects.

Returns:

Number of the added boundary control point array

INT32 RVC::GEOREFERENCE::AddCtrlPoint

(

const CTRLPOINT3 &

CtrlPoint

)

Add a georeference control point to the list of control points Works for either basic or extented georeference objects.

Returns:

Number of the added control point

INT32 RVC::GEOREFERENCE::AddCtrlPointEdge

(

const CTRLPTEDGE &

CtrlPtEdge

)

Add a georeference control point edge entry to the list of control points edge entries Only works for extented georeference objects.

Returns:

Number of the added control point edge entry

ERRVALUE RVC::GEOREFERENCE::ClearBoundaries

(

)

Clear out all georeference control point array entries Only works for extented georeference objects.

ERRVALUE RVC::GEOREFERENCE::ClearCtrlPointEdges

(

)

Clear out all georeference control point edge entries Only works for extented georeference objects.

ERRVALUE RVC::GEOREFERENCE::ClearCtrlPoints

(

)

Clear out all georeference control point entries Works for either basic or extented georeference objects.

ERRVALUE RVC::GEOREFERENCE::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 RVC::GEOREFERENCE::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 RVC::GEOREFERENCE::ConvertInverse

(

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 RVC::GEOREFERENCE::ConvertInverse

(

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 RVC::GEOREFERENCE::ConvertToExtended

(

)

Convert a basic georeference object to an extented georeference object Only works for basic georeference objects.

ERRVALUE RVC::GEOREFERENCE::DeleteCtrlPoint

(

INT32

CtrlPointNum

)

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 RVC::GEOREFERENCE::DeleteCtrlPointEdge

(

INT32

CtrlPointEdgeNum

)

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.

const TRANS2D_AFFINE& RVC::GEOREFERENCE::GetAffineMatrix

(

)

const

Get georeference affine matrix.

Only value if GetGeorefType() == GEOREFTYPE_AffineMatrix

Returns:

Affine matrix

TRANSMODEL RVC::GEOREFERENCE::GetCalibModel

(

)

const

Obtain the calibration / translation model from the rvc georeference object.

Returns:

calibration / translation model class instance

const SPATREF::COORDREFSYS& RVC::GEOREFERENCE::GetCoordRefSys

(

)

const

Get georeference Coordinate reference system parameters.

Returns:

Coordinate reference system parameters to use

GEOREFTYPE RVC::GEOREFERENCE::GetGeorefType

(

)

const

Obtain the georeference type.

Returns:

Georeference Type

ERRVALUE RVC::GEOREFERENCE::GetMapTrans	(	TRANS2D_MAPGEN &	tmg,
		bool	DoOutput = false,
		TRANSMODEL	model = 0
	)			const

Generate a TRANS2D_MAPGEN from the georeference instance.

Parameters:

	tmg	Generic transformation generated and RETURNED
	DoOutput	Place transformation on output side if true
	model	Translation model, zero sets up the default model

INT32 RVC::GEOREFERENCE::GetNumBoundaries

(

)

Get the number of boundary control point array items Only works for extented georeference objects.

Returns:

Number of boundary control point array entries

INT32 RVC::GEOREFERENCE::GetNumCtrlPointEdges

(

)

Get the number of control points edge entries Only works for extented georeference objects.

Returns:

Number of control point edge entries

INT32 RVC::GEOREFERENCE::GetNumCtrlPoints

(

)

Get the number of control points Works for either basic or extented georeference objects.

Returns:

Number of control points

ERRVALUE RVC::GEOREFERENCE::GetPointList

(

SIMPLE_ARRAY< CTRLPOINT3 > &

CtrlList

)

const

Generate a control point list from the georeference This method will generate control points if the georeference is not a control point georeference.

Parameters:

CtrlList

Control point list allocated and returned

ERRVALUE RVC::GEOREFERENCE::InsertCtrlPoint	(	INT32	CtrlPointNum,
		const CTRLPOINT3 &	CtrlPoint
	)

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 RVC::GEOREFERENCE::InsertCtrlPointEdge	(	INT32	CtrlPointEdgeNum,
		const CTRLPTEDGE &	CtrlPtEdge
	)

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.

bool RVC::GEOREFERENCE::IsBasicFormat

(

)

Determine if the georeference object is basic or extented.

Returns:

'True' if the georeference object is basic, 'false' if extented

bool RVC::GEOREFERENCE::IsCtrlPointEnabled

(

INT32

CtrlPointIndex

)

Determine if the referenced control point is enabled Works for either basic or extented georeference objects.

Standard georeference objects always return 'true'

Returns:

'True' if the control point is enabled, 'false' if not

bool RVC::GEOREFERENCE::IsEquivalentTo

(

const RVC::GEOREFERENCE &

GeorefObj

)

const

Determine if the two georeference objects are equivalent.

Returns:

'True' if the georeference information is equivalent, 'false' if not

RVC::GEOREFERENCE& RVC::GEOREFERENCE::operator=

(

const RVC::GEOREFERENCE &

rhs

)

Assignment.

Reimplemented from RVC::SIMPLE.

ERRVALUE RVC::GEOREFERENCE::ReadBoundary	(	INT32	BoundaryIndex,
		SIMPLE_ARRAY< INT32 > &	Boundary
	)

Read a specific georeference boundary control point array entry Only works for extented georeference objects.

ERRVALUE RVC::GEOREFERENCE::ReadCtrlPoint	(	INT32	CtrlPointIndex,
		CTRLPOINT3 &	CtrlPoint
	)

Read a specific georeference control point Works for either basic or extented georeference objects.

ERRVALUE RVC::GEOREFERENCE::ReadCtrlPointEdge	(	INT32	CtrlPointEdgeIndex,
		CTRLPTEDGE &	CtrlPtEdge
	)

Read a specific georeference control point edge entry Only works for extented georeference objects.

INT32 RVC::GEOREFERENCE::ReadCtrlPointID

(

INT32

CtrlPointIndex

)

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.

ERRVALUE RVC::GEOREFERENCE::ReadCtrlPointName	(	INT32	CtrlPointIndex,
		MISTRING &	CtrlPointName
	)

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 RVC::GEOREFERENCE::ResizeCtrlPointEdges

(

INT32

NumCtrlPointEdges

)

Set the number of control point edge entries Only works for extented georeference objects.

ERRVALUE RVC::GEOREFERENCE::ResizeCtrlPoints

(

INT32

NumCtrlPoints

)

Set the number of control points Works for either basic or extented georeference objects.

void RVC::GEOREFERENCE::SetAffine

(

const TRANS2D_AFFINE &

taf

)

Set georeference to be an affine transformation.

Parameters:

taf

Affine transformation to set in georeference

void RVC::GEOREFERENCE::SetCalibModel

(

const TRANSMODEL &

model

)

Set calibration model.

Parameters:

model

Calibration / translation model to use

ERRVALUE RVC::GEOREFERENCE::SetCoordRefSys

(

const SPATREF::COORDREFSYS &

CoordRefSys

)

Set georeference Coordinate reference system parameters.

Parameters:

CoordRefSys

Coordinate reference system parameters to use

ERRVALUE RVC::GEOREFERENCE::SetCtrlPointEnabled	(	INT32	CtrlPointIndex,
		bool	IsEnabled
	)

Set the specified control point to be enabled or disabled Only works for extented georeference objects.

void RVC::GEOREFERENCE::SetImplied

(

)

Set georeference to be an implied transformation.

void RVC::GEOREFERENCE::SetManifold

(

)

Set georeference to be a Manifold georeference.

ERRVALUE RVC::GEOREFERENCE::SetPointList	(	const CTRLPOINT3 *	CtrlPtList,
		int	NumCtrlPts
	)

Set georeference to be an control point transformation.

Parameters:

	CtrlPtList	Control point list to use
	NumCtrlPts	Number of control points

ERRVALUE RVC::GEOREFERENCE::SetPointList

(

const SIMPLE_ARRAY< CTRLPOINT3 > &

CtrlList

)

Set georeference to be an control point transformation.

Parameters:

CtrlList

Control point list to use

ERRVALUE RVC::GEOREFERENCE::WriteBoundary	(	INT32	BoundaryIndex,
		const SIMPLE_ARRAY< INT32 > &	Boundary
	)

Write a specific georeference boundary control point array entry Only works for extented georeference objects.

ERRVALUE RVC::GEOREFERENCE::WriteCtrlPoint	(	INT32	CtrlPointIndex,
		const CTRLPOINT3 &	CtrlPoint
	)

Write a specific georeference control point.

Use AddCtrlPoint() to add control points to the list Works for either basic or extented georeference objects.

ERRVALUE RVC::GEOREFERENCE::WriteCtrlPointEdge	(	INT32	CtrlPointEdgeIndex,
		const CTRLPTEDGE &	CtrlPtEdge
	)

Write a specific georeference control point edge entry Only works for extented georeference objects.

ERRVALUE RVC::GEOREFERENCE::WriteCtrlPointID	(	INT32	CtrlPointIndex,
		INT32	CtrlPointID
	)

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 RVC::GEOREFERENCE::WriteCtrlPointName	(	INT32	CtrlPointIndex,
		const MISTRING &	CtrlPointName
	)

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.

---

The documentation for this class was generated from the following file:

• rvc/georefer.h