org.jscience.astronomy.solarsystem.coordinates
Class Converter

java.lang.Object
  org.jscience.astronomy.solarsystem.coordinates.Transformer
      org.jscience.astronomy.solarsystem.coordinates.Converter

All Implemented Interfaces:

Named

public class Converter
extends Transformer
implements Named

A converter applies a succession of transformations on the data

Constructor Summary

Converter()

Method Summary

void	add(Transformer trans) Add a component to the transformation
void	debug(boolean flag)
java.lang.String	getDescription()
int	getInputDimension() Get the dimensionality of the input vectors.
java.lang.String	getName() DOCUMENT ME!
int	getOutputDimension() Get the dimensionality of the output vectors.
Converter	inverse() Return the inverse of this series of transformations.
boolean	isInverse(Transformer t) Is this the inverse of another transformation.
void	transform(double[][] in, double[][] out) Transform an array of vectors
void	transform(double[] in, double[] out) Transform a vector

Methods inherited from class org.jscience.astronomy.solarsystem.coordinates.Transformer

transform

Methods inherited from class java.lang.Object

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

Constructor Detail

Converter

public Converter()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Named

DOCUMENT ME!

Specified by:

getName in interface Named

Returns:

DOCUMENT ME!

getDescription

public java.lang.String getDescription()

debug

public void debug(boolean flag)

getInputDimension

public int getInputDimension()

Get the dimensionality of the input vectors.

Specified by:

getInputDimension in class Transformer

getOutputDimension

public int getOutputDimension()

Get the dimensionality of the output vectors.

Specified by:

getOutputDimension in class Transformer

add

public void add(Transformer trans)
         throws TransformationException

Add a component to the transformation

Throws:

TransformationException

transform

public void transform(double[] in,
                      double[] out)

Transform a vector

Specified by:

transform in class Transformer

Parameters:

in - The input vector.

out - The output vector, it may be the same as the input vector if the dimensionalities are the same. All transformers are expected to work with aliased inputs and output.

transform

public void transform(double[][] in,
                      double[][] out)

Transform an array of vectors

Overrides:

transform in class Transformer

Parameters:

in - A set of positions to be transformed. The first dimension should be consistent with getInputDimension, while the second is the number of points to be transferred.

out - The updated positions. The first dimension should be consistent with getOutputDimension, while the second is the number of points to be transferred. This argument may point to the same data as the input.

inverse

public Converter inverse()

Return the inverse of this series of transformations.

Specified by:

inverse in class Transformer

isInverse

public boolean isInverse(Transformer t)

Is this the inverse of another transformation.

Specified by:

isInverse in class Transformer