net.aerith.misao.catalog.star
Class HicStar

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.HicStar

public class HicStar

extends CatalogStar

The HicStar represents a star data in the Hipparcos Input Catalogue.

Field Summary

static byte	ACCURACY_1000TH The number of accuracy, which represents 0.001 mag.
static byte	ACCURACY_100TH The number of accuracy, which represents 0.01 mag.
static byte	ACCURACY_10TH The number of accuracy, which represents 0.1 mag.
protected float	b_v The B-V magnitude.
protected byte	bv_accuracy The accuracy of B-V magnitude.
protected byte	hp_accuracy The accuracy of Hp magnitude.
protected int	number The star number.
protected java.lang.Integer	parallax The parallax in milli-arcsec.
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 byte	v_accuracy The accuracy of V magnitude.
protected float	v_mag The V 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

HicStar()
Constructs an empty HicStar.

HicStar(int number, Coor coor, double hp_mag, byte hp_accuracy)
Constructs a HicStar 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	setBVDifference(double b_v, byte accuracy) Sets the difference between the V and B magnitude.
void	setKeyAndValue(KeyAndValue key_and_value) Sets the value of the specified key.
void	setName(java.lang.String name) Sets the name of this star.
void	setParallax(int parallax) Sets the parallax in milli-arcsec.
void	setProperMotionInDecl(double prop) Sets the proper motion in Decl.
void	setProperMotionInRA(double prop) Sets the proper motion in R.A.
void	setSpectrum(java.lang.String spectrum) Sets the spectrum.
void	setVMagnitude(double v_mag, byte accuracy) Sets the V 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 star number.

v_mag

protected float v_mag

The V magnitude.

b_v

protected float b_v

The B-V magnitude.

hp_accuracy

protected byte hp_accuracy

The accuracy of Hp magnitude.

v_accuracy

protected byte v_accuracy

The accuracy of V magnitude.

bv_accuracy

protected byte bv_accuracy

The accuracy of B-V magnitude.

spectrum

protected java.lang.String spectrum

The spectrum.

prop_ra

protected java.lang.Float prop_ra

The proper motion in R.A. ("/yr).

prop_decl

protected java.lang.Float prop_decl

The proper motion in Decl. ("/yr).

parallax

protected java.lang.Integer parallax

The parallax in milli-arcsec.

ACCURACY_10TH

public static final byte ACCURACY_10TH

The number of accuracy, which represents 0.1 mag.

ACCURACY_100TH

public static final byte ACCURACY_100TH

The number of accuracy, which represents 0.01 mag.

ACCURACY_1000TH

public static final byte ACCURACY_1000TH

The number of accuracy, which represents 0.001 mag.

Constructor Detail

HicStar

public HicStar()

Constructs an empty HicStar. It is used in StarClass#newInstance to review the XML data.

HicStar

public HicStar(int number,
               Coor coor,
               double hp_mag,
               byte hp_accuracy)

Constructs a HicStar with data read from the catalog file.

Parameters:

number - the number.

coor - the R.A. and Decl.

hp_mag - the Hp magnitude.

hp_accuracy - the accuracy of Hp magnitude.

Method Detail

getName

public java.lang.String getName()

Gets the name of this star. This method returns such a string as HIC 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 HIC1234.

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.

setVMagnitude

public void setVMagnitude(double v_mag,
                          byte accuracy)

Sets the V magnitude.

Parameters:

v_mag - the V magnitude.

accuracy - the accuracy of V magnitude.

setBVDifference

public void setBVDifference(double b_v,
                            byte accuracy)

Sets the difference between the V and B magnitude.

Parameters:

b_v - the difference between the V and B magnitude.

accuracy - the accuracy of V magnitude.

setSpectrum

public void setSpectrum(java.lang.String spectrum)

Sets the spectrum.

Parameters:

spectrum - the spectrum.

setProperMotionInRA

public void setProperMotionInRA(double prop)

Sets the proper motion in R.A. ("/yr).

Parameters:

prop - the proper motion in R.A. ("/yr).

setProperMotionInDecl

public void setProperMotionInDecl(double prop)

Sets the proper motion in Decl. ("/yr).

Parameters:

prop - the proper motion in Decl. ("/yr).

setParallax

public void setParallax(int parallax)

Sets the parallax in milli-arcsec.

Parameters:

parallax - the parallax in milli-arcsec.

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.