SimpleStar

java.lang.Object
- astro.SimpleStar

All Implemented Interfaces:

Star, Serializable, Cloneable

Direct Known Subclasses:

HauckCatalog.StromgrenStar, PastelStar, PpmXlStar, SextractorStar, SqlStar, UcacStar
```
public class SimpleStar
extends Object
implements Cloneable, Serializable, Star
```
A helper class containing general information on a star. This class expands the HashMap class and provides access to the following properties.
- Star.NAME: The name of the star. Can be any string, but consider using catalog definitions like HD 12545.
- Star.ID: The unique star identifier. A parsable integer, zero denoting undefined. Defaults to DEFID.
- Star.RA: The right ascension of the star. A parsable double, in degrees.
- Star.DEC: The declination of the star. A parsable double, in degrees.
- Star.PROPRA: The proper motion in right ascension of the star, in mas per year. For convenience already multiplied with the cosine of the stars declination. Defaults to DEFPROPRA.
- Star.PROPDEC: The proper motion in declination of the star, in mas per year. Defaults to DEFPROPDEC
- Star.EPOCH: The epoch of the star position. Defaults to Star.DEFEPOCH.
- Star.EQUINOX: The equinox of the star position. Defaults to Star.DEFEQUINOX.
- Star.MAG: The brightness of the star, in magnitudes. Should use Johnson V.
- Star.COLOR: The color index of the star, in magnitudes. Should use Johnson B-V. Defaults to DEFCOLOR
Additional to the Object returns of the simple properties lookup defined above, this class allows retrieving and setting of the following properties as primitive data types.
- getID(): Returns the integer-id of the star
- getRa(): Returns the double of the right ascension.
- #getDec: Returns the double of the declination.
- getPropRa(): Returns the double of the proper motion in ra.
- #getPropDec: Returns the double of the proper motion in dec.
- getMag(): Returns the float of the brightness
- getColor(): Returns the float of the color index.
- getEpoch(): Returns the float of the epoch of the star position.
- getEquinox(): Returns the float of the equinox of the star position
Note that retrieving the the double values is not costly because an internal copy of the appropriate values is asociated with instances of this class. On the other hand, no validity checks are performed on retrieving values from this object. It is in the users responsibility to handle this class correctly.
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SimpleStar.Distance` For sorting star lists to distance of center.
`static class`	`SimpleStar.StarComparator` Gets a star definition comparator linked to the named property of the star.

Field Summary

Fields
Modifier and Type	Field and Description
`private Map<String,Object>`	`addon` A mapping of additinal properties of the stars to their values.
`private Float`	`color` The color of the star.
`private Double`	`de` The declination of the star.
`static float`	`DEFCOLOR` The default color of the star (0.0).
`private static int`	`DEFDECPRECISSION`
`static int`	`DEFID` The default star id (0=undefined).
`static double`	`DEFPROPDEC` The default proper motion in dec (0.0).
`static double`	`DEFPROPRA` The default proper motion in ra (0.0).
`private static int`	`DEFRAPRECISSION`
`private Float`	`epoch` Epoch.
`private Float`	`equinox` Equinox of ra de.
`static String`	`HTM` Star names from HTM.
`private Integer`	`id` Integer id of the star.
`private Float`	`mag` The magnitude of the star.
`private String`	`name` Name of the star.
`private Double`	`pmde` Proper motion in de, in milli arc-sec per year.
`private Double`	`pmra` Proper motion in ra, in milli arc-sec per year, divided by cosine dec.
`private Double`	`ra` The right ascension of the star.
`private static long`	`serialVersionUID`
`static float`	`SKYMAG` Unknown mag, use sky brightness.
`static SimpleStar`	`SOL`
`private static String`	`SOLNAME`
`static String`	`UNKNOWN` Unknown star names.

Fields inherited from interface astro.Star
COLOR, DEC, DEFEPOCH, DEFEQUINOX, EPOCH, EQUINOX, ID, MAG, NAME, PROPDEC, PROPRA, RA

Constructor Summary

Constructors
Constructor and Description
`SimpleStar()` Constructs a new empty star description.
`SimpleStar(Star copy)` Constructs a new star description from the source object.
`SimpleStar(String name)` Constructs a new empty star description.
`SimpleStar(String name, String ras, String decs, String mags)` Constructs a new star description with the minimal information.
`SimpleStar(String name, String id, String ras, String decs, String mags, String color)` Constructs a new star description.
`SimpleStar(String name, String id, String ras, String decs, String pra, String pdec, String mags, String color)` Constructs a new star description.
`SimpleStar(String name, String id, String ras, String decs, String pra, String pdec, String ep, String eq, String mags, String color)` Constructs a new full star description.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)` Two stars are equal if they have the same name, or if their separation is zero.
`static Map<Integer,Star>`	`exportIdMap(List<Star> l)` Exports a list of stas as a mapping of star names to stars.
`static Map<String,Star>`	`exportNameMap(List<Star> l)` Exports a list of stas as a mapping of star names to stars.
`static SimpleStar`	`fillMissing(Star main, Star fill)` Adds all data that is missing from the first star entry, but present in the second into the first and returns it.
`Object`	`get(String key)` Returns the queried value in its string representation of addintional info.
`float`	`getColor()` Returns the color of the star as a float.
`double`	`getDe()` Returns the declination of the star as a double in degrees.
`float`	`getEpoch()` Returns the epoch of the position coordinate system as a float.
`float`	`getEquinox()` Returns the equinox of the position coordinate system as a float.
`static String`	`getHtmName(double ra, double de)`
`static String`	`getHtmName(Star marginal)`
`int`	`getID()` Returns the star id as an int.
`float`	`getMag()` Returns the magnitude of the star as a float.
`static SimpleStar.StarComparator`	`getMagComparator()` Convenience method.
`String`	`getName()` Returns the target name.
`double`	`getPropDe()` Returns the proper motion in declination of the star as a double.
`String`	`getProperty(String key)` Returns the queried value in its string representation of addintional info.
`double`	`getPropRa()` Returns the proper motion in ra of the star as a double.
`double`	`getRa()` Returns the right ascension of the star as a double in degrees.
`double`	`getSeparation(double ra2, double de2)` Returns the distance in degrees of this star description to the argument one.
`static double`	`getSeparation(double ra1, double ra2, double de1, double de2)` Returns the distance of two stars, in degrees.
`double`	`getSeparation(Star other)` Returns the distance in degrees of this star description to the argument one.
`static double`	`getSeparation(Star s1, double ra2, double de2)` Returns the distance of two stars, in degrees.
`static double`	`getSeparation(Star s1, Star s2)` Returns the distance of two stars, in degrees.
`boolean`	`isFullyValid()` Checks if ra, de, mag, color, pmra, and pmde are defined.
`boolean`	`isMarginallyValid()` Checks if at least the right ascension and the declination is valid.
`static boolean`	`isSexagesimal(String dm)` We try to infer if a specified string is in sexagesimal format, which we define by twice occurance of ':'.
`boolean`	`isValid()` Checks if ra, de, and mag of the star is defined.
`boolean`	`isVeryValid()` Checks if ra, de, mag, and color is defined.
`boolean`	`matches(Star s2, double maxdist, float magoff)` Tries to match two stars.
`static boolean`	`matches(Star s1, Star s2, double maxdist, float magoff)` Tries to match two stars.
`static double`	`parseSexagesimal(String dm)` We convert a string given as dd:mm:ss.sss into a normal double.
`String`	`raDeString()`
`String`	`raDeString(int raprec, int deprec)`
`static String`	`raDeString(Star onto)`
`static String`	`raDeString(Star s, int raprec, int deprec)`
`Object`	`set(String key, Object to)` Sets the object.
`Object`	`setColor(float bv)` Sets the color of the star.
`Object`	`setDe(double dec)` Sets the declination of the star.
`Object`	`setEpoch(float ep)` Sets the epoch of the position coordinate system.
`Object`	`setEquinox(float eq)` Sets the equinox of the position coordinate system.
`Object`	`setID(int id)` Sets the star id.
`Object`	`setMag(float v)` Sets the brightness of the star.
`Object`	`setName(String name)` Sets the target name.
`Object`	`setPropDe(double pdec)` Sets the proper motion in dec of the star.
`Object`	`setProperty(String key, String val)` Scans the key for recognized keywords.
`Object`	`setPropRa(double pra)` Sets the proper motion in ra of the star.
`Object`	`setRa(double ra)` Sets the right ascension of the star.
`String`	`sexagesimal()`
`String`	`sexagesimal(int raprec, int deprec)`
`static String`	`sexagesimal(Star s)`
`static String`	`sexagesimal(Star s, int raprec, int deprec)`
`String`	`toBasicString()` Returns sexagesimal RA in hours and DE, appends mag if valid.
`static String`	`toBasicString(Star s)` Returns sexagesimal RA in hours and DE, appends mag if valid.
`String`	`toDegreeString()` Returns decimal RA in degrees and DE.
`static String`	`toDegreeString(Star s)` Returns decimal RA in degrees and DE.
`String`	`toString()` Converts the star description name, ra, dec, mag and color into a string.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFDECPRECISSION
```
private static final int DEFDECPRECISSION
```
    See Also:
    
    Constant Field Values
  - DEFRAPRECISSION
```
private static final int DEFRAPRECISSION
```
    See Also:
    
    Constant Field Values
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - UNKNOWN
```
public static final String UNKNOWN
```
    Unknown star names.
    
    See Also:
    
    Constant Field Values
  - HTM
```
public static final String HTM
```
    Star names from HTM.
    
    See Also:
    
    Constant Field Values
  - SKYMAG
```
public static final float SKYMAG
```
    Unknown mag, use sky brightness.
    
    See Also:
    
    Constant Field Values
  - DEFPROPRA
```
public static final double DEFPROPRA
```
    The default proper motion in ra (0.0).
    
    See Also:
    
    Constant Field Values
  - DEFPROPDEC
```
public static final double DEFPROPDEC
```
    The default proper motion in dec (0.0).
    
    See Also:
    
    Constant Field Values
  - DEFCOLOR
```
public static final float DEFCOLOR
```
    The default color of the star (0.0).
    
    See Also:
    
    Constant Field Values
  - DEFID
```
public static final int DEFID
```
    The default star id (0=undefined).
    
    See Also:
    
    Constant Field Values
  - SOLNAME
```
private static final String SOLNAME
```
    See Also:
    
    Constant Field Values
  - name
```
private String name
```
    Name of the star.
  - id
```
private Integer id
```
    Integer id of the star. Unique number defining the star, like a HD #.
  - ra
```
private Double ra
```
    The right ascension of the star.
  - de
```
private Double de
```
    The declination of the star.
  - mag
```
private Float mag
```
    The magnitude of the star. Color system unspecified, but mostly V.
  - color
```
private Float color
```
    The color of the star. Filter difference unspecified, but mostly B-V.
  - epoch
```
private Float epoch
```
    Epoch.
  - equinox
```
private Float equinox
```
    Equinox of ra de.
  - pmra
```
private Double pmra
```
    Proper motion in ra, in milli arc-sec per year, divided by cosine dec.
  - pmde
```
private Double pmde
```
    Proper motion in de, in milli arc-sec per year.
  - addon
```
private Map<String,Object> addon
```
    A mapping of additinal properties of the stars to their values.
  - SOL
```
public static SimpleStar SOL
```
- Constructor Detail
  - SimpleStar
```
public SimpleStar()
```
    Constructs a new empty star description. Note that all fields are undefined.
  - SimpleStar
```
public SimpleStar(String name)
```
    Constructs a new empty star description. Note that all fields are undefined.
  - SimpleStar
```
public SimpleStar(Star copy)
```
    Constructs a new star description from the source object. Does not copy the extra information, this is lost.
  - SimpleStar
```
public SimpleStar(String name,
                  String ras,
                  String decs,
                  String mags)
```
    Constructs a new star description with the minimal information.
    
    Parameters:
    
    name - Name of the star.
    
    ras - Right ascension of the star.
    
    decs - Declination of the star.
    
    mags - Brightness of the star.
  - SimpleStar
```
public SimpleStar(String name,
                  String id,
                  String ras,
                  String decs,
                  String mags,
                  String color)
```
    Constructs a new star description.
    
    Parameters:
    
    name - Name of the star.
    
    id - ID of the star.
    
    ras - Right ascension of the star.
    
    decs - Declination of the star.
    
    mags - Brightness of the star.
    
    color - Color index of the star.
  - SimpleStar
```
public SimpleStar(String name,
                  String id,
                  String ras,
                  String decs,
                  String pra,
                  String pdec,
                  String mags,
                  String color)
```
    Constructs a new star description.
    
    Parameters:
    
    name - Name of the star.
    
    id - ID of the star.
    
    ras - Right ascension of the star.
    
    decs - Declination of the star.
    
    mags - Brightness of the star.
    
    color - Color index of the star.
  - SimpleStar
```
public SimpleStar(String name,
                  String id,
                  String ras,
                  String decs,
                  String pra,
                  String pdec,
                  String ep,
                  String eq,
                  String mags,
                  String color)
```
    Constructs a new full star description.
    
    Parameters:
    
    name - Name of the star.
    
    id - ID of the star.
    
    ras - Right ascension of the star.
    
    decs - Declination of the star.
    
    pra - Proper motion in ra of the star.
    
    pdec - Proper motion in dec of the star.
    
    ep - Epoch of the coordinate system.
    
    eq - Equinox of the coordinate system.
    
    mags - Brightness of the star.
    
    color - Color index of the star.
- Method Detail
  - get
```
public Object get(String key)
```
    Returns the queried value in its string representation of addintional info.
    
    Specified by:
    
    get in interface Star
  - getProperty
```
public String getProperty(String key)
```
    Returns the queried value in its string representation of addintional info.
  - setProperty
```
public Object setProperty(String key,
                          String val)
```
    Scans the key for recognized keywords. If the key is known, the appropriate set... method is called, otherwise the parent's class put method is invoked. If parsing fails the property in the underlying Hashtable is not changed.
  - set
```
public Object set(String key,
                  Object to)
```
    Sets the object.
    
    Returns:
    
    Old mapping or null if not set.
  - setName
```
public Object setName(String name)
```
    Sets the target name.
  - getName
```
public String getName()
```
    Description copied from interface: Star
    
    Returns the target name.
    
    Specified by:
    
    getName in interface Star
  - setID
```
public Object setID(int id)
```
    Sets the star id.
  - getID
```
public int getID()
```
    Description copied from interface: Star
    
    Returns the star id as an int.
    
    Specified by:
    
    getID in interface Star
  - getHtmName
```
public static String getHtmName(Star marginal)
```
  - getHtmName
```
public static String getHtmName(double ra,
                                double de)
```
  - setRa
```
public Object setRa(double ra)
```
    Sets the right ascension of the star.
    
    Parameters:
    
    ra - Right ascension in degrees
  - getRa
```
public double getRa()
```
    Description copied from interface: Star
    
    Returns the right ascension of the star as a double in degrees.
    
    Specified by:
    
    getRa in interface Star
  - setDe
```
public Object setDe(double dec)
```
    Sets the declination of the star.
    
    Parameters:
    
    dec - Declination of star in degrees.
  - getDe
```
public double getDe()
```
    Description copied from interface: Star
    
    Returns the declination of the star as a double in degrees.
    
    Specified by:
    
    getDe in interface Star
  - setPropRa
```
public Object setPropRa(double pra)
```
    Sets the proper motion in ra of the star.
  - getPropRa
```
public double getPropRa()
```
    Description copied from interface: Star
    
    Returns the proper motion in ra of the star as a double.
    
    Specified by:
    
    getPropRa in interface Star
  - setPropDe
```
public Object setPropDe(double pdec)
```
    Sets the proper motion in dec of the star.
  - getPropDe
```
public double getPropDe()
```
    Description copied from interface: Star
    
    Returns the proper motion in declination of the star as a double.
    
    Specified by:
    
    getPropDe in interface Star
  - setEpoch
```
public Object setEpoch(float ep)
```
    Sets the epoch of the position coordinate system.
  - getEpoch
```
public float getEpoch()
```
    Description copied from interface: Star
    
    Returns the epoch of the position coordinate system as a float.
    
    Specified by:
    
    getEpoch in interface Star
  - setEquinox
```
public Object setEquinox(float eq)
```
    Sets the equinox of the position coordinate system.
  - getEquinox
```
public float getEquinox()
```
    Description copied from interface: Star
    
    Returns the equinox of the position coordinate system as a float.
    
    Specified by:
    
    getEquinox in interface Star
  - setMag
```
public Object setMag(float v)
```
    Sets the brightness of the star.
  - getMag
```
public float getMag()
```
    Description copied from interface: Star
    
    Returns the magnitude of the star as a float.
    
    Specified by:
    
    getMag in interface Star
  - setColor
```
public Object setColor(float bv)
```
    Sets the color of the star.
  - getColor
```
public float getColor()
```
    Description copied from interface: Star
    
    Returns the color of the star as a float.
    
    Specified by:
    
    getColor in interface Star
  - getSeparation
```
public double getSeparation(Star other)
```
    Returns the distance in degrees of this star description to the argument one. This method assumes the two stars to be in close vicinity.
  - getSeparation
```
public double getSeparation(double ra2,
                            double de2)
```
    Returns the distance in degrees of this star description to the argument one. This method assumes the two stars to be in close vicinity.
  - getSeparation
```
public static final double getSeparation(Star s1,
                                         Star s2)
```
    Returns the distance of two stars, in degrees. Does not check for equinox/epoch equality, this is assumed to be identical.
    
    Returns:
    
    The distance of the two stars in degrees.
  - getSeparation
```
public static final double getSeparation(Star s1,
                                         double ra2,
                                         double de2)
```
    Returns the distance of two stars, in degrees. Does not check for equinox/epoch equality, this is assumed to be identical.
    
    Returns:
    
    The distance of the two stars in degrees.
  - getSeparation
```
public static final double getSeparation(double ra1,
                                         double ra2,
                                         double de1,
                                         double de2)
```
    Returns the distance of two stars, in degrees. Does not check for equinox/epoch equality, this is assumed to be identical.
    
    Returns:
    
    The distance of the two positions in degrees.
  - equals
```
public boolean equals(Object other)
```
    Two stars are equal if they have the same name, or if their separation is zero.
    
    Overrides:
    
    equals in class Object
  - matches
```
public boolean matches(Star s2,
                       double maxdist,
                       float magoff)
```
    Tries to match two stars. This method returns true, if the separation between the stars is within the maximum distance and if their magnitudes match. Color is considered to be rather unreliable, therefore it is not matched. If either this stars or the target star has a non-defined magnitude, the magnitude comparison is supressed.
  - matches
```
public static boolean matches(Star s1,
                              Star s2,
                              double maxdist,
                              float magoff)
```
    Tries to match two stars. This method returns true, if the separation between the stars is within the maximum distance and if their magnitudes match. Color is considered to be rather unreliable, therefore it is not matched. If either this stars or the target star has a non-defined magnitude, the magnitude comparison is supressed.
  - toString
```
public String toString()
```
    Converts the star description name, ra, dec, mag and color into a string. String starinfo = (guide.getName() == null ? "N/N":guide.getName())+ " (RA: "+Convert.getSexagesimal(guide.getRa()/15.,":",":","",1)+ " DE: " +Convert.getSexagesimal(guide.getDec(),":",":","",0)+")";
    
    Overrides:
    
    toString in class Object
  - sexagesimal
```
public String sexagesimal()
```
  - sexagesimal
```
public String sexagesimal(int raprec,
                          int deprec)
```
  - sexagesimal
```
public static String sexagesimal(Star s)
```
  - sexagesimal
```
public static String sexagesimal(Star s,
                                 int raprec,
                                 int deprec)
```
  - raDeString
```
public String raDeString()
```
  - raDeString
```
public String raDeString(int raprec,
                         int deprec)
```
  - raDeString
```
public static String raDeString(Star onto)
```
  - raDeString
```
public static String raDeString(Star s,
                                int raprec,
                                int deprec)
```
  - toBasicString
```
public String toBasicString()
```
    Returns sexagesimal RA in hours and DE, appends mag if valid.
    
    Returns:
    
    S hort string with position and possibly mag.
  - toBasicString
```
public static String toBasicString(Star s)
```
    Returns sexagesimal RA in hours and DE, appends mag if valid.
    
    Returns:
    
    S hort string with position and possibly mag.
  - toDegreeString
```
public String toDegreeString()
```
    Returns decimal RA in degrees and DE.
    
    Returns:
    
    Short string with position.
  - toDegreeString
```
public static String toDegreeString(Star s)
```
    Returns decimal RA in degrees and DE.
    
    Returns:
    
    Short string with position.
  - isSexagesimal
```
public static boolean isSexagesimal(String dm)
```
    We try to infer if a specified string is in sexagesimal format, which we define by twice occurance of ':'.
  - parseSexagesimal
```
public static double parseSexagesimal(String dm)
```
    We convert a string given as dd:mm:ss.sss into a normal double.
  - isMarginallyValid
```
public boolean isMarginallyValid()
```
    Description copied from interface: Star
    
    Checks if at least the right ascension and the declination is valid.
    
    Specified by:
    
    isMarginallyValid in interface Star
  - isValid
```
public boolean isValid()
```
    Description copied from interface: Star
    
    Checks if ra, de, and mag of the star is defined.
    
    Specified by:
    
    isValid in interface Star
  - isVeryValid
```
public boolean isVeryValid()
```
    Description copied from interface: Star
    
    Checks if ra, de, mag, and color is defined.
    
    Specified by:
    
    isVeryValid in interface Star
  - isFullyValid
```
public boolean isFullyValid()
```
    Description copied from interface: Star
    
    Checks if ra, de, mag, color, pmra, and pmde are defined.
    
    Specified by:
    
    isFullyValid in interface Star
  - fillMissing
```
public static SimpleStar fillMissing(Star main,
                                     Star fill)
```
    Adds all data that is missing from the first star entry, but present in the second into the first and returns it.
  - exportNameMap
```
public static Map<String,Star> exportNameMap(List<Star> l)
```
    Exports a list of stas as a mapping of star names to stars. Null-names are ignored.
  - exportIdMap
```
public static Map<Integer,Star> exportIdMap(List<Star> l)
```
    Exports a list of stas as a mapping of star names to stars. Null-id are overwritn in -1
  - getMagComparator
```
public static SimpleStar.StarComparator getMagComparator()
```
    Convenience method.
    
    Returns:

Class SimpleStar

Nested Class Summary

Field Summary

Fields inherited from interface astro.Star

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFDECPRECISSION

DEFRAPRECISSION

serialVersionUID

UNKNOWN

HTM

SKYMAG

DEFPROPRA

DEFPROPDEC

DEFCOLOR

DEFID

SOLNAME

name

id

ra

de

mag

color

epoch

equinox

pmra

pmde

addon

SOL

Constructor Detail

SimpleStar

SimpleStar

SimpleStar

SimpleStar

SimpleStar

SimpleStar

SimpleStar

Method Detail

get

getProperty

setProperty

set

setName

getName

setID

getID

getHtmName

getHtmName

setRa

getRa

setDe

getDe

setPropRa

getPropRa

setPropDe

getPropDe

setEpoch

getEpoch

setEquinox

getEquinox

setMag

getMag

setColor

getColor

getSeparation

getSeparation

getSeparation

getSeparation

getSeparation

equals

matches

matches

toString

sexagesimal

sexagesimal

sexagesimal

sexagesimal

raDeString