Changes between Version 3 and Version 4 of GeoDjangoDatabaseAPI

Timestamp:

Oct 8, 2007, 1:21:57 PM (17 years ago)

Author:

jbronn

Comment:

--

GeoDjangoDatabaseAPI

@@ -99 +99 @@
 
 = Extra Instance Methods =
-
-A model with geometry fields will get the following methods, substitute {{{GEOM}}} with the name of the geometry field.
-
-'''Update:''' All of the extra instance methods below (except {{{get_GEOM_ogr}}} and {{{get_GEOM_srs}}}) have been deprecated in r5657 due to lazy geometry support.  In other words, these properties may be directly accessed as attributes from the geometry field.  As part of the deprecation process, [http://docs.python.org/lib/module-warnings.html warnings] are issued when such methods are invoked so that users have notice to change their code before these methods disappear in the future.
-
-== get_GEOM_ogr ==
-Returns a {{{OGRGeometry}}} instance for the geometry.  For example, using the {{{Zip}}} model, as above:
-
-{{{
-#!python
->>> from django.contrib.gis.gdal import OGRGeometry # Where to import from
->>> z = Zip.objects.get(code='77096')
->>> geom = z.get_poly_ogr()
->>> print geom
-POLYGON(( 10 10, 10 20, 20 20, 20 15, 10 10))
->>> for ring in poly:
-...    print ring
-...    for point in ring:
-...        print point
-...
-LINEARRING (10 10,10 20,20 20,20 15,10 10)
-(10.0, 10.0)
-(10.0, 20.0)
-(20.0, 20.0)
-(20.0, 15.0)
-(10.0, 10.0)
-}}}
-
-== get_GEOM_srs ==
-
-Returns the OGR {{{SpatialReference}}} object for this geometry.
-
-{{{
-#!python
->>> from django.contrib.gis.gdal import SpatialReference # Where these related classes reside
->>> z = Zip.objects.get(code='77096')
->>> srs = z.get_poly_srs()
->>> print srs
-GEOGCS["WGS 84",
-    DATUM["WGS_1984",
-        SPHEROID["WGS 84",6378137,298.257223563,
-            AUTHORITY["EPSG","7030"]],
-        TOWGS84[0,0,0,0,0,0,0],
-        AUTHORITY["EPSG","6326"]],
-    PRIMEM["Greenwich",0,
-        AUTHORITY["EPSG","8901"]],
-    UNIT["degree",0.01745329251994328,
-        AUTHORITY["EPSG","9122"]],
-    AUTHORITY["EPSG","4326"]]
->>> print srs.semi_major, srs.semi_minor, srs.inverse_flattening
-6378137.0 6356752.31425 298.257223563
->>> print srs.geographic
-True
-}}}
-
-== get_GEOM_geos ==
-'''Update:''' This extra instance method was deprecated in r5657 -- and may now be accessed directly through the attribute name of the geometry field -- ''e.g.'', {{{dist.poly}}} returns a {{{GEOSGeometry}}} instance for the {{{PolygonField}}} of the {{{District}}} model.
-
-Returns a {{{GEOSGeometry}}} instance for the geometry.  For example (using the {{{District}}} model from the [wiki:GeoDjango#Example example]):
-
-{{{
-#!python
->>> from django.contrib.gis.geos import GEOSGeometry # Where to import from
->>> dist = District.objects.get(name='Houston ISD')
->>> geom = dist.get_poly_geos()
->>> print geom.centroid.wkt
-POINT(-95.231713 29.723235)
->>> print geom.area
-0.08332
->>> print geom.geom_type
-Polygon
->>> print geom.centroid.geom_type
-Point
->>> print geom.intersects(GEOSGeometry('POINT(-95.395223 29.798088)'))
-False
-}}}
-
-== get_GEOM_srid ==
-
-'''Update:''' This extra instance method was deprecated in r5657 -- and may now be accessed directly through the attribute name of the geometry field -- ''e.g.'', {{{dist.poly.srid}}}.
-
-Returns the SRID (source reference identifier) for the geometry.
-
-== get_GEOM_wkt ==
-
-'''Update:''' This extra instance method was deprecated in r5657 -- and may now be accessed directly through the attribute name of the geometry field -- ''e.g.'', {{{skool.point.wkt}}}, or simply {{{str(skool.point)}}}.
-
-Returns the OGC WKT (Well Known Text) for the geometry.  For example (using the {{{School}}} model from the [wiki:GeoDjango#Example example]):
-
-{{{
-#!python
->>> skool = School.objects.get(name='PSAS')
->>> print skool.get_point_wkt()
-POINT(-95.460822 29.745463)
-}}}
-
-== get_GEOM_centroid ==
-
-'''Update:''' This extra instance method was deprecated in r5657 -- and may now be accessed directly through the attribute name of the geometry field -- ''e.g.'', {{{dist.poly.centroid.wkt}}}.
-
-This routine will return the centroid of the geometry.  For example (using the {{{District}}} model from above):
-
-{{{
-#!python
->>> dist = District.objects.get(name='Houston ISD')
->>> print dist.get_poly_centroid()
-POINT(-95.231713 29.723235)
-}}}
-
-== get_GEOM_area ==
-
-'''Update:''' This extra instance method was deprecated in r5657 -- and may now be accessed directly through the attribute name of the geometry field -- ''e.g.'', {{{dist.poly.area}}}.
-
-This routine will return the area of the geometry field.
-
-{{{
-#!python
->>> dist = District.objects.get(name='Houston ISD')
->>> print dist.get_poly_area()
-0.08332
-}}}
-
-'''Note''': Units are in the projected units of the coordinate system.  In the example above, the units are in degrees since we're using WGS84.
+'''Update:''' All of the extra instance methods haave been deprecated as of r6467 because lazy geometry support includes all of their functionality (including OGR geometries and OSR spatial references with the `ogr` and `srs` properties, respectively).  In other words, these properties may be directly accessed as attributes from the geometry field.