com.luciad.format.netcdf.lightspeed

Weather & Environment StandardsClass TLspNetCDFLayerBuilder

java.lang.Object

com.luciad.view.lightspeed.layer.ALspLayerBuilder

com.luciad.format.netcdf.lightspeed.TLspNetCDFLayerBuilder

public final class TLspNetCDFLayerBuilder
extends ALspLayerBuilder

Layer builder for NetCDF models. It tries to provide sensible coloring defaults.

An example of how to use this builder:

   ILspLayer layer = TLspNetCDFLayerBuilder.newBuilder()
       .model(myNetCDFModel)
       .build();
 

Note that this layer builder cannot handle model tree nodes. In order to visualize a model tree node with multiple NetCDF leaf models, one can create a layer tree node for the model tree node, and use this layer builder for the leaf NetCDF models.

NetCDF images can also be visualized as an icon grid. This happens automatically when the ALcdImage to be painted contains 2 bands. Icon grid visualization can also be enable/customized by setting a TLspParameterizedRasterIconStyle as the styler. In other cases, the image is visualized as a raster.

Since:

2015.0

Method Summary

Modifier and Type	Method and Description
ILspEditableStyledLayer	build() Creates a new layer instance.
static TLcdColorMap	createDefaultColorMap(Object aNetCDFObject) Creates a default color map for the given NetCDF object or ALcdImage.
TLspNetCDFLayerBuilder	filter(ILcdDynamicFilter aFilter) Sets a filter that will be used to filter objects to prevent them from being painted by the layer.
TLspNetCDFLayerBuilder	icon(ILcdIcon aIcon) Sets the icon of the layer.
TLspNetCDFLayerBuilder	label(String aLabel) Sets the label of the layer.
TLspNetCDFLayerBuilder	layerStyle(TLspLayerStyle aLayerStyle) Set a layer style to be used during the rendering of the layer.
TLspNetCDFLayerBuilder	layerType(ILspLayer.LayerType aLayerType) This method is not supported for NetCDF layers.
TLspNetCDFLayerBuilder	model(ILcdModel aModel) Sets the model of the layer.
static TLspNetCDFLayerBuilder	newBuilder() Returns a new layer builder with the default settings
TLspNetCDFLayerBuilder	styler(TLspPaintRepresentationState aPaintRepresentationState, ILspStyler aStyler) Sets the styler used to visualize the image.

Methods inherited from class com.luciad.view.lightspeed.layer.ALspLayerBuilder

getIcon, getLabel, getLayerStyle, getLayerType, getModel

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static TLspNetCDFLayerBuilder newBuilder()

Returns a new layer builder with the default settings

Returns:

a new layer builder with the default settings.

createDefaultColorMap

public static TLcdColorMap createDefaultColorMap(Object aNetCDFObject)

Creates a default color map for the given NetCDF object or ALcdImage. It takes into account the type of data and the min and max values of the data, if available. This layer builder uses the color map retrieved from this method as default color map.

Parameters:

aNetCDFObject - the NetCDF object or ALcdImage for which to create a color map.

Returns:

a default color map for the given image.

Throws:

IllegalArgumentException - if the given NetCDF object is not created by the NetCDF model decoder.

build

public ILspEditableStyledLayer build()

Creates a new layer instance.

When styler is not called, the created layer exposes an ILspCustomizableStyler with the default styles.

Specified by:

build in class ALspLayerBuilder

Returns:

the new layer instance

styler

public TLspNetCDFLayerBuilder styler(TLspPaintRepresentationState aPaintRepresentationState,
                                     ILspStyler aStyler)

Sets the styler used to visualize the image.

Only the TLspPaintRepresentation#BODY affects the style of the raster.

Refer to the TLspRasterLayerBuilder class javadoc for an overview of the supported styles.

The default styler drapes the raster data on top of the view's terrain and paints a red hatched rectangle when zoom out too far. It also configures a default color map.

Parameters:

aPaintRepresentationState - the paint representation.

aStyler - the styler

Returns:

this builder

filter

public TLspNetCDFLayerBuilder filter(ILcdDynamicFilter aFilter)

Sets a filter that will be used to filter objects to prevent them from being painted by the layer. No filter is set by default.

The objects passed to the layer filter are domain objects of a TLcdNetCDFFilteredModel. See TLcdNetCDFFilteredModel javadoc for more information about these domain objects. Note that NetCDF models typically contain exactly one domain object.

Parameters:

aFilter - the filter

Returns:

this builder

model

public TLspNetCDFLayerBuilder model(ILcdModel aModel)

Sets the model of the layer.

Overrides:

model in class ALspLayerBuilder

Parameters:

aModel - a model

Returns:

this builder

Throws:

IllegalArgumentException - if the given model is not a NetCDF model

See Also:

ILcdLayer.getModel()

label

public TLspNetCDFLayerBuilder label(String aLabel)

Sets the label of the layer. This is a short textual representation for it, often used to represent the layer to end-users.

The default value is null. In that case, the display name of the model descriptor is used as label.

Overrides:

label in class ALspLayerBuilder

Parameters:

aLabel - the label

Returns:

this builder

See Also:

ILcdLayer.getLabel()

layerType

public TLspNetCDFLayerBuilder layerType(ILspLayer.LayerType aLayerType)

This method is not supported for NetCDF layers. The default of LayerType#EDITABLE is used.

Overrides:

layerType in class ALspLayerBuilder

Parameters:

aLayerType - the layer type

Returns:

this builder

Throws:

UnsupportedOperationException - this method is not supported for NetCDF layers

See Also:

ILspLayer.getLayerType()

layerStyle

public TLspNetCDFLayerBuilder layerStyle(TLspLayerStyle aLayerStyle)

Description copied from class: ALspLayerBuilder

Set a layer style to be used during the rendering of the layer. TLspLayerStyle is used to style the layer as a whole. Layer style can for example modify the transparency of a layer. Also, layer style can be modified after building the layer by calling ILspLayer.setLayerStyle(TLspLayerStyle).

Overrides:

layerStyle in class ALspLayerBuilder

Parameters:

aLayerStyle - the layer style. Must not be null. If you want to set the default layer style, set TLspLayerStyle.newBuilder().build()

Returns:

this

See Also:

ILspLayer.getLayerStyle(), ILspLayer.setLayerStyle(TLspLayerStyle)

icon

public TLspNetCDFLayerBuilder icon(ILcdIcon aIcon)

Description copied from class: ALspLayerBuilder

Sets the icon of the layer.

The default value is null.

Overrides:

icon in class ALspLayerBuilder

Parameters:

aIcon - the icon

Returns:

this builder

See Also:

ILcdLayer.getIcon()