agi.foundation.geometry.discrete

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

Class SpecifiedNumberOfPointsCoverageGriddingTechnique

java.lang.Object

agi.foundation.geometry.discrete.SpecifiedNumberOfPointsCoverageGriddingTechnique

All Implemented Interfaces:

ICoverageGriddingTechnique

public class SpecifiedNumberOfPointsCoverageGriddingTechnique
extends Object
implements ICoverageGriddingTechnique

Grids a given coordinate with a specified number of points. The input range is gridded from the lower to the upper bounds inclusive. If fewer than two points are requested then the lower bounds is returned as the sole grid point. When cyclic gridding is selected this technique will be sure to only place one point at 0/2pi.

Constructor Summary

Constructors

Constructor and Description
SpecifiedNumberOfPointsCoverageGriddingTechnique(int numberOfPoints) Initializes the gridding method with the specified number of points.

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

SpecifiedNumberOfPointsCoverageGriddingTechnique

public SpecifiedNumberOfPointsCoverageGriddingTechnique(int numberOfPoints)

Initializes the gridding method with the specified number of points.

Parameters:

numberOfPoints - The number of points this coordinate is to have.

Throws:

ArgumentException - Thrown if numberOfPoints is less than one.

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.