ilog.views.maps.raster

Class IlvRasterAbstractReader

java.lang.Object

ilog.views.maps.raster.IlvRasterAbstractReader

All Implemented Interfaces:

IlvPersistentObject, IlvMapFeatureIterator, IlvMapReusableFeatureIterator

Direct Known Subclasses:

IlvComputedRasterReader, IlvGTopo30Reader, IlvRasterASRPReader, IlvRasterBasicImageReader, IlvRasterCADRGReader, IlvRasterDTEDReader, IlvRasterGeoTiffReader, IlvRasterSDOReader

public abstract class IlvRasterAbstractReader
extends Object
implements IlvMapReusableFeatureIterator, IlvPersistentObject

Class containing the methods for all readers of raster image formats. It contains a built-in mechanism for tiling the image to be displayed.
The raster to be displayed is managed by IlvRasterMappedBuffer, information about the raster to be displayed in the image is in IlvRasterProperties, and the mechanism of the dynamic tiling is managed by a IlvRasterTileLoader.

The raster image will be read by the reader in a method of the subclassed reader, often called read. This method adds a raster to the list of the rasters using the addRaster(IlvRasterProperties, IlvRasterMappedBuffer)method. Then the image is built when the getTileLoader(int) method is called. It creates a IlvRasterTileLoaderto tile the raster.

The IlvRasterAbstractReader needs the projection or the original raster and the projection to use in the view. From these it can compute dynamically all the pixel values in the image to produce from the raster of the original image.
The classes extending the IlvRasterAbstractReader must provide the implementation of the getInternalTransformation(int)in order to provide the projection of the source.
The other projection is used to project the raster in order to fill the image created by the reader.

Since:

JViews 7.5

See Also:

IlvRasterProperties, IlvRasterMappedBuffer, IlvRasterTileLoader

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	needReload Indicates that this reader should be reloaded when the data source is called.

Constructor Summary

Constructors

Constructor and Description
IlvRasterAbstractReader() Default constructor.
IlvRasterAbstractReader(IlvInputStream stream) Stream constructor.

Method Summary

Modifier and Type	Method and Description
int	addRaster(IlvRasterProperties rasterInfo, IlvRasterMappedBuffer source) Adds a new set of image information to the list managed by the raster reader.
protected Rectangle2D.Double	computeGisImageBounds(int imgIndex, IlvRasterProperties rasterInfo) Computes the map bounds of the GIS image displaying the raster.
protected Rectangle2D.Double	computeLimits(int imgIndex, IlvCoordinate min, IlvCoordinate max, int horizStep, int verticStep) Compute bounds projected with the projection of the view given two points projected with the original projection.
IlvRasterTileLoader	createRasterTileLoader(IlvRasterProperties rasterInfo, IlvRasterMappedBuffer source, int imageIndex, boolean allowSubsampling) Creates the IlvRasterTileLoaderused to tile the images produced by the getTileLoader(int)method.
void	dispose() Disposes this reader.
IlvFeatureRenderer	getDefaultFeatureRenderer() Returns an IlvFeatureRenderer suitable for the IlvMapFeature built by this reader.
static int	getDefaultMaximumIntervalsForDeterminingImageLocation() Returns the default maximum number of intervals for determining the image location.
Rectangle2D.Double	getImageBounds(int imageIndex) Returns the bounds of the image in manager coordinates.
int	getImageCount() Returns The number of registered images.
abstract IlvMathTransform	getInternalTransformation(int imageIndex) Return the projection associated with the raster stored at the given index.
IlvCoordinateTransformation	getInverseTransformation() Gets the transformation used to reproject the data to produce the bounds returned by the getImageBounds(int)method.
IlvCoordinate	getLowerRightCorner() Retrieves the lower right corner of the image or null if none has been set.
protected IlvCoordinate	getLowerRightCorner(int idxImage) Retrieves the lower right corner of the image.
int	getMaximumIntervalsForDeterminingImageLocation() Returns the maximum number of intervals for determining Image location.
IlvMapFeature	getNextFeature() Returns the IlvMapFeature whose geometry is an IlvMapImage.
abstract IlvFeatureAttributeProperty	getProperties(int imageIndex) Returns the feature properties to be associated with the image.
IlvRasterMappedBuffer	getRasterMappedBuffer(int imageIndex) Retrieves the pixel buffer of the image.
IlvRasterProperties	getRasterProperties(int imageIndex) Retrieves the raster properties of the image.
IlvRasterTileLoader	getTileLoader(int imageIndex) Creates and returns the image corresponding to the raster info and raster image source of the provided index.
IlvRasterTileLoader	getTileLoader(int imageIndex, boolean allowSubsampling) Creates and returns the image corresponding to the raster info and raster image source of the provided index.
Collection<IlvRasterTileLoader>	getTileLoaders() Creates and returns the images corresponding to the rasters read.
IlvCoordinateTransformation	getTransformation() Gets the transformation used to reproject the data to produce the images returned by the getTileLoader(int)method.
IlvCoordinate	getUpperLeftCorner() Retrieves the upper left corner of the first image or null if none has been set.
protected IlvCoordinate	getUpperLeftCorner(int idxImage) Retrieves the upper left corner of the image.
boolean	isForceImageLoadingWhenSaving() Indicates whether this reader loads all images at the time that the map is saved.
boolean	isGeoreferenced() Indicates if the reader is georeferenced (that is if a source projection has been defined for this reader.
boolean	isHighQualityRendering() Indicates if the icon should be rendered high quality.
boolean	isNeedReload() Returns the needReload.
void	reload(IlvThreadMonitoringData monitorInfo) Given the state of the reader (number of images read, coverage zone,...), the purpose of this method is to recreate all images from the original source.
void	removeRaster(int imageIndex) Remove a raster image from the list known by the raster reader.
void	restart() Rewinds the iterator for a new use.
static void	setDefaultMaximumIntervalsForDeterminingImageLocation(int maxIntervals) Sets the default number of intervals on the border of an image for the purpose of determining its location in the manager.
void	setForceImageLoadingWhenSaving(boolean force) Sets whether to force this reader to load all images at the time that the map is saved.
void	setHighQualityRendering(boolean value) Changes the rendering quality state of the images produced by the IlvRasterTileLoader created by this reader.
void	setMaximumIntervalsForDeterminingImageLocation(int maxIntervals) Optimizes the number of intervals on the border of an image for the purpose of determining its location in the manager.
void	setTransformation(IlvCoordinateTransformation transformation) Sets the transformation to use to project the data read from the file.
void	write(IlvOutputStream stream) Writes the attributes of a persistent object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.views.maps.IlvMapFeatureIterator

getCoordinateSystem

Field Detail

needReload

protected boolean needReload

Indicates that this reader should be reloaded when the data source is called. This is used for example when users load a "theme only" map or when they change terrain analysis parameters.

Constructor Detail

IlvRasterAbstractReader

public IlvRasterAbstractReader()

Default constructor.

IlvRasterAbstractReader

public IlvRasterAbstractReader(IlvInputStream stream)
                        throws IlvReadFileException

Stream constructor.

Parameters:

stream -

Throws:

IlvReadFileException

Method Detail

getDefaultMaximumIntervalsForDeterminingImageLocation

public static int getDefaultMaximumIntervalsForDeterminingImageLocation()

Returns the default maximum number of intervals for determining the image location.

Returns:

Returns the maximum number of intervals for determining the image location.

Since:

JViews 8.6

See Also:

setMaximumIntervalsForDeterminingImageLocation(int)

setDefaultMaximumIntervalsForDeterminingImageLocation

public static void setDefaultMaximumIntervalsForDeterminingImageLocation(int maxIntervals)

Sets the default number of intervals on the border of an image for the purpose of determining its location in the manager.

Parameters:

maxIntervals - The default maximum number of intervals for determining the image location.

Since:

JViews 8.6

See Also:

setMaximumIntervalsForDeterminingImageLocation(int)

reload

public void reload(IlvThreadMonitoringData monitorInfo)

Given the state of the reader (number of images read, coverage zone,...), the purpose of this method is to recreate all images from the original source. Note : this method should not rely on the list of IlvRasterProperties of the reader as they might not be saved when the theme only is saved.

Parameters:

monitorInfo - Used to update task progress.

addRaster

public int addRaster(IlvRasterProperties rasterInfo,
                     IlvRasterMappedBuffer source)

Adds a new set of image information to the list managed by the raster reader. The image information is split in two parts: the information about the raster and the raster data.

Parameters:

rasterInfo - Information about the raster.

source - The raster data.

Returns:

The index of the raster in the list of rasters read by the reader.

removeRaster

public void removeRaster(int imageIndex)

Remove a raster image from the list known by the raster reader.

Parameters:

imageIndex - The index of the information stored in the list of rasters.

See Also:

addRaster(IlvRasterProperties, IlvRasterMappedBuffer)

createRasterTileLoader

public IlvRasterTileLoader createRasterTileLoader(IlvRasterProperties rasterInfo,
                                                  IlvRasterMappedBuffer source,
                                                  int imageIndex,
                                                  boolean allowSubsampling)

Creates the IlvRasterTileLoaderused to tile the images produced by the getTileLoader(int)method.

Parameters:

rasterInfo - Information to tile the raster.

source - The raster data.

imageIndex - The index of the image (ignored in default implementation).

allowSubsampling - If true, will generate a loader that shows only the necessary subsampled image for the current zoom factor, and reloads it when the zoom factor changes.

Returns:

The tile loader in charge of splitting the image into tiles.

setHighQualityRendering

public void setHighQualityRendering(boolean value)

Changes the rendering quality state of the images produced by the IlvRasterTileLoader created by this reader. Setting the value to true will improve the rendering. The default value is false.

Parameters:

value - The value.

Since:

JViews 8.0

isHighQualityRendering

public boolean isHighQualityRendering()

Indicates if the icon should be rendered high quality.

Returns:

true if the icon is high quality.

Since:

JViews 8.0

dispose

public void dispose()

Disposes this reader.

Specified by:

dispose in interface IlvMapFeatureIterator

getDefaultFeatureRenderer

public IlvFeatureRenderer getDefaultFeatureRenderer()

Returns an IlvFeatureRenderer suitable for the IlvMapFeature built by this reader. The returned IlvFeatureRenderer is an IlvDefaultImageRenderer.

Specified by:

getDefaultFeatureRenderer in interface IlvMapFeatureIterator

Returns:

An IlvDefaultImageRenderer.

getImageBounds

public Rectangle2D.Double getImageBounds(int imageIndex)

Returns the bounds of the image in manager coordinates.

Parameters:

imageIndex - The index of the information stored in the list of rasters.

Returns:

The bounds of the image in the manager.

getInternalTransformation

public abstract IlvMathTransform getInternalTransformation(int imageIndex)

Return the projection associated with the raster stored at the given index.

Parameters:

imageIndex - The index of the raster.

Returns:

The projection that corresponds to the raster stored at the given index.

getInverseTransformation

public IlvCoordinateTransformation getInverseTransformation()

Gets the transformation used to reproject the data to produce the bounds returned by the getImageBounds(int)method.

Returns:

The inverse transformation of the one set using setTransformation.

getLowerRightCorner

public IlvCoordinate getLowerRightCorner()

Retrieves the lower right corner of the image or null if none has been set.

Specified by:

getLowerRightCorner in interface IlvMapFeatureIterator

Returns:

The lower right corner.

getNextFeature

public IlvMapFeature getNextFeature()

Returns the IlvMapFeature whose geometry is an IlvMapImage.

Specified by:

getNextFeature in interface IlvMapFeatureIterator

Returns:

The resulting IlvMapFeature.

restart

public void restart()

Rewinds the iterator for a new use.

Specified by:

restart in interface IlvMapReusableFeatureIterator

See Also:

IlvMapReusableFeatureIterator.restart()

getProperties

public abstract IlvFeatureAttributeProperty getProperties(int imageIndex)

Returns the feature properties to be associated with the image.

Parameters:

imageIndex - The index of the image.

Returns:

The properties to be associated with the image.

getTileLoader

public IlvRasterTileLoader getTileLoader(int imageIndex)

Creates and returns the image corresponding to the raster info and raster image source of the provided index.

Parameters:

imageIndex - The index of the information stored in the list of rasters.

Returns:

A tile loader to create the image from the information stored.

See Also:

addRaster(IlvRasterProperties, IlvRasterMappedBuffer)

getTileLoader

public IlvRasterTileLoader getTileLoader(int imageIndex,
                                         boolean allowSubsampling)

Creates and returns the image corresponding to the raster info and raster image source of the provided index.

Parameters:

imageIndex - The index of the information stored in the list of rasters.

allowSubsampling - If true, will generate a loader that show only the necessary subsampled image for the current zoom factor, and reload it when the zoom factor changes.

Returns:

A tile loader to create the image out of the information stored.

See Also:

addRaster(IlvRasterProperties, IlvRasterMappedBuffer)

getTileLoaders

public Collection<IlvRasterTileLoader> getTileLoaders()

Creates and returns the images corresponding to the rasters read. When a subclass of the IlvRasterAbstractReader reads a raster file, it stores the raster using the addRaster(IlvRasterProperties, IlvRasterMappedBuffer) method. The images returned by this method are built from the stored info.

Returns:

a Collection of IlvRasterTileLoader

See Also:

getTileLoader(int)

getTransformation

public IlvCoordinateTransformation getTransformation()

Gets the transformation used to reproject the data to produce the images returned by the getTileLoader(int)method.

Returns:

The transformation set using setTransformation.

getUpperLeftCorner

public IlvCoordinate getUpperLeftCorner()

Retrieves the upper left corner of the first image or null if none has been set.

Specified by:

getUpperLeftCorner in interface IlvMapFeatureIterator

Returns:

The upper left corner.

isGeoreferenced

public boolean isGeoreferenced()

Indicates if the reader is georeferenced (that is if a source projection has been defined for this reader.

Specified by:

isGeoreferenced in interface IlvMapFeatureIterator

Returns:

true if a source projection has been set, false otherwise.

setTransformation

public void setTransformation(IlvCoordinateTransformation transformation)

Sets the transformation to use to project the data read from the file.

Parameters:

transformation - The transformation of the view.

setForceImageLoadingWhenSaving

public void setForceImageLoadingWhenSaving(boolean force)

Sets whether to force this reader to load all images at the time that the map is saved. If all the images are loaded, references to the original image sources are not included in the .ivl file.

Parameters:

force - Indicates whether the reader loads all images at write time. By default, some images may not be loaded, and references to them remain in the saved .ivl file. Set to true if you want to redistribute the .ivl file without references to unread raster files.

Since:

JViews 8.8

isForceImageLoadingWhenSaving

public boolean isForceImageLoadingWhenSaving()

Indicates whether this reader loads all images at the time that the map is saved.

Returns:

If true, the reader loads all images at write time, and any references to unread raster files are not included in the saved .ivl file.

Since:

JViews 8.8

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the attributes of a persistent object.

Specified by:

write in interface IlvPersistentObject

Parameters:

stream - The output stream.

Throws:

IOException - thrown when an exception occurs during the write operation for this object.

computeGisImageBounds

protected Rectangle2D.Double computeGisImageBounds(int imgIndex,
                                                   IlvRasterProperties rasterInfo)

Computes the map bounds of the GIS image displaying the raster.

Parameters:

imgIndex - The index of the image that will fill these bounds.

rasterInfo - The information about the raster.

Returns:

The bounds covered by this raster using the projection of the view.

computeLimits

protected Rectangle2D.Double computeLimits(int imgIndex,
                                           IlvCoordinate min,
                                           IlvCoordinate max,
                                           int horizStep,
                                           int verticStep)

Compute bounds projected with the projection of the view given two points projected with the original projection.

Parameters:

imgIndex - The index of the image that will fill these bounds.

min - The lower left corner.

max - The upper right corner.

horizStep - The step for the x coordinates in the view projection.

verticStep - The step for the x coordinates in the view projection.

Returns:

The bounds.

getLowerRightCorner

protected IlvCoordinate getLowerRightCorner(int idxImage)

Retrieves the lower right corner of the image.

Parameters:

idxImage - The index of the information stored in the list of rasters.

Returns:

The lower right corner of the image.

getRasterMappedBuffer

public IlvRasterMappedBuffer getRasterMappedBuffer(int imageIndex)

Retrieves the pixel buffer of the image.

Parameters:

imageIndex - The index of the image.

Returns:

The pixel buffer of the image.

getRasterProperties

public IlvRasterProperties getRasterProperties(int imageIndex)

Retrieves the raster properties of the image.

Parameters:

imageIndex - The index of the image.

Returns:

The raster properties of the image.

getUpperLeftCorner

protected IlvCoordinate getUpperLeftCorner(int idxImage)

Retrieves the upper left corner of the image.

Parameters:

idxImage - The index of the information stored in the list of rasters.

Returns:

The upper left corner of the image.

getImageCount

public int getImageCount()

Returns The number of registered images.

Returns:

The number of registered images.

getMaximumIntervalsForDeterminingImageLocation

public int getMaximumIntervalsForDeterminingImageLocation()

Returns the maximum number of intervals for determining Image location.

Returns:

Returns the maximum number of intervals for determining Image location.

setMaximumIntervalsForDeterminingImageLocation

public void setMaximumIntervalsForDeterminingImageLocation(int maxIntervals)

Optimizes the number of intervals on the border of an image for the purpose of determining its location in the manager. The reader will try to project all possible points in the border of the image to guess its correct bounds on the screen. Setting a low value (3 for example) may significantly increase creation performance.

Parameters:

maxIntervals - The maximum number of intervals for determining the image location. The default value is 16, which is a good compromise for speed. Increase it when the projection seems to leave out parts of the image. Decrease it to improve performance when you have a relatively rectangular projection or many images

isNeedReload

public boolean isNeedReload()

Returns the needReload.

Returns:

The needReload.