SRM

Class SRF_PolarStereographic

java.lang.Object

SRM.BaseSRF

SRM.BaseSRF_3D

SRM.BaseSRF_WithEllipsoidalHeight

SRM.BaseSRF_MapProjection

SRM.SRF_PolarStereographic

All Implemented Interfaces:

Cloneable

public class SRF_PolarStereographic
extends BaseSRF_MapProjection

SRF_PolarStereographic class declaration.

Author:

David Shen

See Also:

BaseSRF_MapProjection

Field Summary

Fields inherited from class SRM.BaseSRF_MapProjection

_ormData

Fields inherited from class SRM.BaseSRF_3D

_component_is_angular, _component_valid_region

Fields inherited from class SRM.BaseSRF

_internalSRFs, _myCsCode, _myOpSeq, _mySrftCode, _orm, _rt

Constructor Summary

Constructors

Constructor and Description
SRF_PolarStereographic(SRM_ORM_Code orm, SRM_RT_Code rt, SRF_PS_Params params) Constructor by SRF parameter object
SRF_PolarStereographic(SRM_ORM_Code orm, SRM_RT_Code rt, SRM_Polar_Aspect polar_aspect, double origin_longitude, double central_scale, double false_easting, double false_northing) Constructor by individual SRF parameters

Method Summary

Methods

Modifier and Type	Method and Description
protected double	comCalculation(OrmData e_constants, double[] cd_coord)
Coord3D	createCoordinate3D() Create specific 3D coordinate for SRF_PolarStereographic with [ Double.NaN, Double.NaN, Double.NaN ]
Coord3D	createCoordinate3D(double coord_comp1, double coord_comp2, double coord_comp3) Create specific 3D coordinate for SRF_PolarStereographic with input values
CoordSurf	createSurfaceCoordinate() Create specific Surface coordinate for SRF_PolarStereographic with [ Double.NaN, Double.NaN ]
CoordSurf	createSurfaceCoordinate(double coord_comp1, double coord_comp2) Create specific Surface coordinate for SRF_PolarStereographic with input values
double	get_central_scale() Returns the central_scale SRF parameter value
double	get_false_easting() Returns the false_easting SRF parameter value
double	get_false_northing() Returns the false_northing SRF parameter value
double	get_origin_longitude() Returns the origin_longitude SRF parameter value
SRM_Polar_Aspect	get_polar_aspect() Returns the polar_aspect SRF parameter value
CoordSurf	getAssociatedSurfaceCoordinate(Coord3D coord) Returns a surface coordinate associated with a 3D coordinate for SRF_PolarStereographic
Coord3D	getPromotedSurfaceCoordinate(CoordSurf surf_coord) Returns a 3D coordinate representing the same location as specified by a surface coordinate for SRF_PolarStereographic
SRF_PS_Params	getSRFParameters() Returns the SRF parameter object
boolean	isEqual(BaseSRF srf) Returns TRUE if the SRF parameters are equal
protected double	pointScaleCalculation(OrmData e_constants, double[] cd_coord)
String	toString() Returns a String with the parameter values

Methods inherited from class SRM.BaseSRF_MapProjection

calculateConvergenceOfTheMeridian, calculateMapAzimuth, calculatePointScale, getExtendedValidGeodeticRegion, getValidGeodeticRegion, setExtendedValidGeodeticRegion, setValidGeodeticRegion

Methods inherited from class SRM.BaseSRF_WithEllipsoidalHeight

calculateEuclideanDistance, calculateGeodesicDistance, calculateVerticalSeparationOffset, createLocalTangentSpaceEuclideanSRF, getNaturalSRFSetMember, getNaturalSRFSetMemberCode, getSurfaceCoordinateValues

Methods inherited from class SRM.BaseSRF_3D

calculateEuclideanDistance, changeCoordinate3DArraySRF, changeCoordinate3DArraySRFObject, changeCoordinate3DSRF, changeCoordinate3DSRFObject, changeDirectionArraySRF, changeDirectionArraySRFObject, changeDirectionSRF, changeDirectionSRFObject, checkDirection, comp_ori_mat, compLTP, computeSRFOrientation, createDirection, createDirection, createLococentricEuclidean3DSRF, getCoordinate3DValues, getDirectionValues, getExtendedValidRegion, getLocalTangentFrameSRFParameters, getMemberCode, getNaturalSRFSetMember, getNaturalSRFSetMemberCode, getValidRegion, setExtendedValidRegion, setValidRegion, transformOrientation, transformOrientationCommonOrigin, transformVector, transformVectorCommonOrigin, transformVectorInBodyFrame, transformVectorInBodyFrameCommonOrigin

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, makeClone, querySRFTSupport, setSrfCode, setSrfSetCode, setSrfSetMemberCode

Methods inherited from class java.lang.Object

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

Constructor Detail

SRF_PolarStereographic

public SRF_PolarStereographic(SRM_ORM_Code orm,
                      SRM_RT_Code rt,
                      SRF_PS_Params params)
                       throws SrmException

Constructor by SRF parameter object

Throws:

SrmException

SRF_PolarStereographic

public SRF_PolarStereographic(SRM_ORM_Code orm,
                      SRM_RT_Code rt,
                      SRM_Polar_Aspect polar_aspect,
                      double origin_longitude,
                      double central_scale,
                      double false_easting,
                      double false_northing)
                       throws SrmException

Constructor by individual SRF parameters

Throws:

SrmException

Method Detail

createCoordinate3D

public Coord3D createCoordinate3D()

Create specific 3D coordinate for SRF_PolarStereographic with [ Double.NaN, Double.NaN, Double.NaN ]

Specified by:

createCoordinate3D in class BaseSRF_3D

Returns:

a 3D coordinate object

createCoordinate3D

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

Create specific 3D coordinate for SRF_PolarStereographic with input values

Specified by:

createCoordinate3D in class BaseSRF_3D

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

createSurfaceCoordinate

public CoordSurf createSurfaceCoordinate()

Create specific Surface coordinate for SRF_PolarStereographic with [ Double.NaN, Double.NaN ]

Specified by:

createSurfaceCoordinate in class BaseSRF_WithEllipsoidalHeight

Returns:

a surface coordinate object

createSurfaceCoordinate

public CoordSurf createSurfaceCoordinate(double coord_comp1,
                                double coord_comp2)

Create specific Surface coordinate for SRF_PolarStereographic with input values

Specified by:

createSurfaceCoordinate in class BaseSRF_WithEllipsoidalHeight

Parameters:

coord_comp1 - in: the values of the first component of the surface coordinate

coord_comp2 - in: the values of the second component of the surface coordinate

Returns:

a surface coordinate object

getSRFParameters

public SRF_PS_Params getSRFParameters()

Returns the SRF parameter object

get_polar_aspect

public SRM_Polar_Aspect get_polar_aspect()

Returns the polar_aspect SRF parameter value

get_origin_longitude

public double get_origin_longitude()

Returns the origin_longitude SRF parameter value

get_central_scale

public double get_central_scale()

Returns the central_scale SRF parameter value

get_false_easting

public double get_false_easting()

Returns the false_easting SRF parameter value

get_false_northing

public double get_false_northing()

Returns the false_northing SRF parameter value

getAssociatedSurfaceCoordinate

public CoordSurf getAssociatedSurfaceCoordinate(Coord3D coord)
                                         throws SrmException

Returns a surface coordinate associated with a 3D coordinate for SRF_PolarStereographic

Specified by:

getAssociatedSurfaceCoordinate in class BaseSRF_WithEllipsoidalHeight

Parameters:

coord - in: a 3D coordinate in this SRF

Returns:

a surface coordinate object in this SRF

Throws:

SrmException

getPromotedSurfaceCoordinate

public Coord3D getPromotedSurfaceCoordinate(CoordSurf surf_coord)
                                     throws SrmException

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

Specified by:

getPromotedSurfaceCoordinate in class BaseSRF_WithEllipsoidalHeight

Parameters:

surf_coord - in: a surface coordinate in this SRF

Returns:

a 3D coordinate object in this SRF

Throws:

SrmException

isEqual

public boolean isEqual(BaseSRF srf)

Returns TRUE if the SRF parameters are equal

Specified by:

isEqual in class BaseSRF

Returns:

TRUE if the SRF parameters are equal.

toString

public String toString()

Returns a String with the parameter values

Overrides:

toString in class BaseSRF

comCalculation

protected double comCalculation(OrmData e_constants,
                    double[] cd_coord)
                         throws SrmException

Specified by:

comCalculation in class BaseSRF_MapProjection

Throws:

SrmException

pointScaleCalculation

protected double pointScaleCalculation(OrmData e_constants,
                           double[] cd_coord)
                                throws SrmException

Specified by:

pointScaleCalculation in class BaseSRF_MapProjection

Throws:

SrmException