Class/Object

geotrellis.vector

Line

Related Docs: object Line | package vector

Permalink

case class Line(jtsGeom: LineString) extends Geometry with OneDimension with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, OneDimension, AtLeastOneDimension, AtMostOneDimension, Dimensions, Geometry, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Line
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. OneDimension
  7. AtLeastOneDimension
  8. AtMostOneDimension
  9. Dimensions
  10. Geometry
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Line(jtsGeom: LineString)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def &(g: AtLeastOneDimension): OneDimensionAtLeastOneDimensionIntersectionResult

    Permalink

    Computes a Result that represents a Geometry made up of the points shared by this Line and a geometry of at least one dimension.

    Computes a Result that represents a Geometry made up of the points shared by this Line and a geometry of at least one dimension.

    g

    the geometry to intersect with

  4. def &(mp: MultiPoint): MultiPointAtLeastOneDimensionIntersectionResult

    Permalink

    Computes a Result that represents a Geometry made up of the points shared by this Line and a MultiPoint.

    Computes a Result that represents a Geometry made up of the points shared by this Line and a MultiPoint.

    mp

    the multipoint to intersect with

  5. def &(p: Point): PointOrNoResult

    Permalink

    Computes a Result that represents a Geometry made up of the points shared by this Line and p.

    Computes a Result that represents a Geometry made up of the points shared by this Line and p.

    p

    the point to intersect with

  6. def &(g: Geometry): TwoDimensionsTwoDimensionsIntersectionResult

    Permalink
    Definition Classes
    Geometry
  7. def -(g: AtLeastOneDimension): LineAtLeastOneDimensionDifferenceResult

    Permalink

    Computes a Result that represents a Geometry made up of all the points in this Line that are not in g.

    Computes a Result that represents a Geometry made up of all the points in this Line that are not in g.

    g

    the geometry to diff against

  8. def -(g: ZeroDimensions): LineResult

    Permalink

    Computes a Result that represents a Geometry made up of all the points in this Line that are not in g.

    Computes a Result that represents a Geometry made up of all the points in this Line that are not in g.

    g

    the geometry to diff against

  9. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def as[G <: Geometry](implicit arg0: ClassTag[G]): Option[G]

    Permalink

    Attempt to convert this Geometry to the provided type

    Attempt to convert this Geometry to the provided type

    Definition Classes
    Geometry
  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. lazy val boundary: OneDimensionBoundaryResult

    Permalink

    Returns the boundary of this Line.

    Returns the boundary of this Line. The boundary of a non-closed Line consists of its two end points. The boundary of a closed Line is empty.

  13. def buffer(d: Double): Polygon

    Permalink

    Computes a buffer area around this Line having width d.

    Computes a buffer area around this Line having width d.

    d

    the buffer width

  14. def centroid: PointOrNoResult

    Permalink

    Calculate centroid of this Geometry

    Calculate centroid of this Geometry

    Definition Classes
    Geometry
  15. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def closed(): Line

    Permalink

    Returns a closed version of the line.

    Returns a closed version of the line. If already closed, just return this.

  17. def contains(g: AtMostOneDimension): Boolean

    Permalink

    Tests whether this Line contains the specified AtMostOneDimension g.

    Tests whether this Line contains the specified AtMostOneDimension g. Returns true if the DE-9IM Intersection Matrix for the two geometries is T*****FF*.

    g

    the geometry to use in containment check

  18. def coveredBy(g: AtLeastOneDimension): Boolean

    Permalink

    Tests whether this Line is covered by the specified AtLeastOneDimension g.

    Tests whether this Line is covered by the specified AtLeastOneDimension g. Returns true if the DE-9IM Intersection Matrix for the two geometries is T*F**F*** or *TF**F*** or **FT*F*** or **F*TF***.

    g

    the geometry to use in checking whether this line is covered

  19. def covers(g: AtMostOneDimension): Boolean

    Permalink

    Tests whether this Line covers the specified AtMostOneDimensions g.

    Tests whether this Line covers the specified AtMostOneDimensions g. Returns true if the DE-9IM Intersection Matrix for the two geometries is T*****FF* or *T****FF* or ***T**FF* or ****T*FF*.

    g

    the geometry to check for coverage over

  20. def crosses(g: AtLeastOneDimension): Boolean

    Permalink

    Tests whether this Line crosses the specified AtLeastOneDimension g.

    Tests whether this Line crosses the specified AtLeastOneDimension g. Returns true if the DE-9IM Intersection Matrix for the two geometries is 0******** (L/L) or T*T****** (L/A).

    g

    the geometry to check if this line crosses

  21. def crosses(mp: MultiPoint): Boolean

    Permalink

    Tests whether this Line crosses the specified MultiPoint mp.

    Tests whether this Line crosses the specified MultiPoint mp. Returns true if the DE-9IM Intersection Matrix for the two geometries is T*****T** (L/P).

    mp

    the multipoint to check if this line crosses

  22. def difference(g: AtLeastOneDimension): LineAtLeastOneDimensionDifferenceResult

    Permalink

    Computes a Result that represents a Geometry made up of all the points in this Line that are not in g.

    Computes a Result that represents a Geometry made up of all the points in this Line that are not in g.

    g

    the geometry to diff against

  23. def difference(g: ZeroDimensions): LineResult

    Permalink

    Computes a Result that represents a Geometry made up of all the points in this Line that are not in g.

    Computes a Result that represents a Geometry made up of all the points in this Line that are not in g.

    g

    the geometry to diff against

  24. def disjoint(other: Geometry): Boolean

    Permalink
    Definition Classes
    Geometry
  25. def distance(other: Geometry): Double

    Permalink

    Calculate the distance to another Geometry

    Calculate the distance to another Geometry

    Definition Classes
    Geometry
  26. def envelope: Extent

    Permalink
    Definition Classes
    Geometry
  27. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. def equals(other: Any): Boolean

    Permalink
    Definition Classes
    Geometry → AnyRef → Any
  29. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  30. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  31. def hashCode(): Int

    Permalink
    Definition Classes
    Geometry → AnyRef → Any
  32. def interiorPoint: PointOrNoResult

    Permalink
    Definition Classes
    Geometry
  33. def intersection(g: AtLeastOneDimension): OneDimensionAtLeastOneDimensionIntersectionResult

    Permalink

    Computes a Result that represents a Geometry made up of the points shared by this Line and g.

    Computes a Result that represents a Geometry made up of the points shared by this Line and g.

    g

    the geometry to intersect with

  34. def intersection(mp: MultiPoint): MultiPointAtLeastOneDimensionIntersectionResult

    Permalink

    Computes a Result that represents a Geometry made up of the points shared by this Line and a MultiPoint.

    Computes a Result that represents a Geometry made up of the points shared by this Line and a MultiPoint.

    mp

    the multipoint to intersect with

  35. def intersection(p: Point): PointOrNoResult

    Permalink

    Computes a Result that represents a Geometry made up of the points shared by this Line and a Point.

    Computes a Result that represents a Geometry made up of the points shared by this Line and a Point.

    p

    the point to intersect with

  36. def intersection(g: Geometry): TwoDimensionsTwoDimensionsIntersectionResult

    Permalink

    Computes a Result that represents a Geometry made up of the points shared by this Polygon and g.

    Computes a Result that represents a Geometry made up of the points shared by this Polygon and g.

    Definition Classes
    Geometry
  37. def intersectionSafe(g: Geometry): TwoDimensionsTwoDimensionsIntersectionResult

    Permalink

    Computes a Result that represents a Geometry made up of the points shared by this Polygon and g.

    Computes a Result that represents a Geometry made up of the points shared by this Polygon and g. If it fails, it reduces the precision to avoid TopologyException.

    Definition Classes
    Geometry
  38. def intersects(other: Geometry): Boolean

    Permalink
    Definition Classes
    Geometry
  39. lazy val isClosed: Boolean

    Permalink

    Tests if the initial vertex equals the final vertex.

  40. def isEmpty: Boolean

    Permalink

    Is this Geometry empty? This is faster than checking manually like:

    Is this Geometry empty? This is faster than checking manually like:

    val mp: MultiPoint = ...
    val ps: Array[Point] = mp.points  // `.points` is a lazy val with processing overhead
    
    ps.isEmpty  // possible, but mp.isEmpty is faster

    It would be similar for MultiLine or MultiPolygon.

    Definition Classes
    Geometry
  41. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  42. lazy val isSimple: Boolean

    Permalink

    Tests whether this Line is simple.

    Tests whether this Line is simple. A Line is simple iff it does not self-intersect at points other than boundary points.

  43. def isValid: Boolean

    Permalink

    Check the validity of this geometry

    Check the validity of this geometry

    Definition Classes
    Geometry
  44. val jtsGeom: LineString

    Permalink

    Return the wrapped jts Geometry

    Return the wrapped jts Geometry

    Definition Classes
    LineDimensionsGeometry
  45. lazy val length: Double

    Permalink

    Returns the length of this Line.

  46. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  47. def normalized(): Line

    Permalink

    Returns a unique representation of the geometry based on standard coordinate ordering.

  48. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  49. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  50. def overlaps(g: OneDimension): Boolean

    Permalink

    Tests whether this Line overlaps the specified OneDimension g.

    Tests whether this Line overlaps the specified OneDimension g. Returns true if The DE-9IM Intersection Matrix for the two geometries is 1*T***T**.

    g

    the geometry to check for overlap against

  51. def points: Array[Point]

    Permalink

    Returns the points which determine this line (i.e.

    Returns the points which determine this line (i.e. its vertices

  52. def symDifference(mp: MultiPolygon): LineMultiPolygonSymDifferenceResult

    Permalink

    Computes a Result that represents a Geometry made up of all the points in this Line that are not in mp and all the points in mp that are not in this Line.

    Computes a Result that represents a Geometry made up of all the points in this Line that are not in mp and all the points in mp that are not in this Line.

    mp

    the multipolygon to diff against

  53. def symDifference(p: Polygon): AtMostOneDimensionPolygonSymDifferenceResult

    Permalink

    Computes a Result that represents a Geometry made up of all the points in this Line that are not in p and all the points in p that are not in this Line.

    Computes a Result that represents a Geometry made up of all the points in this Line that are not in p and all the points in p that are not in this Line.

    p

    the polygon to diff against

  54. def symDifference(g: OneDimension): OneDimensionOneDimensionSymDifferenceResult

    Permalink

    Computes a Result that represents a Geometry made up of all the points in this Line that are not in g and all the points in g that are not in this Line.

    Computes a Result that represents a Geometry made up of all the points in this Line that are not in g and all the points in g that are not in this Line.

    g

    the geometry to diff against

  55. def symDifference(g: ZeroDimensions): ZeroDimensionsLineSymDifferenceResult

    Permalink

    Computes a Result that represents a Geometry made up of all the points in this Line that are not in g and all the points in g that are not in this Line.

    Computes a Result that represents a Geometry made up of all the points in this Line that are not in g and all the points in g that are not in this Line.

    g

    the geometry to diff against

  56. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  57. def toString(): String

    Permalink
    Definition Classes
    Geometry → AnyRef → Any
  58. def touches(g: Geometry): Boolean

    Permalink

    Tests whether this Line touches the specified Geometry g.

    Tests whether this Line touches the specified Geometry g. Returns true if the DE-9IM Intersection Matrix for the two geometries is FT*******, F**T***** or F***T****.

    g

    the geometry to check if this line is touching

  59. def union(mp: MultiPolygon): LineMultiPolygonUnionResult

    Permalink

    Computes a Result that represents a Geometry made up of all the points in this Line and a MultiPolygon.

  60. def union(p: Polygon): AtMostOneDimensionPolygonUnionResult

    Permalink

    Computes a Result that represents a Geometry made up of all the points in this Line and a Polygon.

    Computes a Result that represents a Geometry made up of all the points in this Line and a Polygon.

    p

    the geometry to union with

  61. def union(g: OneDimension): LineOneDimensionUnionResult

    Permalink

    Computes a Result that represents a Geometry made up of all the points in this Line and a OneDimension geometry.

    Computes a Result that represents a Geometry made up of all the points in this Line and a OneDimension geometry.

    g

    the geometry to union with

  62. def union(g: ZeroDimensions): ZeroDimensionsLineUnionResult

    Permalink

    Computes a Result that represents a Geometry made up of all the points in this Line and a a ZeroDimensions geometry.

    Computes a Result that represents a Geometry made up of all the points in this Line and a a ZeroDimensions geometry.

    g

    the geometry to union with

  63. lazy val vertexCount: Int

    Permalink

    Returns the number of vertices in this geometry

  64. def vertices: Array[Point]

    Permalink

    Returns the points which determine this line (i.e.

    Returns the points which determine this line (i.e. its vertices

  65. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  66. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  67. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  68. def within(g: AtLeastOneDimension): Boolean

    Permalink

    Tests whether this Line is within the specified AtLeastOneDimension g.

    Tests whether this Line is within the specified AtLeastOneDimension g. Returns true if the DE-9IM Intersection Matrix for the two geometries is T*F**F***.

    g

    the geometry to check if this line is within

  69. def withinDistance(other: Geometry, dist: Double): Boolean

    Permalink

    Determine whether another Geometry is within a given distance

    Determine whether another Geometry is within a given distance

    other

    The geometry to check

    dist

    The radius of the circle within which this check is conducted

    Definition Classes
    Geometry
  70. def |(mp: MultiPolygon): LineMultiPolygonUnionResult

    Permalink

    Computes a Result that represents a Geometry made up of all the points in this Line and a MultiPolygon.

  71. def |(p: Polygon): AtMostOneDimensionPolygonUnionResult

    Permalink

    Computes a Result that represents a Geometry made up of all the points in this Line and a Polygon.

    Computes a Result that represents a Geometry made up of all the points in this Line and a Polygon.

    p

    the geometry to union with

  72. def |(g: OneDimension): LineOneDimensionUnionResult

    Permalink

    Computes a Result that represents a Geometry made up of all the points in this Line and a OneDimension geometry.

    Computes a Result that represents a Geometry made up of all the points in this Line and a OneDimension geometry.

    g

    the geometry to union with

  73. def |(g: ZeroDimensions): ZeroDimensionsLineUnionResult

    Permalink

    Computes a Result that represents a Geometry made up of all the points in this Line and a a ZeroDimensions geometry.

    Computes a Result that represents a Geometry made up of all the points in this Line and a a ZeroDimensions geometry.

    g

    the geometry to union with

Deprecated Value Members

  1. def safeIntersection(g: Geometry): TwoDimensionsTwoDimensionsIntersectionResult

    Permalink
    Definition Classes
    Geometry
    Annotations
    @deprecated
    Deprecated

    (Since version 1.2) This will be removed in 2.0 - use intersectionSafe instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from OneDimension

Inherited from AtLeastOneDimension

Inherited from AtMostOneDimension

Inherited from Dimensions

Inherited from Geometry

Inherited from AnyRef

Inherited from Any

Ungrouped