SRM

Class BaseSRF_3D

java.lang.Object

SRM.BaseSRF

SRM.BaseSRF_3D

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

BaseSRF_WithEllipsoidalHeight, BaseSRF_WithTangentPlaneSurface, SRF_Celestiocentric, SRF_Celestiomagnetic, SRF_EquatorialInertial, SRF_HeliosphericAriesEcliptic, SRF_HeliosphericEarthEcliptic, SRF_HeliosphericEarthEquatorial, SRF_LocalSpaceRectangular3D, SRF_LococentricEuclidean3D, SRF_SolarEcliptic, SRF_SolarEquatorial, SRF_SolarMagneticDipole, SRF_SolarMagneticEcliptic

public abstract class BaseSRF_3D
extends BaseSRF

The BaseSRF_3D abstract class is the base class for the 3D SRFs.

Author:

David Shen

See Also:

BaseSRF, BaseSRF_2D

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean[]	_component_is_angular boolean flag indicating whether the coordinate component associated with this SRF is angular
protected SRM_Extended_Valid_Region_Params[]	_component_valid_region member data for the geodetic valid region

Fields inherited from class SRM.BaseSRF

_internalSRFs, _myCsCode, _myOpSeq, _mySrftCode, _orm, _rt

Constructor Summary

Constructors

Constructor and Description
BaseSRF_3D()

Method Summary

Methods

Modifier and Type	Method and Description
static double	calculateEuclideanDistance(Coord3D coord1, Coord3D coord2) Returns the euclidean distance between two coordinates.
int	changeCoordinate3DArraySRF(Coord3D[] src, Coord3D[] tgt, SRM_Coordinate_Valid_Region_Code[] region) Changes an array of 3D coordinate to this SRF.
int	changeCoordinate3DArraySRFObject(Coord3D[] src, SRM_ORM_Trans_3D_Params hst, Coord3D[] tgt, SRM_Coordinate_Valid_Region_Code[] region) Changes an array of coordinates to this SRF using tranformation object.
SRM_Coordinate_Valid_Region_Code	changeCoordinate3DSRF(Coord3D src, Coord3D tgt) Changes a coordinate's values to this SRF.
SRM_Coordinate_Valid_Region_Code	changeCoordinate3DSRFObject(Coord3D src, SRM_ORM_Trans_3D_Params hst, Coord3D tgt) Changes a coordinate's values to this SRF using tranformation object.
int	changeDirectionArraySRF(Direction[] src_dir, Direction[] tgt_dir, SRM_Coordinate_Valid_Region_Code[] region) Changes an array of directions to this SRF.
int	changeDirectionArraySRFObject(Direction[] src_dir, SRM_ORM_Trans_3D_Params hst, Direction[] tgt_dir, SRM_Coordinate_Valid_Region_Code[] region) Changes an array of directions to this SRF using tranformation object.
SRM_Coordinate_Valid_Region_Code	changeDirectionSRF(Direction src_dir, Direction tgt_dir) Changes a direction's reference coordinate and vector to this SRF.
SRM_Coordinate_Valid_Region_Code	changeDirectionSRFObject(Direction src_dir, SRM_ORM_Trans_3D_Params hst, Direction tgt_dir) Changes a direction's values to this SRF using tranformation object.
SRM_Coordinate_Valid_Region_Code	checkDirection(Direction direction) Check a direction in this SRF.
protected SRM_Matrix_3x3	comp_ori_mat(SRM.BaseSRF_3D.LTP_vec src, SRM.BaseSRF_3D.LTP_vec tgt)
protected SRM.BaseSRF_3D.LTP_vec	compLTP(BaseSRF srf, Coord3D coord)
void	computeSRFOrientation(Coord3D src_ref_point, Coord3D tgt_ref_point, Orientation out_ori) This method creates an Orientation object representing the orientation of the source srf (at the source reference point) with respect to this (the target) srf (at the target reference point).
abstract Coord3D	createCoordinate3D() Creates a 3D coordinate object.
abstract Coord3D	createCoordinate3D(double coord_comp1, double coord_comp2, double coord_comp3) Creates a 3D coordinate object.
Direction	createDirection() Creates a direction object with reference location and vector components as Double.NaN.
Direction	createDirection(Coord3D ref_coord, double[] vec) Creates a direction object.
SRF_LococentricEuclidean3D	createLococentricEuclidean3DSRF(Coord3D lococentre, Direction primary_axis, Direction secondary_axis) creates a Loccentric Euclidean 3D SRF whose origin in at the input lococentre and the primary and secodary axes are aligned with the input direction axes.
double[]	getCoordinate3DValues(Coord3D coord) Retrieves the 3D coordinate component values.
void	getDirectionValues(Direction direction, Coord3D ref_coord, double[] vec) Retrieves the direction component values.
SRM_Extended_Valid_Region_Params	getExtendedValidRegion(int component) Get the Extended Valid Region for this SRF.
SRF_LCE_3D_Params	getLocalTangentFrameSRFParameters(Coord3D ref_point) Computes the parameters corresponding to the local tangent frame at the input reference coordinate.
protected SRM_SRFSM_Code	getMemberCode(double[] src_coord, SRM_ORM_Code orm_dst, SRM_RT_Code rt_dst, SRM_SRFS_Code tgt_srfs)
BaseSRF_3D	getNaturalSRFSetMember(Coord3D src_coord, SRM_ORM_Code orm_dst, SRM_RT_Code rt_dst, SRM_SRFS_Code tgt_srfs) Returns the natural SRF Set member instance that the 3D coordinate is located in the target SRF Set.
SRM_SRFSM_Code	getNaturalSRFSetMemberCode(Coord3D src_coord, SRM_ORM_Code orm_dst, SRM_RT_Code rt_dst, SRM_SRFS_Code tgt_srfs) Computes the natural SRF Set member code (region) where the 3D coordinate is located in the target SRF Set.
SRM_Valid_Region_Params	getValidRegion(int component) Get the Valid Region for this SRF.
void	setExtendedValidRegion(int component, SRM_Interval_Type type, double extended_lower, double lower, double upper, double extended_upper) Set the Extended Valid Region for this SRF.
void	setValidRegion(int component, SRM_Interval_Type type, double lower, double upper) Set the Valid Region for this SRF.
void	transformOrientation(Coord3D src_ref_loc, Orientation src_ori, Coord3D tgt_ref_loc, Orientation tgt_ori) Given an orientation with respect to a local tangent frame (LTF_S) associated with a reference location in the source SRF, this method computes the orientation with respect to the local tangent frame (LTF_T) associated with the specified reference location in the target SRF.
SRM_Coordinate_Valid_Region_Code	transformOrientationCommonOrigin(Coord3D src_ref_loc, Orientation src_ori, Coord3D tgt_ref_loc, Orientation tgt_ori) Given an orientation with respect to a local tangent frame (LTF_S) associated with a reference location in the source SRF, this method computes the orientation with respect to the local tangent frame (LTF_T) associated with the specified reference location in the target SRF.
void	transformVector(Coord3D src_ref_loc, double[] src_vec, Coord3D tgt_ref_loc, double[] tgt_vec) Given a vector in the local tangent frame (LTF_S) associated with a reference location in the source SRF, this method computes the vector in the local tangent frame (LTF_T) associated with the specified reference location in the target SRF.
SRM_Coordinate_Valid_Region_Code	transformVectorCommonOrigin(Coord3D src_ref_loc, double[] src_vec, Coord3D tgt_ref_loc, double[] tgt_vec) Given a vector in the local tangent frame (LTF_S) associated with a reference location in the source SRF, this method computes the vector in the local tangent frame (LTF_T) associated with the specified reference location in the target SRF.
void	transformVectorInBodyFrame(Coord3D src_ref_loc, Orientation src_ori, double[] src_vec, Coord3D tgt_ref_loc, double[] tgt_vec) Given a vector in a body frame (or in general any linear reference frame) whose orientation with respect to the local tangent frame (LTF_S) that is associated with a reference location in the source SRF, this method computes the vector in the local tangent frame (LTF_T) associated with the specified reference location in the target SRF.
SRM_Coordinate_Valid_Region_Code	transformVectorInBodyFrameCommonOrigin(Coord3D src_ref_loc, Orientation src_ori, double[] src_vec, Coord3D tgt_ref_loc, double[] tgt_vec) Given a vector in a body frame (or in general any linear reference frame) whose orientation with respect to the local tangent frame (LTF_S) that is associated with a reference location in the source SRF, this method computes the vector in the local tangent frame (LTF_T) associated with the specified reference location in the target SRF.

Methods inherited from class SRM.BaseSRF

calculateEuclideanDistance, changeCoordinateSRF, checkCoordinate, createSRFSetMember, createStandardSRF, get_orm, get_rt, getA, getCSCode, getF, getImplVerInfo, getOrm, getRt, getSRFCode, getSRFSetCode, getSRFSetMemberCode, getSRFTemplateCode, interimConv, isEqual, makeClone, querySRFTSupport, setSrfCode, setSrfSetCode, setSrfSetMemberCode, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_component_valid_region

protected SRM_Extended_Valid_Region_Params[] _component_valid_region

member data for the geodetic valid region

_component_is_angular

protected boolean[] _component_is_angular

boolean flag indicating whether the coordinate component associated with this SRF is angular

Constructor Detail

BaseSRF_3D

public BaseSRF_3D()

Method Detail

createCoordinate3D

public abstract Coord3D createCoordinate3D()

Creates a 3D coordinate object.

Returns:

a 3D coordinate object

createCoordinate3D

public abstract Coord3D createCoordinate3D(double coord_comp1,
                         double coord_comp2,
                         double coord_comp3)

Creates a 3D coordinate object.

Parameters:

coord_comp1 - in: the values of the first component of the 3D coordinate

coord_comp2 - in: the values of the second component of the 3D coordinate

coord_comp3 - in: the values of the third component of the 3D coordinate

Returns:

a 3D coordinate object

getCoordinate3DValues

public double[] getCoordinate3DValues(Coord3D coord)
                               throws SrmException

Retrieves the 3D coordinate component values.

Parameters:

coord - in: a 3D coordinate

Returns:

an array of size 3 containing the component values for the 3D coordinate

Throws:

SrmException

changeCoordinate3DSRF

public SRM_Coordinate_Valid_Region_Code changeCoordinate3DSRF(Coord3D src,
                                                     Coord3D tgt)
                                                       throws SrmException

Changes a coordinate's values to this SRF.

Parameters:

src - in: the source 3D coordinate in some other 3D SRF

tgt - in out: the target coordinate in this 3D SRF

Returns:

the Valid Region of the target coordinate

Throws:

SrmException

changeCoordinate3DArraySRF

public int changeCoordinate3DArraySRF(Coord3D[] src,
                             Coord3D[] tgt,
                             SRM_Coordinate_Valid_Region_Code[] region)
                               throws SrmException

Changes an array of 3D coordinate to this SRF.

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

region - out: the array of valid region associated with the array of target coordinates

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.

Throws:

SrmException

setValidRegion

public void setValidRegion(int component,
                  SRM_Interval_Type type,
                  double lower,
                  double upper)
                    throws SrmException

Set the Valid Region for this SRF.

Parameters:

component - in: the coordinate component (1, 2, or 3)

type - in: the type of interval

lower - in: the lower value of the interval

upper - in: the upper value of the interval

Throws:

SrmException

setExtendedValidRegion

public void setExtendedValidRegion(int component,
                          SRM_Interval_Type type,
                          double extended_lower,
                          double lower,
                          double upper,
                          double extended_upper)
                            throws SrmException

Set the Extended Valid Region for this SRF.

Parameters:

component - in: the coordinate component (1, 2, or 3)

type - in: the type of interval

extended_lower - in: the extended lower value of the interval

lower - in: the lower value of the interval

upper - in: the upper value of the interval

extended_upper - in: the extended_upper value of the interval

Throws:

SrmException

getValidRegion

public SRM_Valid_Region_Params getValidRegion(int component)
                                       throws SrmException

Get the Valid Region for this SRF.

Parameters:

component - in: the coordinate component (1, 2, or 3)

Returns:

the valid region parameters

Throws:

SrmException

getExtendedValidRegion

public SRM_Extended_Valid_Region_Params getExtendedValidRegion(int component)
                                                        throws SrmException

Get the Extended Valid Region for this SRF.

Parameters:

component - in: the coordinate component (1, 2, or 3)

Returns:

the extended valid region parameters

Throws:

SrmException

changeCoordinate3DSRFObject

public SRM_Coordinate_Valid_Region_Code changeCoordinate3DSRFObject(Coord3D src,
                                                           SRM_ORM_Trans_3D_Params hst,
                                                           Coord3D tgt)
                                                             throws SrmException

Changes a coordinate's values to this SRF using tranformation object.

Parameters:

src - in: the source coordinate in some other 3D SRF

hst - in: the ORM 3D transformation

tgt - in out: the target coordinate in this 3D SRF

Returns:

the Valid Region of the target coordinate

Throws:

SrmException

changeCoordinate3DArraySRFObject

public int changeCoordinate3DArraySRFObject(Coord3D[] src,
                                   SRM_ORM_Trans_3D_Params hst,
                                   Coord3D[] tgt,
                                   SRM_Coordinate_Valid_Region_Code[] region)
                                     throws SrmException

Changes an array of coordinates to this SRF using tranformation object.

Parameters:

src - in: the array of source coordinates in some other 3D SRF

hst - in: the ORM 3D transformation object

tgt - out: the array of target coordinates in this 3D SRF

region - out: the array of valid region associated with the array of target coordinates

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.

Throws:

SrmException

createDirection

public Direction createDirection(Coord3D ref_coord,
                        double[] vec)
                          throws SrmException

Creates a direction object.

Parameters:

ref_coord - in: the 3D reference coordinate in this SRF.

vec[] - in: the array of size 3 containing the vector component values. It can be changed after the direction is created.

Returns:

a direction object

Throws:

SrmException

createDirection

public Direction createDirection()
                          throws SrmException

Creates a direction object with reference location and vector components as Double.NaN.

Returns:

a direction object

Throws:

SrmException

getDirectionValues

public void getDirectionValues(Direction direction,
                      Coord3D ref_coord,
                      double[] vec)
                        throws SrmException

Retrieves the direction component values.

Parameters:

direction - in: the direction object

ref_coord - out: the 3D reference coordinate in this SRF

vec[] - out: the 3D reference coordinate in this SRF

Throws:

SrmException

changeDirectionSRF

public SRM_Coordinate_Valid_Region_Code changeDirectionSRF(Direction src_dir,
                                                  Direction tgt_dir)
                                                    throws SrmException

Changes a direction's reference coordinate and vector to this SRF.

Parameters:

src_dir - in: the source direction in some other SRF

tgt_dir - out: the target direction in this SRF

Throws:

SrmException

changeDirectionArraySRF

public int changeDirectionArraySRF(Direction[] src_dir,
                          Direction[] tgt_dir,
                          SRM_Coordinate_Valid_Region_Code[] region)
                            throws SrmException

Changes an array of directions to this SRF.

Parameters:

src_dir - in: the array of source direction in some other 3D SRF

tgt_dir - out: the array of target direction in this 3D SRF

region - out: the array of valid region associated with the array of target direction

Returns:

the index of the offending direction in the source array when an error condition occurs. Otherwise, it is the size of the source array plus one.

Throws:

SrmException

changeDirectionSRFObject

public SRM_Coordinate_Valid_Region_Code changeDirectionSRFObject(Direction src_dir,
                                                        SRM_ORM_Trans_3D_Params hst,
                                                        Direction tgt_dir)
                                                          throws SrmException

Changes a direction's values to this SRF using tranformation object.

Parameters:

src_dir - in: the source direction in some other SRF

hst - in: the ORM 3D transformation

tgt_dir - out: the target direction in this SRF

Returns:

valid region category for the reference location associated with the target direction

Throws:

SrmException

changeDirectionArraySRFObject

public int changeDirectionArraySRFObject(Direction[] src_dir,
                                SRM_ORM_Trans_3D_Params hst,
                                Direction[] tgt_dir,
                                SRM_Coordinate_Valid_Region_Code[] region)
                                  throws SrmException

Changes an array of directions to this SRF using tranformation object.

Parameters:

src_dir - in: the array of source direction in some other 3D SRF

hst - in: the ORM 3D transformation

tgt_dir - out: the array of target direction in this 3D SRF

region - out: the array of valid region associated with the array of target direction

Returns:

the index of the offending direction in the source array when an error condition occurs. Otherwise, it is the size of the source array plus one.

Throws:

SrmException

checkDirection

public SRM_Coordinate_Valid_Region_Code checkDirection(Direction direction)
                                                throws SrmException

Check a direction in this SRF.

Parameters:

direction - in: the direction in this SRF

Returns:

the coordinate valid region code in the direction's SRF

Throws:

SrmException

computeSRFOrientation

public void computeSRFOrientation(Coord3D src_ref_point,
                         Coord3D tgt_ref_point,
                         Orientation out_ori)
                           throws SrmException

This method creates an Orientation object representing the orientation of the source srf (at the source reference point) with respect to this (the target) srf (at the target reference point). The Orientation is computed as the cosine matrix of the source local tangent frame with respect to the target local tangent frame.

Parameters:

src_ref_point - in : the source reference point

tgt_ref_point - in : the target reference point in this SRF

out_ori - out : the resulting orientation

Throws:

SrmException

getLocalTangentFrameSRFParameters

public SRF_LCE_3D_Params getLocalTangentFrameSRFParameters(Coord3D ref_point)
                                                    throws SrmException

Computes the parameters corresponding to the local tangent frame at the input reference coordinate.

Parameters:

ref_point - in : the reference point

Returns:

the parameters for the local tangent frame, which are the parameters for the Lococentric Euclidean 3D SRF at the reference coordinate

Throws:

SrmException

transformOrientation

public void transformOrientation(Coord3D src_ref_loc,
                        Orientation src_ori,
                        Coord3D tgt_ref_loc,
                        Orientation tgt_ori)
                          throws SrmException

Given an orientation with respect to a local tangent frame (LTF_S) associated with a reference location in the source SRF, this method computes the orientation with respect to the local tangent frame (LTF_T) associated with the specified reference location in the target SRF. The output orientation is computed by composing the orientation of LTF_S with respect to LTF_T with the input source orientation. The SRF invoking this method is the target SRF.

Parameters:

src_ref_loc - in : the source reference location (a coordinate in the source SRF) where the origin of the source local tangent frame (LTF_S) is located

src_ori - in : the source orientation of some linear reference frame with respect to LTF_S

tgt_ref_loc - in : the target reference location (a coordinate in this SRF, the target SRF) where the origin of the target local tangent frame (LTF_T) is located

tgt_ori - out : the target orientation with respect to LTF_T

Throws:

SrmException

transformOrientationCommonOrigin

public SRM_Coordinate_Valid_Region_Code transformOrientationCommonOrigin(Coord3D src_ref_loc,
                                                                Orientation src_ori,
                                                                Coord3D tgt_ref_loc,
                                                                Orientation tgt_ori)
                                                                  throws SrmException

Given an orientation with respect to a local tangent frame (LTF_S) associated with a reference location in the source SRF, this method computes the orientation with respect to the local tangent frame (LTF_T) associated with the specified reference location in the target SRF. LTF_S and LTF_T have a common origin. The output orientation is computed by composing the orientation of LTF_S with respect to LTF_T with the input source orientation. The SRF invoking this method is the target SRF.

Parameters:

src_ref_loc - in : the source reference location (a coordinate in the source SRF) where the origin of the source local tangent frame (LTF_S) is located

src_ori - in : the source orientation of some linear reference frame with respect to LTF_S

tgt_ref_loc - out : the coordinate of the common reference location in the target SRF

tgt_ori - out : the target orientation with respect to LTF_T

Returns:

valid region category for the target reference location

Throws:

SrmException

transformVectorInBodyFrame

public void transformVectorInBodyFrame(Coord3D src_ref_loc,
                              Orientation src_ori,
                              double[] src_vec,
                              Coord3D tgt_ref_loc,
                              double[] tgt_vec)
                                throws SrmException

Given a vector in a body frame (or in general any linear reference frame) whose orientation with respect to the local tangent frame (LTF_S) that is associated with a reference location in the source SRF, this method computes the vector in the local tangent frame (LTF_T) associated with the specified reference location in the target SRF. The output vector is computed by applying the composed orientation, from the orientation of LTF_S with respect to LTF_T with the source orientation, to the source vector. This method is equivalent to applying the orientation result from the transformOrientation method to the source vector. The SRF invoking this method is the target SRF.

Parameters:

src_ref_loc - in : the source reference location (a coordinate in the source SRF) where the origin of the source local tangent frame (LTF_S) is located

src_ori - in : the source orientation of some linear reference frame L with respect to LTF_S

src_vec - in : the input vector in L

tgt_ref_loc - in : the target reference location (a coordinate in this SRF, the target SRF) where the origin of the target local tangent frame (LTF_T) is located

tgt_vec - out : the target vector in LTF_T

Throws:

SrmException

transformVectorInBodyFrameCommonOrigin

public SRM_Coordinate_Valid_Region_Code transformVectorInBodyFrameCommonOrigin(Coord3D src_ref_loc,
                                                                      Orientation src_ori,
                                                                      double[] src_vec,
                                                                      Coord3D tgt_ref_loc,
                                                                      double[] tgt_vec)
                                                                        throws SrmException

Given a vector in a body frame (or in general any linear reference frame) whose orientation with respect to the local tangent frame (LTF_S) that is associated with a reference location in the source SRF, this method computes the vector in the local tangent frame (LTF_T) associated with the specified reference location in the target SRF. LTF_S and LTF_T have a common origin. The output vector is computed by applying the composed orientation, from the orientation of LTF_S with respect to LTF_T with the source orientation, to the source vector. This method is equivalent to applying the orientation result from the transformOrientation method to the source vector. The SRF invoking this method is the target SRF.

Parameters:

src_ref_loc - in : the source reference location (a coordinate in the source SRF) where the origin of the source local tangent frame (LTF_S) is located

src_ori - in : the source orientation of some linear reference frame L with respect to LTF_S

src_vec - in : the input vector in L

tgt_ref_loc - out : the coordinate of the common reference location in the target SRF

tgt_vec - out : the target vector in LTF_T

Returns:

valid region category for the target reference location

Throws:

SrmException

transformVector

public void transformVector(Coord3D src_ref_loc,
                   double[] src_vec,
                   Coord3D tgt_ref_loc,
                   double[] tgt_vec)
                     throws SrmException

Given a vector in the local tangent frame (LTF_S) associated with a reference location in the source SRF, this method computes the vector in the local tangent frame (LTF_T) associated with the specified reference location in the target SRF. The output vector is computed by applying the orientation of LTF_S with respect to LTF_T to the source vector. The SRF invoking this method is the target SRF.

Parameters:

src_ref_loc - in : the source reference location (a coordinate in the source SRF) where the origin of the source local tangent frame (LTF_S) is located

src_vec - in : the source vector in LTF_S

tgt_ref_loc - in : the target reference location (a coordinate in this SRF, the target SRF) where the origin of the target local tangent frame (LTF_T) is located

tgt_vec - out : the target vector in LTF_T

Throws:

SrmException

transformVectorCommonOrigin

public SRM_Coordinate_Valid_Region_Code transformVectorCommonOrigin(Coord3D src_ref_loc,
                                                           double[] src_vec,
                                                           Coord3D tgt_ref_loc,
                                                           double[] tgt_vec)
                                                             throws SrmException

Given a vector in the local tangent frame (LTF_S) associated with a reference location in the source SRF, this method computes the vector in the local tangent frame (LTF_T) associated with the specified reference location in the target SRF. LTF_S and LTF_T have a common origin. The output vector is computed by applying the orientation of LTF_S with respect to LTF_T to the source vector. The SRF invoking this method is the target SRF.

Parameters:

src_ref_loc - in : the source reference location (a coordinate in the source SRF) where the origin of the source local tangent frame (LTF_S) is located

src_vec - in : the source vector in LTF_S

tgt_ref_loc - out : coordinate of the common reference location in the target SRF

tgt_vec - out : the target vector in LTF_T

Returns:

valid region category for the target reference location

Throws:

SrmException

createLococentricEuclidean3DSRF

public SRF_LococentricEuclidean3D createLococentricEuclidean3DSRF(Coord3D lococentre,
                                                         Direction primary_axis,
                                                         Direction secondary_axis)
                                                           throws SrmException

creates a Loccentric Euclidean 3D SRF whose origin in at the input lococentre and the primary and secodary axes are aligned with the input direction axes.

Parameters:

lococentre - in : the lococentre of the SRF

primary_axis - in : the direction of the primary axis

secondary_axis - in : the direction of the secondary axis

Returns:

an instance of Lococentric Euclidean 3D SRF

Throws:

This - method throws srm::Exception

SrmException

calculateEuclideanDistance

public static double calculateEuclideanDistance(Coord3D coord1,
                                Coord3D coord2)
                                         throws SrmException

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 Coord3D coordinates (in meters).

Throws:

SrmException

getNaturalSRFSetMemberCode

public SRM_SRFSM_Code getNaturalSRFSetMemberCode(Coord3D 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 3D coordinate is located in the target SRF Set.

Parameters:

src_coord - in : the source 3D 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

Throws:

SrmException

getNaturalSRFSetMember

public BaseSRF_3D getNaturalSRFSetMember(Coord3D src_coord,
                                SRM_ORM_Code orm_dst,
                                SRM_RT_Code rt_dst,
                                SRM_SRFS_Code tgt_srfs)
                                  throws SrmException

Returns the natural SRF Set member instance that the 3D coordinate is located in the target SRF Set.

Parameters:

src_coord - in : the source 3D 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

Throws:

SrmException

getMemberCode

protected SRM_SRFSM_Code getMemberCode(double[] src_coord,
                           SRM_ORM_Code orm_dst,
                           SRM_RT_Code rt_dst,
                           SRM_SRFS_Code tgt_srfs)
                                throws SrmException

Throws:

SrmException

compLTP

protected SRM.BaseSRF_3D.LTP_vec compLTP(BaseSRF srf,
                             Coord3D coord)
                                  throws SrmException

Throws:

SrmException

comp_ori_mat

protected SRM_Matrix_3x3 comp_ori_mat(SRM.BaseSRF_3D.LTP_vec src,
                          SRM.BaseSRF_3D.LTP_vec tgt)