ProjectedSpatialReferenceSystem Class

Summary: Projected SRS is a result of application a projection to geographic SRS.
A projected SRS can be two dimensional or three dimensional.
If projected SRS is three dimensional, then it is actually a compound SRS of two dimensional projected SRS and one dimensional vertical SRS.

Module: aspose.gis.spatialreferencing

Full Name: aspose.gis.spatialreferencing.ProjectedSpatialReferenceSystem

Inheritance: SpatialReferenceSystem

Aspose.PSD Version: 25.9.0

Properties

Name	Type	Access	Description
angular_unit	Unit	r	Unit, that is used for angular values in this SRS and for angular parameters of ProjectedSpatialReferenceSystem.projection. Matches angular unit of ProjectedSpatialReferenceSystem.base.
as_compound	CompoundSpatialReferenceSystem	r	Returns this SRS converted to CompoundSpatialReferenceSystem. Use SpatialReferenceSystem.is_compound to find out if conversion is possible.
as_geocentric	GeocentricSpatialReferenceSystem	r	Returns this SRS converted to GeocentricSpatialReferenceSystem. Use SpatialReferenceSystem.type to find out if conversion is possible.
as_geographic	GeographicSpatialReferenceSystem	r	Returns this SRS converted to GeographicSpatialReferenceSystem. Use SpatialReferenceSystem.type to find out if conversion is possible.
as_local	LocalSpatialReferenceSystem	r	Returns this SRS converted to LocalSpatialReferenceSystem. Use SpatialReferenceSystem.type to find out if conversion is possible.
as_projected	ProjectedSpatialReferenceSystem	r	Return this.
as_vertical	VerticalSpatialReferenceSystem	r	Returns this SRS converted to VerticalSpatialReferenceSystem. Use SpatialReferenceSystem.type to find out if conversion is possible.
axises_order	ProjectedAxisesOrder	r	Order of axises in this SRS. If this SRS is not valid and has wrong axises directions, ProjectedAxisesOrder.INVALID is returned.
base	GeographicSpatialReferenceSystem	r	Geographic SRS to which ProjectedSpatialReferenceSystem.projection was applied to get this SRS.
dimensions_count	int	r	Returns dimensions count in this SRS. For projected SRS this can be: two - if this is single projected SRS. three - if this is compound SRS, which consists of single, two dimensional, projected SRS and vertical SRS, that adds third dimension.
epsg_code	int	r	If this objects identifier is EPSG identifier - return its code. Otherwise - return -1.
etrs89 [static]	GeographicSpatialReferenceSystem	r	ETRS 89 (EPSG:4258) spatial reference system.
etrs_89_lambert_azimuthal_equal_area [static]	ProjectedSpatialReferenceSystem	r	ETRS 89 / ETRS Lambert Azimuthal Equal Area (EPSG:3035) spatial reference system.
etrs_89_lambert_conformal_conic [static]	ProjectedSpatialReferenceSystem	r	ETRS 89 / Lambert Conformal Conic (EPSG:3034) spatial reference system.
geographic_datum	GeographicDatum	r	Returns geographic datum of this SRS.
has_geographic_datum	bool	r	Returns true, since projected SRS always have prime meridian.
has_prime_meridian	bool	r	Returns true, since projected SRS always have prime meridian.
identifier	Identifier	r	Identifier of this identifiable object.
is_compound	bool	r	Returns whether this SRS is compound (a union of two SRS). Following combinations of SRS in compound SRS are considered valid: Geographic SRS + Vertical SRS, in this case type of compound SRS will be SpatialReferenceSystemType.GEOGRAPHIC. Projected SRS + Vertical SRS, in this case type of compound SRS will be SpatialReferenceSystemType.PROJECTED. If combination of SRSs differs, type of compound SRS will be SpatialReferenceSystemType.UNKNOWN.
is_single	bool	r	Returns whether this SRS is single (not a union of two SRS).
is_valid	bool	r	Same as , but don’t return error message.
linear_unit	Unit	r	Unit, that is used for linear dimensions in this SRS and for linear parameters of ProjectedSpatialReferenceSystem.projection.
nad83 [static]	GeographicSpatialReferenceSystem	r	NAD 83 (EPSG:4269) spatial reference system.
name	string	r	Name of this object.
osgb36 [static]	GeographicSpatialReferenceSystem	r	OSGB 36 (EPSG:4277) spatial reference system.
osgb_36_british_national_grid [static]	ProjectedSpatialReferenceSystem	r	OSGB 36 / British National Grid (EPSG:27700) spatial reference system.
prime_meridian	PrimeMeridian	r	Returns prime meridian of this SRS.
projection	Projection	r	Projection, that was applied to ProjectedSpatialReferenceSystem.base to get this SRS.
type	SpatialReferenceSystemType	r	Returns SpatialReferenceSystemType.PROJECTED.
web_mercator [static]	ProjectedSpatialReferenceSystem	r	Web Mercator (EPSG:3857) spatial reference system.
wgs72 [static]	GeographicSpatialReferenceSystem	r	WGS 72 (EPSG:4322) spatial reference system.
wgs84 [static]	GeographicSpatialReferenceSystem	r	WGS 84 (EPSG:4326) spatial reference system.

Methods

Name	Description
create_compound(name, head, tail, identifier)	Create compound SRS.
create_from_epsg(epsg)	Create a spatial reference system based the specified EPSG code.
create_from_wkt(wkt)	Creates a new SpatialReferenceSystem based on WKT (Well-Known Text) string.
create_geocentric(parameters, identifier)	Create geocentric SRS from custom parameters.
create_geographic(parameters, identifier)	Create geographic SRS from custom parameters.
create_local(name, datum, unit, axises, identifier)	Create local Spatial Reference System.
create_projected(parameters, identifier)	Create projected SRS from custom parameters.
create_transformation_to(target_srs)	Creates transformation from this SpatialReferenceSystem to another SpatialReferenceSystem.
create_vertical(name, vertical_datum, vertical_unit, vertical_axis, identifier)	Create vertical SRS.
export_to_wkt()	Returns representation of this SRS as WKT string. The result WKT string will match OGC 01-009 specification, usually named “WKT1”.
get_axis(dimension)	Get Axis that describes dimension.
get_unit(dimension)	Get Unit of dimension.
is_equivalent(other)	Detects whether this SRS is equivalent to other SRS. SpatialReferenceSystem.is_equivalent(srs1, srs2).
is_equivalent(srs1, srs2)	Determines if two SRS are equivalent. Same coordinates of equivalent SRS match same place on Earth. Some parameters of equivalent SRS can be different, for example IdentifiableObject.name.
try_create_from_epsg(epsg, value)	Create a spatial reference system based the specified EPSG code.
try_create_from_wkt(wkt, value)	Creates a new SpatialReferenceSystem based on WKT (Well-Known Text) string.
try_create_transformation_to(target_srs, value)	Creates transformation from this SpatialReferenceSystem to another SpatialReferenceSystem.
validate(error_message)	Determine if this SRS is valid.

Method: create_compound(name, head, tail, identifier) [static]

 create_compound(name, head, tail, identifier) 

Create compound SRS.

Parameters:

Parameter	Type	Description
name	string	Name of new SRS.
head	SpatialReferenceSystem	Head SRS of new SRS.
tail	SpatialReferenceSystem	Tail SRS of new SRS.
identifier	Identifier	Identifier, that will be attached to SRS. Attaching an Identifier will not modify other SRS parameters. Its up to you to ensure consistency of identifier and SRS parameters.

Returns

Type	Description
CompoundSpatialReferenceSystem	New Compound SRS.

Method: create_from_epsg(epsg) [static]

 create_from_epsg(epsg) 

Create a spatial reference system based the specified EPSG code.

Parameters:

Parameter	Type	Description
epsg	int	EPSG code of the spatial reference system.

Returns

Type	Description
SpatialReferenceSystem	A new spatial reference system with the specified EPSG code.

Method: create_from_wkt(wkt) [static]

 create_from_wkt(wkt) 

Creates a new SpatialReferenceSystem based on WKT (Well-Known Text) string.

Parameters:

Parameter	Type	Description
wkt	string	WKT string.

Returns

Type	Description
SpatialReferenceSystem	New SpatialReferenceSystem.

Method: create_geocentric(parameters, identifier) [static]

 create_geocentric(parameters, identifier) 

Create geocentric SRS from custom parameters.

Parameters:

Parameter	Type	Description
parameters	GeocentricSpatialReferenceSystemParameters	Parameters to create from.
identifier	Identifier	Identifier, that will be attached to SRS. Attaching an Identifier will not modify other SRS parameters. Its up to you to ensure consistency of identifier and SRS parameters.

Returns

Type	Description
GeocentricSpatialReferenceSystem	New Geocentric SRS.

Method: create_geographic(parameters, identifier) [static]

 create_geographic(parameters, identifier) 

Create geographic SRS from custom parameters.

Parameters:

Parameter	Type	Description
parameters	GeographicSpatialReferenceSystemParameters	Parameters to create from.
identifier	Identifier	Identifier, that will be attached to SRS. Attaching an Identifier will not modify other SRS parameters. Its up to you to ensure consistency of identifier and SRS parameters.

Returns

Type	Description
GeographicSpatialReferenceSystem	New Geographic SRS.

Method: create_local(name, datum, unit, axises, identifier) [static]

 create_local(name, datum, unit, axises, identifier) 

Create local Spatial Reference System.

Parameters:

Parameter	Type	Description
name	string	Name of Spatial Reference System.
datum	LocalDatum	Datum to be used in SRS.
unit	Unit	Unit to be used in SRS.
axises	System.Collections.Generic.ICollection	Axises to be used in SRS. Must be non empty
identifier	Identifier	Identifier, that will be attached to SRS. Attaching an Identifier will not modify other SRS parameters. Its up to you to ensure consistency of identifier and SRS parameters.

Returns

Type	Description
LocalSpatialReferenceSystem	New Local Spatial Reference System.

Method: create_projected(parameters, identifier) [static]

 create_projected(parameters, identifier) 

Create projected SRS from custom parameters.

Parameters:

Parameter	Type	Description
parameters	ProjectedSpatialReferenceSystemParameters	Parameters to create from.
identifier	Identifier	Identifier, that will be attached to SRS. Attaching an Identifier will not modify other SRS parameters. Its up to you to ensure consistency of identifier and SRS parameters.

Returns

Type	Description
ProjectedSpatialReferenceSystem	New Projected SRS.

Method: create_transformation_to(target_srs)

 create_transformation_to(target_srs) 

Creates transformation from this SpatialReferenceSystem to another SpatialReferenceSystem.

Parameters:

Parameter	Type	Description
target_srs	SpatialReferenceSystem	Another SpatialReferenceSystem.

Returns

Type	Description
SpatialReferenceSystemTransformation	Transformation from this SpatialReferenceSystem to another SpatialReferenceSystem.

Method: create_vertical(name, vertical_datum, vertical_unit, vertical_axis, identifier) [static]

 create_vertical(name, vertical_datum, vertical_unit, vertical_axis, identifier) 

Create vertical SRS.

Parameters:

Parameter	Type	Description
name	string	Name of SRS. If .
vertical_datum	VerticalDatum	Datum to be used in SRS.
vertical_unit	Unit	Unit to be used in SRS. If , Unit.meter will be used.
vertical_axis	Axis	Axis with “up” or “down” direction, to be used in SRS. If , axis with up direction will be used.
identifier	Identifier	Identifier, that will be attached to SRS. Attaching an Identifier will not modify other SRS parameters. Its up to you to ensure consistency of identifier and SRS parameters.

Returns

Type	Description
VerticalSpatialReferenceSystem	New Vertical SRS.

Method: export_to_wkt()

 export_to_wkt() 

Returns representation of this SRS as WKT string.
The result WKT string will match OGC 01-009 specification, usually named “WKT1”.

Returns

Type	Description
string	WKT representation of this SRS.

Method: get_axis(dimension)

 get_axis(dimension) 

Get Axis that describes dimension.

Parameters:

Parameter	Type	Description
dimension	int	Number of dimension.

Returns

Type	Description
Axis	Axis that describes dimension.

Method: get_unit(dimension)

 get_unit(dimension) 

Get Unit of dimension.

Parameters:

Parameter	Type	Description
dimension	int	Number of dimension.

Returns

Type	Description
Unit	Unit of dimension.

Method: is_equivalent(other)

 is_equivalent(other) 

Detects whether this SRS is equivalent to other SRS. SpatialReferenceSystem.is_equivalent(srs1, srs2).

Parameters:

Parameter	Type	Description
other	SpatialReferenceSystem	Other SRS.

Returns

Type	Description
bool	bool value, indicating whether this SRS is equivalent to other SRS.

Method: is_equivalent(srs1, srs2) [static]

 is_equivalent(srs1, srs2) 

Determines if two SRS are equivalent.
Same coordinates of equivalent SRS match same place on Earth.
Some parameters of equivalent SRS can be different, for example IdentifiableObject.name.

Parameters:

Parameter	Type	Description
srs1	SpatialReferenceSystem	First SRS.
srs2	SpatialReferenceSystem	Second SRS.

Returns

Type	Description
bool	bool value, indicating whether two SRS are equivalent.

Method: try_create_from_epsg(epsg, value) [static]

 try_create_from_epsg(epsg, value) 

Create a spatial reference system based the specified EPSG code.

Parameters:

Parameter	Type	Description
epsg	int	EPSG code of the spatial reference system.
value	SpatialReferenceSystem[]	When this methods returns , contains a SRS with the specified EPSG code; otherwise, contains .

Returns

Type	Description
bool	if specified EPSG code is known and SRS was created; otherwise.

Method: try_create_from_wkt(wkt, value) [static]

 try_create_from_wkt(wkt, value) 

Creates a new SpatialReferenceSystem based on WKT (Well-Known Text) string.

Parameters:

Parameter	Type	Description
wkt	string	WKT string.
value	SpatialReferenceSystem[]	When this methods returns , contains an SRS created from WKT; otherwise, contains .

Returns

Type	Description
bool	if SRS was successfully created; otherwise.

Method: try_create_transformation_to(target_srs, value)

 try_create_transformation_to(target_srs, value) 

Creates transformation from this SpatialReferenceSystem to another SpatialReferenceSystem.

Parameters:

Parameter	Type	Description
target_srs	SpatialReferenceSystem	Another SpatialReferenceSystem.
value	SpatialReferenceSystemTransformation[]	When this methods returns , contains a transformation; otherwise, contains .

Returns

Type	Description
bool	Transformation from this SpatialReferenceSystem to another SpatialReferenceSystem.

Method: validate(error_message)

 validate(error_message) 

Determine if this SRS is valid.

Parameters:

Parameter	Type	Description
error_message	String	If method return , then this is description of invalidity.

Returns

Type	Description
bool	if SRS is valid, otherwise.