summaryrefslogtreecommitdiff
path: root/docs/ref/contrib/gis/model-api.txt
diff options
context:
space:
mode:
authorArthur Koziel <arthur@arthurkoziel.com>2010-09-13 00:04:27 +0000
committerArthur Koziel <arthur@arthurkoziel.com>2010-09-13 00:04:27 +0000
commitdd49269c7db008b2567f50cb03c4d3d9b321daa1 (patch)
tree326dd25bb045ac016cda7966b43cbdfe1f67d699 /docs/ref/contrib/gis/model-api.txt
parentc9b188c4ec939abbe48dae5a371276742e64b6b8 (diff)
downloaddjango-soc2010/app-loading.tar.gz
[soc2010/app-loading] merged trunkarchive/soc2010/app-loadingsoc2010/app-loading
git-svn-id: http://code.djangoproject.com/svn/django/branches/soc2010/app-loading@13818 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs/ref/contrib/gis/model-api.txt')
-rw-r--r--docs/ref/contrib/gis/model-api.txt40
1 files changed, 20 insertions, 20 deletions
diff --git a/docs/ref/contrib/gis/model-api.txt b/docs/ref/contrib/gis/model-api.txt
index 7c83a7e267..cf73747463 100644
--- a/docs/ref/contrib/gis/model-api.txt
+++ b/docs/ref/contrib/gis/model-api.txt
@@ -8,11 +8,11 @@ GeoDjango Model API
:synopsis: GeoDjango model and field API.
This document explores the details of the GeoDjango Model API. Throughout this
-section, we'll be using the following geographic model of a `ZIP code`__ as our
+section, we'll be using the following geographic model of a `ZIP code`__ as our
example::
from django.contrib.gis.db import models
-
+
class Zipcode(models.Model):
code = models.CharField(max_length=5)
poly = models.PolygonField()
@@ -23,7 +23,7 @@ __ http://en.wikipedia.org/wiki/ZIP_code
Geometry Field Types
====================
-Each of the following geometry field types correspond with the
+Each of the following geometry field types correspond with the
OpenGIS Simple Features specification [#fnogc]_.
``GeometryField``
@@ -92,7 +92,7 @@ Selecting an SRID
^^^^^^^^^^^^^^^^^
Choosing an appropriate SRID for your model is an important decision that the
-developer should consider carefully. The SRID is an integer specifier that
+developer should consider carefully. The SRID is an integer specifier that
corresponds to the projection system that will be used to interpret the data
in the spatial database. [#fnsrid]_ Projection systems give the context to the
coordinates that specify a location. Although the details of `geodesy`__ are
@@ -105,7 +105,7 @@ location on the earth's surface. However, latitude and longitude are angles,
not distances. [#fnharvard]_ In other words, while the shortest path between two points on
a flat surface is a straight line, the shortest path between two points on a curved
surface (such as the earth) is an *arc* of a `great circle`__. [#fnthematic]_ Thus,
-additional computation is required to obtain distances in planar units (e.g.,
+additional computation is required to obtain distances in planar units (e.g.,
kilometers and miles). Using a geographic coordinate system may introduce
complications for the developer later on. For example, PostGIS versions 1.4
and below do not have the capability to perform distance calculations between
@@ -113,12 +113,12 @@ non-point geometries using geographic coordinate systems, e.g., constructing a
query to find all points within 5 miles of a county boundary stored as WGS84.
[#fndist]_
-Portions of the earth's surface may projected onto a two-dimensional, or
+Portions of the earth's surface may projected onto a two-dimensional, or
Cartesian, plane. Projected coordinate systems are especially convenient
for region-specific applications, e.g., if you know that your database will
-only cover geometries in `North Kansas`__, then you may consider using projection
-system specific to that region. Moreover, projected coordinate systems are
-defined in Cartesian units (such as meters or feet), easing distance
+only cover geometries in `North Kansas`__, then you may consider using projection
+system specific to that region. Moreover, projected coordinate systems are
+defined in Cartesian units (such as meters or feet), easing distance
calculations.
.. note::
@@ -131,7 +131,7 @@ calculations.
Additional Resources:
-* `spatialreference.org`__: A Django-powered database of spatial reference
+* `spatialreference.org`__: A Django-powered database of spatial reference
systems.
* `The State Plane Coordinate System`__: A website covering the various
projection systems used in the United States. Much of the U.S. spatial
@@ -150,7 +150,7 @@ __ http://welcome.warnercnr.colostate.edu/class_info/nr502/lg3/datums_coordinate
.. attribute:: GeometryField.spatial_index
Defaults to ``True``. Creates a spatial index for the given geometry
-field.
+field.
.. note::
@@ -185,7 +185,7 @@ three-dimensonal support.
.. attribute:: GeometryField.geography
If set to ``True``, this option will create a database column of
-type geography, rather than geometry. Please refer to the
+type geography, rather than geometry. Please refer to the
:ref:`geography type <geography-type>` section below for more
details.
@@ -212,7 +212,7 @@ to degrees if called on a geometry column in WGS84).
Because geography calculations involve more mathematics, only a subset of the
PostGIS spatial lookups are available for the geography type. Practically,
this means that in addition to the :ref:`distance lookups <distance-lookups>`
-only the following additional :ref:`spatial lookups <spatial-lookups>` are
+only the following additional :ref:`spatial lookups <spatial-lookups>` are
available for geography columns:
* :lookup:`bboverlaps`
@@ -231,13 +231,13 @@ determining `when to use geography data type over geometry data type
.. currentmodule:: django.contrib.gis.db.models
.. class:: GeoManager
-In order to conduct geographic queries, each geographic model requires
+In order to conduct geographic queries, each geographic model requires
a ``GeoManager`` model manager. This manager allows for the proper SQL
-construction for geographic queries; thus, without it, all geographic filters
+construction for geographic queries; thus, without it, all geographic filters
will fail. It should also be noted that ``GeoManager`` is required even if the
-model does not have a geographic field itself, e.g., in the case of a
-``ForeignKey`` relation to a model with a geographic field. For example,
-if we had an ``Address`` model with a ``ForeignKey`` to our ``Zipcode``
+model does not have a geographic field itself, e.g., in the case of a
+``ForeignKey`` relation to a model with a geographic field. For example,
+if we had an ``Address`` model with a ``ForeignKey`` to our ``Zipcode``
model::
from django.contrib.gis.db import models
@@ -251,7 +251,7 @@ model::
zipcode = models.ForeignKey(Zipcode)
objects = models.GeoManager()
-The geographic manager is needed to do spatial queries on related ``Zipcode`` objects,
+The geographic manager is needed to do spatial queries on related ``Zipcode`` objects,
for example::
qs = Address.objects.filter(zipcode__poly__contains='POINT(-104.590948 38.319914)')
@@ -260,7 +260,7 @@ for example::
.. [#fnogc] OpenGIS Consortium, Inc., `Simple Feature Specification For SQL <http://www.opengis.org/docs/99-049.pdf>`_, Document 99-049 (May 5, 1999).
.. [#fnogcsrid] *See id.* at Ch. 2.3.8, p. 39 (Geometry Values and Spatial Reference Systems).
.. [#fnsrid] Typically, SRID integer corresponds to an EPSG (`European Petroleum Survey Group <http://www.epsg.org>`_) identifier. However, it may also be associated with custom projections defined in spatial database's spatial reference systems table.
-.. [#fnharvard] Harvard Graduate School of Design, `An Overview of Geodesy and Geographic Referencing Systems <http://www.gsd.harvard.edu/gis/manual/projections/fundamentals/>`_. This is an excellent resource for an overview of principles relating to geographic and Cartesian coordinate systems.
+.. [#fnharvard] Harvard Graduate School of Design, `An Overview of Geodesy and Geographic Referencing Systems <http://www.gsd.harvard.edu/gis/manual/projections/fundamentals/>`_. This is an excellent resource for an overview of principles relating to geographic and Cartesian coordinate systems.
.. [#fnthematic] Terry A. Slocum, Robert B. McMaster, Fritz C. Kessler, & Hugh H. Howard, *Thematic Cartography and Geographic Visualization* (Prentice Hall, 2nd edition), at Ch. 7.1.3.
.. [#fndist] This limitation does not apply to PostGIS 1.5. It should be noted that even in previous versions of PostGIS, this isn't impossible using GeoDjango; you could for example, take a known point in a projected coordinate system, buffer it to the appropriate radius, and then perform an intersection operation with the buffer transformed to the geographic coordinate system.
.. [#fngeography] Please refer to the `PostGIS Geography Type <http://postgis.refractions.net/documentation/manual-1.5/ch04.html#PostGIS_Geography>`_ documentation for more details.