Geo::OSR::SpatialReference Class Reference

Documentation of the underlying C++ class at www.gdal.org More...

List of all members.

Public Class Methods
Geo::OSR::SpatialReference	new (scalar wkt=undef)
Geo::OSR::SpatialReference	create (hash params)
Public Object Methods
Geo::OSR::SpatialReference	Clone ()
Geo::OSR::SpatialReference	CloneGeogCS ()
	Export (scalar format)
	Set (hash params)
scalar	IsSame (scalar rs)
scalar	IsSameGeogCS (scalar rs)
scalar	IsGeographic ()
scalar	IsProjected ()
scalar	IsLocal ()
scalar	IsCompound ()
scalar	IsGeocentric ()
scalar	IsVertical ()
scalar	IsSameVertCS (scalar rs)
scalar	GetAttrValue (scalar name, scalar child=0)
scalar	GetAngularUnits ()
scalar	GetLinearUnits ()
scalar	GetLinearUnitsName ()
scalar	GetAuthorityCode (scalar target_key)
scalar	GetAuthorityName (scalar target_key)
scalar	GetProjParm (scalar name, scalar default_val=0.0)
scalar	GetNormProjParm (scalar name, scalar default_val=0.0)
	CopyGeogCSFrom (scalar rhs)
	GetTOWGS84 ()
	GetInvFlattening ()
	GetSemiMinor ()
	GetSemiMajor ()
	GetUTMZone ()
	AutoIdentifyEPSG ()
	EPSGTreatsAsLatLong ()
	Validate ()
	StripCTParms ()
	FixupOrdering ()
	Fixup ()
	MorphToESRI ()
	MorphFromESRI ()
Public Attributes
list	PROJECTIONS
list	PARAMETERS

---

Detailed Description

Documentation of the underlying C++ class at www.gdal.org

---

Member Function Documentation

Geo::OSR::SpatialReference::AutoIdentifyEPSG

(

)

Set EPSG authority info if possible.

Geo::OSR::SpatialReference Geo::OSR::SpatialReference::Clone

(

)

Make a duplicate of this SpatialReference object.

Returns:

a new Geo::OSR::SpatialReference object

Geo::OSR::SpatialReference Geo::OSR::SpatialReference::CloneGeogCS

(

)

Make a duplicate of the GEOGCS node of this SpatialReference object.

Returns:

a new Geo::OSR::SpatialReference object

Geo::OSR::SpatialReference::CopyGeogCSFrom

(

scalar

rhs

)

Parameters:

rhs	Geo::OSR::SpatialReference

Geo::OSR::SpatialReference Geo::OSR::SpatialReference::create

(

hash

params

)

Create a new spatial reference object using a named parameter. This constructor recognizes the following key words (alternative in parenthesis): WKT (Text), Proj4, ESRI, EPSG, EPSGA, PCI, USGS, GML (XML), URL, ERMapper (ERM), MapInfoCS (MICoordSys). The value depends on the key.

• WKT: Well Known Text string
• Proj4: PROJ.4 string
• ESRI: reference to a list of strings (contents of ESRI .prj file)
• EPSG: EPSG code number
• EPSGA: EPSG code number (the resulting CS will have EPSG preferred axis ordering)
• PCI: listref: [PCI_projection_string, Grid_units_code, [17 cs parameters]]
• USGS: listref: [Projection_system_code, Zone, [15 cs parameters], Datum_code, Format_flag]
• GML: GML string
• URL: URL for downloading the spatial reference from
• ERMapper: listref: [Projection, Datum, Units]
• MapInfoCS: MapInfo style co-ordinate system definition

For more information, consult the import methods in OGR documentation.

Note:

ImportFrom* methods also exist but are not documented here.

Usage:

$sr = Geo::OSR::SpatialReference->create( key => value );

Returns:

a new Geo::OSR::SpatialReference object

Geo::OSR::SpatialReference::EPSGTreatsAsLatLong

(

)

Returns TRUE if EPSG feels this geographic coordinate system should be treated as having lat/long coordinate ordering.

Geo::OSR::SpatialReference::Export

(

scalar

format

)

Export the spatial reference to a selected format.

Note:

a.k.a. As

Parameters:

format

One of the following. The return value is explained after the format. Other arguments are explained in parenthesis. WKT (Text): Well Known Text string PrettyWKT: Well Known Text string nicely formatted (simplify) Proj4: PROJ.4 string PCI: a list: ($proj_string, $units, [$parms1, ...]) USGS: a list: ($code, $zone, [$parms1, ...], $datum) GML (XML): GML based string (dialect) MapInfoCS (MICoordSys): MapInfo style co-ordinate system definition

Note:

The named parameter syntax also works and is needed is those cases when other arguments need or may be given. The format should be given using key as, 'to' or 'format'.

ExportTo* and AsText methods also exist but are not documented here.

Returns:

a scalar or a list depending on the export format

Geo::OSR::SpatialReference::Fixup

(

)

Geo::OSR::SpatialReference::FixupOrdering

(

)

scalar Geo::OSR::SpatialReference::GetAngularUnits

(

)

Returns:

a number

scalar Geo::OSR::SpatialReference::GetAttrValue	(	scalar	name,
		scalar	child = 0
	)

Parameters:

name
child

Returns:

string

scalar Geo::OSR::SpatialReference::GetAuthorityCode

(

scalar

target_key

)

Parameters:

target_key

Returns:

string

scalar Geo::OSR::SpatialReference::GetAuthorityName

(

scalar

target_key

)

Parameters:

target_key

Returns:

string

Geo::OSR::SpatialReference::GetInvFlattening

(

)

scalar Geo::OSR::SpatialReference::GetLinearUnits

(

)

Returns:

a number

scalar Geo::OSR::SpatialReference::GetLinearUnitsName

(

)

Returns:

string

scalar Geo::OSR::SpatialReference::GetNormProjParm	(	scalar	name,
		scalar	default_val = 0.0
	)

Parameters:

name
default_val

Returns:

a number

scalar Geo::OSR::SpatialReference::GetProjParm	(	scalar	name,
		scalar	default_val = 0.0
	)

Parameters:

name
default_val

Returns:

a number

Geo::OSR::SpatialReference::GetSemiMajor

(

)

Geo::OSR::SpatialReference::GetSemiMinor

(

)

Geo::OSR::SpatialReference::GetTOWGS84

(

)

Returns:

array = ($p1, $p2, $p3, $p4, $p5, $p6, $p7)

Geo::OSR::SpatialReference::GetUTMZone

(

)

Get UTM zone information.

Returns:

The UTM zone (integer). In scalar context the returned value is negative for southern hemisphere zones. In list context returns two values ($zone, $north), where $zone is always non-negative and $north is true or false.

scalar Geo::OSR::SpatialReference::IsCompound

(

)

Returns:

boolean

scalar Geo::OSR::SpatialReference::IsGeocentric

(

)

Returns:

boolean

scalar Geo::OSR::SpatialReference::IsGeographic

(

)

Returns:

boolean

scalar Geo::OSR::SpatialReference::IsLocal

(

)

Returns:

boolean

scalar Geo::OSR::SpatialReference::IsProjected

(

)

Returns:

boolean

scalar Geo::OSR::SpatialReference::IsSame

(

scalar

rs

)

Parameters:

rs	a Geo::OSR::SpatialReference object

Returns:

boolean

scalar Geo::OSR::SpatialReference::IsSameGeogCS

(

scalar

rs

)

Parameters:

rs	a Geo::OSR::SpatialReference object

Returns:

boolean

scalar Geo::OSR::SpatialReference::IsSameVertCS

(

scalar

rs

)

Parameters:

rs	a Geo::OSR::SpatialReference object

Returns:

boolean

scalar Geo::OSR::SpatialReference::IsVertical

(

)

Returns:

boolean

Geo::OSR::SpatialReference::MorphFromESRI

(

)

Geo::OSR::SpatialReference::MorphToESRI

(

)

Geo::OSR::SpatialReference Geo::OSR::SpatialReference::new

(

scalar

wkt = undef

)

Parameters:

wkt	well known text

Returns:

a new Geo::OSR::SpatialReference object

Geo::OSR::SpatialReference::Set

(

hash

params

)

Set a parameter or parameters in the spatial reference object.

Parameters:

params

Named parameters. Recognized keys and respective values are the following. Authority: authority name Node: partial or complete path to the target node AngularUnits: angular units for the geographic coordinate system LinearUnits: linear units for the target node or the object CoordinateSystem: 'UTM', 'State Plane', 'WGS' or a user visible name Zone: zone for setting up UTM or State Plane coordinate systems (State Plane zone in USGS numbering scheme) Projection: one from @Geo::OSR::PROJECTIONS Parameter: one from @Geo::OSR::PARAMETERS Code: code for value with an authority Value: value to be assigned to a node, the projection or the object Normalized: set to true to indicate that the Value argument is in "normalized" form Parameters: a reference to a list containing the projection parameters Name: Transverse Mercator variant name or a well known name (e.g. WGS84) GuessFrom: tries to guess from given text North: set false for southern hemisphere NAD83: set false if the NAD27 zone definition should be used instead of NAD83 UnitName: to override the legal definition for a zone UnitConversionFactor: to override the legal definition for a zone LOCAL_CS: local cs name Datum: a known (OGC or EPSG) name Spheroid: user visible name GeocentricCS: Geocentric coorinate system name HorizontalCS: Horizontal coordinate system name VerticalCS: Vertical coordinate system name (setting requires Datum)

Note:

Numerous Set* methods also exist but are not documented here.

Geo::OSR::SpatialReference::StripCTParms

(

)

Geo::OSR::SpatialReference::Validate

(

)

---

Member Data Documentation

list Geo::OSR::SpatialReference::PARAMETERS

Some projection parameters known to GDAL

list Geo::OSR::SpatialReference::PROJECTIONS

Projections known to GDAL

---

The documentation for this class was generated from the following file:

• lib/Geo/OSR.pm