org.javaseis.properties
Class AxisDefinition

java.lang.Object
  org.javaseis.properties.AxisDefinition

All Implemented Interfaces:

java.io.Serializable

public class AxisDefinition
extends java.lang.Object
implements java.io.Serializable

The AxisDefinition class provides...

See Also:

Serialized Form

Field Summary

protected DataDomain	_domain
protected AxisLabel	_label
protected long	_length
protected long	_logicalDelta
protected long	_logicalOrigin
protected double	_physicalDelta
protected double	_physicalOrigin
protected Units	_units

Constructor Summary

AxisDefinition(AxisLabel label, Units units, DataDomain domain, long length, long logicalOrigin, long logicalDelta, double physicalOrigin, double physicalDelta)
Axis definition constuctor.

Method Summary

static AxisDefinition[]	getDefault(int ndim, int[] idim)
DataDomain	getDomain()
AxisLabel	getLabel()
long	getLength()
long	getLogicalDelta()
long	getLogicalOrigin()
double	getPhysicalDelta()
double	getPhysicalOrigin()
Units	getUnits()
AxisDefinition	subRange(long[] range)

Methods inherited from class java.lang.Object

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

Field Detail

_domain

protected DataDomain _domain

_label

protected AxisLabel _label

_length

protected long _length

_logicalDelta

protected long _logicalDelta

_logicalOrigin

protected long _logicalOrigin

_physicalDelta

protected double _physicalDelta

_physicalOrigin

protected double _physicalOrigin

_units

protected Units _units

Constructor Detail

AxisDefinition

public AxisDefinition(AxisLabel label,
                      Units units,
                      DataDomain domain,
                      long length,
                      long logicalOrigin,
                      long logicalDelta,
                      double physicalOrigin,
                      double physicalDelta)

Axis definition constuctor. None of the input parameters can be null.

Parameters:

label - the label of the axis.

units - the physical units along the axis.

domain - the physical domain of the axis.

length - the length of the axis (number of samples).

logicalOrigin - the logical origin of the axis (e.g. the first inline number).

logicalDelta - the logical increment along the axis.

physicalOrigin - the physical origin of the axis (i.e. the coordinate of the first sample).

physicalDelta - the physical increment between samples.

Method Detail

getDefault

public static AxisDefinition[] getDefault(int ndim,
                                          int[] idim)

getDomain

public DataDomain getDomain()

getLabel

public AxisLabel getLabel()

getLength

public long getLength()

getLogicalDelta

public long getLogicalDelta()

getLogicalOrigin

public long getLogicalOrigin()

getPhysicalDelta

public double getPhysicalDelta()

getPhysicalOrigin

public double getPhysicalOrigin()

getUnits

public Units getUnits()

subRange

public AxisDefinition subRange(long[] range)