SRM.BaseSRF_2D Class Reference

The BaseSRF_2D abstract class is the base class for the 2D SRFs. More...

Inheritance diagram for SRM.BaseSRF_2D:

[legend]List of all members.

Public Member Functions
abstract Coord2D	createCoordinate2D ()
	Creates a 2D coordinate object.
abstract Coord2D	createCoordinate2D (double coord_comp1, double coord_comp2)
	Creates a 2D coordinate object.
double[]	getCoordinate2DValues (Coord2D coord) throws SrmException
	Retrieves the 2D coordinate component values.
void	changeCoordinate2DSRF (Coord2D src, Coord2D tgt) throws SrmException
	Changes a coordinate's values to this SRF.
int	changeCoordinate2DArraySRF (Coord2D[] src, Coord2D[] tgt) throws SrmException
	Changes a array of 2D coordinates to this SRF.
void	changeCoordinate2DSRFObject (Coord2D src, SRM_ORM_Trans_2D_Params hst, Coord2D tgt) throws SrmException
	Changes a coordinate's values to this SRF using tranformation object.
int	changeCoordinate2DArraySRFObject (Coord2D[] src, SRM_ORM_Trans_2D_Params hst, Coord2D[] tgt) throws SrmException
	Changes an array of 2D coordinates to this SRF using tranformation object.
Static Public Member Functions
double	calculateEuclideanDistance (Coord2D coord1, Coord2D coord2) throws SrmException
	Returns the Euclidean distance between two coordinates.

---

Detailed Description

The BaseSRF_2D abstract class is the base class for the 2D SRFs.

Author:

David Shen

See also:

BaseSRF, BaseSRF_3D

---

Member Function Documentation

double SRM.BaseSRF_2D.calculateEuclideanDistance (  Coord2D  coord1, Coord2D  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 Coord2D coordinates (in metres). Note: The input coordinates do not need to be from the same SRF. This method will make (and cache) internal conversions when the input coordinates are from SRFs other than SRF_Celestiocentric.

int SRM.BaseSRF_2D.changeCoordinate2DArraySRF (  Coord2D  src[], Coord2D  tgt[] )  throws SrmException

Changes a array of 2D coordinates to this SRF. Note: all the arrays must be of same length. all the coordinate in an array must be associated with the same SRF. the returned integer value will be the length of the array plus one to indicate that the operation successfully converted all the coordinates in the source array. Otherwise, the return value is the index of the offending coordinate in the source array. Parameters: src  in: the array of source 3D coordinate in some other 3D SRF tgt  out: the array of target coordinate in this 3D SRF Returns: the index of the offending coordinate in the source array when an error condition occurs. Otherwise, it is the size of the source array plus one.

int SRM.BaseSRF_2D.changeCoordinate2DArraySRFObject (  Coord2D  src[], SRM_ORM_Trans_2D_Params  hst, Coord2D  tgt[] )  throws SrmException

Changes an array of 2D coordinates to this SRF using tranformation object. Note: all the arrays must be of same length. all the coordinate in an array must be associated with the same SRF. the returned integer value will be the length of the array plus one to indicate that the operation successfully converted all the coordinates in the source array. Otherwise, the return value is the index of the offending coordinate in the source array. The value of omega for hst must be within the range (-2_PI, 2_PI). The value of delta_s for hst must be stricly greater than -1.0. Parameters: src  in: the array of source 3D coordinate in some other 3D SRF hst  in: the ORM 2D transformation tgt  out: the array of target coordinate in this 3D SRF Returns: the index of the offending coordinate in the source array when an error condition occurs. Otherwise, it is the size of the source array plus one.

void SRM.BaseSRF_2D.changeCoordinate2DSRF (  Coord2D  src, Coord2D  tgt )  throws SrmException

Changes a coordinate's values to this SRF. Parameters: src  in: the source coordinate in some other 2D SRF tgt  out: the target coordinate in this 2D SRF

void SRM.BaseSRF_2D.changeCoordinate2DSRFObject (  Coord2D  src, SRM_ORM_Trans_2D_Params  hst, Coord2D  tgt )  throws SrmException

Changes a coordinate's values to this SRF using tranformation object. Note: The target coordinate must have been created using this SRF. The value of omega for hst must be within the range (-2_PI, 2_PI). The value of delta_s for hst must be stricly greater than -1.0. Parameters: src  in: the source coordinate in some other 2D SRF hst  in: the ORM 2D transformation tgt  out: the target coordinate in this 2D SRF

abstract Coord2D SRM.BaseSRF_2D.createCoordinate2D (  double  coord_comp1, double  coord_comp2 )  [pure virtual]

Creates a 2D coordinate object. Parameters: coord_comp1  in: the values of the first component of the 2D coordinate coord_comp2  in: the values of the second component of the 2D coordinate Returns: a 2D coordinate object Implemented in SRM.SRF_LocalSpaceAzimuthal, SRM.SRF_LocalSpacePolar, and SRM.SRF_LocalSpaceRectangular2D.

abstract Coord2D SRM.BaseSRF_2D.createCoordinate2D (   )  [pure virtual]

Creates a 2D coordinate object. Returns: a 2D coordinate object Note: The initial coordinate value is defaulted to [ Double.NaN, Double.NaN ]. Implemented in SRM.SRF_LocalSpaceAzimuthal, SRM.SRF_LocalSpacePolar, and SRM.SRF_LocalSpaceRectangular2D.

double [] SRM.BaseSRF_2D.getCoordinate2DValues (  Coord2D  coord  )  throws SrmException

Retrieves the 2D coordinate component values. Note: The input coordinate must have been created using this SRF. Parameters: coord  in: a 2D coordinate, which must have been created using this SRF Returns: an array of size 2 containing the component values for the 2D coordinate

---

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

• BaseSRF_2D.java

---

Spatial Reference Model Java API	Version 4.4.0 - January 21, 2010
Copyright © 2010 SEDRIS™	Docs by Doxygen 1.3.2