net.aerith.misao.catalog.star
Class Tycho2Star

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

public class Tycho2Star

extends CatalogStar

The Tycho2Star represents a star data in the Tycho-2 Catalogue file.

Field Summary

protected float	bt_mag The BT magnitude.
protected float	epoch_decl The mean epoch of Decl.
protected float	epoch_ra The mean epoch of R.A.
protected float	err_bt The error of BT magnitude.
protected float	err_decl The error of Decl.
protected float	err_ra The error of R.A.
protected float	err_vt The error of VT magnitude.
protected java.lang.Float	prop_decl The proper motion in Decl.
protected java.lang.Float	prop_ra The proper motion in R.A.
protected short	tyc1 The TYC1 number.
protected short	tyc2 The TYC2 number.
protected short	tyc3 The TYC3 number.
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

Tycho2Star()
Constructs an empty Tycho2Star.

Tycho2Star(short tyc1, short tyc2, short tyc3, Coor coor)
Constructs a Tycho2Star 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	getBtMagnitudeError() Gets the error of BT 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).
double	getVtMagnitudeError() Gets the error of VT magnitude.
void	setBtMagnitude(double mag) Sets the BT magnitude.
void	setBtMagnitudeError(double err) Sets the error of BT magnitude.
void	setDeclError(double err) Sets the error of Decl.
void	setEpochInDecl(double epoch) Sets the mean epoch of Decl.
void	setEpochInRA(double epoch) Sets the mean epoch of R.A.
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	setProperMotionInDecl(double prop) Sets the proper motion in Decl.
void	setProperMotionInRA(double prop) Sets the proper motion in R.A.
void	setRAError(double err) Sets the error of R.A.
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

tyc1

protected short tyc1

The TYC1 number.

tyc2

protected short tyc2

The TYC2 number.

tyc3

protected short tyc3

The TYC3 number.

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

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.

epoch_ra

protected float epoch_ra

The mean epoch of R.A. in year.

epoch_decl

protected float epoch_decl

The mean epoch of Decl. in year.

bt_mag

protected float bt_mag

The BT magnitude.

vt_mag

protected float vt_mag

The VT magnitude.

err_bt

protected float err_bt

The error of BT magnitude.

err_vt

protected float err_vt

The error of VT magnitude.

Constructor Detail

Tycho2Star

public Tycho2Star()

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

Tycho2Star

public Tycho2Star(short tyc1,
                  short tyc2,
                  short tyc3,
                  Coor coor)

Constructs a Tycho2Star with data read from the catalog file.

Parameters:

tyc1 - the TYC1 number.

tyc2 - the TYC2 number.

tyc3 - the TYC3 number.

coor - the R.A. and Decl.

Method Detail

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

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.

setEpochInRA

public void setEpochInRA(double epoch)

Sets the mean epoch of R.A. in year.

Parameters:

epoch - the mean epoch of R.A. in year.

setEpochInDecl

public void setEpochInDecl(double epoch)

Sets the mean epoch of Decl. in year.

Parameters:

epoch - the mean epoch of Decl. in year.

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.

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.

getName

public java.lang.String getName()

Gets the name of this star. This method returns such a string as TYC 123-4567-1.

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 TYC123-4567-1.

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.

getBtMagnitudeError

public double getBtMagnitudeError()
                           throws UnsupportedMagnitudeSystemException

Gets the error of BT magnitude.

Returns:

the error of BT magnitude.

Throws:

UnsupportedMagnitudeSystemException - if no error of BT mag is recorded in this catalog.

getVtMagnitudeError

public double getVtMagnitudeError()
                           throws UnsupportedMagnitudeSystemException

Gets the error of VT magnitude.

Returns:

the error of VT magnitude.

Throws:

UnsupportedMagnitudeSystemException - if no error of VT mag 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.