|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GridCoordSystem
A Coordinate System for gridded data. Assume:
Method Summary | |
---|---|
int[] |
findXYindexFromCoord(double x_coord,
double y_coord,
int[] result)
Given a point in x,y coordinate space, find the x,y indices. |
int[] |
findXYindexFromCoordBounded(double x_coord,
double y_coord,
int[] result)
Given a point in x,y coordinate space, find the x,y indices. |
int[] |
findXYindexFromLatLon(double lat,
double lon,
int[] result)
Given a lat,lon point, find the x,y index of the containing grid point. |
int[] |
findXYindexFromLatLonBounded(double lat,
double lon,
int[] result)
Given a lat,lon point, find the x,y index of the containing grid point. |
ProjectionRect |
getBoundingBox()
Get horizontal bounding box in projection coordinates. |
java.util.List<CoordinateAxis> |
getCoordinateAxes()
Get the list of all axes. |
java.util.List<CoordinateTransform> |
getCoordinateTransforms()
Get the list of all CoordinateTransforms. |
DateRange |
getDateRange()
If there is a time coordinate, get the time covered. |
java.util.List<Dimension> |
getDomain()
Get the list of dimensions used by any of the Axes in the Coordinate System. |
CoordinateAxis1D |
getEnsembleAxis()
Get the ensemble axis. |
LatLonPoint |
getLatLon(int xindex,
int yindex)
Get the Lat/Lon coordinates of the midpoint of a grid cell, using the x,y indices. |
LatLonRect |
getLatLonBoundingBox()
Get horizontal bounding box in lat, lon coordinates. |
java.lang.String |
getName()
The name of the Grid Coordinate System, consisting of the list of coordinate axes, seperated by blanks. |
ProjectionImpl |
getProjection()
Get the Projection that performs the transform math. |
ProjectionCT |
getProjectionCT()
Get the Projection CoordinateTransform. |
java.util.List<Range> |
getRangesFromLatLonRect(LatLonRect llbb)
Get Index Ranges for the given lat, lon bounding box. |
CoordinateAxis1DTime |
getRunTimeAxis()
Get the RunTime axis. |
CoordinateAxis |
getTimeAxis()
Get the Time axis, if it exists. |
CoordinateAxis1DTime |
getTimeAxis1D()
Get the Time axis, if it exists, and its 1-dimensional. |
CoordinateAxis1DTime |
getTimeAxisForRun(int run_index)
This is the case of a 2D time axis, which depends on the run index. |
CoordinateAxis1D |
getVerticalAxis()
Get the Z axis. |
VerticalCT |
getVerticalCT()
Get the Vertical CoordinateTransform, it it exists. |
VerticalTransform |
getVerticalTransform()
Get the VerticalTransform that performs the transform math. |
CoordinateAxis |
getXHorizAxis()
Get the X axis. |
CoordinateAxis |
getYHorizAxis()
Get the Y axis. |
boolean |
hasTimeAxis()
True if there is a Time Axis. |
boolean |
hasTimeAxis1D()
True if there is a Time Axis and it is 1D. |
boolean |
isLatLon()
Does this use lat/lon horizontal axes? If not, then the horizontal axes are GeoX, GeoY, and there must be a Projection defined. |
boolean |
isProductSet()
True if all axes are 1 dimensional. |
boolean |
isRegularSpatial()
True if both X and Y axes are 1 dimensional and are regularly spaced. |
boolean |
isZPositive()
True if increasing z coordinate values means "up" in altitude |
Method Detail |
---|
java.lang.String getName()
java.util.List<Dimension> getDomain()
java.util.List<CoordinateAxis> getCoordinateAxes()
boolean isProductSet()
CoordinateAxis getXHorizAxis()
CoordinateAxis getYHorizAxis()
CoordinateAxis1D getVerticalAxis()
CoordinateAxis getTimeAxis()
CoordinateAxis1D getEnsembleAxis()
CoordinateAxis1DTime getRunTimeAxis()
java.util.List<CoordinateTransform> getCoordinateTransforms()
ProjectionCT getProjectionCT()
ProjectionImpl getProjection()
VerticalCT getVerticalCT()
VerticalTransform getVerticalTransform()
boolean isLatLon()
LatLonRect getLatLonBoundingBox()
ProjectionRect getBoundingBox()
boolean isRegularSpatial()
java.util.List<Range> getRangesFromLatLonRect(LatLonRect llbb) throws InvalidRangeException
llbb
- a lat/lon bounding box.
InvalidRangeException
- if llbb generates bad rangesint[] findXYindexFromCoord(double x_coord, double y_coord, int[] result)
x_coord
- position in x coordinate space, ie, units of getXHorizAxis().y_coord
- position in y coordinate space, ie, units of getYHorizAxis().result
- optionally pass in the result array to use.
int[] findXYindexFromCoordBounded(double x_coord, double y_coord, int[] result)
x_coord
- position in x coordinate space, ie, units of getXHorizAxis().y_coord
- position in y coordinate space, ie, units of getYHorizAxis().result
- optionally pass in the result array to use.
int[] findXYindexFromLatLon(double lat, double lon, int[] result)
lat
- latitude position.lon
- longitude position.result
- put result in here, may be null
int[] findXYindexFromLatLonBounded(double lat, double lon, int[] result)
lat
- latitude position.lon
- longitude position.result
- return result here, may be null
LatLonPoint getLatLon(int xindex, int yindex)
xindex
- x indexyindex
- y index
boolean isZPositive()
DateRange getDateRange()
boolean hasTimeAxis()
boolean hasTimeAxis1D()
CoordinateAxis1DTime getTimeAxis1D()
CoordinateAxis1DTime getTimeAxisForRun(int run_index)
run_index
- which run?
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |