Defines the Universal Polar Stereographic projection, also known as the UPS projection. More...

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

Inheritance diagram for IlvUniversalPolarStereographicProjection:

Public Member Functions
	IlvUniversalPolarStereographicProjection (IlBoolean south=IlFalse)
	Initializes an instance of the UPS projection. More...

IlBoolean	isSouth () const
	Checks if the projection is set for the South Pole. More...

virtual void	setLLCenter (IlDouble, IlDouble)
	Specifies the central meridian and the central parallel (in radian) associated with the projection. More...

virtual void	setScaleFactor (IlDouble)
	Sets the scale factor applied to the central meridian. More...

void	setSouth (IlBoolean south)
	Sets the projection either for the South Pole or for the North Pole. More...

virtual void	write (IlvOutputFile &) const
	Saves the parameters of a projection to the specified output file. More...

Public Member Functions inherited from IlvStereographicProjection
	IlvStereographicProjection ()
	Initializes a new of the class `IlvStereographicProjection` instance.

IlDouble	getLatitudeOfTrueScale () const
	Returns the latitude of the true scale in radian. More...

IlDouble	getScaleFactor () const
	Returns the scale factor applied to the central meridian. More...

virtual IlvMapsError	setEllipsoid (const IlvEllipsoid &)
	Sets the ellipsoid used for the projection. More...

void	setLatitudeOfTrueScale (IlDouble latitudeOfTrueScale)
	Sets the latitude of the true scale in radian. More...

Public Member Functions inherited from IlvProjection
virtual IlvProjection *	copy () const =0
	Returns a copy of the projection. More...

virtual IlvMapsError	forward (const IlvCoordinate &llIn, IlvCoordinate &xyOut) const
	Converts a latitude and a longitude to Cartesian coordinates (x, y). More...

virtual IlvMapsError	forward (IlvCoordinate &coords) const
	Projects a latitude and a longitude pair to Cartesian coordinates. More...

IlDouble	getCentralMeridian () const
	Returns the central meridian of the projection. More...

IlDouble	getCentralParallel () const
	Returns the central parallel of the projection. More...

virtual IlvProjectionClassInfo *	getClassInfo () const
	Returns the class information for the projection. More...

const IlvHorizontalDatum *	getDatum (void) const
	Returns the horizontal datum used for the projection. More...

const IlvEllipsoid *	getEllipsoid () const
	Returns the ellipsoid used for the projection. More...

IlvMapsError	getError () const
	Returns the status of the projection. More...

IlDouble	getFalseEasting () const
	Returns the false easting of the projection. More...

IlDouble	getFalseNorthing () const
	Returns the false northing of the projection. More...

IlvProjectionInterface *	getInterface ()
	Returns the interface of the projection. More...

IlvCoordinate	getLLCenter (void) const
	Returns the central meridian and the central parallel associated with the projection (0-0 by default). More...

IlvProjectionGeometricProperty	getProperty () const
	Returns the geometric property of the projection. More...

const IlvUnitConverter *	getUnitConverter () const
	Returns the unit converter. More...

IlvCoordinate	getXYOffset () const
	Returns the false easting and the false northing of the projection. More...

virtual IlvMapsError	inverse (const IlvCoordinate &xyIn, IlvCoordinate &llOut) const
	Converts the specified coordinate to a latitude and a longitude. More...

virtual IlvMapsError	inverse (IlvCoordinate &coords) const
	Invserse-projects Cartesian coordinates to a latitude and a longitude. More...

IlBoolean	isBad () const
	Checks for an inconsistent state of the projection. More...

IlBoolean	isEllipsoidEnabled () const
	Indicates if non spherical ellipsoids can be used for the projection. More...

IlBoolean	isGeocentric () const
	Checks if the projection uses geocentric latitudes. More...

IlBoolean	isInverseEnabled () const
	Indicates if the inverse function is supported by the projection. More...

IlBoolean	isShared () const
	Indicates that the projection is shared. More...

IlBoolean	isUsingLongitudeReduction () const
	Returns `IlTrue` if the projection uses range reduction for longitudes. More...

void	lock ()
	Locks the projection.

virtual std::ostream &	printPROJ4Descriptor (std::ostream &ostr, IlvMapsError *status=0) const
	This virtual member function converts the projection to a string in the `PROJ4` format. More...

void	save (IlvOutputFile &outputFile) const
	Saves an instance of a subclass of `IlvProjection` to the specified output file. More...

void	setCentralMeridian (IlDouble lon)
	Sets the central meridian of the projection. More...

void	setCentralParallel (IlDouble lat)
	Sets the central parallel of the projection. More...

virtual IlvMapsError	setDatum (const IlvHorizontalDatum *datum)
	Sets the datum used for the projection. More...

void	setFalseEasting (IlDouble falseEasting)
	Sets the false easting of the projection. More...

void	setFalseNorthing (IlDouble falseNorthing)
	Sets the false northing of the projection. More...

void	setGeocentric (IlBoolean geoc)
	Specifies whether the projection uses geocentric or geodetic latitudes. More...

void	setShared ()
	Specifies that the projection will be shared. More...

void	setUnitConverter (const IlvUnitConverter &converter)
	Sets the unit converter of the projection. More...

void	setUsingLongitudeReduction (IlBoolean use)
	Specifies whether the projection uses longitude reduction. More...

virtual void	setXYOffset (IlDouble x0, IlDouble y0)
	Specifies the false easting and the false northing. More...

void	unLock ()
	Unlocks the object. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvProjection
static IlvProjectionClassInfo *	ClassInfo ()
	Returns the class information of the class. More...

static IlvClassInfo **	ClassInfoRef ()
	Returns the address of the class information of the class. More...

static IlvMapsError	InputError ()
	Indicates that the coordinates passed to the forward function are not in a valid range for radian angles.

static IlvMapsError	InvalidEllipsoidError ()
	Indicates that you attempt to set a non spherical ellipsoid to a projection that does not support non spherical ellipsoids.

static IlvProjection *	Load (IlvInputFile &inputFile)
	Loads a projection from the specified file. More...

static IlvProjection *	PROJ4ToIlvProjection (const char proj4Descriptor, IlvMapsError status=0)
	Creates the projection from a `PROJ4` descriptor. More...

static IlvMapsError	ToleranceConditionError ()
	Indicates that an internal projection computation failed. More...

static IlvMapsError	UnsupportedFeatureError ()
	Indicates that an unsupported projection feature is requested, like inverse projection for a projection that does not support inverse projection.

Protected Member Functions inherited from IlvStereographicProjection
virtual IlvMapsError	eForward (IlvCoordinate &) const
	Must be redefined in subclasses to implement the projection for a non spherical ellipsoid. More...

virtual IlvMapsError	eInverse (IlvCoordinate &) const
	Implements the inverse projection for a non spherical ellipsoid. More...

virtual IlvMapsError	sForward (IlvCoordinate &) const
	Must be redefined in subclasses to implement the projection for a sphere. More...

virtual IlvMapsError	sInverse (IlvCoordinate &) const
	Must be redefined in subclasses to implement the inverse projection for a sphere. More...

Protected Member Functions inherited from IlvProjection
	IlvProjection (IlBoolean ellipsoidEnabled, IlBoolean inverseEnabled, IlvProjectionGeometricProperty property)
	Initializes a new `IlvProjection` instance. More...

void	addError (IlvMapsError error)
	Used by the constructors of subclasses if an error occurs during an object initialization. More...

virtual bool	isUsingProj4 () const
	Are we using proj4 implementation. More...

void	setError (IlvMapsError error)
	Sets the status of this projection. More...

Detailed Description

Defines the Universal Polar Stereographic projection, also known as the UPS projection.

Library: ilvmaps

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

See also: IlvUniversalTransverseMercatorProjection.

Constructor & Destructor Documentation

◆ IlvUniversalPolarStereographicProjection()

IlvUniversalPolarStereographicProjection::IlvUniversalPolarStereographicProjection ( IlBoolean south = IlFalse )

Initializes an instance of the UPS projection.

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

Member Function Documentation

◆ isSouth()

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.

◆ setLLCenter()

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.

◆ setScaleFactor()

virtual void IlvUniversalPolarStereographicProjection::setScaleFactor ( IlDouble k0 )

virtual

Sets the scale factor applied to the central meridian.

By default, the scale factor is 1.

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 new scale factor applied to the central meridian.

Reimplemented from IlvStereographicProjection.

◆ setSouth()

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.

◆ write()

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.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IlvUniversalPolarStereographicProjection()

Member Function Documentation

◆ isSouth()

◆ setLLCenter()

◆ setScaleFactor()

◆ setSouth()

◆ write()