net.aerith.misao.catalog.star
Class Bsc5Star

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

public class Bsc5Star

extends CatalogStar

The Bsc5Star represents a star data in the Bright Star Catalogue, 5th Revised Ed.

Field Summary

protected float	b_v The B-V magnitude.
protected int	number The star number.
protected java.lang.Float	prop_decl The proper motion in Decl.
protected java.lang.Float	prop_ra The proper motion in R.A.
protected float	r_i The R-I magnitude.
protected java.lang.String	spectrum The spectrum.
protected float	u_b The U-B 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

Bsc5Star()
Constructs an empty Bsc5Star.

Bsc5Star(int number, Coor coor, double v_mag)
Constructs a Bsc5Star 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	getUMagnitude() Gets the U magnitude.
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) 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	setProperMotionInDecl(double prop) Sets the proper motion in Decl.
void	setProperMotionInRA(double prop) Sets the proper motion in R.A.
void	setRIDifference(double r_i) Sets the difference between the I and R magnitude.
void	setSpectrum(java.lang.String spectrum) Sets the spectrum.
void	setUBDifference(double u_b) Sets the difference between the B and U 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, 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.

b_v

protected float b_v

The B-V magnitude.

u_b

protected float u_b

The U-B magnitude.

r_i

protected float r_i

The R-I 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).

Constructor Detail

Bsc5Star

public Bsc5Star()

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

Bsc5Star

public Bsc5Star(int number,
                Coor coor,
                double v_mag)

Constructs a Bsc5Star with data read from the catalog file.

Parameters:

number - the number.

coor - the R.A. and Decl.

v_mag - the Johnson V magnitude.

Method Detail

getName

public java.lang.String getName()

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

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.

getUMagnitude

public double getUMagnitude()
                     throws UnsupportedMagnitudeSystemException

Gets the U magnitude.

Overrides:

getUMagnitude in class CatalogStar

Returns:

the U magnitude.

Throws:

UnsupportedMagnitudeSystemException - if no U 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.

setBVDifference

public void setBVDifference(double b_v)

Sets the difference between the V and B magnitude.

Parameters:

b_v - the difference between the V and B magnitude.

setUBDifference

public void setUBDifference(double u_b)

Sets the difference between the B and U magnitude.

Parameters:

u_b - the difference between the B and U magnitude.

setRIDifference

public void setRIDifference(double r_i)

Sets the difference between the I and R magnitude.

Parameters:

r_i - the difference between the I and R 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).

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.