org.geotools.referencing.operation.transform
Class LogarithmicTransform1D

java.lang.Object
  extended byorg.geotools.referencing.wkt.Formattable
      extended byorg.geotools.referencing.operation.transform.AbstractMathTransform
          extended byorg.geotools.referencing.operation.transform.LogarithmicTransform1D
All Implemented Interfaces:
org.opengis.referencing.operation.MathTransform, org.opengis.referencing.operation.MathTransform1D, java.io.Serializable

public class LogarithmicTransform1D
extends AbstractMathTransform
implements org.opengis.referencing.operation.MathTransform1D, java.io.Serializable

A one dimensional, logarithmic transform. Input values x are converted into output values y using the following equation:

y  =  offset + logbase(x)   =   offset + ln(x)/ln(base)

This transform is the inverse of ExponentialTransform1D.

Since:
2.0
Version:
$Id: LogarithmicTransform1D.java 17672 2006-01-19 00:25:55Z desruisseaux $
Author:
Martin Desruisseaux
See Also:
ExponentialTransform1D, LinearTransform1D, Serialized Form

Nested Class Summary
static class LogarithmicTransform1D.Provider
          The provider for the LogarithmicTransform1D.
 
Nested classes inherited from class org.geotools.referencing.operation.transform.AbstractMathTransform
AbstractMathTransform.Inverse
 
Field Summary
 double base
          The base of the logarithm.
 double offset
          The offset to add to the logarithm.
 
Constructor Summary
protected LogarithmicTransform1D(double base, double offset)
          Constructs a new logarithmic transform.
 
Method Summary
static org.opengis.referencing.operation.MathTransform1D create(double base, double offset)
          Constructs a new logarithmic transform.
 double derivative(double value)
          Gets the derivative of this function at a value.
 boolean equals(java.lang.Object object)
          Compares the specified object with this math transform for equality.
 org.opengis.parameter.ParameterDescriptorGroup getParameterDescriptors()
          Returns the parameter descriptors for this math transform.
 org.opengis.parameter.ParameterValueGroup getParameterValues()
          Returns the parameter values for this math transform.
 int getSourceDimensions()
          Gets the dimension of input points, which is 1.
 int getTargetDimensions()
          Gets the dimension of output points, which is 1.
 int hashCode()
          Returns a hash value for this transform.
 org.opengis.referencing.operation.MathTransform inverse()
          Creates the inverse transform of this object.
 double transform(double value)
          Transforms the specified value.
 void transform(double[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts)
          Transforms a list of coordinate point ordinal values.
 void transform(float[] srcPts, int srcOff, float[] dstPts, int dstOff, int numPts)
          Transforms a list of coordinate point ordinal values.
 
Methods inherited from class org.geotools.referencing.operation.transform.AbstractMathTransform
createTransformedShape, derivative, derivative, ensureNonNull, formatWKT, getDimSource, getDimTarget, isIdentity, needCopy, rollLongitude, transform, transform
 
Methods inherited from class org.geotools.referencing.wkt.Formattable
toString, toWKT, toWKT, toWKT
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.opengis.referencing.operation.MathTransform
derivative, isIdentity, toWKT, transform
 

Field Detail

base

public final double base
The base of the logarithm.


offset

public final double offset
The offset to add to the logarithm.

Constructor Detail

LogarithmicTransform1D

protected LogarithmicTransform1D(double base,
                                 double offset)
Constructs a new logarithmic transform. This constructor is provided for subclasses only. Instances should be created using the factory method, which may returns optimized implementations for some particular argument values.

Parameters:
base - The base of the logarithm.
offset - The offset to add to the logarithm.
Method Detail

create

public static org.opengis.referencing.operation.MathTransform1D create(double base,
                                                                       double offset)
Constructs a new logarithmic transform.

Parameters:
base - The base of the logarithm.
offset - The offset to add to the logarithm.

getParameterDescriptors

public org.opengis.parameter.ParameterDescriptorGroup getParameterDescriptors()
Returns the parameter descriptors for this math transform.

Overrides:
getParameterDescriptors in class AbstractMathTransform
Returns:
The parameter descriptors for this math transform, or .
See Also:
OperationMethod.getParameters()

getParameterValues

public org.opengis.parameter.ParameterValueGroup getParameterValues()
Returns the parameter values for this math transform.

Overrides:
getParameterValues in class AbstractMathTransform
Returns:
A copy of the parameter values for this math transform.
See Also:
Operation.getParameterValues()

getSourceDimensions

public int getSourceDimensions()
Gets the dimension of input points, which is 1.

Specified by:
getSourceDimensions in interface org.opengis.referencing.operation.MathTransform
Specified by:
getSourceDimensions in class AbstractMathTransform

getTargetDimensions

public int getTargetDimensions()
Gets the dimension of output points, which is 1.

Specified by:
getTargetDimensions in interface org.opengis.referencing.operation.MathTransform
Specified by:
getTargetDimensions in class AbstractMathTransform

inverse

public org.opengis.referencing.operation.MathTransform inverse()
Creates the inverse transform of this object.

Specified by:
inverse in interface org.opengis.referencing.operation.MathTransform
Overrides:
inverse in class AbstractMathTransform

derivative

public double derivative(double value)
Gets the derivative of this function at a value.

Specified by:
derivative in interface org.opengis.referencing.operation.MathTransform1D

transform

public double transform(double value)
Transforms the specified value.

Specified by:
transform in interface org.opengis.referencing.operation.MathTransform1D

transform

public void transform(float[] srcPts,
                      int srcOff,
                      float[] dstPts,
                      int dstOff,
                      int numPts)
Transforms a list of coordinate point ordinal values.

Specified by:
transform in interface org.opengis.referencing.operation.MathTransform
Overrides:
transform in class AbstractMathTransform

transform

public void transform(double[] srcPts,
                      int srcOff,
                      double[] dstPts,
                      int dstOff,
                      int numPts)
Transforms a list of coordinate point ordinal values.

Specified by:
transform in interface org.opengis.referencing.operation.MathTransform

hashCode

public int hashCode()
Returns a hash value for this transform. This value need not remain consistent between different implementations of the same class.

Overrides:
hashCode in class AbstractMathTransform

equals

public boolean equals(java.lang.Object object)
Compares the specified object with this math transform for equality.

Overrides:
equals in class AbstractMathTransform


Copyright © GeoTools. All Rights Reserved.