Package uk.ac.starlink.ttools.task
Class SkyCoordParameter
- java.lang.Object
-
- uk.ac.starlink.task.Parameter<java.lang.String>
-
- uk.ac.starlink.task.StringParameter
-
- uk.ac.starlink.ttools.task.SkyCoordParameter
-
public class SkyCoordParameter extends uk.ac.starlink.task.StringParameter
Utilities for sky coordinate parameters.- Since:
- 15 May 2014
- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Constructor Description SkyCoordParameter(java.lang.String name, java.lang.String coordName, java.lang.String coordSys, java.lang.String tableDescrip)
Constructor.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static uk.ac.starlink.task.StringParameter
createDecParameter(java.lang.String paramName, java.lang.String coordSys, java.lang.String tableDescrip)
Utility method to create a parameter representing Declination.static uk.ac.starlink.task.StringParameter
createRaParameter(java.lang.String paramName, java.lang.String coordSys, java.lang.String tableDescrip)
Utility method to create a parameter representing Right Ascension.static java.lang.String
guessDecDegreesExpression(uk.ac.starlink.table.StarTable inTable)
Looks at table columns and makes a guess at a JEL expression which will give Declination in degrees.static java.lang.String
guessRaDegreesExpression(uk.ac.starlink.table.StarTable inTable)
Looks at table columns and makes a guess at a JEL expression which will give Right Ascension in degrees.-
Methods inherited from class uk.ac.starlink.task.Parameter
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getUsage, getValueClass, isNullPermitted, objectToString, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setUsage, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toString
-
-
-
-
Constructor Detail
-
SkyCoordParameter
public SkyCoordParameter(java.lang.String name, java.lang.String coordName, java.lang.String coordSys, java.lang.String tableDescrip)
Constructor.- Parameters:
name
- parameter namecoordName
- text name for the coordinate, full word, capitalised, for instance "Right ascension"coordSys
- name of coordinate system, or nulltableDescrip
- text denoting table to which the coordinate refers, for instance "the input table"
-
-
Method Detail
-
createRaParameter
public static uk.ac.starlink.task.StringParameter createRaParameter(java.lang.String paramName, java.lang.String coordSys, java.lang.String tableDescrip)
Utility method to create a parameter representing Right Ascension.- Parameters:
paramName
- parameter namecoordSys
- name of coordinate system, or nulltableDescrip
- text denoting table to which the coordinate refers, for instance "the input table"- Returns:
- new RA parameter
-
createDecParameter
public static uk.ac.starlink.task.StringParameter createDecParameter(java.lang.String paramName, java.lang.String coordSys, java.lang.String tableDescrip)
Utility method to create a parameter representing Declination.- Parameters:
paramName
- parameter namecoordSys
- name of coordinate system, or nulltableDescrip
- text denoting table to which the coordinate refers, for instance "the input table"- Returns:
- new declination parameter
-
guessRaDegreesExpression
public static java.lang.String guessRaDegreesExpression(uk.ac.starlink.table.StarTable inTable)
Looks at table columns and makes a guess at a JEL expression which will give Right Ascension in degrees.- Parameters:
inTable
- table- Returns:
- expression for RA in degrees, or null if none can be found
-
guessDecDegreesExpression
public static java.lang.String guessDecDegreesExpression(uk.ac.starlink.table.StarTable inTable)
Looks at table columns and makes a guess at a JEL expression which will give Declination in degrees.- Parameters:
inTable
- table- Returns:
- expression for Dec in degrees, or null if none can be found
-
-