com.luciad.util.measure

LuciadLightspeedInterface ILcdModelMeasureProviderFactory

All Known Implementing Classes:

TLcdEarthMultivaluedMeasureProviderFactory, TLcdGRIBMeasureProviderFactory , TLcdImageModelMeasureProviderFactory, TLcdMagneticNorthMeasureProviderFactory, TLcyCompositeModelMeasureProviderFactory

public interface ILcdModelMeasureProviderFactory

Factory that allows retrieving measured values for a particular model.

Relation to the ILcdLayerMeasureProviderFactory

This interface is similar to the ILcdLayerMeasureProviderFactory except that it creates a measure provider from a model instead of a layer and view. Using a model-based measure provider gives you more control over the data that it samples. It for example allows to retrieve measures of the most detailed level in a multilevel raster. Model measure provider factories are typically used for analysis, whereas layer measure provider factories can for example be used for a mouse read-out. Note that model measure provider factories are also often used as a fallback for layer measure provider factories.

Sample Code

 
 // Create a measure provider factory.
 ILcdModelMeasureProviderFactory factory = ...

 // Create a measure provider from a layer.
 ALcdMeasureProvider measureProvider = factory.createMeasureProvider(aModel);

 // Create a parameters object with an optional interpolation type and sample density.
 Parameters parameters = Parameters.newBuilder().interpolationType(type).sampleDensity(sampleDensity).build();

 // Retrieve measurements using this measure provider.
 TLcdISO19103Measure[] measures = measureProvider.retrieveMeasuresAt(point, pointReference, parameters);
 

Note that instances of this interface can be used to configure a view measure provider that makes it easy to retrieve measure for all layers in a view. See for example TLcdGXYViewMeasureProvider.

Note that LuciadLightspeed uses more specific API for height values: ILcdModelHeightProviderFactory

Since:

2013.0

Method Summary

Modifier and Type	Method and Description
ALcdMeasureProvider	createMeasureProvider(ILcdModel aModel) Creates a new measure provider, based on the given model, or null if no measure provider can be created for the given model.

Method Detail

createMeasureProvider

ALcdMeasureProvider createMeasureProvider(ILcdModel aModel)

Creates a new measure provider, based on the given model, or null if no measure provider can be created for the given model.

Parameters:

aModel - a model.

Returns:

a measure provider, or null if no measure provider can be created for the given model.