Main Page | Packages | Class Hierarchy | Alphabetical List | Compound List | Namespace Members | Compound Members | Related Pages

SRM.BaseSRF_WithEllipsoidalHeight Class Reference

The BaseSRF_WithEllipsoidalHeight abstract class. More...

Inheritance diagram for SRM.BaseSRF_WithEllipsoidalHeight:

Inheritance graph
[legend]
List of all members.

Public Member Functions

abstract CoordSurf createSurfaceCoordinate ()
 Creates a surface coordinate object with default [ Double.NaN, Double.NaN ].

abstract CoordSurf createSurfaceCoordinate (double coord_surf_comp1, double coord_surf_comp2)
 Creates a surface coordinate object with initial values.

double[] getSurfaceCoordinateValues (CoordSurf coord_surf) throws SrmException
 Retrieves a coordinate surface component values.

abstract CoordSurf getAssociatedSurfaceCoordinate (Coord3D coord) throws SrmException
 Returns a surface coordinate associated with a 3D coordinate.

abstract Coord3D getPromotedSurfaceCoordinate (CoordSurf surf_coord) throws SrmException
 Returns a 3D coordinate representing the same location as specified by a surface coordinate.

SRF_LocalTangentSpaceEuclidean createLocalTangentSpaceEuclideanSRF (CoordSurf surf_coord, double azimuth, double false_x_origin, double false_y_origin, double offset_height) throws SrmException
 Creates a Local Tangent Euclidean SRF with natural origin at a given position.

SRM_SRFSM_Code getNaturalSRFSetMemberCode (CoordSurf src_coord, SRM_ORM_Code orm_dst, SRM_RT_Code rt_dst, SRM_SRFS_Code tgt_srfs) throws SrmException
 Computes the natural SRF Set member code (region) where the Surface coordinate is located in the target SRF Set.

BaseSRF_3D getNaturalSRFSetMember (CoordSurf src_coord, SRM_ORM_Code orm_dst, SRM_RT_Code rt_dst, SRM_SRFS_Code tgt_srfs) throws SrmException
 Computes the natural SRF Set member instance that the surface coordinate is located in the target SRF Set.

double calculateGeodesicDistance (CoordSurf src_coord, CoordSurf des_coord) throws SrmException
 Returns the geodesic distance between two surface coordinates.

double calculateVerticalSeparationOffset (SRM_DSS_Code dss, CoordSurf surf_coord) throws SrmException
 Returns the vertical separation at a position.


Static Public Member Functions

double calculateEuclideanDistance (CoordSurf coord1, CoordSurf coord2) throws SrmException
 Returns the Euclidean distance between two coordinates.

Detailed Description

The BaseSRF_WithEllipsoidalHeight abstract class.

Author:
David Shen
See also:
BaseSRF_3D, BaseSRF

Member Function Documentation

double SRM.BaseSRF_WithEllipsoidalHeight.calculateEuclideanDistance (  CoordSurf  coord1,
CoordSurf  coord2
)  throws SrmException [static]
 

Returns the Euclidean distance between two coordinates.

Parameters:
coord1 in: a coordinate in some SRF
coord2 in: a coordinate in some SRF
Returns:
the Euclidean distance between the two CoordSurf coordinates (in meters).
Note:
The input coordinates do not need to be from the same SRF.

This method will make (and cache) internal conversions when the inputs coordinates are from SRFs other than SRF_Celestiocentric.

double SRM.BaseSRF_WithEllipsoidalHeight.calculateGeodesicDistance (  CoordSurf  src_coord,
CoordSurf  des_coord
)  throws SrmException
 

Returns the geodesic distance between two surface coordinates.

Parameters:
src_coord in: the source surface coordinate in this SRF
des_coord in: the destination surface coordinate in this SRF
Returns:
the geodesic distance between the two surface coordinates (in meters)
Note:
The input surface coordinates must have been created using this SRF.

double SRM.BaseSRF_WithEllipsoidalHeight.calculateVerticalSeparationOffset (  SRM_DSS_Code  dss,
CoordSurf  surf_coord
)  throws SrmException
 

Returns the vertical separation at a position.

Parameters:
dss in: the reference vertical offset surface model
surf_coord in: the surface coordinate in this SRF
Returns:
the vertical separation distance (in meters)
Note:
The input surface coordinate must have been created using this SRF.

SRF_LocalTangentSpaceEuclidean SRM.BaseSRF_WithEllipsoidalHeight.createLocalTangentSpaceEuclideanSRF (  CoordSurf  surf_coord,
double  azimuth,
double  false_x_origin,
double  false_y_origin,
double  offset_height
)  throws SrmException
 

Creates a Local Tangent Euclidean SRF with natural origin at a given position.

Parameters:
surf_coord in: a surface coordinate
azimuth in: the LTE's azimuth parameter
false_x_origin in: the LTE's false x origin
false_y_origin in: the LTE's false y origin
offset_height in: the LTE's offset height
Returns:
a local tangent euclidean object
Note:
The input surface coordinate must have been created using this SRF.

abstract CoordSurf SRM.BaseSRF_WithEllipsoidalHeight.createSurfaceCoordinate (  double  coord_surf_comp1,
double  coord_surf_comp2
)  [pure virtual]
 

Creates a surface coordinate object with initial values.

Parameters:
coord_surf_comp1 in: the values of the first component of the surface coordinate
coord_surf_comp2 in: the values of the second component of the surface coordinate
Returns:
a surface coordinate object

Implemented in SRM.SRF_Celestiodetic, SRM.SRF_EquidistantCylindrical, SRM.SRF_LambertConformalConic, SRM.SRF_Mercator, SRM.SRF_ObliqueMercatorSpherical, SRM.SRF_Planetodetic, SRM.SRF_PolarStereographic, and SRM.SRF_TransverseMercator.

abstract CoordSurf SRM.BaseSRF_WithEllipsoidalHeight.createSurfaceCoordinate (   )  [pure virtual]
 

Creates a surface coordinate object with default [ Double.NaN, Double.NaN ].

Returns:
a surface coordinate object

Implemented in SRM.SRF_Celestiodetic, SRM.SRF_EquidistantCylindrical, SRM.SRF_LambertConformalConic, SRM.SRF_Mercator, SRM.SRF_ObliqueMercatorSpherical, SRM.SRF_Planetodetic, SRM.SRF_PolarStereographic, and SRM.SRF_TransverseMercator.

abstract CoordSurf SRM.BaseSRF_WithEllipsoidalHeight.getAssociatedSurfaceCoordinate (  Coord3D  coord  )  throws SrmException [pure virtual]
 

Returns a surface coordinate associated with a 3D coordinate.

Parameters:
coord in: a 3D coordinate in this SRF
Returns:
a surface coordinate object in this SRF
Note:
The input coordinate must have been created using this SRF.

Implemented in SRM.SRF_Celestiodetic, SRM.SRF_EquidistantCylindrical, SRM.SRF_LambertConformalConic, SRM.SRF_Mercator, SRM.SRF_ObliqueMercatorSpherical, SRM.SRF_Planetodetic, SRM.SRF_PolarStereographic, and SRM.SRF_TransverseMercator.

BaseSRF_3D SRM.BaseSRF_WithEllipsoidalHeight.getNaturalSRFSetMember (  CoordSurf  src_coord,
SRM_ORM_Code  orm_dst,
SRM_RT_Code  rt_dst,
SRM_SRFS_Code  tgt_srfs
)  throws SrmException
 

Computes the natural SRF Set member instance that the surface coordinate is located in the target SRF Set.

Note:
The input coordinate must have been created using this SRF.
Parameters:
src_coord in : the source surface coordinate in an SRF
orm_dst in : the ORM for the destination SRF Set
rt_dst in : the Rt for the destination SRF Set
tgt_srfs in : the destination SRF Set Code
Returns:
the SRF Set Member instance for the destination SRF Set

SRM_SRFSM_Code SRM.BaseSRF_WithEllipsoidalHeight.getNaturalSRFSetMemberCode (  CoordSurf  src_coord,
SRM_ORM_Code  orm_dst,
SRM_RT_Code  rt_dst,
SRM_SRFS_Code  tgt_srfs
)  throws SrmException
 

Computes the natural SRF Set member code (region) where the Surface coordinate is located in the target SRF Set.

Note:
The input coordinate must have been created using this SRF.
Parameters:
src_coord in : the source surface coordinate in an SRF
orm_dst in : the ORM for the destination SRF Set
rt_dst in : the RT for the destination SRF Set
tgt_srfs in : the destination SRF Set Code
Returns:
the SRF Set Member code for the destination SRF Set

abstract Coord3D SRM.BaseSRF_WithEllipsoidalHeight.getPromotedSurfaceCoordinate (  CoordSurf  surf_coord  )  throws SrmException [pure virtual]
 

Returns a 3D coordinate representing the same location as specified by a surface coordinate.

Parameters:
surf_coord in: a surface coordinate in this SRF
Returns:
a 3D coordinate object in this SRF
Note:
The input surface coordinate must have been created using this SRF.

Implemented in SRM.SRF_Celestiodetic, SRM.SRF_EquidistantCylindrical, SRM.SRF_LambertConformalConic, SRM.SRF_Mercator, SRM.SRF_ObliqueMercatorSpherical, SRM.SRF_Planetodetic, SRM.SRF_PolarStereographic, and SRM.SRF_TransverseMercator.

double [] SRM.BaseSRF_WithEllipsoidalHeight.getSurfaceCoordinateValues (  CoordSurf  coord_surf  )  throws SrmException
 

Retrieves a coordinate surface component values.

Parameters:
coord_surf in: a surface coordinate
Returns:
an array of size 2 containing the component values for the surface coordinate
Note:
The input surface coordinate must have been created using this SRF.

The documentation for this class was generated from the following file:
Spatial Reference Model Java API Version 4.4.0 - January 21, 2010
Copyright © 2010 SEDRIS™ Docs by Doxygen 1.3.2