Package org.geotools.coverage.processing.operation

Class ShadedRelief

Object

AbstractOperation

Operation2D

OperationJAI

ShadedRelief

All Implemented Interfaces:

Serializable, Operation

public class ShadedRelief
extends OperationJAI

A simple wrapper for the jai-ext ShadedRelief operation.

Creates a hillshade effect on a grid containing altitude measures.

Name: "ShadedRelief"
JAI operator: "ShadedRelief"
Parameters:

Name	Class	Default value	Allowed values	Property name
"Source"	GridCoverage2D	N/A
"roi"	org.eclipse.imagen.ROI		N/A
"srcNoData"	org.eclipse.imagen.media.range.Range
"dstNoData"	double	0.0
"resX"	double	1.0
"resY"	double	1.0
"zetaFactor"	double	1.0
"scale"	double	1.0
"altitude"	double	1.0		JAI-EXT.shadedrelief.altitude
"azimuth"	double	1.0		JAI-EXT.shadedrelief.azimuth
"algorithm"	org.eclipse.imagen.media.shadedrelief.ShadedReliefAlgorithm	COMBINED	ZEVENBERGEN_THORNE, ZEVENBERGEN_THORNE_COMBINED, COMBINED	JAI-EXT.shadedrelief.algorithm

Author:

Emanuele Tajariol <etj at geo-solutions.it>

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class OperationJAI

OperationJAI.Parameters

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	CUSTOMIZABLE_PARAMS
static final String	PARAM_ALGORITHM
static final String	PARAM_ALTITUDE
static final String	PARAM_AZIMUTH
static final String	PARAM_DSTNODATA
static final String	PARAM_RESX
static final String	PARAM_RESY
static final String	PARAM_ROI
static final String	PARAM_SCALE
static final String	PARAM_SRCNODATA
static final String	PARAM_ZETA
static final String	STATS_PROPERTY	ShadedRelief property name

Fields inherited from class OperationJAI

operation, RENDERED_MODE

Fields inherited from class Operation2D

PRIMARY_SOURCE_INDEX, SOURCE_0

Fields inherited from class AbstractOperation

descriptor

Constructor Summary

Constructors

Constructor	Description
ShadedRelief()

Method Summary

Modifier and Type	Method	Description
String	getName()	Returns the name of the processing operation.
protected Map<String,?>	getProperties(RenderedImage data, CoordinateReferenceSystem crs, InternationalString name, MathTransform gridToCRS, GridCoverage2D[] sources, OperationJAI.Parameters parameters)	Prepares the properties to be given to the coverage created by the deriveGridCoverage method.
protected void	handleJAIEXTParams(ParameterBlockJAI jaiParams, ParameterValueGroup params)	Extension point for adding to the JAI ParameterBlockJAI object the parameters defined in the ParameterValueGroup, which can be read by the JAI-EXT operations.

Methods inherited from class OperationJAI

createRenderedImage, deriveCategory, deriveGridCoverage, deriveName, deriveRange, deriveSampleDimension, deriveUnit, doOperation, equals, extractSources, getJAI, getOperationDescriptor, getQuantitative, handleROINoDataInternal, handleROINoDataProperties, hashCode, prepareParameters, resampleToCommonGeometry

Methods inherited from class Operation2D

extractSources, getFactory

Methods inherited from class AbstractOperation

getDescription, getDocURL, getNumSources, getParameters, getVendor, getVersion, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

STATS_PROPERTY

public static final String STATS_PROPERTY

ShadedRelief property name

See Also:

• Constant Field Values

PARAM_ROI

public static final String PARAM_ROI

See Also:

• Constant Field Values

PARAM_SRCNODATA

public static final String PARAM_SRCNODATA

See Also:

• Constant Field Values

PARAM_DSTNODATA

public static final String PARAM_DSTNODATA

See Also:

• Constant Field Values

PARAM_RESX

public static final String PARAM_RESX

See Also:

• Constant Field Values

PARAM_RESY

public static final String PARAM_RESY

See Also:

• Constant Field Values

PARAM_ZETA

public static final String PARAM_ZETA

See Also:

• Constant Field Values

PARAM_SCALE

public static final String PARAM_SCALE

See Also:

• Constant Field Values

PARAM_ALTITUDE

public static final String PARAM_ALTITUDE

See Also:

• Constant Field Values

PARAM_AZIMUTH

public static final String PARAM_AZIMUTH

See Also:

• Constant Field Values

PARAM_ALGORITHM

public static final String PARAM_ALGORITHM

See Also:

• Constant Field Values

CUSTOMIZABLE_PARAMS

public static final String[] CUSTOMIZABLE_PARAMS

Constructor Details

ShadedRelief

public ShadedRelief()
             throws OperationNotFoundException

Throws:

OperationNotFoundException

Method Details

getName

public String getName()

Description copied from class: AbstractOperation

Returns the name of the processing operation. The default implementation returns the AbstractOperation.descriptor code name.

Specified by:

getName in interface Operation

Overrides:

getName in class AbstractOperation

Returns:

The name of the processing operation.

handleJAIEXTParams

protected void handleJAIEXTParams(ParameterBlockJAI jaiParams,
 ParameterValueGroup params)

Description copied from class: OperationJAI

Extension point for adding to the JAI ParameterBlockJAI object the parameters defined in the ParameterValueGroup, which can be read by the JAI-EXT operations.

Notice that if you are using JAI, the new parameters will not be accepted by the ParameterBlockJAI instance.

Overrides:

handleJAIEXTParams in class OperationJAI

Parameters:

jaiParams - ParameterBlockJAI instance used by the current JAI-EXT/JAI operation

params - ParameterValueGroup instance containing input operation parameters

getProperties

protected Map<String,?> getProperties(RenderedImage data,
 CoordinateReferenceSystem crs,
 InternationalString name,
 MathTransform gridToCRS,
 GridCoverage2D[] sources,
 OperationJAI.Parameters parameters)

Description copied from class: OperationJAI

Prepares the properties to be given to the coverage created by the deriveGridCoverage method. The default implementation returns null.

Overrides:

getProperties in class OperationJAI

Parameters:

data - The RenderedImage created by this operation.

crs - The coordinate reference system assigned to the coverage this OperationJAI will produce.

name - The name assigned to the coverage this OperationJAI will produce.

gridToCRS - The transform from grid to crs to be assigned to the coverage this OperationJAI will produce.

sources - The sources to be assigned to the coverage this OperationJAI will produce.

parameters - The parameters that were used by this OperationJAI.

Returns:

a Map with the properties generated by this OperationJAI or null if we haven't any.