agi.foundation.geometry.discrete

(agi.foundation.spatial-2024r3.jar)

Class SpecifiedCollectionCoverageGriddingTechnique

java.lang.Object

agi.foundation.geometry.discrete.SpecifiedCollectionCoverageGriddingTechnique

All Implemented Interfaces:

ICoverageGriddingTechnique

public class SpecifiedCollectionCoverageGriddingTechnique
extends Object
implements ICoverageGriddingTechnique

Grids a given coordinate by the specified collection.

Constructor Summary

Constructors

Constructor and Description
SpecifiedCollectionCoverageGriddingTechnique(Iterable<Double> points) Initializes the gridding method with the specified collection.

Method Summary

Modifier and Type	Method and Description
List<Double>	grid(Bounds coordinateBounds, boolean isCyclic) Grids the coordinate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpecifiedCollectionCoverageGriddingTechnique

public SpecifiedCollectionCoverageGriddingTechnique(@Nonnull
                                                    Iterable<Double> points)

Initializes the gridding method with the specified collection.

The input collection will be copied and sorted in ascending order, and each point will be verified to be within the bounds.

Parameters:

points - The collection of points.

Throws:

ArgumentNullException - Thrown if points is null.

Method Detail

grid

@Nonnull
public final List<Double> grid(@Nonnull
                                         Bounds coordinateBounds,
                                         boolean isCyclic)

Grids the coordinate.

Specified by:

grid in interface ICoverageGriddingTechnique

Parameters:

coordinateBounds - The bounds for the coordinate that is to be gridded. These bounds are inclusive.

isCyclic - Indicates if the coordinate is cyclic (i.e. an angle). Winding must be removed before gridding.

Returns:

A list of sorted grid points in the coordinate. The list is sorted in ascending order.

Throws:

IllegalStateException - Thrown if any point within the collection is outside of the bounds of the gridding coordinate.