Package org.eclipse.imagen.media.piecewise

Class DefaultPiecewiseTransform1DElement

Object

DefaultDomainElement1D

DefaultPiecewiseTransform1DElement

All Implemented Interfaces:

Serializable, Comparable<DomainElement1D>, DomainElement1D, PiecewiseTransform1DElement

Direct Known Subclasses:

DefaultLinearPiecewiseTransform1DElement, DefaultPassthroughPiecewiseTransform1DElement

public class DefaultPiecewiseTransform1DElement
extends DefaultDomainElement1D
implements PiecewiseTransform1DElement

Convenience implementation of the DefaultPiecewiseTransform1DElement .

Author:

Simone Giannecchini, GeoSolutions

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultPiecewiseTransform1DElement(CharSequence name, Range valueRange)	Protected constructor for DomainElement1Ds that want to build their transform later on.
DefaultPiecewiseTransform1DElement(CharSequence name, Range valueRange, MathTransformation transform)	Public constructor for building a DomainElement1D which applies the specified transformation on the values that fall into its definition range.

Method Summary

Modifier and Type	Method	Description
static DefaultPiecewiseTransform1DElement	create(CharSequence name)	Creates a pass-through DefaultPiecewiseTransform1DElement.
static DefaultPiecewiseTransform1DElement	create(CharSequence name, Range valueRange)	Creates a pass-through DefaultPiecewiseTransform1DElement.
static DefaultPiecewiseTransform1DElement	create(CharSequence name, Range inRange, byte value)	Builds up a DefaultPiecewiseTransform1DElement which maps a range to a constant value.
static DefaultPiecewiseTransform1DElement	create(CharSequence name, Range inRange, double value)	Builds up a DefaultPiecewiseTransform1DElement which maps a range to a constant value.
static DefaultPiecewiseTransform1DElement	create(CharSequence name, Range inRange, int value)	Builds up a DefaultPiecewiseTransform1DElement which maps a range to a constant value.
static DefaultPiecewiseTransform1DElement	create(CharSequence name, Range inRange, Range outRange)	Constructor.
static DefaultPiecewiseTransform1DElement	create(String string, Range range, MathTransformation mathTransform1D)
boolean	equals(Object obj)	Implementation of Object.equals(Object) for DomainElement1Ds.
int	getSourceDimensions()	Returns the input transformation dimensions
int	getTargetDimensions()	Returns the output transformation dimensions
int	hashCode()	Returns a hash value for this domain element.
MathTransformation	inverse()	Returns the inverse of this MathTransformation instance
boolean	isIdentity()	Defines if the transformation is an identity
double	transform(double value)	Transforms the specified value.
Position	transform(Position ptSrc, Position ptDst)	Transforms the specified ptSrc and stores the result in ptDst.

Methods inherited from class DefaultDomainElement1D

compareTo, contains, contains, contains, getInputMaximum, getInputMinimum, getName, getRange, isInputMaximumInfinite, isInputMaximumNaN, isInputMinimumInfinite, isInputMinimumNaN, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Comparable

compareTo

Methods inherited from interface DomainElement1D

contains, contains, contains, getName, getRange

Constructor Details

DefaultPiecewiseTransform1DElement

public DefaultPiecewiseTransform1DElement(CharSequence name,
 Range valueRange)
                                   throws IllegalArgumentException

Protected constructor for DomainElement1Ds that want to build their transform later on.

Parameters:

name - for this DomainElement1D.

valueRange - for this DomainElement1D.

Throws:

IllegalArgumentException

DefaultPiecewiseTransform1DElement

public DefaultPiecewiseTransform1DElement(CharSequence name,
 Range valueRange,
 MathTransformation transform)
                                   throws IllegalArgumentException

Public constructor for building a DomainElement1D which applies the specified transformation on the values that fall into its definition range.

Parameters:

name - for this DomainElement1D.

valueRange - for this DomainElement1D.

transform - for this DomainElement1D.

Throws:

IllegalArgumentException

Method Details

create

public static DefaultPiecewiseTransform1DElement create(CharSequence name,
 Range inRange,
 double value)

Builds up a DefaultPiecewiseTransform1DElement which maps a range to a constant value.

Parameters:

name - for this DomainElement1D

inRange - for this DomainElement1D

outVal - for this DefaultLinearPiecewiseTransform1DElement

Throws:

IllegalArgumentException - in case the input values are illegal.

create

public static DefaultPiecewiseTransform1DElement create(CharSequence name,
 Range inRange,
 byte value)

Builds up a DefaultPiecewiseTransform1DElement which maps a range to a constant value.

Parameters:

name - for this DomainElement1D

inRange - for this DomainElement1D

outVal - for this DefaultLinearPiecewiseTransform1DElement

Throws:

IllegalArgumentException - in case the input values are illegal.

create

public static DefaultPiecewiseTransform1DElement create(CharSequence name,
 Range inRange,
 int value)

Builds up a DefaultPiecewiseTransform1DElement which maps a range to a constant value.

Parameters:

name - for this DomainElement1D

inRange - for this DomainElement1D

outVal - for this DefaultLinearPiecewiseTransform1DElement

Throws:

IllegalArgumentException - in case the input values are illegal.

create

public static DefaultPiecewiseTransform1DElement create(CharSequence name,
 Range inRange,
 Range outRange)

Constructor.

Parameters:

name - for this DefaultLinearPiecewiseTransform1DElement.

inRange - for this DefaultLinearPiecewiseTransform1DElement.

outRange - for this DefaultLinearPiecewiseTransform1DElement.

create

public static DefaultPiecewiseTransform1DElement create(CharSequence name)
                                                 throws IllegalArgumentException

Creates a pass-through DefaultPiecewiseTransform1DElement.

Parameters:

name - for this DomainElement1D.

Throws:

IllegalArgumentException

create

public static DefaultPiecewiseTransform1DElement create(CharSequence name,
 Range valueRange)
                                                 throws IllegalArgumentException

Creates a pass-through DefaultPiecewiseTransform1DElement.

Parameters:

name - for this DomainElement1D.

valueRange - for this DomainElement1D.

Throws:

IllegalArgumentException

transform

public double transform(double value)
                 throws TransformationException

Transforms the specified value.

Specified by:

transform in interface PiecewiseTransform1DElement

Parameters:

value - The value to transform.

Returns:

the transformed value.

Throws:

TransformationException - if the value can't be transformed.

transform

public Position transform(Position ptSrc,
 Position ptDst)
                   throws TransformationException

Transforms the specified ptSrc and stores the result in ptDst.

Throws:

TransformationException

getSourceDimensions

public int getSourceDimensions()

Returns the input transformation dimensions

getTargetDimensions

public int getTargetDimensions()

Returns the output transformation dimensions

inverse

public MathTransformation inverse()
                           throws NoninvertibleTransformException

Returns the inverse of this MathTransformation instance

Throws:

NoninvertibleTransformException

isIdentity

public boolean isIdentity()

Defines if the transformation is an identity

equals

public boolean equals(Object obj)

Description copied from class: DefaultDomainElement1D

Implementation of Object.equals(Object) for DomainElement1Ds.

Two DefaultDomainElement1Ds are considered to be equal if they have the same inputr range and the same name.

Specified by:

equals in interface DomainElement1D

Overrides:

equals in class DefaultDomainElement1D

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

• Object.equals(Object)

hashCode

public int hashCode()

Description copied from class: DefaultDomainElement1D

Returns a hash value for this domain element. This value need not remain consistent between different implementations of the same class.

Overrides:

hashCode in class DefaultDomainElement1D

create

public static DefaultPiecewiseTransform1DElement create(String string,
 Range range,
 MathTransformation mathTransform1D)