django.contrib.gis.geos.linestring.LineString

class documentation

class LineString(LinearGeometryMixin, GEOSGeometry):

Known subclasses: django.contrib.gis.geos.linestring.LinearRing

View In Hierarchy

Undocumented

Method __init__ Initialize on the given sequence -- may take lists, tuples, NumPy arrays of X,Y pairs, or Point objects. If Point objects are used, ownership is _not_ transferred to the LineString object.
Method __iter__ Allow iteration over this LineString.
Method __len__ Return the number of points in this LineString.
Method ​_checkdim Undocumented
Method ​_get​_single​_external Undocumented
Method ​_listarr Return a sequence (list) corresponding with the given function. Return a numpy array if possible.
Method ​_set​_list Undocumented
Method ​_set​_single Undocumented
Class Variable ​_minlength Undocumented
Class Variable has​_cs Undocumented
Instance Variable ptr Undocumented
Instance Variable srid Get the SRID for the geometry. Return None if no SRID is set.
Property array Return a numpy array for the LineString.
Property tuple Return a tuple version of the geometry from the coordinate sequence.
Property x Return a list or numpy array of the X variable.
Property y Return a list or numpy array of the Y variable.
Property z Return a list or numpy array of the Z variable.

Inherited from LinearGeometryMixin:

Method interpolate Undocumented
Method interpolate​_normalized Undocumented
Method project Undocumented
Method project​_normalized Undocumented
Property closed Return whether or not this Geometry is closed.
Property merged Return the line merge of this Geometry.

Inherited from GEOSGeometryBase (via GEOSGeometry):

Class Method from​_gml Undocumented
Static Method from​_ewkt Undocumented
Class Method ​_from​_wkb Undocumented
Static Method ​_from​_wkt Undocumented
Method __and__ Return the intersection of this Geometry and the other.
Method __copy__ Return a clone because the copy of a GEOSGeometry may contain an invalid pointer location if the original is garbage collected.
Method __deepcopy__ The deepcopy routine is used by the Node class of django.utils.tree; thus, the protocol routine needs to be implemented to return correct copies (clones) of these GEOS objects, which use C pointers.
Method __eq__ Equivalence testing, a Geometry may be compared with another Geometry or an EWKT representation.
Method __getstate__ Undocumented
Method __hash__ Undocumented
Method __or__ Return the union of this Geometry and the other.
Method __repr__ Short-hand representation because WKT may be very large.
Method __setstate__ Undocumented
Method __str__ EWKT is used for the string representation.
Method __sub__ Return the difference this Geometry and the other.
Method __xor__ Return the symmetric difference of this Geometry and the other.
Method ​_from​_pickle​_wkb Undocumented
Method ​_ogr​_ptr Undocumented
Method ​_post​_init Perform post-initialization setup.
Method ​_to​_pickle​_wkb Undocumented
Method ​_topology Return Geometry from the given pointer.
Method buffer No summary
Method buffer​_with​_style Same as buffer() but allows customizing the style of the buffer.
Method clone Clone this Geometry.
Method contains Return true if other.within(this) returns true.
Method covers Return True if the DE-9IM Intersection Matrix for the two geometries is T*****FF*, T****FF, **T**FF, or ****T*FF*. If either geometry is empty, return False.
Method crosses Return true if the DE-9IM intersection matrix for the two Geometries is T*T****** (for a point and a curve,a point and an area or a line and an area) 0******** (for two curves).
Method difference Return a Geometry representing the points making up this Geometry that do not make up other.
Method disjoint Return true if the DE-9IM intersection matrix for the two Geometries is FF*FF****.
Method distance Return the distance between the closest points on this Geometry and the other. Units will be in those of the coordinate system of the Geometry.
Method equals Return true if the DE-9IM intersection matrix for the two Geometries is T*F**FFF*.
Method equals​_exact Return true if the two Geometries are exactly equal, up to a specified tolerance.
Method intersection Return a Geometry representing the points shared by this Geometry and other.
Method intersects Return true if disjoint return false.
Method normalize Convert this Geometry to normal form (or canonical form).
Method overlaps Return true if the DE-9IM intersection matrix for the two Geometries is T*T***T** (for two points or two surfaces) 1*T***T** (for two curves).
Method relate Return the DE-9IM intersection matrix for this Geometry and the other.
Method relate​_pattern Return true if the elements in the DE-9IM intersection matrix for the two Geometries match the elements in pattern.
Method simplify Return the Geometry, simplified using the Douglas-Peucker algorithm to the specified tolerance (higher tolerance => less points). If no tolerance provided, defaults to 0.
Method srid.setter Set the SRID for the geometry.
Method sym​_difference Return a set combining the points in this Geometry not in other, and the points in other not in this Geometry.
Method touches Return true if the DE-9IM intersection matrix for the two Geometries is FT*******, F**T***** or F***T****.
Method transform No summary
Method union Return a Geometry representing all the points in this Geometry and other.
Method within Return true if the DE-9IM intersection matrix for the two Geometries is T*F**F***.
Constant ​_GEOS​_CLASSES Undocumented
Instance Variable __class__ Undocumented
Instance Variable ​_cs Undocumented
Instance Variable ​_ptr Undocumented
Property area Return the area of the Geometry.
Property boundary Return the boundary as a newly allocated Geometry object.
Property centroid The centroid is equal to the centroid of the set of component Geometries of highest dimension (since the lower-dimension geometries contribute zero "weight" to the centroid).
Property convex​_hull Return the smallest convex Polygon that contains all the points in the Geometry.
Property coord​_seq Return a clone of the coordinate sequence for this Geometry.
Property crs Alias for srs property.
Property dims Return the dimension of this Geometry (0=point, 1=line, 2=surface).
Property empty Return a boolean indicating whether the set of points in this Geometry are empty.
Property envelope Return the envelope for this geometry (a polygon).
Property ewkb Return the EWKB representation of this Geometry as a Python buffer. This is an extension of the WKB specification that includes any SRID value that are a part of this geometry.
Property ewkt Return the EWKT (SRID + WKT) of the Geometry.
Property extent Return the extent of this geometry as a 4-tuple, consisting of (xmin, ymin, xmax, ymax).
Property geom​_type Return a string representing the Geometry type, e.g. 'Polygon'
Property geom​_typeid Return an integer representing the Geometry type.
Property hasz Return whether the geometry has a 3D dimension.
Property hex Return the WKB of this Geometry in hexadecimal form. Please note that the SRID is not included in this representation because it is not a part of the OGC specification (use the hexewkb property instead).
Property hexewkb Return the EWKB of this Geometry in hexadecimal form. This is an extension of the WKB specification that includes SRID value that are a part of this geometry.
Property json Return GeoJSON representation of this Geometry.
Property kml Return the KML representation of this Geometry.
Property length Return the length of this Geometry (e.g., 0 for point, or the circumference of a Polygon).
Property num​_coords Return the number of coordinates in the Geometry.
Property num​_geom Return the number of geometries in the Geometry.
Property num​_points Return the number points, or coordinates, in the Geometry.
Property ogr Return the OGR Geometry for this Geometry.
Property point​_on​_surface Compute an interior point of this Geometry.
Property prepared Return a PreparedGeometry corresponding to this geometry -- it is optimized for the contains, intersects, and covers operations.
Property ring Return whether or not the geometry is a ring.
Property simple Return false if the Geometry isn't simple.
Property srs Return the OSR SpatialReference for SRID of this Geometry.
Property unary​_union Return the union of all the elements of this geometry.
Property valid Test the validity of this Geometry.
Property valid​_reason Return a string containing the reason for any invalidity.
Property wkb Return the WKB (Well-Known Binary) representation of this Geometry as a Python buffer. SRID and Z values are not included, use the ewkb property instead.
Property wkt Return the WKT (Well-Known Text) representation of this Geometry.

Inherited from CPointerBase (via GEOSGeometry, GEOSGeometryBase, GEOSBase):

Method __del__ Free the memory used by the C++ object.
Method ptr.setter Undocumented
Class Variable destructor Undocumented

Inherited from ListMixin (via GEOSGeometry):

Method __add__ add another list-like object
Method __delitem__ Delete the item(s) at the specified index/slice.
Method __eq__ Undocumented
Method __getitem__ Get the item(s) at the specified index/slice.
Method __iadd__ add another list-like object to self
Method __imul__ multiply
Method __lt__ Undocumented
Method __mul__ multiply
Method __radd__ add to another list-like object
Method __rmul__ multiply
Method __setitem__ Set the item(s) at the specified index/slice.
Method ​_assign​_extended​_slice Assign an extended slice by re-assigning individual items
Method ​_assign​_extended​_slice​_rebuild Assign an extended slice by rebuilding entire list
Method ​_assign​_simple​_slice Assign a simple slice; Can assign slice of any length
Method ​_check​_allowed Undocumented
Method ​_checkindex Undocumented
Method ​_rebuild Undocumented
Method ​_set​_single​_rebuild Undocumented
Method ​_set​_slice Assign values to a slice of the object
Method append Standard list append method
Method count Standard list count method
Method extend Standard list extend method
Method index Standard list index method
Method insert Standard list insert method
Method pop Standard list pop method
Method remove Standard list remove method
Method reverse Standard list reverse method
Method sort Standard list sort method
Class Variable ​_maxlength Undocumented
Instance Variable ​_get​_single​_internal Undocumented
def __init__(self, *args, **kwargs):
overrides django.contrib.gis.geos.geometry.GEOSGeometry.__init__

Initialize on the given sequence -- may take lists, tuples, NumPy arrays of X,Y pairs, or Point objects. If Point objects are used, ownership is _not_ transferred to the LineString object.

Examples:
ls = LineString((1, 1), (2, 2)) ls = LineString([(1, 1), (2, 2)]) ls = LineString(array([(1, 1), (2, 2)])) ls = LineString(Point(1, 1), Point(2, 2))
def __iter__(self):
Allow iteration over this LineString.
def __len__(self):
Return the number of points in this LineString.
def _checkdim(self, dim):

Undocumented

def _get_single_external(self, index):

Undocumented

def _listarr(self, func):
Return a sequence (list) corresponding with the given function. Return a numpy array if possible.
def _set_list(self, length, items):

Undocumented

def _set_single(self, index, value):
overrides django.contrib.gis.geos.mutable_list.ListMixin._set_single

Undocumented

_minlength: int =
overrides django.contrib.gis.geos.mutable_list.ListMixin._minlength
overridden in django.contrib.gis.geos.linestring.LinearRing

Undocumented

has_cs: bool =
overrides django.contrib.gis.geos.geometry.GEOSGeometryBase.has_cs

Undocumented

ptr =
overrides django.contrib.gis.geos.geometry.GEOSGeometryBase.ptr

Undocumented

srid =
overrides django.contrib.gis.geos.geometry.GEOSGeometry.srid
Get the SRID for the geometry. Return None if no SRID is set.
@property
array =
Return a numpy array for the LineString.
@property
tuple =
Return a tuple version of the geometry from the coordinate sequence.
@property
x =
Return a list or numpy array of the X variable.
@property
y =
Return a list or numpy array of the Y variable.
@property
z =
Return a list or numpy array of the Z variable.