C++ API Users' Guide

SRM SDK Release 4.1.4

July 1, 2011

  1. Introduction
  2. SRM Concepts
  3. SRM Capability
  4. Conversion Types
  5. Typical Usages
  6. Sample Application

Introduction

Spatial information processing requires a robust capability to describe geometric properties such as position, direction and distance. Information may be spatially referenced to local structures (Example: building interiors) and regions (Example: cities), or spatially referenced to the Earth as a whole (Example: global weather). Information may be spatially referenced to other celestial bodies (Examples: astronomical, orbital, and geomagnetic observations). Information may also be spatially referenced to objects defined within contexts such as virtual realities (Example: 3D models). In each of these cases, a spatial reference frame is defined, with respect to which the values of geometric properties may be determined.

It is often necessary to represent position in several different spatial reference frames, simultaneously, according to the context in which the position is to be used. Each spatial reference frame corresponds to a particular way of expressing position. Spatial reference frames may be relative to moving objects (Examples: planets and spacecraft), and therefore have values that are a function of time. It is necessary to specify the time to which the spatial position refers, and the time for which the spatial reference frame is defined.

The Spatial reference model (SRM) defines the conceptual model and the methodologies that allow the description, and transformation or conversion, of geometric properties within or among spatial reference frames. The SRM supports unambiguous specification of the positions, directions, distances, and times associated with spatial information. It also defines algorithms for precise transformation of positions, directions and distances among different spatial reference frames.

SRM Concepts

The SRM provides an integrated framework and precise terminology for describing spatial concepts and operations on spatial information (including positions, directions, and distances):

  1. Spatial positions are identified by coordinates in a spatial coordinate system. The collection of spatial positions associated with a spatial object of interest, such as the Earth, is called its object-space.
  2. A spatial reference frame specifies a spatial coordinate system by combining an abstract coordinate system with an object reference model. An abstract coordinate system may be combined with many different object reference models. Thus, a geodetic coordinate tied to the Earth object reference model WGS_1984 does not identify the same place as when tied to the Earth object reference model EUROPEAN_1950, or when tied to an object reference model for Mars.
  3. An abstract coordinate system associates coordinates with positions in an abstract Euclidean space, which is called its position-space. Abstract coordinate systems are defined independently of any object-space. There are many spatial spherical coordinate systems for a given object-space, but there is only one abstract spherical coordinate system for a position-space.
  4. An object reference model determines a precise relationship between position-space and the object-space for a spatial object of interest. Different object reference models for the Earth relate position-space to the object-space of the Earth in different ways. Thus, the object reference model WGS_1984 relates the position-space x-axis to the direction from the Earth's center of mass towards the intersection of the Greenwich meridian with the equator, while the object reference model EARTH_INERTIAL_J2000r0 relates the position-space x-axis to the direction from the Earth's centre of mass towards the first point of Aries (see 4.5 and Clause 7).
  5. The position-space to object-space relationship determined by an object reference model is expressed mathematically by a length-preserving embedding function called a normal embedding.
  6. A reference datum is a geometric primitive that relates measurements and/or geometric characteristics of object-space to position-space. Object reference models use reference datums to specify the position-space to object-space relationship. An object reference model may also use reference datums to model a geometric aspect of a spatial object. Thus, an oblate ellipsoid reference datum may be used to model the figure of the Earth or other celestial bodies.
  7. Temporal coordinate systems are introduced to describe the time-varying characteristics of spatial reference frames.
  8. Vertical offset surfaces are introduced to define heights with respect to equipotential or other complex surfaces. In particular, the vertical offset surface EGM96_GEOID represents the geopotential surface defined by the WGS 84 EGM 96 Earth Gravitational Model that is closely associated with the mean ocean surface.

The relationships among some of these concepts are depicted in the following figure. An abstract coordinate system is based on the underlying Euclidean structure of position-space. The reference datums that comprise the object reference model determine how position-space relates to object-space. That relationship is mathematically expressed by a normal embedding. A spatial reference frame combines the abstract coordinate system with the object reference model to specify a spatial coordinate system. This allows positions to be expressed relative to a spatial object of interest, such as the Earth.

Spatial Reference Frame


Spatial Reference Frame

A spatial coordinate system is a means of associating a unique coordinate with a point in object-space. It is defined by binding an abstract Coordinate System (CS) to a normal embedding. A spatial reference frame is a specification of a spatial coordinate system for a region of object-space. It is formed by the binding of an abstract coordinate system to the normal embedding specified by an Object Reference Model (ORM) for that object. A full specification specifies the CS and the ORM and includes values for CS parameters, if any, and a specification of the region of object-space. Some or all CS parameters may be bound by ORM parameters. In particular, a CS based on an oblate ellipsoid (or sphere) must match the parameters of the oblate ellipsoid (or sphere) Reference Datum of the ORM.

A spatial reference frame template is an abstraction of a collection of spatial reference frames that share the same abstract coordinate system, coordinate system parameter binding rules, and similar ORMs that model the same spatial object type. Spatial reference frames may be organized into specified sets so as to form an atlas for a large region of space. The SRM specifies a collection of spatial reference frame templates, realizations of those templates, and sets of those realizations.

SRM defined the following SRF Templates (SRFT):

  1. Celestiocentric (CC)
  2. Local Space Rectangular 3D (LSR_3D)
  3. Celestiodetic (CD)
  4. Planetodetic (PD)
  5. Local Tangent Space Euclidean (LTSE)
  6. Local Tangent Space Azimuthal Spherical (LTSAS)
  7. Local Tangent Space Cylindrical (LTSC)
  8. Lococentric Euclidean 3D (LCE_3D)
  9. Celestiomagnetic (CM)
  10. Equatorial Inertial (EI)
  11. Solar Ecliptic (SEC)
  12. Solar Equatorial (SEQ)
  13. Solar Magnetic Ecliptic (SME)
  14. Solar Magnetic Dipole (SMD)
  15. Heliospheric Aries Ecliptic (HAEC)
  16. Heliospheric Earth Ecliptic (HEEC)
  17. Heliospheric Earth Equatorial (HEEQ)
  18. Mercator (M)
  19. Oblique Mercator Spherical (OMS)
  20. Transverse Mercator (TM)
  21. Lambert Conformal Conic (LCC)
  22. Polar Stereographic (PS)
  23. Equidistant Cylindrical (EC)
  24. Local Space Rectangular 2D (LSR_2D)
  25. Local Space Azimuthal (LSA)
  26. Local Space Polar (LSP)

SRM defined the following SRF Sets and their intrinsic SRF template types:

  1. Alabama State Plane Coordinate System (SPCS) - TM
  2. Geo-Tile Reference System Global Coordinate System (GTRS GCS) - LTSE
  3. Japan Rectangular Plane CS - TM
  4. Lambert NTF - LCC
  5. Universal Polar Stereographic (UPS) - PS
  6. Universal Transverse Mercator (UTM) - TM
  7. Wisconsin State Plane Coordinate System (SPCS) - LCC

SRM defined the following Standard SRFs and their intrinsic SRF template types:

  1. British National Grid (BNG) - TM
  2. British OSGRS80 Grid - TM
  3. Delaware State Plane Coordinate System (SPCS) 1983 - TM
  4. Geocentric WGS 1984 - CC
  5. Geodetic Australia 1984 - CD
  6. Geodetic WGS 1984 - CD
  7. Geodetic North America 1983 - CD
  8. Irish Grid 1965 - TM
  9. Irish Transverse Mercator 1989 - TM
  10. Lambert 1993 - LCC
  11. Lambert II Wide - LCC
  12. Mars Planetocentric 2000 - CD
  13. Mars Planetographic 2000 - PD
  14. Maryland State Plane Coordinate System (SPCS) 1983 - LCC

Reference Datum (RD)

A reference datum is a geometric primitive in position-space. Reference datums are points or directed curves in 2D position-space or points, directed curves or oriented surfaces in 3D position-space.

A reference datum is bound when the reference datum in position-space is identified with a corresponding constructed entity (i.e., a measured or conceptual geometric aspect of a spatial object) in object-space. The term "corresponding" in this context means that each position-space reference datum is bound to a constructed geometric entity of the same geometric object type. That is, position-space points are bound to object-space points, position-space lines to object-space lines, position-space curves to object-space curves, position-space planes to object-space planes, and position-space surfaces to object-space surfaces.

Object Reference Model (ORM)

A set of bound Reference Datums can be selected so as to be compatible with only one normal embedding. In this way, a set of bound RDs with properly constrained relationships can specify a unique normal embedding. Such a constrained set of bound RDs is called an object reference model.

An object reference model (ORM) for a spatial object is a set of bound RDs for which there exists exactly one normal embedding that is compatible with each bound RD in the set. In the 3D case, this unique embedding shall also be right-handed.

An ORM is object-fixed if each of its RD bindings are object-fixed, otherwise it is called object-dynamic. The object-fixed definition assumes that the object itself is not changing in time by an amount significant for the accuracy and time scale of an application. The normal embedding determined by an ORM is, correspondingly, either an object-fixed embedding or an object-dynamic embedding.

Examples of ORMs are: World Geodesic System 1984 (WGS 1894), and COAMPS, and Heliocentric Aries Ecliptic.

Reference Transformation (RT)

A reference transformation (RT) for an ORM is a similarity transformation from the ORM normal embedding to the normal embedding of the reference ORM for that object, ORMR. The reference transformation for an ORM, ORMS, shall be denoted by HSR.

For 3D ORMs, a reference transformation shall be specified by the seven parameters of the corresponding seven-parameter embedding specification. For 2D ORMs, a reference transformation shall be specified by the four parameters of the corresponding four-parameter embedding specification.

For a list of supported reference transformations for each ORM see the ORM-RT Relationship Table. Notice that the leading part of the RT names is the name of the ORM with which they are associated.

Coordinate System

An abstract coordinate system is a means of identifying positions in position-space by coordinate n-tuples. An abstract coordinate system is completely defined in terms of the mathematical structure of position-space. In SRM, the term "coordinate system" is defined to mean "abstract coordinate system".

A temporal coordinate system is defined as a means of identifying events in the time continuum by coordinate 1-tuples using an abstract coordinate system of coordinate system type 1D. A spatial coordinate system is defined as an abstract coordinate system suitably combined with a normal embedding as a means of identifying points in object-space by coordinate n-tuples.

Coordinate

A coordinate is an element of the coordinate system domain. In particular, if the domain is a subset of 3D Euclidean space (R3), each coordinate is called a 3D coordinate. If the domain is a subset of 2D Euclidean space (R2), each coordinate is called a 2D coordinate. Surface coordinates are defined as the projection of the 3D coordinate onto the surface of an RD.

Examples of coordinates are: Celestiocentric 3D coordinate, Local Space Rectangular 2D coordinate, and Transverse Mercator surface coordinate.

SRM Capability

The SRM API supports the following functionality:

  1. Instantiation and access
    1. SRFs
      1. SRF templates (e.g., LSR 3D, TM, Celestiodetic, Celestiocentric)
      2. SRF set members (e.g., UTM zone 12 Northern Hemisphere, GTRS cell 1234, UPS Northern Pole)
      3. Standard SRFs (e.g., British National Grid)
    2. Coordinates
      1. 2D coordinates
      2. 3D coordinates
      3. Surface coordinates
    3. Directions
    4. Orientations
  2. Conversion
    1. Coordinate conversion between SRFs
    2. Direction conversion between SRFs
    3. Orientation conversion between SRFs
  3. Validation
    1. Coordinate validation within an SRF
      NOTE: Coordinate validation within an SRF is set to 'on' by default. If a user instructs an SRF to set coordinate validation to 'off', it is the user's responsibility to ensure that he or she then supplies valid data for any coordinate conversion. The accuracy and performance of the conversion algorithms require that their input be within the validity regions specified in the Spatial Reference Model ISO standard.
    2. Direction validation within an SRF
    3. Orientation validation within an SRF
  4. Calculation
    1. Euclidean distance
    2. Geodesic distance
    3. Point scale
    4. Vertical separation offset
    5. Convergence of the Meridian
    6. Map azimuth
    7. Natural Extent (zone)

Note that this release only supports the EGM_96 Geoid and WGS_84 Ellipsoid DSS codes for the Vertical Separation Offset calculation. See the Release Notes for additional information.

Conversion Types

There are three types of coordinate conversions:
  1. Direct

    These are conversions that have an algorithm implemented between the source SRF and the target SRF. For instance, the coordinate conversion from a Celestiodetic SRF to a Celestiocentric SRF is a direct conversion. This type of conversion does not involve intermediate SRFs for its computation and thus they are most efficient.

  2. Indirect (a.k.a."chained" or "transitive")

    These conversions are chains of direct conversions, converting first from the source SRF to intermediate SRFs, then to the target SRF. Consequently, these conversions typically take more time to be executed. For instance, the coordinate conversion from a Transverse Mercator SRF to a Celestiocentric SRF is an indirect conversion going through an intermediary conversion to Celestiodetic SRF.

  3. Reflexive

    Reflexive conversions are the cases where the source and the target SRFs are of the same class. The trivial case of this type of conversion is when the source and the target SRFs have the exact same parameter values. In that case, the identity transformation is applied to the source coordinate. Another example, when converting from a CD SRF to another CD SRF with a different ORM/RT pair, a datum shift is performed by converting the coordinate from the source CD SRF to an intermediate CC SRF, apply the datum shift, then converting to the target CD SRF.

The type of conversion applied to the coordinates is transparent to the users. The users can invoke the SRM_changeCoordinateSRF() method, regardless of whether the conversion is direct, indirect, or reflexive. The API will perform the conversion in a most efficient way. If a conversion is not supported between the two given SRFs, then the call to SRM_changeCoordinateSRF() will raise an exception.

The chart below is provided as a reference to indicate which coordinate conversions are supported in SRM Version 4.1.x. Empty cells indicate conversion not supported in 4.1.x.

  LSA CC CD CM EC EI HAEC HEEC HEEQ LCC LCE_3D LSR_
2D
LSR_
3D
LTSAS LTSC LTSE M OM PD LSP PS SEC SEQ SME SMD TM
LSA R                     D               I            
CC   R D D I D D D D I D     I I D I I I   I D D D D I
CD   D R I D I I I I D I     I I I D D D   D I I I I D
CM   D I R I I I I I I I     I I I I I I   I I I I I I
EC   I D I R I I I I I I     I I I I I I   I I I I I I
EI   D I I I R I I I I I     I I I I I I   I I I I I I
HAEC   D I I I I R I I I I     I I I I I I   I I I I I I
HEEC   D I I I I I R I I I     I I I I I I   I I I I I I
HEEQ   D I I I I I I R I I     I I I I I I   I I I I I I
LCC   I D I I I I I I R I     I I I I I I   I I I I I I
LCE_3D   D I I I I I I I I R     I I I I I I   I I I I I I
LSR_2D D                     R               D            
LSR_3D                         R                          
LTSAS   I I I I I I I I I I     R I D I I I   I I I I I I
LTSC   I I I I I I I I I I     I R D I I I   I I I I I I
LTSE   D I I I I I I I I I     D D R I I I   I I I I I I
M   I D I I I I I I I I     I I I R I I   I I I I I I
OM   I D I I I I I I I I     I I I I R I   I I I I I I
PD   I D I I I I I I I I     I I I I I R   I I I I I I
LSP I                     D               R            
PS   I D I I I I I I I I     I I I I I I   R I I I I I
SEC   D I I I I I I I I I     I I I I I I   I R I I I I
SEQ   D I I I I I I I I I     I I I I I I   I I R I I I
SME   D I I I I I I I I I     I I I I I I   I I I R I I
SMD   D I I I I I I I I I     I I I I I I   I I I I R I
TM   I D I I I I I I I I     I I I I I I   I I I I I R

Typical Usages

A few typical API usages are described in this section

Convert a coordinate from one SRF to another

In order to convert a coordinate from one SRF to another, the user has to instantiate a source and a target SRF and their associated coordinates:

The details on how to instantiate SRFs, instantiate coordinates and convert coordinates are as follows:

  1. Instantiate an SRF

    There are three ways to instantiate SRFs, depending on whether they are instances of SRF Templates, SRF Sets, or standard SRFs. Once an SRF is instantiated, its parameter values cannot be changed:

    1. From an SRF Template:

      There are 26 SRF Template classes in SRM (see Spatial Reference Frame). These include Celestiodetic, Celestiocentric, Local Space Rectangular 3D, and Transverse Mercator. Use their class constructors to instantiate these types of SRFs. For example, to instantiate a Celestiodetic SRF using the WGS 1984 ORM with the Identity reference transformation:

      SRF_Celestiodetic *cd_srf = SRF_Celestiodetic::create
                                  (SRM_ORMCOD_WGS_1984,
                                   SRM_RTCOD_WGS_1984_IDENTITY);
      
    2. From an SRF Set:

      There are 7 SRF Sets currently defined in SRM (see Spatial Reference Frame). These include Universal Transverse Mercator (UTM), Geotile Reference System Global Coordinate System (GTRS GCS), and Universal Polar Stereographic (UPS). Each of these SRF Sets is composed of a well-defined set of members. For example, UTM is composed of 120 members (zones) while GTRS GCS has 59,896 members (cells). These SRF Set members can be instantiated by invoking the static createSRFSetMember method in BaseSRF class. For example, to instantiate an instance of UTM zone 12 in North hemisphere using the WGS 1984 ORM with the Identity reference transformation:

      SRM_SRFS_Info utm12_srfs_params;
      
      utm12_srfs_params.srfs_code_info.srfs_code       = SRM_SRFSCOD_UNIVERSAL_TRANSVERSE_MERCATOR;
      utm12_srfs_params.srfs_code_info.value.srfsm_utm = SRM_SRFSMUTMCOD_ZONE_12_NORTHERN_HEMISPHERE;
      utm12_srfs_params.orm_code                       = SRM_ORM_WGS_1984;
      
      SRF_TransverseMercator *utm12_srf = (SRF_TransverseMercator*)BaseSRF::createSRFSetMember
                                                                            (utm12_srfs_params,
                                                                             SRM_RTCOD_WGS_1984_IDENTITY);
      

      The SRF template type for the Universal Transverse Mercator SRF is intrinsically Transverse Mercator. In other words, the instantiated UTM SRF is an instance of the Transverse Mercator SRF Template, and therefore supports all the methods defined for that SRF Template. Likewise, for example, a GTRS GCS SRF is intrinsically an instance of the Local Tangent Space Euclidean SRF Template.

    3. From a Standard SRF:

      There are 14 Standard SRFs currently defined in SRM (see Spatial Reference Frame). These include British National Grid (BNG), Irish Grid, and the Maryland State Plane Coordinate System (SPCS). These Standard SRFs can be instantiated by invoking the static createStandardSRF() method in the BaseSRF class using the proper SRF code. For example, to instantiate an instance of BNG with the OSGB 1936 England reference transformation:

      SRF_TransverseMercator *bng_stf = (SRF_TransverseMercator*)BaseSRF::createStandardSRF
                                        (SRM_SRFCOD_BRITISH_NATIONAL_GRID,
                                         SRM_RTCOD_OSGB_1936_ENGLAND);
      

      The SRF template type for the British National Grid SRF is intrinsically Transverse Mercator. In other words, the instantiated BNG SRF is actually an instance of the Transverse Mercator SRF Template, and therefore, supports all the methods defined for that SRF Template. Likewise, for example, a Maryland SPCS SRF is intrinsically an instance of the Lambert Conformal Conic SRF Template.

      The ORM parameter is pre-defined for each standard SRF. Users can only specify the reference transformation parameter that are applicable to that particular ORM. The pre-specified ORMs for the standard SRFs are as follows:

      Standard SRFORM
      British National Grid (BNG) SRM_ORMCOD_OSGB_1936
      British OSGRS80 Grid SRM_ORMCOD_ETRS_1989
      Delaware State Plane Coordinate System (SPCS) 1983 SRM_ORMCOD_N_AM_1983
      Geocentric WGS 1984 SRM_ORMCOD_WGS_1984
      Geodetic Australia 1984 SRM_ORMCOD_AUSTRALIAN_GEOD_1984
      Geodetic WGS 1984 SRM_ORMCOD_WGS_1984
      Geodetic North America 1983 SRM_ORMCOD_N_AM_1983
      Irish Grid 1965 SRM_ORMCOD_IRELAND_1965
      Irish Transverse Mercator 1989 SRM_ORMCOD_ETRS_1989
      Lambert 1993 SRM_ORMCOD_RGF_1993
      Lambert II Wide SRM_ORMCOD_NTF_1896_PM_PARIS
      Mars Planetocentric 2000 SRM_ORMCOD_MARS_SPHERE_2000
      Mars Planetographic 2000 SRM_ORMCOD_MARS_2000
      Maryland State Plane Coordinate System (SPCS) 1983 SRM_ORMCOD_N_AM_1983


  2. Instantiate a Coordinate

    Each SRF Template has its specific coordinates defined. The coordinates are only valid when associated with a specific SRF. Depending on the SRF instantiated, 2D, 3D or surface coordinates can be instantiated from it. There are mainly two way to instantiate coordinates:

    1. Using methods in SRF:

      A SRF instance can instantiate a coordinate associated with the SRF using the createCoordinateXX() method, where "XX" can be "2D", "3D", and "Surf" depending on the STF. For example, to instantiate a 3D coordinate for a Celestiodetic SRF:

      Coord3D_Celestiodetic* cd_3d_coord
                         = (Coord3D_Celestiodetic*)cd_srf.createCoordinate3D( 0.8987, 0.5645, 1000.0 );
      

      Another example to instantiate a UTM surface coordinate for a UTM SRF:

      CoordSurf_TransverseMercator utm12_surf_coord
                         = (CoordSurf_TransverseMercator*)utm12_srf.createSurfaceCoordinate( 550.0, 320.0 );
      

      Notice that the instantiate UTM SRF is intrinsically a TM SRF, and therefore, supports the createCoordinate3D method defined in the TM SRF Template class. Consequently, the surface coordinate instantiated by the UTM SRF is of CoordSurf_TransverseMercator class.

    2. Using the coordinate class constructors

      Each coordinate class takes in its constructor SRF parameters to which the coordinate is associated. For example, to instantiate a 3D coordinate for a Celestiodetic SRF:

      Coord3D_Celestiodetic cd_3d_coord
                         = Coord3D_Celestiodetic( cd_srf, 0.17865, 0.01234, 1000.0 ));
      

      To instantiate a UTM surface coordinate for a UTM SRF:

      CoordSurf_TransverseMercator utm_surf_coord
                         = CoordSurf_TransverseMercator( utm12_srf, 500.0, 500.0, 1000.0 );
      
  3. Convert a source coordinate from a source SRF to a target SRF

    Having instantiated the source and target SRFs and coordinates, invoke the changeCoordinateSRF() method of the target SRF to calculate the target coordinate and the Valid Region. For example, to convert a Celestiodetic 3D coordinate to a Transverse Mercator SRF:

    SRM_Coordinate_Valid_Region  validRegion;
    Coord3D_TransverseMercator  *utm12_3d_coord( utm12_srf ); // coordinate with default values
    validRegion = utm12_srf.changeCoordinateSRF( cd_3d_coord, utm12_3d_coord );
    
    In this example, the 3D Celestiodetic coordinate is converted to a UTM SRF. The validRegion indicates where the resulting UTM coordinate is within the valid, extended or defined regions.

Convert a direction from one SRF to another

The steps to convert a direction (source direction) from its original SRF (source SRF) to another SRF (target SRF) resulting in the final direction (target direction) is similar to converting a coordinate as follows:

  1. Instantiate an SRF (same as above).
  2. Instantiate a reference location coordinate (same as above). The restriction is that this coordinate must be a 3D coordinate.
  3. Instantiate a Direction

    A Direction object can be instantiated using the createDirection() method in any subclass of BaseSRF_3D. For example, to instantiate a Direction using a Celestiodetic 3D coordinate "cd_ref_location" associated with and a direction vector (0.0, 0.0, 1.0):

    SRM_Long_Float vector[3] = { 0.0, 0.0, 1.0 };
    Direction* cd_dir = cd_srf.createDirection( cd_ref_location, vector );
    

    The Celestiodetic SRF "cd_srf" must be the same one used to instantiate both the reference location "cd_ref_location" and the direction object "cd_dir".

  4. Convert a source Direction from the source SRF to a target SRF

    Having instantiated the source and target SRFs and Directions, invoke the changeDirectionSRF() method of the target SRF to calculate the target direction and the Valid Region. For example, to convert the Celestiodetic direction to a Transverse Mercator SRF "tm_srf":

    SRM_Coordinate_Valid_Region validRegion;
    validRegion = tm_srf.changeDirectionSRF( cd_dir, tm_dir);
    

    In converting a Direction, both its reference location and the vector are converted to the target SRF. The valid region is associated with the resulting reference location.

Convert an orientation from one SRF to another

The steps to convert a orientation (source orientation) from its original SRF (source SRF) to another SRF (target SRF) resulting in the final orientation (target direction) is similar to converting a direction as follows:

  1. Instantiate an SRF (same as above).
  2. Instantiate a reference location coordinate (same as above). The restriction is that this coordinate must be a 3D coordinate.
  3. Instantiate an orientation

    An Orientation object can be instantiated using the createOrientation() method in any subclass of BaseSRF_3D. For example, to instantiate a Direction using a Celestiodetic 3D coordinate "cd_ref_location" associated with and an identity matrix:

    SRM_Long_Float ident_mat[3][3] = { {1.0, 0.0, 0.0},
                                       {0.0, 1.0, 0.0},
                                       {0.0, 0.0, 1.0} };
    Orientation* cd_ori = cd_srf.createOrientation( cd_ref_location, ident_mat );
    

    The Celestiodetic SRF "cd_srf" must be the same one used to instantiate both the reference location "cd_ref_location" and the direction object "cd_ori".

  4. Convert a source orientation from the source SRF to a target SRF

    Having instantiated the source SRF and orientation and the target SRF, invoke the changeOrientationSRF() method of the target SRF to calculate the target orientation and the Valid Region. For example, to convert the Celestiodetic orientation to a Transverse Mercator SRF "tm_srf":

    SRM_Coordinate_Valid_Region validRegion;
    validRegion = tm_srf.changeOrientationSRF( cd_ori, tm_ori);
    
    The conversion of Orientation, both its reference location and the matrix (three row vectors) are converted to the target SRF. The valid region is associated with the the resulting reference location.

Sample Application

The following sample code performs a series of conversions between three coordinate formats using the SRM C++ API:

#if defined(SC52) || defined(_WIN32) || defined(linux) || defined(gnu)
#include <iostream>
using namespace std;
#else
#include <iostream.h>
#endif

#include "srf_all.h"

#ifndef PI
#define PI 3.14159265358979323846
#endif

#define TO_DEGREES(__rad)   (__rad*(180/PI))

using namespace srm;

int main(int argc, char* argv[])
{
    // SRF containers, parameters, and coordinates
    SRF_TransverseMercator* utm12_srf   = NULL;
    SRF_Celestiodetic*      cd_srf      = NULL;
    SRF_Celestiocentric*    cc_srf      = NULL;
    SRM_SRFS_Info           utm12_srfs_params;
    SRM_Status_Code         status;

    SRM_Long_Float          src_ord1 = 500000.0,
                            src_ord2 = 0.0,
                            src_ord3 = 1000.0;
    SRM_SRFS_Code           utm_srf_code = SRM_SRFSCOD_UNIVERSAL_TRANSVERSE_MERCATOR;
    SRM_SRF_Code            cd_srf_code = SRM_SRFCOD_GEODETIC_WGS_1984,
                            cc_srf_code = SRM_SRFCOD_GEOCENTRIC_WGS_1984;
    SRM_ORM_Code            orm = SRM_ORMCOD_WGS_1984;
    SRM_RT_Code             rt = SRM_RTCOD_WGS_1984_IDENTITY;

    cout << "SEDRIS SRM v4.1.4 C++ SDK Sample Conversion App"
        << endl << endl;

    try
    {
        // Initialize SRFs and coordinates
        utm12_srfs_params.srfs_code_info.srfs_code = utm_srf_code;
        utm12_srfs_params.srfs_code_info.value.srfsm_utm =
            SRM_SRFSMUTMCOD_ZONE_12_NORTHERN_HEMISPHERE;
        utm12_srfs_params.orm_code = orm;

        utm12_srf = (SRF_TransverseMercator*)BaseSRF::createSRFSetMember(
            utm12_srfs_params, rt);
        cd_srf = (SRF_Celestiodetic *)BaseSRF::createStandardSRF(cd_srf_code, rt);
        cc_srf = (SRF_Celestiocentric *)BaseSRF::createStandardSRF(cc_srf_code, rt);

        Coord3D_TransverseMercator   utm_coord(utm12_srf, src_ord1, src_ord2, src_ord3);
        Coord3D_Celestiodetic        cd_coord(cd_srf);
        Coord3D_Celestiocentric      cc_coord(cc_srf);

        // Perform conversions and print results
        cd_srf->changeCoordinate3DSRF(utm_coord, cd_coord);
        cc_srf->changeCoordinate3DSRF(cd_coord, cc_coord);

        cout.setf(ios::fixed,ios::floatfield);
        cout.precision(6);
        cout << "UTM (Zone N12) "
            << "[ " << utm_coord.get_easting() << ", " << utm_coord.get_northing()
            << ", " << utm_coord.get_ellipsoidal_height() << " ]" << endl;
        cout << "  => CD "
            << "[ " << TO_DEGREES(cd_coord.get_longitude())
            << ", " << TO_DEGREES(cd_coord.get_latitude())
            << ", " << cd_coord.get_ellipsoidal_height()
            << " ]" << endl << endl;

        cout << "CD "
            << "[ " << TO_DEGREES(cd_coord.get_longitude())
            << ", " << TO_DEGREES(cd_coord.get_latitude())
            << ", " << cd_coord.get_ellipsoidal_height()
            << " ]" << endl;
        cout << "  => CC "
            << "[ " << cc_coord.get_u() << ", " << cc_coord.get_v()
            << ", " << cc_coord.get_w() << " ]" << endl << endl;
    }
    catch (srm::Exception(ex))
    {
        cout << "Caught exception: " << ex.getWhat() << endl;
    }

    return 0;
}
Executing the sample code would result the following output:
SEDRIS SRM v4.1.4 C++ SDK Sample Conversion App

UTM (Zone N12) [ 500000.000000, 0.000000, 1000.000000 ]
  => CD [ -111.000000, -0.000000, 1000.000000 ]

CD [ -111.000000, -0.000000, 1000.000000 ]
  => CC [ -2286078.246559, -5955437.441144, -0.000000 ]

Return to: Top

Copyright © 2011 SEDRIS