agi.foundation.geometry.discrete

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

Class SpecifiedResolutionCoverageGriddingTechnique

java.lang.Object

agi.foundation.geometry.discrete.SpecifiedResolutionCoverageGriddingTechnique

All Implemented Interfaces:

ICoverageGriddingTechnique

public class SpecifiedResolutionCoverageGriddingTechnique
extends Object
implements ICoverageGriddingTechnique

Grids a given coordinate with a specified resolution. The input range is gridded with the gridding start location included, and the lower and upper bounds excluded. These end points may be included by setting the appropriate flags. When cyclic gridding is selected this technique will be sure to only place one point at 0/2pi.

Constructor Summary

Constructors

Constructor and Description
SpecifiedResolutionCoverageGriddingTechnique(double resolution) Initializes the gridding method with the specified resolution, both bounds explicitly included, and the gridding start point set to the lower bounds.
SpecifiedResolutionCoverageGriddingTechnique(double resolution, Double griddingStartPoint, boolean includeExactBounds) Initializes the gridding method.
SpecifiedResolutionCoverageGriddingTechnique(double resolution, Double griddingStartPoint, boolean includeExactLowerBound, boolean includeExactUpperBound) Initializes the gridding method.

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

SpecifiedResolutionCoverageGriddingTechnique

public SpecifiedResolutionCoverageGriddingTechnique(double resolution)

Initializes the gridding method with the specified resolution, both bounds explicitly included, and the gridding start point set to the lower bounds.

Parameters:

resolution - The spacing in this coordinate.

SpecifiedResolutionCoverageGriddingTechnique

public SpecifiedResolutionCoverageGriddingTechnique(double resolution,
                                                    @Nullable
                                                    Double griddingStartPoint,
                                                    boolean includeExactBounds)

Initializes the gridding method.

The griddingStartPoint must lie within the coordinate bounds.

Parameters:

resolution - The space between points in the coordinate.

griddingStartPoint - The optional starting point for the gridding algorithm. If this is null then gridding will begin at the lower bound. Gridding proceeds in both directions from this point.

includeExactBounds - A boolean indicating if the exact upper and lower bounds are to be included.

Throws:

ArgumentException - Thrown if resolution is not positive.

SpecifiedResolutionCoverageGriddingTechnique

public SpecifiedResolutionCoverageGriddingTechnique(double resolution,
                                                    @Nullable
                                                    Double griddingStartPoint,
                                                    boolean includeExactLowerBound,
                                                    boolean includeExactUpperBound)

Initializes the gridding method.

The griddingStartPoint must lie within the coordinate bounds.

Parameters:

resolution - The space between points in the coordinate.

griddingStartPoint - The optional starting point for the gridding algorithm. If this is null then gridding will begin at the lower bound. Gridding proceeds in both directions from this point.

includeExactLowerBound - A boolean indicating if the exact lower bounds is to be included.

includeExactUpperBound - A boolean indicating if the exact upper bounds is to be included.

Throws:

ArgumentException - Thrown if resolution is not positive.

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.