org.geotoolkit.referencing.operation.provider
Class Logarithmic

Object
  FormattableObject
      AbstractIdentifiedObject
          DefaultOperationMethod
              MathTransformProvider
                  Logarithmic

All Implemented Interfaces:

Serializable, Formattable, Deprecable, LenientComparable, IdentifiedObject, OperationMethod

@Immutable
public class Logarithmic
extends MathTransformProvider

The provider for LogarithmicTransform1D.

The following table summarizes the parameters recognized by this provider. For a more detailed parameter list, see the PARAMETERS constant.

Operation name: Logarithmic

Parameter name	Default value
base	10
offset	0

Since:

2.0

Version:

3.20

Author:

Martin Desruisseaux (IRD, Geomatys)

See Also:

LogarithmicTransform1D, Geotk coordinate operations matrix, Serialized Form

Module:

referencing/geotk-referencing (download)

View source code for this class

Field Summary

static ParameterDescriptor<Double>	BASE Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<Double>	OFFSET Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptorGroup	PARAMETERS The group of all parameters expected by this coordinate operation.

Fields inherited from class DefaultOperationMethod

sourceDimension, targetDimension

Fields inherited from class FormattableObject

EPSG, GEOTIFF, INTERNAL, OGC, SINGLE_LINE

Fields inherited from interface OperationMethod

FORMULA_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

Logarithmic()
Creates a provider for logarithmic transforms.

Method Summary

protected MathTransform1D	createMathTransform(ParameterValueGroup values) Creates a logarithmic transform from the specified group of parameter values.
Class<Conversion>	getOperationType() Returns the operation type.

Methods inherited from class MathTransformProvider

ensureValidValues, formatWKT

Methods inherited from class DefaultOperationMethod

checkDimensions, computeHashCode, equals, getFormula, getParameters, getSourceDimensions, getTargetDimensions

Methods inherited from class AbstractIdentifiedObject

equals, getAlias, getIdentifier, getIdentifiers, getName, getName, getRemarks, hashCode, isDeprecated, nameMatches

Methods inherited from class FormattableObject

getDefaultIndentation, print, setDefaultIndentation, toString, toWKT, toWKT, toWKT, toWKT

Methods inherited from class Object

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

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Detail

BASE

@Deprecated
public static final ParameterDescriptor<Double> BASE

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the base parameter value. Valid values range from 0 to infinity. The default value is 10.

OFFSET

@Deprecated
public static final ParameterDescriptor<Double> OFFSET

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the offset parameter value. Valid values range is unrestricted. The default value is 0.

PARAMETERS

public static final ParameterDescriptorGroup PARAMETERS

The group of all parameters expected by this coordinate operation. The following table lists the operation names and the parameters recognized by Geotk:

Name:

Geotk:

Logarithmic

Name:

Geotk:

base

Type:	Double
Obligation:	mandatory
Value range:	[0…∞)
Default value:	10

Name:

Geotk:

offset

Type:	Double
Obligation:	mandatory
Value range:	(-∞ … ∞)
Default value:	0

Constructor Detail

Logarithmic

public Logarithmic()

Creates a provider for logarithmic transforms.

Method Detail

getOperationType

public Class<Conversion> getOperationType()

Returns the operation type.

Overrides:

getOperationType in class MathTransformProvider

Returns:

The GeoAPI interface implemented by this operation.

createMathTransform

protected MathTransform1D createMathTransform(ParameterValueGroup values)
                                       throws ParameterNotFoundException

Creates a logarithmic transform from the specified group of parameter values.

Specified by:

createMathTransform in class MathTransformProvider

Parameters:

values - The group of parameter values.

Returns:

The created math transform.

Throws:

ParameterNotFoundException - if a required parameter was not found.