net.aerith.misao.catalog.star
Class HipparcosStar

java.lang.Object
  |
  +--net.aerith.misao.util.Position
        |
        +--net.aerith.misao.util.star.StarPosition
              |
              +--net.aerith.misao.util.star.Star
                    |
                    +--net.aerith.misao.util.star.CatalogStar
                          |
                          +--net.aerith.misao.catalog.star.HipparcosStar

public class HipparcosStar
extends CatalogStar

The HipparcosStar represents a star data in the Hipparcos Catalogue.


Field Summary
protected  float b_v
          The B-V magnitude.
protected  float bt_mag
          The BT magnitude.
protected  float err_bt
          The error of BT magnitude.
protected  float err_bv
          The error of B-V magnitude.
protected  float err_decl
          The error of Decl.
protected  float err_hp
          The error of Hp magnitude.
protected  float err_parallax
          The error of parallax in milli-arcsec.
protected  float err_prop_decl
          The error of proper motion in Decl.
protected  float err_prop_ra
          The error of proper motion in R.A.
protected  float err_ra
          The error of R.A.
protected  float err_vi
          The error of V-I magnitude.
protected  float err_vt
          The error of VT magnitude.
protected  float hp_mag
          The Hp magnitude.
protected  float mag_max
          The maximum magnitude.
protected  float mag_min
          The minimum magnitude.
protected  int number
          The number.
protected  java.lang.Float parallax
          The parallax in milli-arcsec.
protected  java.lang.Float period
          The period.
protected  java.lang.Float prop_decl
          The proper motion in Decl.
protected  java.lang.Float prop_ra
          The proper motion in R.A.
protected  java.lang.String spectrum
          The spectrum.
protected  float v_i
          The V-I magnitude.
protected  float v_mag
          The V magnitude.
protected  float vt_mag
          The VT magnitude.
 
Fields inherited from class net.aerith.misao.util.star.CatalogStar
detailed_output
 
Fields inherited from class net.aerith.misao.util.star.Star
color, container_pair, coor
 
Fields inherited from class net.aerith.misao.util.star.StarPosition
mag
 
Fields inherited from class net.aerith.misao.util.Position
x, y
 
Constructor Summary
HipparcosStar()
          Constructs an empty HipparcosStar.
HipparcosStar(int number, Coor coor)
          Constructs a HipparcosStar with data read from the catalog file.
 
Method Summary
 java.lang.String[] getAvailableMagnitudeSystems()
          Gets the list of magnitude systems supported by this catalog.
 double getBMagnitude()
          Gets the B magnitude.
 double getBVDifference()
          Gets the difference between the V and B magnitude.
 java.lang.String getCatalogAcronym()
          Gets the acronym of the catalog.
 java.lang.String getCatalogCategory()
          Gets the category of the catalog.
 java.lang.String getCatalogCode()
          Gets the code of the catalog.
 java.lang.String getCatalogFolderCode()
          Gets the folder string of the catalog.
 java.lang.String getCatalogName()
          Gets the name of the catalog.
 byte getCoorAccuracy()
          Gets the accuracy of R.A.
 PlotProperty getDefaultProperty()
          Gets the default property to plot stars.
 java.lang.String getHelpMessage(java.lang.String name)
          Gets the html help message of the specified name with magnitude system for simple magnitude comparison.
 java.util.Vector getHierarchicalFolders()
          Gets the list of the hierarchical folders.
 double getIcMagnitude()
          Gets the Ic magnitude.
 KeyAndValue[] getKeyAndValues()
          Gets an array of keys and values to output.
 KeyAndValue[] getKeyAndValuesForPhotometry()
          Gets an array of keys and values related to the photometry.
 double getMagnitude(java.lang.String system)
          Gets the magnitude of the specified system.
 java.lang.String getMagnitudeString(java.lang.String system)
          Gets the magnitude string of the specified system to output.
 java.lang.String getName()
          Gets the name of this star.
 java.lang.String getPhotometryHelpMessage()
          Gets the html help message for regular photometry.
 double getRcMagnitude()
          Gets the Rc magnitude.
 java.lang.String getStarFolder()
          Gets the folder string of the star.
 double getVMagnitude()
          Gets the V magnitude.
 java.lang.String getVsnetName()
          Gets the name of this star in a format for the VSNET (Variable Star Network).
 void setBtMagnitude(double mag)
          Sets the BT magnitude.
 void setBtMagnitudeError(double err)
          Sets the error of BT magnitude.
 void setBVDifference(double b_v)
          Sets the B-V magnitude.
 void setBVDifferenceError(double err)
          Sets the error of B-V magnitude.
 void setDeclError(double err)
          Sets the error of Decl.
 void setHpMagnitude(double mag)
          Sets the Hp magnitude.
 void setHpMagnitudeError(double err)
          Sets the error of Hp magnitude.
 void setKeyAndValue(KeyAndValue key_and_value)
          Sets the value of the specified key.
 void setMagMax(double mag)
          Sets the maximum magnitude.
 void setMagMin(double mag)
          Sets the minimum magnitude.
 void setName(java.lang.String name)
          Sets the name of this star.
 void setParallax(double parallax)
          Sets the parallax in milli-arcsec.
 void setParallaxError(double err)
          Sets the error of parallax in milli-arcsec.
 void setPeriod(double period)
          Sets the period.
 void setProperMotionInDecl(double prop)
          Sets the proper motion in Decl.
 void setProperMotionInDeclError(double err)
          Sets the error of proper motion in Decl.
 void setProperMotionInRA(double prop)
          Sets the proper motion in R.A.
 void setProperMotionInRAError(double err)
          Sets the error of proper motion in R.A.
 void setRAError(double err)
          Sets the error of R.A.
 void setSpectrum(java.lang.String spectrum)
          Sets the spectrum.
 void setVIDifference(double v_i)
          Sets the V-I magnitude.
 void setVIDifferenceError(double err)
          Sets the error of V-I magnitude.
 void setVMagnitude(double mag)
          Sets the V magnitude.
 void setVtMagnitude(double mag)
          Sets the VT magnitude.
 void setVtMagnitudeError(double err)
          Sets the error of VT magnitude.
 boolean supportsAstrometry()
          Returns true if the catalog contains accurate R.A.
 boolean supportsMagnitude()
          Returns true if the catalog contains magnitude data.
 boolean supportsPhotometry()
          Returns true if the catalog contains magnitude data enough for photometry.
 
Methods inherited from class net.aerith.misao.util.star.CatalogStar
getCatalogNamesWithMagnitudeSystem, getCatalogNameWithMagnitudeSystem, getCoorString, getCoorStringWithoutUnit, getDate, getMagnitude, getMagnitudeSystem, getMaximumPositionErrorInArcsec, getPositionErrorInArcsec, getUMagnitude, isDescriptionEdittable, reduceOutput, setCoorAccuracy
 
Methods inherited from class net.aerith.misao.util.star.Star
equals, getColor, getCoor, getDecl, getItemDelimiter, getKeyAndValueDelimiter, getOutputString, getOutputStringsWithXY, getOutputStringWithoutName, getOutputStringWithXY, getPair, getPositionString, getPxfString, getPxfStringsWithXY, getPxfStringWithXY, getRA, mapCoordinatesToXY, mapCoordinatesToXY, mapXYToCoordinates, mapXYToCoordinates, setColor, setCoor, setPair
 
Methods inherited from class net.aerith.misao.util.star.StarPosition
getMag, getOutputStrings, paramString, setMag, toString
 
Methods inherited from class net.aerith.misao.util.Position
add, getDistanceFrom, getPositionAngleTo, getX, getY, rescale, setPosition, setX, setY
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

number

protected int number
The number.

v_mag

protected float v_mag
The V magnitude.

bt_mag

protected float bt_mag
The BT magnitude.

vt_mag

protected float vt_mag
The VT magnitude.

hp_mag

protected float hp_mag
The Hp magnitude.

b_v

protected float b_v
The B-V magnitude.

v_i

protected float v_i
The V-I magnitude.

mag_max

protected float mag_max
The maximum magnitude.

mag_min

protected float mag_min
The minimum magnitude.

period

protected java.lang.Float period
The period.

prop_ra

protected java.lang.Float prop_ra
The proper motion in R.A. (mas/yr).

prop_decl

protected java.lang.Float prop_decl
The proper motion in Decl. (mas/yr).

spectrum

protected java.lang.String spectrum
The spectrum.

parallax

protected java.lang.Float parallax
The parallax in milli-arcsec.

err_ra

protected float err_ra
The error of R.A. in mas.

err_decl

protected float err_decl
The error of Decl. in mas.

err_bt

protected float err_bt
The error of BT magnitude.

err_vt

protected float err_vt
The error of VT magnitude.

err_hp

protected float err_hp
The error of Hp magnitude.

err_bv

protected float err_bv
The error of B-V magnitude.

err_vi

protected float err_vi
The error of V-I magnitude.

err_prop_ra

protected float err_prop_ra
The error of proper motion in R.A. (mas/yr).

err_prop_decl

protected float err_prop_decl
The error of proper motion in Decl. (mas/yr).

err_parallax

protected float err_parallax
The error of parallax in milli-arcsec.
Constructor Detail

HipparcosStar

public HipparcosStar()
Constructs an empty HipparcosStar. It is used in StarClass#newInstance to review the XML data.

HipparcosStar

public HipparcosStar(int number,
                     Coor coor)
Constructs a HipparcosStar with data read from the catalog file.
Parameters:
number - the number.
coor - the R.A. and Decl.
Method Detail

setVMagnitude

public void setVMagnitude(double mag)
Sets the V magnitude.
Parameters:
mag - the V magnitude.

setBtMagnitude

public void setBtMagnitude(double mag)
Sets the BT magnitude.
Parameters:
mag - the BT magnitude.

setVtMagnitude

public void setVtMagnitude(double mag)
Sets the VT magnitude.
Parameters:
mag - the VT magnitude.

setHpMagnitude

public void setHpMagnitude(double mag)
Sets the Hp magnitude.
Parameters:
mag - the Hp magnitude.

setBVDifference

public void setBVDifference(double b_v)
Sets the B-V magnitude.
Parameters:
b_v - the B-V magnitude.

setVIDifference

public void setVIDifference(double v_i)
Sets the V-I magnitude.
Parameters:
v_i - the V-I magnitude.

setMagMax

public void setMagMax(double mag)
Sets the maximum magnitude.
Parameters:
mag - the maximum magnitude.

setMagMin

public void setMagMin(double mag)
Sets the minimum magnitude.
Parameters:
mag - the minimum magnitude.

setPeriod

public void setPeriod(double period)
Sets the period.
Parameters:
period - the period.

setProperMotionInRA

public void setProperMotionInRA(double prop)
Sets the proper motion in R.A. (mas/yr).
Parameters:
prop - the proper motion in R.A. (mas/yr).

setProperMotionInDecl

public void setProperMotionInDecl(double prop)
Sets the proper motion in Decl. (mas/yr).
Parameters:
prop - the proper motion in Decl. (mas/yr).

setSpectrum

public void setSpectrum(java.lang.String spectrum)
Sets the spectrum.
Parameters:
spectrum - the spectrum.

setParallax

public void setParallax(double parallax)
Sets the parallax in milli-arcsec.
Parameters:
parallax - the parallax in milli-arcsec.

setRAError

public void setRAError(double err)
Sets the error of R.A. in mas.
Parameters:
err - the error of R.A. in mas.

setDeclError

public void setDeclError(double err)
Sets the error of Decl. in mas.
Parameters:
err - the error of Decl. in mas.

setBtMagnitudeError

public void setBtMagnitudeError(double err)
Sets the error of BT magnitude.
Parameters:
err - the error of BT magnitude.

setVtMagnitudeError

public void setVtMagnitudeError(double err)
Sets the error of VT magnitude.
Parameters:
err - the error of VT magnitude.

setHpMagnitudeError

public void setHpMagnitudeError(double err)
Sets the error of Hp magnitude.
Parameters:
err - the error of Hp magnitude.

setBVDifferenceError

public void setBVDifferenceError(double err)
Sets the error of B-V magnitude.
Parameters:
err - the error of B-V magnitude.

setVIDifferenceError

public void setVIDifferenceError(double err)
Sets the error of V-I magnitude.
Parameters:
err - the error of V-I magnitude.

setProperMotionInRAError

public void setProperMotionInRAError(double err)
Sets the error of proper motion in R.A. (mas/yr).
Parameters:
err - the error of proper motion in R.A. (mas/yr).

setProperMotionInDeclError

public void setProperMotionInDeclError(double err)
Sets the error of proper motion in Decl. (mas/yr).
Parameters:
err - the error of proper motion in Decl. (mas/yr).

setParallaxError

public void setParallaxError(double err)
Sets the error of parallax in milli-arcsec.
Parameters:
err - the error of parallax in milli-arcsec.

getName

public java.lang.String getName()
Gets the name of this star. This method returns such a string as HIP 1234.
Overrides:
getName in class Star
Returns:
the name of this star.

getVsnetName

public java.lang.String getVsnetName()
Gets the name of this star in a format for the VSNET (Variable Star Network). This method returns such a string as HIP1234.
Overrides:
getVsnetName in class Star
Returns:
the name of this star.

setName

public void setName(java.lang.String name)
Sets the name of this star.
Overrides:
setName in class CatalogStar
Parameters:
name - the name to set.

getCatalogName

public java.lang.String getCatalogName()
Gets the name of the catalog. It must be unique among all subclasses.
Overrides:
getCatalogName in class CatalogStar
Returns:
the name of the catalog.

getCatalogAcronym

public java.lang.String getCatalogAcronym()
Gets the acronym of the catalog.
Overrides:
getCatalogAcronym in class CatalogStar
Returns:
the acronym of the catalog.

getCatalogCode

public java.lang.String getCatalogCode()
Gets the code of the catalog. It must be unique among all subclasses.
Overrides:
getCatalogCode in class CatalogStar
Returns:
the code of the catalog.

getCatalogFolderCode

public java.lang.String getCatalogFolderCode()
Gets the folder string of the catalog. It must be unique among all subclasses.
Overrides:
getCatalogFolderCode in class CatalogStar
Returns:
the folder string of the catalog.

getCatalogCategory

public java.lang.String getCatalogCategory()
Gets the category of the catalog.
Overrides:
getCatalogCategory in class CatalogStar
Returns:
the category of the catalog.

getHierarchicalFolders

public java.util.Vector getHierarchicalFolders()
Gets the list of the hierarchical folders.
Overrides:
getHierarchicalFolders in class CatalogStar
Returns:
the list of the hierarchical folders.

getStarFolder

public java.lang.String getStarFolder()
Gets the folder string of the star.
Overrides:
getStarFolder in class CatalogStar
Returns:
the folder string of the star.

getCoorAccuracy

public byte getCoorAccuracy()
Gets the accuracy of R.A. and Decl.
Overrides:
getCoorAccuracy in class CatalogStar
Returns:
the accuracy of R.A. and Decl.

supportsMagnitude

public boolean supportsMagnitude()
Returns true if the catalog contains magnitude data.
Overrides:
supportsMagnitude in class CatalogStar
Returns:
true if the catalog contains magnitude data.

supportsPhotometry

public boolean supportsPhotometry()
Returns true if the catalog contains magnitude data enough for photometry.
Overrides:
supportsPhotometry in class CatalogStar
Returns:
true if the catalog contains magnitude data enough for photometry.

supportsAstrometry

public boolean supportsAstrometry()
Returns true if the catalog contains accurate R.A. and Decl. enough for astrometry.
Overrides:
supportsAstrometry in class CatalogStar
Returns:
true if the catalog contains accurate R.A. and Decl. enough for astrometry.

getVMagnitude

public double getVMagnitude()
                     throws UnsupportedMagnitudeSystemException
Gets the V magnitude.
Overrides:
getVMagnitude in class CatalogStar
Returns:
the V magnitude.
Throws:
UnsupportedMagnitudeSystemException - if no V mag data is recorded in this catalog.

getBMagnitude

public double getBMagnitude()
                     throws UnsupportedMagnitudeSystemException
Gets the B magnitude.
Overrides:
getBMagnitude in class CatalogStar
Returns:
the B magnitude.
Throws:
UnsupportedMagnitudeSystemException - if no B mag data is recorded in this catalog.

getRcMagnitude

public double getRcMagnitude()
                      throws UnsupportedMagnitudeSystemException
Gets the Rc magnitude.
Overrides:
getRcMagnitude in class CatalogStar
Returns:
the Rc magnitude.
Throws:
UnsupportedMagnitudeSystemException - if no Rc mag data is recorded in this catalog.

getIcMagnitude

public double getIcMagnitude()
                      throws UnsupportedMagnitudeSystemException
Gets the Ic magnitude.
Overrides:
getIcMagnitude in class CatalogStar
Returns:
the Ic magnitude.
Throws:
UnsupportedMagnitudeSystemException - if no Rc mag data is recorded in this catalog.

getBVDifference

public double getBVDifference()
                       throws UnsupportedMagnitudeSystemException
Gets the difference between the V and B magnitude.
Overrides:
getBVDifference in class CatalogStar
Returns:
the difference between the V and B magnitude.
Throws:
UnsupportedMagnitudeSystemException - if no V mag or B mag data is recorded in this catalog.

getAvailableMagnitudeSystems

public java.lang.String[] getAvailableMagnitudeSystems()
Gets the list of magnitude systems supported by this catalog.
Overrides:
getAvailableMagnitudeSystems in class CatalogStar
Returns:
the list of magnitude systems supported by this catalog.

getMagnitude

public double getMagnitude(java.lang.String system)
                    throws UnsupportedMagnitudeSystemException
Gets the magnitude of the specified system.
Overrides:
getMagnitude in class CatalogStar
Parameters:
system - the magnitude system.
Returns:
the magnitude of the specified system.
Throws:
UnsupportedMagnitudeSystemException - if the specified magnitude system is not supported.

getMagnitudeString

public java.lang.String getMagnitudeString(java.lang.String system)
                                    throws UnsupportedMagnitudeSystemException
Gets the magnitude string of the specified system to output.
Overrides:
getMagnitudeString in class CatalogStar
Parameters:
system - the magnitude system.
Returns:
the magnitude string of the specified system.
Throws:
UnsupportedMagnitudeSystemException - if the specified magnitude system is not supported.

getPhotometryHelpMessage

public java.lang.String getPhotometryHelpMessage()
Gets the html help message for regular photometry.
Overrides:
getPhotometryHelpMessage in class CatalogStar
Returns:
the html help message for regular photometry.

getHelpMessage

public java.lang.String getHelpMessage(java.lang.String name)
Gets the html help message of the specified name with magnitude system for simple magnitude comparison.
Overrides:
getHelpMessage in class CatalogStar
Parameters:
name - the catalog name with magnitude system.
Returns:
the html help message for simple magnitude comparison.

getDefaultProperty

public PlotProperty getDefaultProperty()
Gets the default property to plot stars.
Overrides:
getDefaultProperty in class CatalogStar
Returns:
the default property to plot stars.

getKeyAndValues

public KeyAndValue[] getKeyAndValues()
Gets an array of keys and values to output.
Overrides:
getKeyAndValues in class Star
Returns:
an array of keys and values to output.

setKeyAndValue

public void setKeyAndValue(KeyAndValue key_and_value)
Sets the value of the specified key.
Overrides:
setKeyAndValue in class Star
Parameters:
key_and_value - the key and value to set.

getKeyAndValuesForPhotometry

public KeyAndValue[] getKeyAndValuesForPhotometry()
Gets an array of keys and values related to the photometry.
Overrides:
getKeyAndValuesForPhotometry in class CatalogStar
Returns:
an array of keys and values related to the photometry.