net.aerith.misao.util.star
Class CatalogStar

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
Direct Known Subclasses:
Ac2000Star, Bsc5Star, DefaultStar, DefaultVariableStar, DetectedStar, Gsc11Star, GspcStar, HicStar, HipparcosStar, IcStar, IrasPscStar, LandoltStar, LoneosPhotometryStar, MinorPlanetCheckerStar, MpcFormatStar, Msx5cStar, MsxStar, NgcStar, SampleStar, SaoStar, StmStar, TargetStar, TicStar, Tycho2Star, TychoStar, Ucac1Star, UserStar, UsnoAStar

public abstract class CatalogStar
extends Star

The CatalogStar represents a star data in catalog. This is the base class of subclasses in net.aerith.misao.catalog.star package.


Field Summary
protected  boolean detailed_output
          True if this object contains all data required for detailed format.
 
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
CatalogStar()
           
 
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.
 java.lang.String[] getCatalogNamesWithMagnitudeSystem()
          Gets the list of catalog names with the supporting magnitude system.
 java.lang.String getCatalogNameWithMagnitudeSystem(java.lang.String system)
          Gets the catalog name with the specified magnitude system.
 byte getCoorAccuracy()
          Gets the accuracy of R.A.
 java.lang.String getCoorString()
          Gets a string representing the R.A.
 java.lang.String getCoorStringWithoutUnit()
          Gets a string representing the R.A.
 JulianDay getDate()
          Returns the date if the 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[] getKeyAndValuesForPhotometry()
          Gets an array of keys and values related to the photometry.
 double getMagnitude(MagnitudeSystem system)
          Gets the magnitude of the specified magnitude system.
 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 getMagnitudeSystem(java.lang.String catalog_name)
          Gets the magnitude system.
 double getMaximumPositionErrorInArcsec()
          Gets the maximum error of position in arcsec.
 java.lang.String getPhotometryHelpMessage()
          Gets the html help message for regular photometry.
 double getPositionErrorInArcsec()
          Gets the mean error of position in arcsec.
 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.
 boolean isDescriptionEdittable()
          Returns true if the catalog description of astrometry and photometry is edittable.
 void reduceOutput()
          Sets the flag to output only in reduced format.
 void setCoorAccuracy(byte accuracy)
          Sets the accuracy of R.A.
 void setName(java.lang.String name)
          Sets the name of this star.
 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.Star
equals, getColor, getCoor, getDecl, getItemDelimiter, getKeyAndValueDelimiter, getKeyAndValues, getName, getOutputString, getOutputStringsWithXY, getOutputStringWithoutName, getOutputStringWithXY, getPair, getPositionString, getPxfString, getPxfStringsWithXY, getPxfStringWithXY, getRA, getVsnetName, mapCoordinatesToXY, mapCoordinatesToXY, mapXYToCoordinates, mapXYToCoordinates, setColor, setCoor, setKeyAndValue, 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

detailed_output

protected boolean detailed_output
True if this object contains all data required for detailed format. If false, this can be output only in reduced format.
Constructor Detail

CatalogStar

public CatalogStar()
Method Detail

setName

public void setName(java.lang.String name)
Sets the name of this star.
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.
Returns:
the name of the catalog.

getCatalogAcronym

public java.lang.String getCatalogAcronym()
Gets the acronym of the catalog.
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.
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.
Returns:
the folder string of the catalog.

getCatalogCategory

public java.lang.String getCatalogCategory()
Gets the category of the catalog.
Returns:
the category of the catalog.

getHierarchicalFolders

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

getStarFolder

public java.lang.String getStarFolder()
Gets the folder string of the star. It must be unique among all subclasses.
Returns:
the folder string of the star.

reduceOutput

public void reduceOutput()
Sets the flag to output only in reduced format.

getPositionErrorInArcsec

public double getPositionErrorInArcsec()
Gets the mean error of position in arcsec.
Returns:
the mean error of position in arcsec.

getMaximumPositionErrorInArcsec

public double getMaximumPositionErrorInArcsec()
Gets the maximum error of position in arcsec. It is the search area size to identify with other stars.
Returns:
the maximum error of position in arcsec.

getCoorAccuracy

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

setCoorAccuracy

public void setCoorAccuracy(byte accuracy)
Sets the accuracy of R.A. and Decl. It must be overrided in the subclasses if the accuracy can be different from the default.
Parameters:
accuracy - the accuracy of R.A. and Decl.

getDate

public JulianDay getDate()
Returns the date if the R.A. and Decl. is date dependent. For example, in the case of astrometric observations in the MPC format. In general, it returns null.
Returns:
the date.

supportsMagnitude

public boolean supportsMagnitude()
Returns true if the catalog contains magnitude data.
Returns:
true if the catalog contains magnitude data.

supportsPhotometry

public boolean supportsPhotometry()
Returns true if the catalog contains magnitude data enough for photometry.
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.
Returns:
true if the catalog contains accurate R.A. and Decl. enough for astrometry.

isDescriptionEdittable

public boolean isDescriptionEdittable()
Returns true if the catalog description of astrometry and photometry is edittable. If not, the description is the catalog name.
Returns:
true if the catalog description of astrometry and photometry is edittable.

getVMagnitude

public double getVMagnitude()
                     throws UnsupportedMagnitudeSystemException
Gets the V magnitude.
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.
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.
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.
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.
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.
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.
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.
Parameters:
system - the magnitude system.
Returns:
the magnitude of the specified system.
Throws:
UnsupportedMagnitudeSystemException - if the specified magnitude system is not supported.

getMagnitude

public double getMagnitude(MagnitudeSystem system)
                    throws UnsupportedMagnitudeSystemException
Gets the magnitude of the specified magnitude system.
Parameters:
system - the magnitude system.
Returns:
the magnitude of the specified system.
Throws:
UnsupportedMagnitudeSystemException - if the magnitude system for the specified photometry setting 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.
Parameters:
system - the magnitude system.
Returns:
the magnitude string of the specified system.
Throws:
UnsupportedMagnitudeSystemException - if the specified magnitude system is not supported.

getCatalogNameWithMagnitudeSystem

public java.lang.String getCatalogNameWithMagnitudeSystem(java.lang.String system)
                                                   throws UnsupportedMagnitudeSystemException
Gets the catalog name with the specified magnitude system.
Parameters:
system - the magnitude system.
Returns:
the catalog name with the specified magnitude system.
Throws:
UnsupportedMagnitudeSystemException - if the specified magnitude system is not supported.

getCatalogNamesWithMagnitudeSystem

public java.lang.String[] getCatalogNamesWithMagnitudeSystem()
Gets the list of catalog names with the supporting magnitude system.
Returns:
the list of catalog names with the supporting magnitude system.

getMagnitudeSystem

public java.lang.String getMagnitudeSystem(java.lang.String catalog_name)
Gets the magnitude system.
Parameters:
catalog_name - the catalog name with magnitude system.
Returns:
the magnitude system.

getPhotometryHelpMessage

public java.lang.String getPhotometryHelpMessage()
Gets the html help message for regular photometry.
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.
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.
Returns:
the default property to plot stars.

getCoorString

public java.lang.String getCoorString()
Gets a string representing the R.A. and Decl. in a proper format and accuracy.
Overrides:
getCoorString in class Star
Returns:
the string representing R.A. and Decl.

getCoorStringWithoutUnit

public java.lang.String getCoorStringWithoutUnit()
Gets a string representing the R.A. and Decl. in a proper format and accuracy without unit.
Overrides:
getCoorStringWithoutUnit in class Star
Returns:
the string representing R.A. and Decl.

getKeyAndValuesForPhotometry

public KeyAndValue[] getKeyAndValuesForPhotometry()
Gets an array of keys and values related to the photometry. In principle, this method must be overrided in subclasses.
Returns:
an array of keys and values related to the photometry.