net.aerith.misao.catalog.star
Class Msx5cStar

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

public class Msx5cStar
extends CatalogStar

The Msx5cStar represents a star data in the MSX5C Infrared Point Source Catalog.


Field Summary
protected  float error_cross_scan
          The cross-scan position error in arcsec.
protected  float error_in_scan
          The in-scan position error in arcsec.
protected  float flux_A
          The flux in band A.
protected  boolean flux_A_var
          The flux variability in band A.
protected  float flux_B1
          The flux in band B1.
protected  boolean flux_B1_var
          The flux variability in band B1.
protected  float flux_B2
          The flux in band B2.
protected  boolean flux_B2_var
          The flux variability in band B2.
protected  float flux_C
          The flux in band C.
protected  boolean flux_C_var
          The flux variability in band C.
protected  float flux_D
          The flux in band D.
protected  boolean flux_D_var
          The flux variability in band D.
protected  float flux_E
          The flux in band E.
protected  boolean flux_E_var
          The flux variability in band E.
protected  java.lang.String name
          The name.
 
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
Msx5cStar()
          Constructs an empty Msx5cStar.
Msx5cStar(java.lang.String name, Coor coor, float error_in_scan, float error_cross_scan)
          Constructs an Msx5cStar with data read from the catalog file.
 
Method Summary
protected static java.lang.String formatFlux(float flux, boolean var)
          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.
 double getMaximumPositionErrorInArcsec()
          Gets the maximum error of position in arcsec.
 java.lang.String getName()
          Gets the name of this star.
 double getPositionErrorInArcsec()
          Gets the mean error of position in arcsec.
 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 setFluxA(float flux, boolean var)
          Sets the flux in band A.
 void setFluxB1(float flux, boolean var)
          Sets the flux in band B1.
 void setFluxB2(float flux, boolean var)
          Sets the flux in band .
 void setFluxC(float flux, boolean var)
          Sets the flux in band C.
 void setFluxD(float flux, boolean var)
          Sets the flux in band D.
 void setFluxE(float flux, boolean var)
          Sets the flux in band E.
 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, getPhotometryHelpMessage, 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

name

protected java.lang.String name
The name.

error_in_scan

protected float error_in_scan
The in-scan position error in arcsec.

error_cross_scan

protected float error_cross_scan
The cross-scan position error in arcsec.

flux_A

protected float flux_A
The flux in band A.

flux_A_var

protected boolean flux_A_var
The flux variability in band A.

flux_B1

protected float flux_B1
The flux in band B1.

flux_B1_var

protected boolean flux_B1_var
The flux variability in band B1.

flux_B2

protected float flux_B2
The flux in band B2.

flux_B2_var

protected boolean flux_B2_var
The flux variability in band B2.

flux_C

protected float flux_C
The flux in band C.

flux_C_var

protected boolean flux_C_var
The flux variability in band C.

flux_D

protected float flux_D
The flux in band D.

flux_D_var

protected boolean flux_D_var
The flux variability in band D.

flux_E

protected float flux_E
The flux in band E.

flux_E_var

protected boolean flux_E_var
The flux variability in band E.
Constructor Detail

Msx5cStar

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

Msx5cStar

public Msx5cStar(java.lang.String name,
                 Coor coor,
                 float error_in_scan,
                 float error_cross_scan)
Constructs an Msx5cStar with data read from the catalog file.
Parameters:
name - the name.
coor - the R.A. and Decl.
error_in_scan - the in-scan position error in arcsec.
error_cross_scan - the cross-scan position error in arcsec.
Method Detail

getName

public java.lang.String getName()
Gets the name of this star. This method returns such a string as MSX5C G123.4567+12.3456.
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 MSX5C_G123.4567+12.3456.
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.

getPositionErrorInArcsec

public double getPositionErrorInArcsec()
Gets the mean error of position in arcsec.
Overrides:
getPositionErrorInArcsec in class CatalogStar
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.
Overrides:
getMaximumPositionErrorInArcsec in class CatalogStar
Returns:
the maximum error of position in arcsec.

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.

setFluxA

public void setFluxA(float flux,
                     boolean var)
Sets the flux in band A.
Parameters:
flux - the flux.
var - true if variable.

setFluxB1

public void setFluxB1(float flux,
                      boolean var)
Sets the flux in band B1.
Parameters:
flux - the flux.
var - true if variable.

setFluxB2

public void setFluxB2(float flux,
                      boolean var)
Sets the flux in band .
Parameters:
flux - the flux.
var - true if variable.

setFluxC

public void setFluxC(float flux,
                     boolean var)
Sets the flux in band C.
Parameters:
flux - the flux.
var - true if variable.

setFluxD

public void setFluxD(float flux,
                     boolean var)
Sets the flux in band D.
Parameters:
flux - the flux.
var - true if variable.

setFluxE

public void setFluxE(float flux,
                     boolean var)
Sets the flux in band E.
Parameters:
flux - the flux.
var - true if variable.

formatFlux

protected static java.lang.String formatFlux(float flux,
                                             boolean var)
Formats the flux.
Parameters:
flux - the flux.
var - true if variable.
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.