net.aerith.misao.catalog.star
Class TicStar

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

public class TicStar

extends CatalogStar

The TicStar represents a star data in the Tycho Input Catalogue.

Field Summary

protected short	area_number The area number.
protected float	b_mag The B magnitude.
protected short	star_number The star number in the area.
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

TicStar()
Constructs an empty TicStar.

TicStar(short area_number, short star_number, Coor coor)
Constructs a TicStar 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	setBMagnitude(double b_mag) Sets the 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	setVMagnitude(double v_mag) 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

area_number

protected short area_number

The area number.

star_number

protected short star_number

The star number in the area.

v_mag

protected float v_mag

The V magnitude.

b_mag

protected float b_mag

The B magnitude.

Constructor Detail

TicStar

public TicStar()

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

TicStar

public TicStar(short area_number,
               short star_number,
               Coor coor)

Constructs a TicStar with data read from the catalog file.

Parameters:

area_numer - the area number.

star_number - the star number in the area.

coor - the R.A. and Decl.

Method Detail

getName

public java.lang.String getName()

Gets the name of this star. This method returns such a string as GSC 01234-05678.

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 GSC1234.5678.

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)

Sets the V magnitude.

Parameters:

v_mag - the V magnitude.

setBMagnitude

public void setBMagnitude(double b_mag)

Sets the B magnitude.

Parameters:

b_mag - the B magnitude.

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.