net.aerith.misao.catalog.star
Class MsxStar

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

public class MsxStar
extends CatalogStar

The MsxStar represents a star data in the MSX Infrared Astrometric Catalog.


Field Summary
protected  float flux_A
          The flux in band A.
protected  float flux_B1
          The flux in band B1.
protected  float flux_B2
          The flux in band B2.
protected  float flux_C
          The flux in band C.
protected  float flux_D
          The flux in band D.
protected  float flux_E
          The flux in band E.
protected  int number
          The number.
protected  Coor pm
          The proper motion in sec/year and arcsec/year.
protected  Coor pm_error
          The proper motion error in mas/year.
protected  Coor position_error
          The position error in sec and arcsec.
protected  byte[] spectrum
          The spectral type.
 
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
MsxStar()
          Constructs an empty MsxStar.
MsxStar(int number, Coor coor, float error_ra, float error_decl, double pm_ra, double pm_decl, float pm_error_ra, float pm_error_decl, float v_mag, java.lang.String spectrum)
          Constructs an MsxStar with data read from the catalog file.
 
Method Summary
protected static java.lang.String formatFlux(float flux)
          Formats the flux.
 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.util.Vector getHierarchicalFolders()
          Gets the list of the hierarchical folders.
 KeyAndValue[] getKeyAndValues()
          Gets an array of keys and values to output.
 java.lang.String getName()
          Gets the name of this star.
 java.lang.String getStarFolder()
          Gets the folder string of the star.
 java.lang.String getVsnetName()
          Gets the name of this star in a format for the VSNET (Variable Star Network).
 void setFlux(float flux_A, float flux_B1, float flux_B2, float flux_C, float flux_D, float flux_E)
          Sets the flux.
 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.
 
Methods inherited from class net.aerith.misao.util.star.CatalogStar
getAvailableMagnitudeSystems, getBMagnitude, getBVDifference, getCatalogNamesWithMagnitudeSystem, getCatalogNameWithMagnitudeSystem, getCoorString, getCoorStringWithoutUnit, getDate, getHelpMessage, getIcMagnitude, getKeyAndValuesForPhotometry, getMagnitude, getMagnitude, getMagnitudeString, getMagnitudeSystem, getMaximumPositionErrorInArcsec, getPhotometryHelpMessage, getPositionErrorInArcsec, getRcMagnitude, getUMagnitude, getVMagnitude, isDescriptionEdittable, reduceOutput, setCoorAccuracy, supportsAstrometry, supportsMagnitude, supportsPhotometry
 
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 number.

position_error

protected Coor position_error
The position error in sec and arcsec.

pm

protected Coor pm
The proper motion in sec/year and arcsec/year.

pm_error

protected Coor pm_error
The proper motion error in mas/year.

flux_A

protected float flux_A
The flux in band A.

flux_B1

protected float flux_B1
The flux in band B1.

flux_B2

protected float flux_B2
The flux in band B2.

flux_C

protected float flux_C
The flux in band C.

flux_D

protected float flux_D
The flux in band D.

flux_E

protected float flux_E
The flux in band E.

spectrum

protected byte[] spectrum
The spectral type.
Constructor Detail

MsxStar

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

MsxStar

public MsxStar(int number,
               Coor coor,
               float error_ra,
               float error_decl,
               double pm_ra,
               double pm_decl,
               float pm_error_ra,
               float pm_error_decl,
               float v_mag,
               java.lang.String spectrum)
Constructs an MsxStar with data read from the catalog file.
Parameters:
number - the number.
coor - the R.A. and Decl.
error_ra - the R.A. error in sec.
error_decl - the Decl. error in arcsec.
pm_ra - the proper motion in R.A. in sec/year.
pm_decl - the proper motion in Decl. in arcsec/year.
pm_error_ra - the proper motion error in R.A. in mas.
pm_error_decl - the proper motion error in Decl. in mas.
v_mag - the V magnitude.
spectrum - the spectral type.
Method Detail

getName

public java.lang.String getName()
Gets the name of this star. This method returns such a string as MSX IR 12345.
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 MSXIR12345.
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.

getDefaultProperty

public PlotProperty getDefaultProperty()
Gets the default property to plot stars.
Overrides:
getDefaultProperty in class CatalogStar
Returns:
the default property to plot stars.

setFlux

public void setFlux(float flux_A,
                    float flux_B1,
                    float flux_B2,
                    float flux_C,
                    float flux_D,
                    float flux_E)
Sets the flux.
Parameters:
flux_A - the flux in band A.
flux_B1 - the flux in band B1.
flux_B2 - the flux in band B2.
flux_C - the flux in band C.
flux_D - the flux in band D.
flux_E - the flux in band E.

formatFlux

protected static java.lang.String formatFlux(float flux)
Formats the flux.
Parameters:
flux - the flux.
Returns:
the formatted flux string.

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.