TLcdSwissDHMMatrixModelDecoder (LuciadFusion API documentation)

java.lang.Object
- com.luciad.format.swissdhm.TLcdSwissDHMMatrixModelDecoder

All Implemented Interfaces:

ILcdInputStreamFactoryCapable, ILcdModelDecoder
```
@LcdService(service=ILcdModelDecoder.class,
            priority=20000)
public class TLcdSwissDHMMatrixModelDecoder
extends Object
implements ILcdModelDecoder, ILcdInputStreamFactoryCapable
```
This model decoder decodes elevation rasters in the SwissTopo Digital Height Model format (DHM25). The MMBLT matrix format as well as the MMBL matrix format are supported.
Input files

File Required Entry point Description

*.mlt x x MMBLT file containing the elevation raster

*.mbl x MMBL file containing the elevation raster

Supported file transfer protocols
- This model decoder supports all transfer protocols that are supported by the inputStreamFactory of this decoder.
Model structure
- This model decoder creates a model per SwissDHMMatrix file.
- All models returned by this model decoder implement ILcd2DBoundsIndexedModel.
Model descriptor
- All models returned by this model decoder have a TLcdSwissDHMMatrixModelDescriptor.
- The type name of the model descriptor is the display name of this decoder.
Model reference
- All models returned by this model decoder have a TLcdSwissGridReference.
Model elements
- Each decoded model contains a single element that implements ILcdRaster.
Useful settings
- The property colorModel allows to override the default 16-bits index color that is attached to the decoded rasters, since DHM25 files don't contain any color information.
Sample code
```
 TLcdSwissDHMMatrixModelDecoder decoder    = new TLcdSwissDHMMatrixModelDecoder();
 ILcdColorModelFactory          factory    = new TLcdDTEDColorModelFactory();
 ColorModel                     colorModel = factory.createColorModel();

 decoder.setColorModel(colorModel);

 ILcdModel model = decoder.decode("elevations.SwissDHMMatrix");
 
```
Performance tips
- Since DHM25 rasters only provide a single level of detail, precomputing and storing multiple levels of detail may speed up visualization and some computations. For instance, the TLcdGeoTIFFModelEncoder can create multilevel GeoTIFF files that can replace the original DHM25 files.
Thread safety
- The decoding of models is thread-safe, as long as no properties are changed during the decoding.
- The decoded models and elements are thread-safe for read access, on the condition that a thread-safe buffer is used.
Supported versions and specifications
- DMG-Datenbestand Digitales Höhenmodell M745 (DHM/M745), Bundesamt für Landestopografie swisstopo
Known limitations
- Elevations are always converted from decimeters to meters.
Since:

3.3

File	Required	Entry point	Description
*.mlt	x	x	MMBLT file containing the elevation raster
*.mbl	x	MMBL file containing the elevation raster

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AVERAGE` The sampling strategy that returns the average value of the corners of each DHM sample cell.
`static int`	`BILINEAR` The sampling strategy that returns a bilinear interpolation of the values of the corners of each DHM sample cell.
`static String`	`DISPLAY_NAME`
`static int`	`MAXIMUM` The sampling strategy that returns the maximum value of the corners of each DHM sample cell.
`static int`	`MINIMUM` The sampling strategy that returns the minimum value of the corners of each DHM sample cell.
`static int`	`NORTH_EAST_CORNER` The sampling strategy that returns the North-East corner of each DHM sample cell.
`static int`	`NORTH_WEST_CORNER` The sampling strategy that returns the North-West corner of each DHM sample cell.
`static int`	`SOUTH_EAST_CORNER` The sampling strategy that returns the South-East corner of each DHM sample cell.
`static int`	`SOUTH_WEST_CORNER` The sampling strategy that returns the South-West corner of each DHM sample cell.

Constructor Summary

Constructors
Constructor and Description
`TLcdSwissDHMMatrixModelDecoder()` Creates a new TLcdSwissDHMMatrixModelDecoder, with a globally shared buffer for caching tiles.
`TLcdSwissDHMMatrixModelDecoder(ILcdBuffer aBuffer)` Creates a new TLcdSwissDHMMatrixModelDecoder with the given buffer.
`TLcdSwissDHMMatrixModelDecoder(ILcdBuffer aBuffer, ColorModel aColorModel)` Creates a new TLcdSwissDHMMatrixModelDecoder with the given buffer and color model.
`TLcdSwissDHMMatrixModelDecoder(ILcdBuffer aBuffer, ColorModel aColorModel, int aDefaultValue)` Creates a new TLcdSwissDHMMatrixModelDecoder.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`canDecodeSource(String aSourceAsString)` Checks whether this model decoder can decode the specified data source.
`ILcdTile`	`createTile(String aSourceName, int aTileWidth, int aTileHeight)` Decodes the given DHM file as an `ILcdTile`.
`ILcdModel`	`decode(String aSourceName)` Creates a new model from the given data source.
`ColorModel`	`getColorModel()` Get the color model to be used for the decoded rasters.
`int`	`getDefaultValue()` Returns default raster value for pixels that cannot be resolved.
`String`	`getDisplayName()` Returns a short, displayable name for the format that is decoded by this `ILcdModelDecoder`.
`ILcdInputStreamFactory`	`getInputStreamFactory()` Returns the input stream factory that is used for creating input streams given source names.
`ILcdModelReference`	`getModelReference()` Returns the reference used for the decoded model.
`int`	`getSampleStrategy()`
`static boolean`	`isClassTraceOn()` Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
`boolean`	`isSupportGeoidDatums()` Returns whether the geodetic datums of the decoded GeoTIFF model references may be geoid datums.
`static void`	`setClassTraceOn(boolean aClassTraceOn)` Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
`void`	`setColorModel(ColorModel aColorModel)` Set the color model to be used for the decoded rasters.
`void`	`setDefaultValue(int aDefaultValue)` Sets default raster value for pixels that cannot be resolved.
`void`	`setInputStreamFactory(ILcdInputStreamFactory aInputStreamFactory)` Sets the input stream factory that will be used for creating input streams given source names.
`void`	`setSampleStrategy(int aSampleStrategy)` Sets the sampling strategy for retrieving elevation values.
`void`	`setSupportGeoidDatums(boolean aSupportGeoidDatums)` Specifies whether the geodetic datums of the decoded model references may be geoid datums, instead of the default ellipsoid datums.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.luciad.model.ILcdModelDecoder
canDecodeSource, decodeModelMetadata, decodeModelMetadata, decodeSource, discoverDataSources

- Field Detail
  - NORTH_WEST_CORNER
```
public static final int NORTH_WEST_CORNER
```
    The sampling strategy that returns the North-West corner of each DHM sample cell.
    
    See Also:
    
    Constant Field Values
  - SOUTH_WEST_CORNER
```
public static final int SOUTH_WEST_CORNER
```
    The sampling strategy that returns the South-West corner of each DHM sample cell.
    
    See Also:
    
    Constant Field Values
  - NORTH_EAST_CORNER
```
public static final int NORTH_EAST_CORNER
```
    The sampling strategy that returns the North-East corner of each DHM sample cell.
    
    See Also:
    
    Constant Field Values
  - SOUTH_EAST_CORNER
```
public static final int SOUTH_EAST_CORNER
```
    The sampling strategy that returns the South-East corner of each DHM sample cell.
    
    See Also:
    
    Constant Field Values
  - MINIMUM
```
public static final int MINIMUM
```
    The sampling strategy that returns the minimum value of the corners of each DHM sample cell.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM
```
public static final int MAXIMUM
```
    The sampling strategy that returns the maximum value of the corners of each DHM sample cell.
    
    See Also:
    
    Constant Field Values
  - AVERAGE
```
public static final int AVERAGE
```
    The sampling strategy that returns the average value of the corners of each DHM sample cell.
    
    See Also:
    
    Constant Field Values
  - BILINEAR
```
public static final int BILINEAR
```
    The sampling strategy that returns a bilinear interpolation of the values of the corners of each DHM sample cell.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_NAME
```
public static final String DISPLAY_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TLcdSwissDHMMatrixModelDecoder
```
public TLcdSwissDHMMatrixModelDecoder()
```
    Creates a new TLcdSwissDHMMatrixModelDecoder, with a globally shared buffer for caching tiles.
    
    See Also:
    
    TLcdSharedBuffer.getBufferInstance()
  - TLcdSwissDHMMatrixModelDecoder
```
public TLcdSwissDHMMatrixModelDecoder(ILcdBuffer aBuffer)
```
    Creates a new TLcdSwissDHMMatrixModelDecoder with the given buffer.
    
    Parameters:
    
    aBuffer - The buffer to use for caching tiles.
  - TLcdSwissDHMMatrixModelDecoder
```
public TLcdSwissDHMMatrixModelDecoder(ILcdBuffer aBuffer,
                                      ColorModel aColorModel)
```
    Creates a new TLcdSwissDHMMatrixModelDecoder with the given buffer and color model.
    
    Parameters:
    
    aBuffer - The buffer to use for caching tiles.
    
    aColorModel - ColorModel to set on the created rasters.
  - TLcdSwissDHMMatrixModelDecoder
```
public TLcdSwissDHMMatrixModelDecoder(ILcdBuffer aBuffer,
                                      ColorModel aColorModel,
                                      int aDefaultValue)
```
    Creates a new TLcdSwissDHMMatrixModelDecoder.
    
    Parameters:
    
    aBuffer - Buffer to use for caching tiles.
    
    aColorModel - ColorModel to set on the created rasters.
    
    aDefaultValue - Default pixel value.
- Method Detail
  - getModelReference
```
public ILcdModelReference getModelReference()
```
    Returns the reference used for the decoded model.
    
    Returns:
    
    Reference used for the decoded model.
  - setColorModel
```
public void setColorModel(ColorModel aColorModel)
```
    Set the color model to be used for the decoded rasters.
    
    Parameters:
    
    aColorModel - color model to be used for the decoded rasters.
  - getColorModel
```
public ColorModel getColorModel()
```
    Get the color model to be used for the decoded rasters.
    
    Returns:
    
    color model to be used for the decoded rasters.
  - setDefaultValue
```
public void setDefaultValue(int aDefaultValue)
```
    Sets default raster value for pixels that cannot be resolved.
    
    Parameters:
    
    aDefaultValue - Default raster value for pixels that cannot be resolved.
  - getDefaultValue
```
public int getDefaultValue()
```
    Returns default raster value for pixels that cannot be resolved.
    
    Returns:
    
    Default raster value for pixels that cannot be resolved.
  - setInputStreamFactory
```
public void setInputStreamFactory(ILcdInputStreamFactory aInputStreamFactory)
```
    Sets the input stream factory that will be used for creating input streams given source names.
    
    Specified by:
    
    setInputStreamFactory in interface ILcdInputStreamFactoryCapable
    
    Parameters:
    
    aInputStreamFactory - the input stream factory to be used.
  - getInputStreamFactory
```
public ILcdInputStreamFactory getInputStreamFactory()
```
    Returns the input stream factory that is used for creating input streams given source names.
    
    Specified by:
    
    getInputStreamFactory in interface ILcdInputStreamFactoryCapable
    
    Returns:
    
    the input stream factory that is used.
  - setSampleStrategy
```
public void setSampleStrategy(int aSampleStrategy)
```
    Sets the sampling strategy for retrieving elevation values.
    
    Parameters:
    
    aSampleStrategy - one of NORTH_WEST_CORNER, SOUTH_WEST_CORNER, NORTH_EAST_CORNER, SOUTH_EAST_CORNER, MINIMUM, MAXIMUM, AVERAGE, or BILINEAR.
  - getSampleStrategy
```
public int getSampleStrategy()
```
  - setSupportGeoidDatums
```
public void setSupportGeoidDatums(boolean aSupportGeoidDatums)
```
    Specifies whether the geodetic datums of the decoded model references may be geoid datums, instead of the default ellipsoid datums. Geoid datums are more accurate for elevation data, but they require more memory and more processing time when they are being used in transformation calculations. The ellipsoid of the Swiss grid system of 1903 is generally a sufficiently accurate approximation, only deviating from the geoid by a few decimeters on average.
  - isSupportGeoidDatums
```
public boolean isSupportGeoidDatums()
```
    Returns whether the geodetic datums of the decoded GeoTIFF model references may be geoid datums.
  - getDisplayName
```
public String getDisplayName()
```
    Description copied from interface: ILcdModelDecoder
    
    Returns a short, displayable name for the format that is decoded by this ILcdModelDecoder.
    
    Specified by:
    
    getDisplayName in interface ILcdModelDecoder
    
    Returns:
    
    the displayable name of this ILcdModelDecoder.
  - canDecodeSource
```
public boolean canDecodeSource(String aSourceAsString)
```
    Description copied from interface: ILcdModelDecoder
    
    Checks whether this model decoder can decode the specified data source. It is acceptable for this method to return true for a source name while decode throws an exception for that same source name.
    For performance reasons, we strongly recommend that this will only be a simple test. For example: check the file extension of a file, but not that the file exists or contains expected content.
    
    Specified by:
    
    canDecodeSource in interface ILcdModelDecoder
    
    Parameters:
    
    aSourceAsString - the data source to be verified; typically a file name or a URL.
    
    Returns:
    
    true if this decoder can likely decode the data specified by the source name, false otherwise.
    
    See Also:
    
    ILcdModelDecoder.decode(String), ILcdModelDecoder.decodeModelMetadata(String)
  - decode
```
public ILcdModel decode(String aSourceName)
                 throws IOException
```
    Description copied from interface: ILcdModelDecoder
    
    Creates a new model from the given data source.
    Specified by:
    
    decode in interface ILcdModelDecoder
    
    Parameters:
    
    aSourceName - the data source to be decoded; typically a file name or a URL.
    
    Returns:
    
    A model containing the decoded data. While null is allowed, implementors are advised to throw an error instead.
    
    Throws:
    IOException - for any exceptions caused by IO problems or invalid data. Since decoding invalid data almost always results in RunTimeExceptions (NullPointerException, IndexOutOfBoundsException, IllegalArgumentException, ...) on unexpected places, implementations are advised to catch RuntimeExceptions in their decode() method, and wrap them into an IOException, as illustrated in the code snippet below.
    public ILcdModel decode( String aSourceName ) throws IOException { try (InputStream input = fInputStreamFactory.createInputStream(aSourceName)) { // Perform decoding ... } catch (RuntimeException e) { throw new IOException(e); } }
    InterruptedIOException - When the thread on which this method is called is interrupted: it is recommended to stop the decoding and throw an InterruptedIOException. This same exception can also be used if the decoder shows UI to the user, and the user cancels the decoding through the UI.
    
    See Also:
    
    ILcdModelDecoder.canDecodeSource(String)
  - createTile
```
public ILcdTile createTile(String aSourceName,
                           int aTileWidth,
                           int aTileHeight)
```
    Decodes the given DHM file as an ILcdTile.
  - isClassTraceOn
```
public static boolean isClassTraceOn()
```
    Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
    
    Returns true if tracing is enabled for this class.
    
    Returns:
    
    true if tracing is enabled for this class, false otherwise.
  - setClassTraceOn
```
public static void setClassTraceOn(boolean aClassTraceOn)
```
    Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
    
    Enables tracing for all instances of this class. If the argument is true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.
    
    Parameters:
    
    aClassTraceOn - if true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

Advanced Raster ServicesClass TLcdSwissDHMMatrixModelDecoder

Input files

Supported file transfer protocols

Model structure

Model descriptor

Model reference

Model elements

Useful settings

Sample code

Performance tips

Thread safety

Supported versions and specifications

Known limitations

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.luciad.model.ILcdModelDecoder

Field Detail

NORTH_WEST_CORNER

SOUTH_WEST_CORNER

NORTH_EAST_CORNER

SOUTH_EAST_CORNER

MINIMUM

MAXIMUM

AVERAGE

BILINEAR

DISPLAY_NAME

Constructor Detail

TLcdSwissDHMMatrixModelDecoder

TLcdSwissDHMMatrixModelDecoder

TLcdSwissDHMMatrixModelDecoder

TLcdSwissDHMMatrixModelDecoder

Method Detail

getModelReference

setColorModel

getColorModel

setDefaultValue

getDefaultValue

setInputStreamFactory

getInputStreamFactory

setSampleStrategy

getSampleStrategy

setSupportGeoidDatums

isSupportGeoidDatums

getDisplayName

canDecodeSource

decode

createTile

isClassTraceOn

setClassTraceOn