net.aerith.misao.catalog.star
Class LoneosPhotometryStar

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

public class LoneosPhotometryStar
extends CatalogStar

The LoneosPhotometryStar represents a star data in the LONEOS Photometry File.


Field Summary
protected  int accuracy
          The accuracy of magnitude.
static int ACCURACY_1000TH
          The number of accuracy, which represents 0.001 mag.
static int ACCURACY_100TH
          The number of accuracy, which represents 0.01 mag.
protected  float b_v
          The B-V magnitude.
protected  byte coor_accuracy
          The accuracy of R.A.
protected  java.lang.String name
          The star name.
protected  float v_i
          The V-I magnitude.
protected  float v_r
          The V-R 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
LoneosPhotometryStar()
          Constructs an empty LoneosPhotometryStar.
LoneosPhotometryStar(java.lang.String name, java.lang.String coor_string, double v_mag, int accuracy)
          Constructs a LoneosPhotometryStar 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 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)
          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 setVIcDifference(double v_i)
          Sets the difference between the Ic and V magnitude.
 void setVRcDifference(double v_r)
          Sets the difference between the Rc and V magnitude.
 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
getCatalogAcronym, getCatalogNamesWithMagnitudeSystem, getCatalogNameWithMagnitudeSystem, getCoorString, getCoorStringWithoutUnit, getDate, getMagnitude, getMagnitudeSystem, getMaximumPositionErrorInArcsec, getPositionErrorInArcsec, getUMagnitude, isDescriptionEdittable, reduceOutput, setCoorAccuracy, supportsAstrometry
 
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

name

protected java.lang.String name
The star name.

coor_accuracy

protected byte coor_accuracy
The accuracy of R.A. and Decl.

b_v

protected float b_v
The B-V magnitude.

v_r

protected float v_r
The V-R magnitude.

v_i

protected float v_i
The V-I magnitude.

accuracy

protected int accuracy
The accuracy of magnitude.

ACCURACY_100TH

public static final int ACCURACY_100TH
The number of accuracy, which represents 0.01 mag.

ACCURACY_1000TH

public static final int ACCURACY_1000TH
The number of accuracy, which represents 0.001 mag.
Constructor Detail

LoneosPhotometryStar

public LoneosPhotometryStar()
Constructs an empty LoneosPhotometryStar. It is used in StarClass#newInstance to review the XML data.

LoneosPhotometryStar

public LoneosPhotometryStar(java.lang.String name,
                            java.lang.String coor_string,
                            double v_mag,
                            int accuracy)
Constructs a LoneosPhotometryStar with data read from the catalog file.
Parameters:
name - the name.
coor_string - the string which represents R.A. and Decl.
v_mag - the V magnitude.
accuracy - the accuracy of magnitude.
Method Detail

getName

public java.lang.String getName()
Gets the name of this star. This method returns such a string as AB CD/123.J123456.7+123456.
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 AB_CD-123.J123456.7+123456.
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.

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.

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.

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.

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.

setVRcDifference

public void setVRcDifference(double v_r)
Sets the difference between the Rc and V magnitude.
Parameters:
v_r - the difference between the Rc and V magnitude.

setVIcDifference

public void setVIcDifference(double v_i)
Sets the difference between the Ic and V magnitude.
Parameters:
v_i - the difference between the Ic and V 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.

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.

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.