{"title":"地理情報データベース関数","version":"5.2","locale":"ja","docname":"ref/contrib/gis/functions","url":"/ja/5.2/ref/contrib/gis/functions/","canonical":"https://djangodocs.dev/ja/5.2/ref/contrib/gis/functions/","summary":"このページで説明する関数を使えば、Django のアノテーションや集約、フィルタで使う地理情報データベース関数にアクセスできます。","html":"

地理情報データベース関数Link to this heading#

\n

このページで説明する関数を使えば、Django のアノテーションや集約、フィルタで使う地理情報データベース関数にアクセスできます。

\n

例:

\n
Python console
>>> from django.contrib.gis.db.models.functions import Length\n>>> Track.objects.annotate(length=Length("line")).filter(length__gt=100)\n
\n

すべてのバックエンドがすべての関数をサポートしているわけではないので、それぞれの関数のドキュメントを参照して、使用したい関数をサポートしているかどうかを確認してください。サポートしていないバックエンドで地理情報関数を呼び出すと、 NotImplementedError 例外が発生します。

\n
\n

寸法Link to this heading#

\n
\n

AreaLink to this heading#

\n
\n
\nclass Area(expression, **extra)Link to this definition#
\n
\n\n

利用可能なDB: MariaDB、MySQL、Oracle、PostGIS、SpatiaLite

\n

単一の地理情報フィールドまたは式を受け取り、そのフィールドの面積を Area 測定値として返します。

\n

LWGEOM/RTTOPOを使用しないMySQLとSpatiaLiteは、地理SRSの面積計算をサポートしていません。

\n
\n
\n

DistanceLink to this heading#

\n
\n
\nclass Distance(expr1, expr2, spheroid=None, **extra)Link to this definition#
\n
\n\n

利用可能なDB: MariaDB, MySQL, PostGIS, Oracle, SpatiaLite

\n

2つの地理情報フィールドまたは式を受け取り、それらの間の距離を Distance オブジェクトとして返します。MySQL では、座標が測地系の場合、生の float 値が返されます。

\n

測地座標での距離計算をサポートするバックエンドでは、ジオメトリの SRID 値に応じて適切なバックエンド関数が自動的に選択されます (例: PostGIS の ST_DistanceSphere)。

\n

デフォルトのWGS84 (4326) SRIDのように測地 (角度) 座標で距離を計算する場合、 spheroid キーワード引数を設定することで、単純な球体 (精度が低く、リソースをあまり必要としない) か球体 (精度が高く、リソースを多く必要とする) のどちらに基づいて計算するかを決めることができます。

\n

以下の例では、Hobart 市から AustraliaCity クエリセット内の他の PointField までの距離を計算しています:

\n
Python console
>>> from django.contrib.gis.db.models.functions import Distance\n>>> pnt = AustraliaCity.objects.get(name="Hobart").point\n>>> for city in AustraliaCity.objects.annotate(distance=Distance("point", pnt)):\n...     print(city.name, city.distance)\n...\nWollongong 990071.220408 m\nShellharbour 972804.613941 m\nThirroul 1002334.36351 m\n...\n
\n\n
\n
\n

GeometryDistanceLink to this heading#

\n
\n
\nclass GeometryDistance(expr1, expr2, **extra)Link to this definition#
\n
\n\n

利用可能なDB: PostGIS

\n

2つの地理情報フィールドまたは式を受け取り、それらの間の距離を返します。 order_by() 節で使用すると、インデックスアシストされた最近傍の結果セットを提供します。

\n
\n
\n

LengthLink to this heading#

\n
\n
\nclass Length(expression, spheroid=True, **extra)Link to this definition#
\n
\n\n

利用可能なDB: MariaDB, MySQL, Oracle, PostGIS, SpatiaLite

\n

単一の地理的な linestring または multilinestring フィールドまたは式を受け取り、その長さを Distance メジャーとして返します。

\n

PostGISとSpatiaLiteでは、座標が測地系 (角度) である場合、単純な球 (精度が低く、リソースの消費量が少ない) か、球体 (精度が高く、リソースの消費量が多い) かを spheroid キーワード引数で指定できます。

\n

MySQLは地理空間SRSにおける長さの計算をサポートしていません。

\n
\n
\n

PerimeterLink to this heading#

\n
\n
\nclass Perimeter(expression, **extra)Link to this definition#
\n
\n\n

利用可能なDB: PostGIS, Oracle, SpatiaLite

\n

単一の地理情報フィールドまたは式を受け取り、ジオメトリフィールドの周長を Distance オブジェクトとして返します。

\n
\n
\n
\n

リレーションLink to this heading#

\n
\n

AzimuthLink to this heading#

\n
\n
\nclass Azimuth(point_a, point_b, **extra)Link to this definition#
\n
\n\n

利用可能なDB: PostGIS, SpatiaLite (LWGEOM/RTTOPO)

\n

与えられた点のジオメトリで定義されるセグメントの方位をラジアンで返します。2つの点が重なっている場合は None を返します。方位は北を基準とした角度で、時計回りが正です: 北 = 0; 東 = π/2; 南 = π; 西 = 3π/2 。

\n
\n
\n

BoundingCircleLink to this heading#

\n
\n
\nclass BoundingCircle(expression, num_seg=48, **extra)Link to this definition#
\n
\n\n

互換性: PostGIS, Oracle, SpatiaLite 5.1以降

\n

単一の地理情報フィールドまたは式を受け取り、そのジオメトリを完全に含むことができる最小の円ポリゴンを返します。

\n

num_seg パラメータは PostGIS 上でのみ使用されます。

\n\n
\n
\n

CentroidLink to this heading#

\n
\n
\nclass Centroid(expression, **extra)Link to this definition#
\n
\n\n

利用可能なDB: MariaDB, MySQL, PostGIS, Oracle, SpatiaLite

\n

単一の地理情報フィールドまたは式を受け取り、ジオメトリの centroid 値を返す。

\n
\n
\n

ClosestPointLink to this heading#

\n
\n
\nclass ClosestPoint(expr1, expr2, **extra)Link to this definition#
\n
\n\n

利用可能なDB: PostGIS, SpatiaLite

\n

2つの地理情報フィールドまたは式を受け取り、地理情報 A 上で地理情報 B に最も近い 2次元ポイントを返します。

\n
\n
\n

EnvelopeLink to this heading#

\n
\n
\nclass Envelope(expression, **extra)Link to this definition#
\n
\n\n

利用可能なDB: MariaDB, MySQL, Oracle, PostGIS, SpatiaLite

\n

1つの地理情報フィールドまたは式を受け取り、ジオメトリのバウンディングボックスを表すジオメトリを返します。

\n
\n
\n

LineLocatePointLink to this heading#

\n
\n
\nclass LineLocatePoint(linestring, point, **extra)Link to this definition#
\n
\n\n

利用可能なDB: PostGIS, SpatiaLite

\n

与えられた point に最も近い linestring 上の点の位置を 0 から 1 までの float で表し、2D 線の長さに対する割合で返す。

\n
\n
\n

PointOnSurfaceLink to this heading#

\n
\n
\nclass PointOnSurface(expression, **extra)Link to this definition#
\n
\n\n

利用可能なDB: PostGIS, MariaDB, Oracle, SpatiaLite

\n

単一の地理情報フィールドまたは式を受け入れ、そのフィールドの表面上にあることが保証された Point ジオメトリを返します。そのような値がない場合は None を返します。

\n
\n
\n
\n

操作Link to this heading#

\n
\n

DifferenceLink to this heading#

\n
\n
\nclass Difference(expr1, expr2, **extra)Link to this definition#
\n
\n\n

利用可能なDB: MariaDB, MySQL, PostGIS, Oracle, SpatiaLite

\n

2つの地理情報フィールドまたは式を受け取り、幾何学的な差、つまり地理情報Aのうち地理情報Bと重ならない部分を返す。

\n
\n
\n

IntersectionLink to this heading#

\n
\n
\nclass Intersection(expr1, expr2, **extra)Link to this definition#
\n
\n\n

利用可能なDB: MariaDB, MySQL, PostGIS, Oracle, SpatiaLite

\n

2 つの地理情報フィールドや式を受け取り、それらの間の幾何学的な交点を返します。

\n
\n
\n

SymDifferenceLink to this heading#

\n
\n
\nclass SymDifference(expr1, expr2, **extra)Link to this definition#
\n
\n\n

利用可能なDB: MariaDB, MySQL, PostGIS, Oracle, SpatiaLite

\n

2つの地理情報フィールドまたは式を受け取り、与えられたパラメータ間の幾何学的対称差 (交差を除いた和) を返します。

\n
\n
\n

UnionLink to this heading#

\n
\n
\nclass Union(expr1, expr2, **extra)Link to this definition#
\n
\n\n

利用可能なDB: MariaDB, MySQL, PostGIS, Oracle, SpatiaLite

\n

2 つの地理情報フィールドまたは式を受け取り、それらの両方のジオメトリの和集合を返します。

\n
\n
\n
\n

編集Link to this heading#

\n
\n

ForcePolygonCWLink to this heading#

\n
\n
\nclass ForcePolygonCW(expression, **extra)Link to this definition#
\n
\n\n

利用可能なDB: PostGIS, SpatiaLite

\n

1つの地理情報フィールドまたは式を受け取り、すべての外側のリングが時計回り、すべての内側のリングが反時計回りであるポリゴン/マルチポリゴンの修正版を返します。多角形以外のジオメトリは変更されずに返されます。

\n
\n
\n

MakeValidLink to this heading#

\n
\n
\nclass MakeValid(expr)Link to this definition#
\n
\n\n

利用可能なDB: PostGIS, SpatiaLite (LWGEOM/RTTOPO)

\n

地理情報フィールドまたは式を受け取り、入力頂点を失うことなくその値を有効なジオメトリに変換しようとします。すでに有効なジオメトリは変更されずに返されます。単純なポリゴンはマルチポリゴンになる可能性があり、結果は入力よりも低次元になる可能性があります。

\n
\n
\n

ReverseLink to this heading#

\n
\n
\nclass Reverse(expression, **extra)Link to this definition#
\n
\n\n

利用可能なDB: PostGIS, Oracle, SpatiaLite

\n

単一の地理情報フィールドまたは式を受け取り、座標を反転したジオメトリを返します。

\n
\n
\n

ScaleLink to this heading#

\n
\n
\nclass Scale(expression, x, y, z=0.0, **extra)Link to this definition#
\n
\n\n

利用可能なDB: PostGIS, SpatiaLite

\n

単一の地理情報フィールドまたは式を受け取り、それらを x、y、任意で z パラメータで乗算してスケーリングした座標を持つジオメトリを返します。

\n
\n
\n

SnapToGridLink to this heading#

\n
\n
\nclass SnapToGrid(expression, *args, **extra)Link to this definition#
\n
\n\n

利用可能なDB: PostGIS, SpatiaLite

\n

1 つの地理情報フィールドまたは式を受け取り、すべての点が指定されたグリッドにスナップされたジオメトリを返します。ジオメトリがグリッドにスナップされる方法は、与えられた数値 (float、integer、long のいずれか) の数によって異なります。

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

引数の数

説明

1

XグリッドとYグリッドの両方をスナップする単一のサイズ。

2

グリッドをスナップさせるXとYのサイズ。

4

X、Yのサイズと、対応するX、Yの原点。

\n
\n
\n
\n

TransformLink to this heading#

\n
\n
\nclass Transform(expression, srid, **extra)Link to this definition#
\n
\n\n

利用可能なDB: PostGIS, Oracle, SpatiaLite

\n

地理情報フィールドまたは式と SRID 整数コードを受け取り、srid パラメータで指定された空間参照系に変換されたジオメトリを返します。

\n\n
\n
\n

TranslateLink to this heading#

\n
\n
\nclass Translate(expression, x, y, z=0.0, **extra)Link to this definition#
\n
\n\n

利用可能なDB: PostGIS, SpatiaLite

\n

単一の地理情報フィールドまたは式を受け取り、その座標を x, y, オプションで z の数値パラメータでオフセットしたジオメトリを返します。

\n
\n
\n
\n

入力フォーマットLink to this heading#

\n
\n

FromWKBLink to this heading#

\n
\n
\nclass FromWKB(expression, srid=0, **extra)Link to this definition#
\n
\n\n

利用可能なDB: MariaDB, MySQL, Oracle, PostGIS, SpatiaLite

\n

Well-known binary (WKB) 表現からジオメトリを作成します。オプションの srid 引数を使用すると、結果として得られるジオメトリのSRIDを指定できます。srid はOracleでは無視されます。

\n\n
\n
\n

FromWKTLink to this heading#

\n
\n
\nclass FromWKT(expression, srid=0, **extra)Link to this definition#
\n
\n\n

利用可能なDB: MariaDB, MySQL, Oracle, PostGIS, SpatiaLite

\n

Well-known text (WKT) 表現からジオメトリを作成します。オプションの srid 引数を使用すると、結果として得られるジオメトリのSRIDを指定できます。srid はOracleでは無視されます。

\n\n
\n
\n
\n

出力フォーマットLink to this heading#

\n
\n

AsGeoJSONLink to this heading#

\n
\n
\nclass AsGeoJSON(expression, bbox=False, crs=False, precision=8, **extra)Link to this definition#
\n
\n\n

利用可能なDB: MariaDB, MySQL, Oracle, PostGIS, SpatiaLite

\n

単一の地理情報フィールドまたは式を受け取り、地理情報の GeoJSON 表現を返す。結果は完全な GeoJSON 構造体ではなく、GeoJSON 構造体のキーコンテンツ geometry だけであることに注意してください。 GeoJSON シリアライザ も参照。

\n

例:

\n
Python console
>>> City.objects.annotate(json=AsGeoJSON("point")).get(name="Chicago").json\n{"type":"Point","coordinates":[-87.65018,41.85039]}\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

キーワード引数

説明

bbox

返される GeoJSON にバウンディングボックスを含めたい場合は、これを True に設定します。Oracle では無視される。

crs

返される GeoJSON に座標参照系を含めたい場合は、これを True に設定してください。MySQLとOracleでは無視されます。

precision

GeoJSON 表現での座標の有効数字の桁数を指定します。デフォルト値は8です。Oracleでは無視されます。

\n
\n
\n
\n

AsGMLLink to this heading#

\n
\n
\nclass AsGML(expression, version=2, precision=8, **extra)Link to this definition#
\n
\n\n

利用可能なDB: Oracle, PostGIS, SpatiaLite

\n

単一の地理情報フィールドまたは式を受け取り、そのジオメトリの Geographic Markup Language (GML) 表現を返します。

\n

例:

\n
Python console
>>> qs = Zipcode.objects.annotate(gml=AsGML("poly"))\n>>> print(qs[0].gml)\n<gml:Polygon srsName="EPSG:4326"><gml:OuterBoundaryIs>-147.78711,70.245363 ...\n-147.78711,70.245363</gml:OuterBoundaryIs></gml:Polygon>\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n

キーワード引数

説明

precision

GML 表現における座標の有効桁数を指定します (デフォルト値は 8)。Oracle では無視されます。

version

使用するGMLバージョンを指定します: 2 (デフォルト) または 3。

\n
\n
\n
\n

AsKMLLink to this heading#

\n
\n
\nclass AsKML(expression, precision=8, **extra)Link to this definition#
\n
\n\n

利用可能なDB: PostGIS、SpatiaLite

\n

単一の地理情報フィールドまたは式を受け取り、地理情報の Keyhole Markup Language (KML) 表現を返す。

\n

例:

\n
Python console
>>> qs = Zipcode.objects.annotate(kml=AsKML("poly"))\n>>> print(qs[0].kml)\n<Polygon><outerBoundaryIs><LinearRing><coordinates>-103.04135,36.217596,0 ...\n-103.04135,36.217596,0</coordinates></LinearRing></outerBoundaryIs></Polygon>\n
\n
\n\n\n\n\n\n\n\n\n\n\n

キーワード引数

説明

precision

このキーワードは、KML表現で座標の有効桁数を指定するために使用できます。デフォルト値は8です。

\n
\n
\n
\n

AsSVGLink to this heading#

\n
\n
\nclass AsSVG(expression, relative=False, precision=8, **extra)Link to this definition#
\n
\n\n

利用可能なDB: PostGIS, SpatiaLite

\n

単一の地理情報フィールドまたは式を受け取り、そのジオメトリの Scalable Vector Graphics (SVG) 表現を返します。

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n

キーワード引数

説明

relative

True に設定すると、経路データは相対移動として実装されます。デフォルトは False で、代わりに絶対移動が使用されます。

precision

このキーワードは、SVG 表現内の座標の有効桁数を指定するために使用できます。デフォルト値は 8 です。

\n
\n
\n
\n

AsWKBLink to this heading#

\n
\n
\nclass AsWKB(expression, **extra)Link to this definition#
\n
\n\n

利用可能なDB: MariaDB, MySQL, Oracle, PostGIS, SpatiaLite

\n

単一の地理情報フィールドまたは式を受け取り、そのジオメトリの Well-known binary (WKB) 表現を返します。

\n

例:

\n
Python console
>>> bytes(City.objects.annotate(wkb=AsWKB("point")).get(name="Chelyabinsk").wkb)\nb'\\x01\\x01\\x00\\x00\\x00]3\\xf9f\\x9b\\x91K@\\x00X\\x1d9\\xd2\\xb9N@'\n
\n
\n
\n

AsWKTLink to this heading#

\n
\n
\nclass AsWKT(expression, **extra)Link to this definition#
\n
\n\n

利用可能なDB: MariaDB, MySQL, Oracle, PostGIS, SpatiaLite

\n

単一の地理情報フィールドまたは式を受け取り、ジオメトリの Well-known text (WKT) 表現を返します。

\n

例:

\n
Python console
>>> City.objects.annotate(wkt=AsWKT("point")).get(name="Chelyabinsk").wkt\n'POINT (55.137555 61.451728)'\n
\n
\n
\n

GeoHashLink to this heading#

\n
\n
\nclass GeoHash(expression, precision=None, **extra)Link to this definition#
\n
\n\n

利用可能なDB: MySQL, PostGIS, SpatiaLite (LWGEOM/RTTOPO)

\n

単一の地理情報フィールドまたは式を受け取り、ジオメトリの GeoHash 表現を返します。

\n

キーワード引数 precision は結果の文字数をコントロールします。

\n
\n
\n
\n

その他Link to this heading#

\n
\n

IsEmptyLink to this heading#

\n
\n
\nclass IsEmpty(expr)Link to this definition#
\n
\n\n

利用可能なDB: PostGIS

\n

地理情報フィールドまたは式を受け取り、その値が空のジオメトリであるかどうかをテストします。値が空の場合は True を返し、そうでない場合は False を返します。

\n
\n
\n

IsValidLink to this heading#

\n
\n
\nclass IsValid(expr)Link to this definition#
\n
\n\n

利用可能なDB: MySQL, PostGIS, Oracle, SpatiaLite

\n

地理情報フィールドまたは式を受け取り、その値が整形されているかどうかをテストします。値が有効なジオメトリであれば True を返し、そうでなければ False を返します。

\n
\n
\n

MemSizeLink to this heading#

\n
\n
\nclass MemSize(expression, **extra)Link to this definition#
\n
\n\n

利用可能なDB: PostGIS

\n

1つの地理情報フィールドまたは式を受け取り、その地理情報フィールドが必要とするメモリサイズ (バイト数) を返します。

\n
\n
\n

NumGeometriesLink to this heading#

\n
\n
\nclass NumGeometries(expression, **extra)Link to this definition#
\n
\n\n

利用可能なDB: MariaDB, MySQL, PostGIS, Oracle, SpatiaLite

\n

単一の地理情報フィールドまたは式を受け取り、地理情報フィールドがコレクション (たとえば GEOMETRYCOLLECTION または MULTI* フィールド) の場合は、ジオメトリ数を返します。単一のジオメトリの場合は 1 を返します。

\n

MySQL では、単一のジオメトリに対して None を返します。

\n
\n
\n

NumPointsLink to this heading#

\n
\n
\nclass NumPoints(expression, **extra)Link to this definition#
\n
\n\n

利用可能なDB: MariaDB, MySQL, PostGIS, Oracle, SpatiaLite

\n

単一の地理情報フィールドまたは式を受け取り、ジオメトリ内のポイント数を返します。

\n

MySQL では、LINESTRING でないジオメトリに対しては None を返します。

\n
\n
","rootId":"module-django.contrib.gis.db.models.functions","toc":[{"title":"寸法","anchor":"measurements","children":[{"title":"Area","anchor":"area","children":[]},{"title":"Distance","anchor":"distance","children":[]},{"title":"GeometryDistance","anchor":"geometrydistance","children":[]},{"title":"Length","anchor":"length","children":[]},{"title":"Perimeter","anchor":"perimeter","children":[]}]},{"title":"リレーション","anchor":"relationships","children":[{"title":"Azimuth","anchor":"azimuth","children":[]},{"title":"BoundingCircle","anchor":"boundingcircle","children":[]},{"title":"Centroid","anchor":"centroid","children":[]},{"title":"ClosestPoint","anchor":"closestpoint","children":[]},{"title":"Envelope","anchor":"envelope","children":[]},{"title":"LineLocatePoint","anchor":"linelocatepoint","children":[]},{"title":"PointOnSurface","anchor":"pointonsurface","children":[]}]},{"title":"操作","anchor":"operations","children":[{"title":"Difference","anchor":"difference","children":[]},{"title":"Intersection","anchor":"intersection","children":[]},{"title":"SymDifference","anchor":"symdifference","children":[]},{"title":"Union","anchor":"union","children":[]}]},{"title":"編集","anchor":"editors","children":[{"title":"ForcePolygonCW","anchor":"forcepolygoncw","children":[]},{"title":"MakeValid","anchor":"makevalid","children":[]},{"title":"Reverse","anchor":"reverse","children":[]},{"title":"Scale","anchor":"scale","children":[]},{"title":"SnapToGrid","anchor":"snaptogrid","children":[]},{"title":"Transform","anchor":"transform","children":[]},{"title":"Translate","anchor":"translate","children":[]}]},{"title":"入力フォーマット","anchor":"input-format","children":[{"title":"FromWKB","anchor":"fromwkb","children":[]},{"title":"FromWKT","anchor":"fromwkt","children":[]}]},{"title":"出力フォーマット","anchor":"output-format","children":[{"title":"AsGeoJSON","anchor":"asgeojson","children":[]},{"title":"AsGML","anchor":"asgml","children":[]},{"title":"AsKML","anchor":"askml","children":[]},{"title":"AsSVG","anchor":"assvg","children":[]},{"title":"AsWKB","anchor":"aswkb","children":[]},{"title":"AsWKT","anchor":"aswkt","children":[]},{"title":"GeoHash","anchor":"geohash","children":[]}]},{"title":"その他","anchor":"miscellaneous","children":[{"title":"IsEmpty","anchor":"isempty","children":[]},{"title":"IsValid","anchor":"isvalid","children":[]},{"title":"MemSize","anchor":"memsize","children":[]},{"title":"NumGeometries","anchor":"numgeometries","children":[]},{"title":"NumPoints","anchor":"numpoints","children":[]}]}],"breadcrumbs":[{"docname":"ref/index","title":"API リファレンス","url":"/ja/5.2/ref/"},{"docname":"ref/contrib/index","title":"contrib パッケージ","url":"/ja/5.2/ref/contrib/"},{"docname":"ref/contrib/gis/index","title":"GeoDjango","url":"/ja/5.2/ref/contrib/gis/"}],"prev":{"docname":"ref/contrib/gis/geoquerysets","title":"GIS QuerySet API リファレンス","url":"/ja/5.2/ref/contrib/gis/geoquerysets/"},"next":{"docname":"ref/contrib/gis/measure","title":"測定オブジェクト","url":"/ja/5.2/ref/contrib/gis/measure/"},"formats":{"html":"/ja/5.2/ref/contrib/gis/functions/","markdown":"/ja/5.2/ref/contrib/gis/functions.md","json":"/ja/5.2/ref/contrib/gis/functions.json"},"source":"https://github.com/django/django/blob/stable/5.2.x/docs/ref/contrib/gis/functions.txt","official":"https://docs.djangoproject.com/ja/5.2/ref/contrib/gis/functions/","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","1.9"],"inLocales":["en","sv","zh-hans","ga","fr","ja","id","it","pt-br","ko","es","el","pl"]}