uk.ac.starlink.ast
Class AstroCoords

java.lang.Object
  extended by uk.ac.starlink.ast.AstroCoords

public class AstroCoords
extends Object

Represents an AstroCoords element from the Space-Time Coordinate (STC) metadata. This class is used in place of AST's KeyMap for user-visible cases where the KeyMap's purpose is to represent an AstroCoords element, since it is easier for programmers and more typesafe. Note however that it does not have all the complexity of an STC AstroCoords element, only those parts which are required for its use with the AST Stc* classes.

Author:
Mark Taylor

Constructor Summary
AstroCoords()
          Constructor.
AstroCoords(String[] axisNames)
          Constructor which allows specification of axis names.
 
Method Summary
 Region getError()
          Returns the error region for this coordinate.
 String[] getName()
          Returns the axis names.
 Region getPixSize()
          Returns the pixel size for this coordinate.
 Region getResolution()
          Returns the resolution region for this coordinate.
 Region getSize()
          Returns the size region for this coordinate.
 Region getValue()
          Returns the value of this coordinate.
 void setError(Region error)
          Sets the error region for this coordinate.
 void setName(String[] axisNames)
          Sets the axis names.
 void setPixSize(Region pixSize)
          Sets the pixel size for this coordinate.
 void setResolution(Region resolution)
          Sets the resolution region for this coordinate.
 void setSize(Region size)
          Sets the size region for this coordinate.
 void setValue(Region value)
          Sets the value of this coordinate.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AstroCoords

public AstroCoords()
Constructor.


AstroCoords

public AstroCoords(String[] axisNames)
Constructor which allows specification of axis names.

Parameters:
axisNames - array of names for each axis in the coordinate system of the corresponding Region
Method Detail

setName

public void setName(String[] axisNames)
Sets the axis names.

Parameters:
axisNames - array of names for each axis in the coordinate system of the corresponding Region

getName

public String[] getName()
Returns the axis names.

Returns:
array of names for each axis in the coordinate system of the corresponding Region

setValue

public void setValue(Region value)
Sets the value of this coordinate.

Parameters:
value - value region

getValue

public Region getValue()
Returns the value of this coordinate.

Returns:
value region

setError

public void setError(Region error)
Sets the error region for this coordinate.

Parameters:
error - error region

getError

public Region getError()
Returns the error region for this coordinate.

Returns:
error region

setResolution

public void setResolution(Region resolution)
Sets the resolution region for this coordinate.

Parameters:
resolution - resolution region

getResolution

public Region getResolution()
Returns the resolution region for this coordinate.

Returns:
resolution region

setSize

public void setSize(Region size)
Sets the size region for this coordinate.

Parameters:
size - size region

getSize

public Region getSize()
Returns the size region for this coordinate.

Returns:
size region

setPixSize

public void setPixSize(Region pixSize)
Sets the pixel size for this coordinate.

Parameters:
pixSize - pixel size

getPixSize

public Region getPixSize()
Returns the pixel size for this coordinate.

Returns:
pixSize pixel size


Copyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.