IlvUniversalPolarStereographicProjection Class Reference

This class defines the Universal Polar Stereographic projection, also known as the UPS projection. More...

#include <ilviews/maps/projection/unipolst.h>

Inheritance diagram for IlvUniversalPolarStereographicProjection:

List of all members.

Public Member Functions
	IlvUniversalPolarStereographicProjection (IlBoolean south=IlFalse)
	Initializes an instance of the UPS projection.
virtual IlvProjection *	copy () const
	Returns a copy of the projection. It must be overridden in each subclass.
virtual IlvProjectionClassInfo *	getClassInfo () const
	Returns the class information for the projection.
IlBoolean	isSouth () const
	Checks if the projection is set for the South Pole.
virtual void	setLLCenter (IlDouble lon, IlDouble lat)
	Specifies the central meridian and the central parallel (in radian) associated with the projection.
virtual void	setScaleFactor (IlDouble k0)
	Sets the scale factor k0 applied to the central meridian.
void	setSouth (IlBoolean south)
	Sets the projection either for the South Pole or for the North Pole.
virtual void	write (IlvOutputFile &f) const
	Saves the parameters of a projection to the specified output file.
Static Public Member Functions
static IlvProjectionClassInfo *	ClassInfo ()
	Returns the class information of the class.
static IlvClassInfo **	ClassInfoRef ()
	Returns the address of the class information of the class.

---

Detailed Description

This class defines the Universal Polar Stereographic projection, also known as the UPS projection.

The UPS projection is a preconfigured form of the Stereographic projection. It is generally used with non-spherical ellipsoids. It is designed to cover regions where lat >= 84N or lat <= 80S. The scale factor is fixed to 0.994. The false northing and false easting are set to 2,000,000 m.

Universal Polar Stereographic Projection

Library: ilvmaps

See also:

IlvUniversalTransverseMercatorProjection.

---

Constructor & Destructor Documentation

IlvUniversalPolarStereographicProjection::IlvUniversalPolarStereographicProjection

(

IlBoolean

south = IlFalse

)

Initializes an instance of the UPS projection.

The ellipsoid is set to the WGS84 ellipsoid. The Boolean argument south is set to IlFalse by default, which means that the projection is initialized for the North Pole.

---

Member Function Documentation

static IlvProjectionClassInfo* IlvUniversalPolarStereographicProjection::ClassInfo

(

)

[static]

Returns the class information of the class.

This static function is also available for the subclasses of IlvProjection.

Returns:

The IlvProjectionClassInfo of the class.

Reimplemented from IlvStereographicProjection.

static IlvClassInfo** IlvUniversalPolarStereographicProjection::ClassInfoRef

(

)

[static]

Returns the address of the class information of the class.

This static function is also available for the subclasses of IlvProjection.

Returns:

The address of the IlvProjectionClassInfo of the class.

Reimplemented from IlvStereographicProjection.

virtual IlvProjection* IlvUniversalPolarStereographicProjection::copy

(

)

const [virtual]

Returns a copy of the projection. It must be overridden in each subclass.

Returns:

The copy of the object.

Reimplemented from IlvStereographicProjection.

virtual IlvProjectionClassInfo* IlvUniversalPolarStereographicProjection::getClassInfo

(

)

const [virtual]

Returns the class information for the projection.

Returns:

The class information for the projection.

Reimplemented from IlvStereographicProjection.

IlBoolean IlvUniversalPolarStereographicProjection::isSouth

(

)

const

Checks if the projection is set for the South Pole.

This member function returns IlTrue if the projection is set for the South Pole or IlFalse if the projection is set for the North Pole (the default value).

Returns:

IlTrue if the projection is set for the South Pole, IlFalse otherwise.

virtual void IlvUniversalPolarStereographicProjection::setLLCenter	(	IlDouble	lon,
		IlDouble	lat
	)			[virtual]

Specifies the central meridian and the central parallel (in radian) associated with the projection.

By default, theses values are set to 0. This function is virtual because it can be overridden by subclasses of IlvProjection to update the internal parameters when the center is changed.

Parameters:

	lon	The central meridian in radian.
	lat	The central parallel in radian.

Reimplemented from IlvStereographicProjection.

virtual void IlvUniversalPolarStereographicProjection::setScaleFactor

(

IlDouble

k0

)

[virtual]

Sets the scale factor k0 applied to the central meridian.

By default, the scale factor is 1.

Warning:

[note] The scale factor is not used if the central parallel of the projection is located at +PI/2 (north pole) or -PI/2 (south pole).

Parameters:

k0

The scale factor applied to the central meridian.

Reimplemented from IlvStereographicProjection.

void IlvUniversalPolarStereographicProjection::setSouth

(

IlBoolean

south

)

Sets the projection either for the South Pole or for the North Pole.

This member function sets the projection either for the South Pole or for the North Pole, depending on the value of the Boolean flag south.

Parameters:

south

Specifies if the projection is to be set for the South Pole.

virtual void IlvUniversalPolarStereographicProjection::write

(

IlvOutputFile &

outputFile

)

const [virtual]

Saves the parameters of a projection to the specified output file.

It must be overridden by subclasses of IlvProjection that need to save additional parameters. This function should not be directly called; use the save function instead.

Parameters:

outputFile

The file to write the projection parameters to.

Reimplemented from IlvStereographicProjection.