Package uk.ac.rdg.resc.edal.grid

Class RectilinearGridImpl

java.lang.Object

uk.ac.rdg.resc.edal.grid.AbstractHorizontalGrid

uk.ac.rdg.resc.edal.grid.RectilinearGridImpl

All Implemented Interfaces:

Serializable, DiscreteDomain<HorizontalPosition,GridCell2D>, DiscreteHorizontalDomain<GridCell2D>, Domain<HorizontalPosition>, HorizontalDomain, HorizontalGrid, RectilinearGrid

Direct Known Subclasses:

RegularGridImpl

public class RectilinearGridImpl
extends AbstractHorizontalGrid
implements RectilinearGrid, Serializable

Immutable implementation of a RectilinearGrid using Doubles.

Author:

Guy Griffiths

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ReferenceableAxis<Double>	xAxis
protected ReferenceableAxis<Double>	yAxis

Fields inherited from class uk.ac.rdg.resc.edal.grid.AbstractHorizontalGrid

crs

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RectilinearGridImpl(org.opengis.referencing.crs.CoordinateReferenceSystem crs)	Single-argument constructor for subclasses who would rather create their axes from constructor arguments (see RegularGridImpl for an example)
	RectilinearGridImpl(ReferenceableAxis<Double> xAxis, ReferenceableAxis<Double> yAxis, org.opengis.referencing.crs.CoordinateReferenceSystem crs)	Instantiates a new rectilinear grid from the given axes

Method Summary

Modifier and Type	Method	Description
boolean	contains(HorizontalPosition position)
boolean	equals(Object obj)
GridCoordinates2D	findIndexOf(HorizontalPosition position)	Finds the index of the specified position within this domain
BoundingBox	getBoundingBox()	Returns the bounding box of the domain in the domain's own coordinate reference system.
org.opengis.referencing.crs.CoordinateReferenceSystem	getCoordinateReferenceSystem()	Returns the co-ordinate reference system of this domain
Array2D<GridCell2D>	getDomainObjects()	Returns an Array of domain objects that comprise this domain.
org.opengis.metadata.extent.GeographicBoundingBox	getGeographicBoundingBox()	Returns the bounding box of the domain in WGS84 latitude-longitude coordinates.
ReferenceableAxis<Double>	getXAxis()	Gets the x axis of the grid.
int	getXSize()
ReferenceableAxis<Double>	getYAxis()	Gets the y axis of the grid.
int	getYSize()
int	hashCode()
long	size()	Returns the size of this domain.

Methods inherited from class java.lang.Object

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

Field Detail

xAxis

protected ReferenceableAxis<Double> xAxis

yAxis

protected ReferenceableAxis<Double> yAxis

Constructor Detail

RectilinearGridImpl

protected RectilinearGridImpl(org.opengis.referencing.crs.CoordinateReferenceSystem crs)

Single-argument constructor for subclasses who would rather create their axes from constructor arguments (see RegularGridImpl for an example)

RectilinearGridImpl

public RectilinearGridImpl(ReferenceableAxis<Double> xAxis,
                           ReferenceableAxis<Double> yAxis,
                           org.opengis.referencing.crs.CoordinateReferenceSystem crs)

Instantiates a new rectilinear grid from the given axes

Parameters:

xAxis - the x-axis

yAxis - the y-axis

crs - the CoordinateReferenceSystem

Method Detail

getDomainObjects

public Array2D<GridCell2D> getDomainObjects()

Description copied from interface: DiscreteDomain

Returns an Array of domain objects that comprise this domain.

Specified by:

getDomainObjects in interface DiscreteDomain<HorizontalPosition,GridCell2D>

Specified by:

getDomainObjects in interface HorizontalGrid

contains

public boolean contains(HorizontalPosition position)

Specified by:

contains in interface Domain<HorizontalPosition>

Returns:

true if the given position is contained within this domain.

getBoundingBox

public BoundingBox getBoundingBox()

Description copied from interface: HorizontalDomain

Returns the bounding box of the domain in the domain's own coordinate reference system. For domains which do not have a native co-ordinate reference system this may return a BoundingBox in a different CRS. Consequently this BoundingBox is not guaranteed to be a tight bound around the domain.

Specified by:

getBoundingBox in interface HorizontalDomain

getGeographicBoundingBox

public org.opengis.metadata.extent.GeographicBoundingBox getGeographicBoundingBox()

Description copied from interface: HorizontalDomain

Returns the bounding box of the domain in WGS84 latitude-longitude coordinates.

Specified by:

getGeographicBoundingBox in interface HorizontalDomain

getXAxis

public ReferenceableAxis<Double> getXAxis()

Description copied from interface: RectilinearGrid

Gets the x axis of the grid.

Specified by:

getXAxis in interface RectilinearGrid

getYAxis

public ReferenceableAxis<Double> getYAxis()

Description copied from interface: RectilinearGrid

Gets the y axis of the grid.

Specified by:

getYAxis in interface RectilinearGrid

getCoordinateReferenceSystem

public org.opengis.referencing.crs.CoordinateReferenceSystem getCoordinateReferenceSystem()

Description copied from interface: HorizontalDomain

Returns the co-ordinate reference system of this domain

Specified by:

getCoordinateReferenceSystem in interface HorizontalDomain

Overrides:

getCoordinateReferenceSystem in class AbstractHorizontalGrid

size

public long size()

Description copied from interface: HorizontalGrid

Returns the size of this domain. Equivalent to getXSize() * getYSize()

Specified by:

size in interface DiscreteHorizontalDomain<GridCell2D>

Specified by:

size in interface HorizontalGrid

findIndexOf

public GridCoordinates2D findIndexOf(HorizontalPosition position)

Description copied from interface: HorizontalGrid

Finds the index of the specified position within this domain

Specified by:

findIndexOf in interface HorizontalGrid

Parameters:

position - The position to find the index of

Returns:

A GridCoordinates2D object representing the index of the position within the domain, or null if the position is outside the domain.

getXSize

public int getXSize()

Specified by:

getXSize in interface HorizontalGrid

Returns:

The size of the x-axis

getYSize

public int getYSize()

Specified by:

getYSize in interface HorizontalGrid

Returns:

The size of the y-axis

hashCode

public int hashCode()

Specified by:

hashCode in interface HorizontalGrid

Overrides:

hashCode in class AbstractHorizontalGrid

equals

public boolean equals(Object obj)

Specified by:

equals in interface HorizontalGrid

Overrides:

equals in class AbstractHorizontalGrid