{"title":"Measurement Objects","version":"1.11","locale":"el","docname":"ref/contrib/gis/measure","url":"/el/1.11/ref/contrib/gis/measure/","canonical":"https://djangodocs.dev/el/1.11/ref/contrib/gis/measure/","summary":"The django.contrib.gis.measure module contains objects that allow for convenient representation of distance and area units of measure. [ 1 ] Specifically, it…","html":"<span id=\"measurement-objects\"></span><h1>Measurement Objects<a class=\"heading-anchor\" href=\"#module-django.contrib.gis.measure\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h1>\n<p>The <a class=\"reference internal\" href=\"#module-django.contrib.gis.measure\" title=\"django.contrib.gis.measure: GeoDjango's distance and area measurement objects.\"><code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">django.contrib.gis.measure</span></code></a> module contains objects that allow\nfor convenient representation of distance and area units of measure. <a class=\"footnote-reference brackets\" href=\"#id3\" id=\"id1\" role=\"doc-noteref\"><span class=\"fn-bracket\">[</span>1<span class=\"fn-bracket\">]</span></a>\nSpecifically, it implements two objects, <a class=\"reference internal\" href=\"#django.contrib.gis.measure.Distance\" title=\"django.contrib.gis.measure.Distance\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">Distance</span></code></a> and\n<a class=\"reference internal\" href=\"#django.contrib.gis.measure.Area\" title=\"django.contrib.gis.measure.Area\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">Area</span></code></a> – both of which may be accessed via the\n<a class=\"reference internal\" href=\"#django.contrib.gis.measure.D\" title=\"django.contrib.gis.measure.D\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">D</span></code></a> and <a class=\"reference internal\" href=\"#django.contrib.gis.measure.A\" title=\"django.contrib.gis.measure.A\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">A</span></code></a> convenience aliases, respectively.</p>\n<section id=\"example\">\n<h2>Example<a class=\"heading-anchor\" href=\"#example\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p><a class=\"reference internal\" href=\"#django.contrib.gis.measure.Distance\" title=\"django.contrib.gis.measure.Distance\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">Distance</span></code></a> objects may be instantiated using a keyword argument indicating the\ncontext of the units.  In the example below, two different distance objects are\ninstantiated in units of kilometers (<code class=\"docutils literal notranslate\"><span class=\"pre\">km</span></code>) and miles (<code class=\"docutils literal notranslate\"><span class=\"pre\">mi</span></code>):</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"gp\">&gt;&gt;&gt; </span><span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">django.contrib.gis.measure</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">Distance</span><span class=\"p\">,</span> <span class=\"n\">D</span>\n<span class=\"gp\">&gt;&gt;&gt; </span><span class=\"n\">d1</span> <span class=\"o\">=</span> <span class=\"n\">Distance</span><span class=\"p\">(</span><span class=\"n\">km</span><span class=\"o\">=</span><span class=\"mi\">5</span><span class=\"p\">)</span>\n<span class=\"gp\">&gt;&gt;&gt; </span><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">d1</span><span class=\"p\">)</span>\n<span class=\"go\">5.0 km</span>\n<span class=\"gp\">&gt;&gt;&gt; </span><span class=\"n\">d2</span> <span class=\"o\">=</span> <span class=\"n\">D</span><span class=\"p\">(</span><span class=\"n\">mi</span><span class=\"o\">=</span><span class=\"mi\">5</span><span class=\"p\">)</span> <span class=\"c1\"># `D` is an alias for `Distance`</span>\n<span class=\"gp\">&gt;&gt;&gt; </span><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">d2</span><span class=\"p\">)</span>\n<span class=\"go\">5.0 mi</span>\n</code></pre></div>\n<p>Conversions are easy, just access the preferred unit attribute to get a\nconverted distance quantity:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"gp\">&gt;&gt;&gt; </span><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">d1</span><span class=\"o\">.</span><span class=\"n\">mi</span><span class=\"p\">)</span> <span class=\"c1\"># Converting 5 kilometers to miles</span>\n<span class=\"go\">3.10685596119</span>\n<span class=\"gp\">&gt;&gt;&gt; </span><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">d2</span><span class=\"o\">.</span><span class=\"n\">km</span><span class=\"p\">)</span> <span class=\"c1\"># Converting 5 miles to kilometers</span>\n<span class=\"go\">8.04672</span>\n</code></pre></div>\n<p>Moreover, arithmetic operations may be performed between the distance\nobjects:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"gp\">&gt;&gt;&gt; </span><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">d1</span> <span class=\"o\">+</span> <span class=\"n\">d2</span><span class=\"p\">)</span> <span class=\"c1\"># Adding 5 miles to 5 kilometers</span>\n<span class=\"go\">13.04672 km</span>\n<span class=\"gp\">&gt;&gt;&gt; </span><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">d2</span> <span class=\"o\">-</span> <span class=\"n\">d1</span><span class=\"p\">)</span> <span class=\"c1\"># Subtracting 5 kilometers from 5 miles</span>\n<span class=\"go\">1.89314403881 mi</span>\n</code></pre></div>\n<p>Two <a class=\"reference internal\" href=\"#django.contrib.gis.measure.Distance\" title=\"django.contrib.gis.measure.Distance\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">Distance</span></code></a> objects multiplied together will yield an <a class=\"reference internal\" href=\"#django.contrib.gis.measure.Area\" title=\"django.contrib.gis.measure.Area\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">Area</span></code></a>\nobject, which uses squared units of measure:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"gp\">&gt;&gt;&gt; </span><span class=\"n\">a</span> <span class=\"o\">=</span> <span class=\"n\">d1</span> <span class=\"o\">*</span> <span class=\"n\">d2</span> <span class=\"c1\"># Returns an Area object.</span>\n<span class=\"gp\">&gt;&gt;&gt; </span><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">a</span><span class=\"p\">)</span>\n<span class=\"go\">40.2336 sq_km</span>\n</code></pre></div>\n<p>To determine what the attribute abbreviation of a unit is, the <code class=\"docutils literal notranslate\"><span class=\"pre\">unit_attname</span></code>\nclass method may be used:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"gp\">&gt;&gt;&gt; </span><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">Distance</span><span class=\"o\">.</span><span class=\"n\">unit_attname</span><span class=\"p\">(</span><span class=\"s1\">&#39;US Survey Foot&#39;</span><span class=\"p\">))</span>\n<span class=\"go\">survey_ft</span>\n<span class=\"gp\">&gt;&gt;&gt; </span><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">Distance</span><span class=\"o\">.</span><span class=\"n\">unit_attname</span><span class=\"p\">(</span><span class=\"s1\">&#39;centimeter&#39;</span><span class=\"p\">))</span>\n<span class=\"go\">cm</span>\n</code></pre></div>\n</section>\n<section id=\"supported-units\">\n<span id=\"id2\"></span><h2>Supported units<a class=\"heading-anchor\" href=\"#supported-units\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<div class=\"table-scroll\" role=\"region\" tabindex=\"0\" aria-label=\"Table\"><table class=\"docutils align-default\">\n<thead>\n<tr class=\"row-odd\"><th class=\"head\"><p>Unit Attribute</p></th>\n<th class=\"head\"><p>Full name or alias(es)</p></th>\n</tr>\n</thead>\n<tbody>\n<tr class=\"row-even\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">km</span></code></p></td>\n<td><p>Kilometre, Kilometer</p></td>\n</tr>\n<tr class=\"row-odd\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">mi</span></code></p></td>\n<td><p>Mile</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">m</span></code></p></td>\n<td><p>Meter, Metre</p></td>\n</tr>\n<tr class=\"row-odd\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">yd</span></code></p></td>\n<td><p>Yard</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">ft</span></code></p></td>\n<td><p>Foot, Foot (International)</p></td>\n</tr>\n<tr class=\"row-odd\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">survey_ft</span></code></p></td>\n<td><p>U.S. Foot, US survey foot</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">inch</span></code></p></td>\n<td><p>Inches</p></td>\n</tr>\n<tr class=\"row-odd\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">cm</span></code></p></td>\n<td><p>Centimeter</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">mm</span></code></p></td>\n<td><p>Millimetre, Millimeter</p></td>\n</tr>\n<tr class=\"row-odd\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">um</span></code></p></td>\n<td><p>Micrometer, Micrometre</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">british_ft</span></code></p></td>\n<td><p>British foot (Sears 1922)</p></td>\n</tr>\n<tr class=\"row-odd\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">british_yd</span></code></p></td>\n<td><p>British yard (Sears 1922)</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">british_chain_sears</span></code></p></td>\n<td><p>British chain (Sears 1922)</p></td>\n</tr>\n<tr class=\"row-odd\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">indian_yd</span></code></p></td>\n<td><p>Indian yard, Yard (Indian)</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">sears_yd</span></code></p></td>\n<td><p>Yard (Sears)</p></td>\n</tr>\n<tr class=\"row-odd\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">clarke_ft</span></code></p></td>\n<td><p>Clarke’s Foot</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">chain</span></code></p></td>\n<td><p>Chain</p></td>\n</tr>\n<tr class=\"row-odd\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">chain_benoit</span></code></p></td>\n<td><p>Chain (Benoit)</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">chain_sears</span></code></p></td>\n<td><p>Chain (Sears)</p></td>\n</tr>\n<tr class=\"row-odd\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">british_chain_benoit</span></code></p></td>\n<td><p>British chain (Benoit 1895 B)</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">british_chain_sears_truncated</span></code></p></td>\n<td><p>British chain (Sears 1922 truncated)</p></td>\n</tr>\n<tr class=\"row-odd\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">gold_coast_ft</span></code></p></td>\n<td><p>Gold Coast foot</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">link</span></code></p></td>\n<td><p>Link</p></td>\n</tr>\n<tr class=\"row-odd\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">link_benoit</span></code></p></td>\n<td><p>Link (Benoit)</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">link_sears</span></code></p></td>\n<td><p>Link (Sears)</p></td>\n</tr>\n<tr class=\"row-odd\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">clarke_link</span></code></p></td>\n<td><p>Clarke’s link</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">fathom</span></code></p></td>\n<td><p>Fathom</p></td>\n</tr>\n<tr class=\"row-odd\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">rod</span></code></p></td>\n<td><p>Rod</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">nm</span></code></p></td>\n<td><p>Nautical Mile</p></td>\n</tr>\n<tr class=\"row-odd\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">nm_uk</span></code></p></td>\n<td><p>Nautical Mile (UK)</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><code class=\"docutils literal notranslate\"><span class=\"pre\">german_m</span></code></p></td>\n<td><p>German legal metre</p></td>\n</tr>\n</tbody>\n</table>\n</div>\n<aside class=\"admonition admonition-note\" role=\"note\">\n<p class=\"admonition-title\">Σημείωση</p>\n<p><a class=\"reference internal\" href=\"#django.contrib.gis.measure.Area\" title=\"django.contrib.gis.measure.Area\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">Area</span></code></a> attributes are the same as <a class=\"reference internal\" href=\"#django.contrib.gis.measure.Distance\" title=\"django.contrib.gis.measure.Distance\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">Distance</span></code></a> attributes,\nexcept they are prefixed with <code class=\"docutils literal notranslate\"><span class=\"pre\">sq_</span></code> (area units are square in nature).\nFor example, <code class=\"docutils literal notranslate\"><span class=\"pre\">Area(sq_m=2)</span></code> creates an <a class=\"reference internal\" href=\"#django.contrib.gis.measure.Area\" title=\"django.contrib.gis.measure.Area\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">Area</span></code></a> object\nrepresenting two square meters.</p>\n</aside>\n</section>\n<section id=\"measurement-api\">\n<h2>Measurement API<a class=\"heading-anchor\" href=\"#measurement-api\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<section id=\"distance\">\n<h3><code class=\"docutils literal notranslate\"><span class=\"pre\">Distance</span></code><a class=\"heading-anchor\" href=\"#distance\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h3>\n<dl class=\"py class\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.gis.measure.Distance\">\n<em class=\"property\"><span class=\"k\"><span class=\"pre\">class</span></span><span class=\"w\"> </span></em><span class=\"sig-name descname\"><span class=\"pre\">Distance</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"o\"><span class=\"pre\">**</span></span><span class=\"n\"><span class=\"pre\">kwargs</span></span></em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.gis.measure.Distance\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>To initialize a distance object, pass in a keyword corresponding to the\ndesired <a class=\"reference internal\" href=\"#supported-units\"><span class=\"std std-ref\">unit attribute name</span></a> set with desired\nvalue. For example, the following creates a distance object representing 5\nmiles:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"gp\">&gt;&gt;&gt; </span><span class=\"n\">dist</span> <span class=\"o\">=</span> <span class=\"n\">Distance</span><span class=\"p\">(</span><span class=\"n\">mi</span><span class=\"o\">=</span><span class=\"mi\">5</span><span class=\"p\">)</span>\n</code></pre></div>\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.gis.measure.Distance.__getattr__\">\n<span class=\"sig-name descname\"><span class=\"pre\">__getattr__</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">unit_att</span></span></em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.gis.measure.Distance.__getattr__\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p>Returns the distance value in units corresponding to the given unit\nattribute. For example:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"gp\">&gt;&gt;&gt; </span><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">dist</span><span class=\"o\">.</span><span class=\"n\">km</span><span class=\"p\">)</span>\n<span class=\"go\">8.04672</span>\n</code></pre></div>\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.gis.measure.Distance.unit_attname\">\n<em class=\"property\"><span class=\"k\"><span class=\"pre\">classmethod</span></span><span class=\"w\"> </span></em><span class=\"sig-name descname\"><span class=\"pre\">unit_attname</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">unit_name</span></span></em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.gis.measure.Distance.unit_attname\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p>Returns the distance unit attribute name for the given full unit name. For\nexample:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"gp\">&gt;&gt;&gt; </span><span class=\"n\">Distance</span><span class=\"o\">.</span><span class=\"n\">unit_attname</span><span class=\"p\">(</span><span class=\"s1\">&#39;Mile&#39;</span><span class=\"p\">)</span>\n<span class=\"go\">&#39;mi&#39;</span>\n</code></pre></div>\n</dd></dl>\n\n<dl class=\"py class\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.gis.measure.D\">\n<em class=\"property\"><span class=\"k\"><span class=\"pre\">class</span></span><span class=\"w\"> </span></em><span class=\"sig-name descname\"><span class=\"pre\">D</span></span><a class=\"heading-anchor\" href=\"#django.contrib.gis.measure.D\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Alias for <a class=\"reference internal\" href=\"#django.contrib.gis.measure.Distance\" title=\"django.contrib.gis.measure.Distance\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">Distance</span></code></a> class.</p>\n</dd></dl>\n\n</section>\n<section id=\"area\">\n<h3><code class=\"docutils literal notranslate\"><span class=\"pre\">Area</span></code><a class=\"heading-anchor\" href=\"#area\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h3>\n<dl class=\"py class\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.gis.measure.Area\">\n<em class=\"property\"><span class=\"k\"><span class=\"pre\">class</span></span><span class=\"w\"> </span></em><span class=\"sig-name descname\"><span class=\"pre\">Area</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"o\"><span class=\"pre\">**</span></span><span class=\"n\"><span class=\"pre\">kwargs</span></span></em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.gis.measure.Area\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>To initialize an area object, pass in a keyword corresponding to the\ndesired <a class=\"reference internal\" href=\"#supported-units\"><span class=\"std std-ref\">unit attribute name</span></a> set with desired\nvalue. For example, the following creates an area object representing 5\nsquare miles:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"gp\">&gt;&gt;&gt; </span><span class=\"n\">a</span> <span class=\"o\">=</span> <span class=\"n\">Area</span><span class=\"p\">(</span><span class=\"n\">sq_mi</span><span class=\"o\">=</span><span class=\"mi\">5</span><span class=\"p\">)</span>\n</code></pre></div>\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.gis.measure.Area.__getattr__\">\n<span class=\"sig-name descname\"><span class=\"pre\">__getattr__</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">unit_att</span></span></em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.gis.measure.Area.__getattr__\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p>Returns the area value in units corresponding to the given unit attribute.\nFor example:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"gp\">&gt;&gt;&gt; </span><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">a</span><span class=\"o\">.</span><span class=\"n\">sq_km</span><span class=\"p\">)</span>\n<span class=\"go\">12.949940551680001</span>\n</code></pre></div>\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.gis.measure.Area.unit_attname\">\n<em class=\"property\"><span class=\"k\"><span class=\"pre\">classmethod</span></span><span class=\"w\"> </span></em><span class=\"sig-name descname\"><span class=\"pre\">unit_attname</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">unit_name</span></span></em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.gis.measure.Area.unit_attname\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p>Returns the area unit attribute name for the given full unit name. For\nexample:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"gp\">&gt;&gt;&gt; </span><span class=\"n\">Area</span><span class=\"o\">.</span><span class=\"n\">unit_attname</span><span class=\"p\">(</span><span class=\"s1\">&#39;Kilometer&#39;</span><span class=\"p\">)</span>\n<span class=\"go\">&#39;sq_km&#39;</span>\n</code></pre></div>\n</dd></dl>\n\n<dl class=\"py class\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.gis.measure.A\">\n<em class=\"property\"><span class=\"k\"><span class=\"pre\">class</span></span><span class=\"w\"> </span></em><span class=\"sig-name descname\"><span class=\"pre\">A</span></span><a class=\"heading-anchor\" href=\"#django.contrib.gis.measure.A\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Alias for <a class=\"reference internal\" href=\"#django.contrib.gis.measure.Area\" title=\"django.contrib.gis.measure.Area\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">Area</span></code></a> class.</p>\n</dd></dl>\n\n<p class=\"rubric\">Footnotes</p>\n<aside class=\"footnote-list brackets\">\n<aside class=\"footnote brackets\" id=\"id3\" role=\"doc-footnote\">\n<span class=\"label\"><span class=\"fn-bracket\">[</span><a role=\"doc-backlink\" href=\"#id1\">1</a><span class=\"fn-bracket\">]</span></span>\n<p><a class=\"reference external\" href=\"https://koordinates.com/\">Robert Coup</a> is the initial author of the measure objects,\nand was inspired by Brian Beck’s work in <a class=\"reference external\" href=\"https://github.com/geopy/geopy/\">geopy</a>\nand Geoff Biggs” PhD work on dimensioned units for robotics.</p>\n</aside>\n</aside>\n</section>\n</section>","rootId":"module-django.contrib.gis.measure","toc":[{"title":"Example","anchor":"example","children":[]},{"title":"Supported units","anchor":"supported-units","children":[]},{"title":"Measurement API","anchor":"measurement-api","children":[{"title":"Distance","anchor":"distance","children":[]},{"title":"Area","anchor":"area","children":[]}]}],"breadcrumbs":[{"docname":"ref/index","title":"API Reference","url":"/el/1.11/ref/"},{"docname":"ref/contrib/index","title":"contrib packages","url":"/el/1.11/ref/contrib/"},{"docname":"ref/contrib/gis/index","title":"GeoDjango","url":"/el/1.11/ref/contrib/gis/"}],"prev":{"docname":"ref/contrib/gis/functions","title":"Geographic Database Functions","url":"/el/1.11/ref/contrib/gis/functions/"},"next":{"docname":"ref/contrib/gis/geos","title":"GEOS API","url":"/el/1.11/ref/contrib/gis/geos/"},"formats":{"html":"/el/1.11/ref/contrib/gis/measure/","markdown":"/el/1.11/ref/contrib/gis/measure.md","json":"/el/1.11/ref/contrib/gis/measure.json"},"source":"https://github.com/django/django/blob/stable/1.11.x/docs/ref/contrib/gis/measure.txt","official":"https://docs.djangoproject.com/el/1.11/ref/contrib/gis/measure/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10"],"inLocales":["en","fr","ja","id","pt-br","ko","es","el","pl"]}