A spatial reference system. More...

Inheritance diagram for Geo::OSR::SpatialReference:

Collaboration diagram for Geo::OSR::SpatialReference:

Public Member Functions
public method	As ()

public method	AutoIdentifyEPSG ()

public Geo::OSR::SpatialReference	Clone ()

public Geo::OSR::SpatialReference	CloneGeogCS ()

public method	CopyGeogCSFrom (scalar rhs)

public method	EPSGTreatsAsLatLong ()

public method	EPSGTreatsAsNorthingEasting ()

public method	Export (scalar format)

public method	Fixup ()

public method	FixupOrdering ()

public scalar	GetAngularUnits ()

public scalar	GetAttrValue (scalar name, scalar child=0)

public scalar	GetAuthorityCode (scalar target_key)

public scalar	GetAuthorityName (scalar target_key)

public method	GetInvFlattening ()

public scalar	GetLinearUnits ()

public scalar	GetLinearUnitsName ()

public scalar	GetNormProjParm (scalar name, scalar default_val=0.0)

public scalar	GetProjParm (scalar name, scalar default_val=0.0)

public method	GetSemiMajor ()

public method	GetSemiMinor ()

public method	GetTOWGS84 ()

public method	GetUTMZone ()

public method	ImportFromOzi ()

public scalar	IsCompound ()

public scalar	IsGeocentric ()

public scalar	IsGeographic ()

public scalar	IsLocal ()

public scalar	IsProjected ()

public scalar	IsSame (scalar rs)

public scalar	IsSameGeogCS (scalar rs)

public scalar	IsSameVertCS (scalar rs)

public scalar	IsVertical ()

public method	MorphFromESRI ()

public method	MorphToESRI ()

public method	Set (hash params)

public method	StripCTParms ()

public method	Validate ()

public Geo::OSR::SpatialReference	new (hash params)

Public Member Functions inherited from Geo::OSR
public list	AngularUnits ()

public method	CreateCoordinateTransformation ()

public list	Datums ()

public list	GetProjectionMethodParamInfo (scalar projection, scalar parameter)

public list	GetProjectionMethodParameterList (scalar projection)

public array reference	GetProjectionMethods ()

public scalar	GetUserInputAsWKT (scalar name)

public scalar	GetWellKnownGeogCSAsWKT (scalar name)
	Get well known geographic coordinate system as WKT. More...

public list	LinearUnits ()

public list	Parameters ()

public list	Projections ()

public method	SRS_PM_GREENWICH ()

public method	SRS_WGS84_INVFLATTENING ()

public method	SRS_WGS84_SEMIMAJOR ()

public method	SRS_WKT_WGS84 ()

Detailed Description

A spatial reference system.

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

Definition at line 12476 of file all.pm.

Member Function Documentation

public method Geo::OSR::SpatialReference::As ( )

Code:

click to view

public method Geo::OSR::SpatialReference::AutoIdentifyEPSG ( )

Set EPSG authority info if possible.

Code:

click to view

public Geo::OSR::SpatialReference Geo::OSR::SpatialReference::Clone ( )

Make a duplicate of this SpatialReference object.

Returns: a new Geo::OSR::SpatialReference object

Code:

click to view

public 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

Code:

click to view

public method Geo::OSR::SpatialReference::CopyGeogCSFrom ( scalar rhs )

Parameters

rhs	Geo::OSR::SpatialReference

Code:

click to view

public method Geo::OSR::SpatialReference::EPSGTreatsAsLatLong ( )

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

Code:

click to view

public method Geo::OSR::SpatialReference::EPSGTreatsAsNorthingEasting ( )

Code:

click to view

public method 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

Code:

click to view

public method Geo::OSR::SpatialReference::Fixup ( )

Code:

click to view

public method Geo::OSR::SpatialReference::FixupOrdering ( )

Code:

click to view

public scalar Geo::OSR::SpatialReference::GetAngularUnits ( )

Returns: a number

Code:

click to view

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

Parameters

name
child

Returns: string

Code:

click to view

public scalar Geo::OSR::SpatialReference::GetAuthorityCode ( scalar target_key )

Parameters

target_key

Returns: string

Code:

click to view

public scalar Geo::OSR::SpatialReference::GetAuthorityName ( scalar target_key )

Parameters

target_key

Returns: string

Code:

click to view

public method Geo::OSR::SpatialReference::GetInvFlattening ( )

Code:

click to view

public scalar Geo::OSR::SpatialReference::GetLinearUnits ( )

Returns: a number

Code:

click to view

public scalar Geo::OSR::SpatialReference::GetLinearUnitsName ( )

Returns: string

Code:

click to view

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

Parameters

name
default_val

Returns: a number

Code:

click to view

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

Parameters

name
default_val

Returns: a number

Code:

click to view

public method Geo::OSR::SpatialReference::GetSemiMajor ( )

Code:

click to view

public method Geo::OSR::SpatialReference::GetSemiMinor ( )

Code:

click to view

public method Geo::OSR::SpatialReference::GetTOWGS84 ( )

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

Code:

click to view

public method 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.

Code:

click to view

public method Geo::OSR::SpatialReference::ImportFromOzi ( )

Code:

click to view

public scalar Geo::OSR::SpatialReference::IsCompound ( )

Returns: boolean

Code:

click to view

public scalar Geo::OSR::SpatialReference::IsGeocentric ( )

Returns: boolean

Code:

click to view

public scalar Geo::OSR::SpatialReference::IsGeographic ( )

Returns: boolean

Code:

click to view

public scalar Geo::OSR::SpatialReference::IsLocal ( )

Returns: boolean

Code:

click to view

public scalar Geo::OSR::SpatialReference::IsProjected ( )

Returns: boolean

Code:

click to view

public scalar Geo::OSR::SpatialReference::IsSame ( scalar rs )

Parameters

rs	a Geo::OSR::SpatialReference object

Returns: boolean

Code:

click to view

public scalar Geo::OSR::SpatialReference::IsSameGeogCS ( scalar rs )

Parameters

rs	a Geo::OSR::SpatialReference object

Returns: boolean

Code:

click to view

public scalar Geo::OSR::SpatialReference::IsSameVertCS ( scalar rs )

Parameters

rs	a Geo::OSR::SpatialReference object

Returns: boolean

Code:

click to view

public scalar Geo::OSR::SpatialReference::IsVertical ( )

Returns: boolean

Code:

click to view

public method Geo::OSR::SpatialReference::MorphFromESRI ( )

Code:

click to view

public method Geo::OSR::SpatialReference::MorphToESRI ( )

Code:

click to view

public Geo::OSR::SpatialReference Geo::OSR::SpatialReference::new ( hash params )

Class method. 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->new( key => value );

Returns: a new Geo::OSR::SpatialReference object

Code:

click to view

public method 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 (give also TargetKey, Node and Code)
TargetKey:
Node: partial or complete path to the target node (Node and Value together sets an attribute value)
Code: code for value with an authority
Value: value to be assigned to a node, a projection parameter or an object
AngularUnits: angular units for the geographic coordinate system (give also Value) (one of Geo::OSR::LinearUnits)
LinearUnits: linear units for the target node or the object (give also Value and optionally Node) (one of Geo::OSR::LinearUnits)
Parameter: projection parameter to set (give also Value and Normalized) (one of Geo::OSR::Parameters)
Normalized: set to true to indicate that the Value argument is in "normalized" form
Name: a well known name of a geographic coordinate system (e.g. WGS84)
GuessFrom: arbitrary text that specifies a projection ("user input")
LOCAL_CS: name of a local coordinate system
GeocentricCS: name of a geocentric coordinate system
VerticalCS: name of a vertical coordinate system (give also Datum and optionally VertDatumType [default is 2005])
Datum: a known (OGC or EPSG) name (or(?) one of Geo::OSR::Datums)
CoordinateSystem: 'WGS', 'UTM', 'State Plane', or a user visible name (give optionally also Parameters, Zone, North, NAD83, UnitName, UnitConversionFactor, Datum, Spheroid, HorizontalCS, and/or VerticalCS
Parameters: a reference to a list containing the coordinate system or projection parameters
Zone: zone for setting up UTM or State Plane coordinate systems (State Plane zone in USGS numbering scheme)
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
Spheroid: user visible name
HorizontalCS: Horizontal coordinate system name
Projection: name of a projection, one of Geo::OSR::Projections (give also optionally Parameters and Variant)

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

Code:

click to view

# Number of lines of code in Set: 151
sub Set {
    my($self, %params) = @_;
    if (exists $params{Authority} and exists $params{TargetKey} and exists $params{Node} and exists $params{Code}) {
        SetAuthority($self, $params{TargetKey}, $params{Authority}, $params{Code});
    } elsif (exists $params{Node} and exists $params{Value}) {
        SetAttrValue($self, $params{Node}, $params{Value});
    } elsif (exists $params{AngularUnits} and exists $params{Value}) {
        SetAngularUnits($self, $params{AngularUnits}, $params{Value});
    } elsif (exists $params{LinearUnits} and exists $params{Node} and exists $params{Value}) {
        SetTargetLinearUnits($self, $params{Node}, $params{LinearUnits}, $params{Value});
    } elsif (exists $params{LinearUnits} and exists $params{Value}) {
        SetLinearUnitsAndUpdateParameters($self, $params{LinearUnits}, $params{Value});
    } elsif ($params{Parameter} and exists $params{Value}) {
        croak "Unknown projection parameter '$params{Parameter}'." unless exists $Geo::OSR::PARAMETERS{$params{Parameter}};
        $params{Normalized} ?
            SetNormProjParm($self, $params{Parameter}, $params{Value}) :
            SetProjParm($self, $params{Parameter}, $params{Value});
    } elsif ($params{Name}) {
        SetWellKnownGeogCS($self, $params{Name});
    } elsif ($params{GuessFrom}) {
        SetFromUserInput($self, $params{GuessFrom});
    } elsif ($params{LOCAL_CS}) {
        SetLocalCS($self, $params{LOCAL_CS});
    } elsif ($params{GeocentricCS}) {
        SetGeocCS($self, $params{GeocentricCS});
    } elsif ($params{VerticalCS} and $params{Datum}) {
        my $type = $params{VertDatumType} || 2005;
        SetVertCS($self, $params{VerticalCS}, $params{Datum}, $type);
    } elsif ($params{CoordinateSystem}) {
        my @parameters = ();
        @parameters = @{$params{Parameters}} if ref($params{Parameters});
        if ($params{CoordinateSystem} eq 'State Plane' and exists $params{Zone}) {
            my $NAD83 = exists $params{NAD83} ? $params{NAD83} : 1;
            my $name = exists $params{UnitName} ? $params{UnitName} : undef;
            my $c = exists $params{UnitConversionFactor} ? $params{UnitConversionFactor} : 0.0;
            SetStatePlane($self, $params{Zone}, $NAD83, $name, $c);
        } elsif ($params{CoordinateSystem} eq 'UTM' and exists $params{Zone} and exists $params{North}) {
            my $north = exists $params{North} ? $params{North} : 1;
            SetUTM($self, $params{Zone}, $north);
        } elsif ($params{CoordinateSystem} eq 'WGS') {
            SetTOWGS84($self, @parameters);
        } elsif ($params{CoordinateSystem} and $params{Datum} and $params{Spheroid}) {
            SetGeogCS($self, $params{CoordinateSystem}, $params{Datum}, $params{Spheroid}, @parameters);
        } elsif ($params{CoordinateSystem} and $params{HorizontalCS} and $params{VerticalCS}) {
            SetCompoundCS($self, $params{CoordinateSystem}, $params{HorizontalCS}, $params{VerticalCS});
        } else {
            SetProjCS($self, $params{CoordinateSystem});
        }
    } elsif ($params{Projection}) {
        confess "Unknown projection." unless exists $Geo::OSR::PROJECTIONS{$params{Projection}};
        my @parameters = ();
        @parameters = @{$params{Parameters}} if ref($params{Parameters});
        if ($params{Projection} eq 'Albers_Conic_Equal_Area') {
            SetACEA($self, @parameters);
        } elsif ($params{Projection} eq 'Azimuthal_Equidistant') {
            SetAE($self, @parameters);
        } elsif ($params{Projection} eq 'Bonne') {
            SetBonne($self, @parameters);
        } elsif ($params{Projection} eq 'Cylindrical_Equal_Area') {
            SetCEA($self, @parameters);
        } elsif ($params{Projection} eq 'Cassini_Soldner') {
            SetCS($self, @parameters);
        } elsif ($params{Projection} eq 'Equidistant_Conic') {
            SetEC($self, @parameters);
            # Eckert_I, Eckert_II, Eckert_III, Eckert_V ?
        } elsif ($params{Projection} eq 'Eckert_IV') {
            SetEckertIV($self, @parameters);
        } elsif ($params{Projection} eq 'Eckert_VI') {
            SetEckertVI($self, @parameters);
        } elsif ($params{Projection} eq 'Equirectangular') {
            @parameters == 4 ?
                SetEquirectangular($self, @parameters) :
                SetEquirectangular2($self, @parameters);
        } elsif ($params{Projection} eq 'Gauss_Schreiber_Transverse_Mercator') {
            SetGaussSchreiberTMercator($self, @parameters);
        } elsif ($params{Projection} eq 'Gall_Stereographic') {
            SetGS($self, @parameters);
        } elsif ($params{Projection} eq 'Goode_Homolosine') {
            SetGH($self, @parameters);
        } elsif ($params{Projection} eq 'Interrupted_Goode_Homolosine') {
            SetIGH($self);
        } elsif ($params{Projection} eq 'Geostationary_Satellite') {
            SetGEOS($self, @parameters);
        } elsif ($params{Projection} eq 'Gnomonic') {
            SetGnomonic($self, @parameters);
        } elsif ($params{Projection} eq 'Hotine_Oblique_Mercator') {
            # Hotine_Oblique_Mercator_Azimuth_Center ?
            SetHOM($self, @parameters);
        } elsif ($params{Projection} eq 'Hotine_Oblique_Mercator_Two_Point_Natural_Origin') {
            SetHOM2PNO($self, @parameters);
        } elsif ($params{Projection} eq 'Krovak') {
            SetKrovak($self, @parameters);
        } elsif ($params{Projection} eq 'Lambert_Azimuthal_Equal_Area') {
            SetLAEA($self, @parameters);
        } elsif ($params{Projection} eq 'Lambert_Conformal_Conic_2SP') {
            SetLCC($self, @parameters);
        } elsif ($params{Projection} eq 'Lambert_Conformal_Conic_1SP') {
            SetLCC1SP($self, @parameters);
        } elsif ($params{Projection} eq 'Lambert_Conformal_Conic_2SP_Belgium') {
            SetLCCB($self, @parameters);
        } elsif ($params{Projection} eq 'miller_cylindrical') {
            SetMC($self, @parameters);
        } elsif ($params{Projection} =~ /^Mercator/) {
            # Mercator_1SP, Mercator_2SP, Mercator_Auxiliary_Sphere ?
            # variant is in Variant (or Name)
            SetMercator($self, @parameters);
        } elsif ($params{Projection} eq 'Mollweide') {
            SetMollweide($self, @parameters);
        } elsif ($params{Projection} eq 'New_Zealand_Map_Grid') {
            SetNZMG($self, @parameters);
        } elsif ($params{Projection} eq 'Oblique_Stereographic') {
            SetOS($self, @parameters);
        } elsif ($params{Projection} eq 'Orthographic') {
            SetOrthographic($self, @parameters);
        } elsif ($params{Projection} eq 'Polyconic') {
            SetPolyconic($self, @parameters);
        } elsif ($params{Projection} eq 'Polar_Stereographic') {
            SetPS($self, @parameters);
        } elsif ($params{Projection} eq 'Robinson') {
            SetRobinson($self, @parameters);
        } elsif ($params{Projection} eq 'Sinusoidal') {
            SetSinusoidal($self, @parameters);
        } elsif ($params{Projection} eq 'Stereographic') {
            SetStereographic($self, @parameters);
        } elsif ($params{Projection} eq 'Swiss_Oblique_Cylindrical') {
            SetSOC($self, @parameters);
        } elsif ($params{Projection} eq 'Transverse_Mercator_South_Orientated') {
            SetTMSO($self, @parameters);
        } elsif ($params{Projection} =~ /^Transverse_Mercator/) {
            my($variant) = $params{Projection} =~ /^Transverse_Mercator_(\w+)/;
            $variant = $params{Variant} unless $variant;
            $variant = $params{Name} unless $variant;
            $variant ?
                SetTMVariant($self, $variant, @parameters) :
                SetTM($self, @parameters);
        } elsif ($params{Projection} eq 'Tunisia_Mining_Grid') {
            SetTMG($self, @parameters);
        } elsif ($params{Projection} eq 'VanDerGrinten') {
            SetVDG($self, @parameters);
        } else {
            # Aitoff, Craster_Parabolic, International_Map_of_the_World_Polyconic, Laborde_Oblique_Mercator
            # Loximuthal, Miller_Cylindrical, Quadrilateralized_Spherical_Cube, Quartic_Authalic, Two_Point_Equidistant
            # Wagner_I, Wagner_II, Wagner_III, Wagner_IV, Wagner_V, Wagner_VI, Wagner_VII
            # Winkel_I, Winkel_II, Winkel_Tripel
            # ?
            SetProjection($self, $params{Projection});
        }
    } else {
        confess "Not enough information for a spatial reference object.";
    }
}

public method Geo::OSR::SpatialReference::StripCTParms ( )

Code:

click to view

public method Geo::OSR::SpatialReference::Validate ( )

Code:

click to view

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

all.pm

Public Member Functions

Detailed Description

Member Function Documentation