ilog.views.maps.format.cadrg

Class IlvCADRGCoverage

java.lang.Object

ilog.views.maps.format.cadrg.IlvCADRGCoverage

public class IlvCADRGCoverage
extends Object

This class stores information about a CADRG coverage as described in a CADRG table of contents. A coverage corresponds physically to a directory in a CADRG distribution. It is composed of a set of frames that are part of the same map.
Most of the coverages are georeferenced, except for those used to store the overview of a CADRG product or the map legends.

Instances of the class IlvCADRGCoverage can be obtained using an IlvCADRGTocReader.

Since:

Rogue Wave JViews 3.0

See Also:

IlvCADRGTocReader

Constructor Summary

Constructors

Constructor and Description
IlvCADRGCoverage(int index, IlvCoordinate upperLeftCorner, IlvCoordinate lowerLeftCorner, IlvCoordinate upperRightCorner, IlvCoordinate lowerRightCorner, double verticalResolution, double horizontalResolution, double verticalInterval, double horizontalInterval, int rows, int columns, String tocPathName, boolean url) Creates a CADRG coverage instance.

Method Summary

Modifier and Type	Method and Description
int	getColumns() Returns the number of frame columns in the coverage.
IlvCoordinateSystem	getCoordinateSystem() Returns the coordinate system used for the coverage.
IlvCADRGFrame	getFrame(int row, int column) Returns the frame of the specified row and column.
double	getFrameHeight() Returns the height of a frame in the file's coordinate system.
double	getFrameWidth() Returns the width of a frame in the file's coordinate system.
double	getHorizontalInterval() Returns the longitude interval between two adjacent pixels of the image.
double	getHorizontalResolution() Returns the nominal horizontal resolution of pixels in the image.
IlvCoordinate	getLowerRightCorner() Returns the lower-right corner of the coverage's region in the coverage's coordinate system.
String	getName() Returns the name of this coverage.
IlvProjection	getProjection() Deprecated. Use #getCoordinateSystem instead.
int	getRows() Returns the number of frame rows in the coverage.
String	getScaleDescription() Returns the scale description of the coverage.
String	getTocPathName() Returns the toc path name.
IlvCoordinate	getUpperLeftCorner() Returns the upper-left corner of the coverage's region in the coverage's coordinate system.
double	getVerticalInterval() Returns the latitude interval between two adjacent pixels of the image.
double	getVerticalResolution() Returns the nominal vertical resolution of pixels in the image.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvCADRGCoverage

public IlvCADRGCoverage(int index,
                        IlvCoordinate upperLeftCorner,
                        IlvCoordinate lowerLeftCorner,
                        IlvCoordinate upperRightCorner,
                        IlvCoordinate lowerRightCorner,
                        double verticalResolution,
                        double horizontalResolution,
                        double verticalInterval,
                        double horizontalInterval,
                        int rows,
                        int columns,
                        String tocPathName,
                        boolean url)

Creates a CADRG coverage instance.
Note: the upperLeftCorner parameter and other points are expressed in degrees as read in the CADRG TOC.

Parameters:

index - The index of this coverage. This parameter is unused.

upperLeftCorner - The coordinate of the upper left corner in degrees.

lowerLeftCorner - The coordinate of the lower left corner in degrees.

upperRightCorner - The coordinate of the upper right corner in degrees.

lowerRightCorner - The coordinate of the lower right corner in degrees.

verticalResolution - The vertical resolution in meters.

horizontalResolution - The horizontal resolution in meters.

verticalInterval - The longitudinal interval between two adjacent pixels in degrees.

horizontalInterval - The latitudinal interval between two adjacent pixels in degrees.

rows - The number of rows in this coverage.

columns - The number of columns in this coverage.

tocPathName - The file name or URL of the table of content file.

url - Set to true if the table of content is found in a URL, set to true for a file name.

Since:

JViews 8.1

Method Detail

getRows

public int getRows()

Returns the number of frame rows in the coverage.

getColumns

public int getColumns()

Returns the number of frame columns in the coverage.

getScaleDescription

public String getScaleDescription()

Returns the scale description of the coverage. The scale is a 12-byte ASCII character string identifying in human-readable form the nominal scale (e.g. "l:lM", "1:12.5K") or nominal resolution (e.g. "100m" or "50m")

Since:

JViews 7.5

getFrameWidth

public double getFrameWidth()

Returns the width of a frame in the file's coordinate system.

getFrameHeight

public double getFrameHeight()

Returns the height of a frame in the file's coordinate system.

getFrame

public final IlvCADRGFrame getFrame(int row,
                                    int column)

Returns the frame of the specified row and column.

Parameters:

row - The row of the frame

column - The column of the frame

Returns:

null if the specified cell is empty.

getUpperLeftCorner

public IlvCoordinate getUpperLeftCorner()

Returns the upper-left corner of the coverage's region in the coverage's coordinate system.

getLowerRightCorner

public IlvCoordinate getLowerRightCorner()

Returns the lower-right corner of the coverage's region in the coverage's coordinate system.

getVerticalInterval

public double getVerticalInterval()

Returns the latitude interval between two adjacent pixels of the image. The interval is expressed in radians.

getHorizontalInterval

public double getHorizontalInterval()

Returns the longitude interval between two adjacent pixels of the image. The interval is expressed in radians.

getProjection

@Deprecated
public IlvProjection getProjection()

Deprecated. Use #getCoordinateSystem instead.

Returns the projection used for the coverage. The projection is either a geographic projection for non polar areas, or an azimuthal equidistant projection for polar areas.

getCoordinateSystem

public IlvCoordinateSystem getCoordinateSystem()

Returns the coordinate system used for the coverage. The coordinate system is either a geographic coordinate system for non polar areas, or a projected coordinate system with an azimuthal equidistant projection for polar areas.

Since:

JViews 5.0

getTocPathName

public final String getTocPathName()

Returns the toc path name.

Since:

JViews 7.5

getName

public String getName()

Returns the name of this coverage.

getVerticalResolution

public double getVerticalResolution()

Returns the nominal vertical resolution of pixels in the image. The resolution is measured in meters. If the exact geographic coordinates associated with the frame files in this coverage are unknown , this field will contain an invalid value.

Since:

JViews 7.5

getHorizontalResolution

public double getHorizontalResolution()

Returns the nominal horizontal resolution of pixels in the image. The resolution is measured in meters. If the exact geographic coordinates associated with the frame files in this coverage are unknown , this field will contain an invalid value.

Since:

JViews 7.5