visad

Class PolarCoordinateSystem

java.lang.Object

visad.CoordinateSystem

visad.PolarCoordinateSystem

All Implemented Interfaces:

Serializable

public class PolarCoordinateSystem
extends CoordinateSystem

PolarCoordinateSystem is the VisAD CoordinateSystem class for (Longitude, Radius) with a Cartesian Reference, and with Longitude in degrees.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PolarCoordinateSystem(RealTupleType reference) construct a CoordinateSystem for (longitude, radius) relative to a 2-D Cartesian reference; this constructor supplies units = {CommonUnit.Degree, null} to the super constructor, in order to ensure Unit compatibility with its use of trigonometric functions

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object cs) Indicates whether or not this instance is equal to an object (note must test for cs == null).
double[][]	fromReference(double[][] tuples) Convert RealTuple values from Reference coordinates; for efficiency, input and output values are passed as double[][] arrays rather than RealTuple[] arrays; the array organization is double[tuple_dimension][number_of_tuples]; can modify and return argument array.
float[][]	fromReference(float[][] tuples) Convert RealTuple values from Reference coordinates; for efficiency, input and output values are passed as float[][] arrays rather than RealTuple[] arrays; the array organization is float[tuple_dimension][number_of_tuples]; can modify and return argument array.
double[][]	toReference(double[][] tuples) Convert RealTuple values to Reference coordinates; for efficiency, input and output values are passed as double[][] arrays rather than RealTuple[] arrays; the array organization is double[tuple_dimension][number_of_tuples]; can modify and return argument array.
float[][]	toReference(float[][] tuples) Convert RealTuple values to Reference coordinates; for efficiency, input and output values are passed as float[][] arrays rather than RealTuple[] arrays; the array organization is float[tuple_dimension][number_of_tuples]; can modify and return argument array.

Methods inherited from class visad.CoordinateSystem

canConvert, fromReference, fromReference, getCoordinateSystemUnits, getDimension, getReference, getReferenceUnits, toReference, toReference, transformCoordinates, transformCoordinates, transformCoordinates, transformCoordinates, transformCoordinatesFreeUnits, transformCoordinatesFreeUnits

Methods inherited from class java.lang.Object

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

Constructor Detail

PolarCoordinateSystem

public PolarCoordinateSystem(RealTupleType reference)
                      throws VisADException

construct a CoordinateSystem for (longitude, radius) relative to a 2-D Cartesian reference; this constructor supplies units = {CommonUnit.Degree, null} to the super constructor, in order to ensure Unit compatibility with its use of trigonometric functions

Throws:

VisADException

Method Detail

toReference

public double[][] toReference(double[][] tuples)
                       throws VisADException

Description copied from class: CoordinateSystem

Convert RealTuple values to Reference coordinates; for efficiency, input and output values are passed as double[][] arrays rather than RealTuple[] arrays; the array organization is double[tuple_dimension][number_of_tuples]; can modify and return argument array.

Specified by:

toReference in class CoordinateSystem

Parameters:

tuples - array of values assumed to be in coordinateSystem units. Input array is not guaranteed to be immutable and could be used for return.

Returns:

array of double values in reference coordinates and Units.

Throws:

VisADException - if problem with conversion.

fromReference

public double[][] fromReference(double[][] tuples)
                         throws VisADException

Description copied from class: CoordinateSystem

Convert RealTuple values from Reference coordinates; for efficiency, input and output values are passed as double[][] arrays rather than RealTuple[] arrays; the array organization is double[tuple_dimension][number_of_tuples]; can modify and return argument array.

Specified by:

fromReference in class CoordinateSystem

Parameters:

tuples - array of values assumed to be in reference Units. Input array is not guaranteed to be immutable and could be used for return.

Returns:

array of double values in CoordinateSystem Units.

Throws:

VisADException - if problem with conversion.

toReference

public float[][] toReference(float[][] tuples)
                      throws VisADException

Description copied from class: CoordinateSystem

Convert RealTuple values to Reference coordinates; for efficiency, input and output values are passed as float[][] arrays rather than RealTuple[] arrays; the array organization is float[tuple_dimension][number_of_tuples]; can modify and return argument array. This implementation converts the input array to doubles and calls CoordinateSystem.toReference(double[][]) and then returns that converted double array back as a float array. For efficiency, subclasses should override this implementation.

Overrides:

toReference in class CoordinateSystem

Parameters:

tuples - array of values assumed to be in coordinateSystem units. Input array is not guaranteed to be immutable and could be used for return.

Returns:

array of float values in reference coordinates and Units.

Throws:

VisADException - if problem with conversion.

fromReference

public float[][] fromReference(float[][] tuples)
                        throws VisADException

Description copied from class: CoordinateSystem

Convert RealTuple values from Reference coordinates; for efficiency, input and output values are passed as float[][] arrays rather than RealTuple[] arrays; the array organization is float[tuple_dimension][number_of_tuples]; can modify and return argument array. This implementation converts the input array to doubles and calls CoordinateSystem.toReference(double[][]) and then returns that converted double array back as a float array. For efficiency, subclasses should override this implementation.

Overrides:

fromReference in class CoordinateSystem

Parameters:

tuples - array of values assumed to be in reference Units. Input array is not guaranteed to be immutable and could be used for return.

Returns:

array of float values in this CoordinateSystem Units.

Throws:

VisADException - if problem with conversion.

equals

public boolean equals(Object cs)

Description copied from class: CoordinateSystem

Indicates whether or not this instance is equal to an object (note must test for cs == null).

Specified by:

equals in class CoordinateSystem

Parameters:

cs - the object in question.

Returns:

true if and only if this instance equals cs.