Class GreatCircleSubset

java.lang.Object
org.apache.commons.geometry.spherical.twod.GreatCircleSubset
All Implemented Interfaces:
Embedding<Point2S,Point1S>, HyperplaneSubset<Point2S>, Splittable<Point2S, HyperplaneSubset<Point2S>>, RegionEmbedding<Point2S,Point1S>, Sized
Direct Known Subclasses:
EmbeddedTreeGreatCircleSubset, GreatArc
public abstract class GreatCircleSubset extends Object implements HyperplaneSubset<Point2S>, RegionEmbedding<Point2S,Point1S>
Class representing a subset of the points in a great circle.
See Also:

  • Field Details

    • circle

      private final GreatCircle circle
      The great circle defining this instance.

  • Constructor Details

    • GreatCircleSubset

      GreatCircleSubset(GreatCircle circle)
      Simple constructor.
      Parameters:
      circle - great circle defining this instance

  • Method Details

    • getCircle

      public GreatCircle getCircle()
      Get the great circle defining this instance.
      Returns:
      the great circle defining this instance
      See Also:

    • getHyperplane

      public GreatCircle getHyperplane()
      Get the hyperplane containing this instance.
      Specified by:
      getHyperplane in interface HyperplaneSubset<Point2S>
      Returns:
      the hyperplane containing this instance

    • toSubspace

      public Point1S toSubspace(Point2S pt)
      Transform a space point into a subspace point.
      Specified by:
      toSubspace in interface Embedding<Point2S,Point1S>
      Parameters:
      pt - n-dimension point of the space
      Returns:
      lower-dimension point of the subspace corresponding to the specified space point
      See Also:

    • toSpace

      public Point2S toSpace(Point1S pt)
      Transform a subspace point into a space point.
      Specified by:
      toSpace in interface Embedding<Point2S,Point1S>
      Parameters:
      pt - lower-dimension point of the subspace
      Returns:
      n-dimension point of the space corresponding to the specified subspace point
      See Also:

    • isFull

      public boolean isFull()
      Return true if this instance contains all points in the hyperplane.
      Specified by:
      isFull in interface HyperplaneSubset<Point2S>
      Returns:
      true if this instance contains all points in the hyperplane

    • isEmpty

      public boolean isEmpty()
      Return true if this instance does not contain any points.
      Specified by:
      isEmpty in interface HyperplaneSubset<Point2S>
      Returns:
      true if this instance does not contain any points

    • getSize

      public double getSize()
      Get the size of the instance.
      Specified by:
      getSize in interface Sized
      Returns:
      the size of the instance

    • getCentroid

      public Point2S getCentroid()
      Get the centroid, or geometric center, of the hyperplane subset or null if no centroid exists or one exists but is not unique. A centroid will not exist for empty or infinite subsets.

      The centroid of a geometric object is defined as the mean position of all points in the object, including interior points, vertices, and other points lying on the boundary. If a physical object has a uniform density, then its center of mass is the same as its geometric centroid.

      Specified by:
      getCentroid in interface HyperplaneSubset<Point2S>
      Returns:
      the centroid of the hyperplane subset or null if no unique centroid exists
      See Also:

    • classify

      public RegionLocation classify(Point2S pt)
      Classify a point with respect to the subset region. The point is classified as follows:
      • INSIDE - The point lies on the hyperplane and inside of the subset region.
      • BOUNDARY - The point lies on the hyperplane and is on the boundary of the subset region.
      • OUTSIDE - The point does not lie on the hyperplane or it does lie on the hyperplane but is outside of the subset region.
      Specified by:
      classify in interface HyperplaneSubset<Point2S>
      Parameters:
      pt - the point to classify
      Returns:
      classification of the point with respect to the hyperplane and subspace region

    • closest

      public Point2S closest(Point2S pt)
      Return the closest point to the argument that is contained in the subset (ie, not classified as outside), or null if no such point exists.
      Specified by:
      closest in interface HyperplaneSubset<Point2S>
      Parameters:
      pt - the reference point
      Returns:
      the closest point to the reference point that is contained in the subset, or null if no such point exists

    • toConvex

      public abstract List<GreatArc> toConvex()
      Convert this instance into a list of convex child subsets representing the same region. Implementations are not required to return an optimal convex subdivision of the current instance. They are free to return whatever subdivision is readily available.
      Specified by:
      toConvex in interface HyperplaneSubset<Point2S>
      Returns:
      a list of hyperplane convex subsets representing the same subspace region as this instance

    • getSubspaceRegion

      public abstract HyperplaneBoundedRegion<Point1S> getSubspaceRegion()
      Get the embedded subspace region.
      Specified by:
      getSubspaceRegion in interface RegionEmbedding<Point2S,Point1S>
      Returns:
      the embedded subspace region

    • getPrecision

      public org.apache.commons.numbers.core.Precision.DoubleEquivalence getPrecision()
      Return the object used to perform floating point comparisons, which is the same object used by the underlying GreatCircle.
      Returns:
      precision object used to perform floating point comparisons.