net.aerith.misao.catalog.star
Class IrasPscStar

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.IrasPscStar
Direct Known Subclasses:
IrasFscStar

public class IrasPscStar
extends CatalogStar

The IrasPscStar represents a star data in the IRAS catalogue of Point Sources.


Field Summary
protected  short ellipse_major
          The uncertainty ellipse major axis.
protected  short ellipse_minor
          The uncertainty ellipse minor axis.
protected  short ellipse_pa
          The uncertainty ellipse position angle.
protected  float flux100
          The flux at 100 um.
protected  boolean flux100_limit
          True if the flux at 100 um is upper limit.
protected  float flux12
          The flux at 12 um.
protected  boolean flux12_limit
          True if the flux at 12 um is upper limit.
protected  float flux25
          The flux at 25 um.
protected  boolean flux25_limit
          True if the flux at 25 um is upper limit.
protected  float flux60
          The flux at 60 um.
protected  boolean flux60_limit
          True if the flux at 60 um is upper limit.
protected  byte[] number
          The number.
protected  byte variability
          The likelihood of variability.
 
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
IrasPscStar()
          Constructs an empty IrasPscStar.
IrasPscStar(java.lang.String number, Coor coor, short ellipse_major, short ellipse_minor, short ellipse_pa)
          Constructs an IrasPscStar with data read from the catalog file.
 
Method Summary
protected static java.lang.String formatFlux(float flux, boolean limit)
          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 setFlux100(float flux, boolean limit)
          Sets the flux at 100 um.
 void setFlux12(float flux, boolean limit)
          Sets the flux at 12 um.
 void setFlux25(float flux, boolean limit)
          Sets the flux at 25 um.
 void setFlux60(float flux, boolean limit)
          Sets the flux at 60 um.
 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 setVariability(int variability)
          Sets the variability.
 
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

number

protected byte[] number
The number.

ellipse_major

protected short ellipse_major
The uncertainty ellipse major axis.

ellipse_minor

protected short ellipse_minor
The uncertainty ellipse minor axis.

ellipse_pa

protected short ellipse_pa
The uncertainty ellipse position angle.

flux12

protected float flux12
The flux at 12 um.

flux25

protected float flux25
The flux at 25 um.

flux60

protected float flux60
The flux at 60 um.

flux100

protected float flux100
The flux at 100 um.

flux12_limit

protected boolean flux12_limit
True if the flux at 12 um is upper limit.

flux25_limit

protected boolean flux25_limit
True if the flux at 25 um is upper limit.

flux60_limit

protected boolean flux60_limit
True if the flux at 60 um is upper limit.

flux100_limit

protected boolean flux100_limit
True if the flux at 100 um is upper limit.

variability

protected byte variability
The likelihood of variability. When no data is recorded, it is set as -1.
Constructor Detail

IrasPscStar

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

IrasPscStar

public IrasPscStar(java.lang.String number,
                   Coor coor,
                   short ellipse_major,
                   short ellipse_minor,
                   short ellipse_pa)
Constructs an IrasPscStar with data read from the catalog file.
Parameters:
number - the IRAS number.
coor - the R.A. and Decl.
ellipse_major - the uncertainty ellipse major axis.
ellipse_minor - the uncertainty ellipse minor axis.
ellipse_pa - the uncertainty ellipse position angle.
Method Detail

getName

public java.lang.String getName()
Gets the name of this star. This method returns such a string as IRAS 01234+5678.
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 IRAS01234+5678.
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.

setFlux12

public void setFlux12(float flux,
                      boolean limit)
Sets the flux at 12 um.
Parameters:
flux - the flux.
limit - true if the flux is upper limit.

setFlux25

public void setFlux25(float flux,
                      boolean limit)
Sets the flux at 25 um.
Parameters:
flux - the flux.
limit - true if the flux is upper limit.

setFlux60

public void setFlux60(float flux,
                      boolean limit)
Sets the flux at 60 um.
Parameters:
flux - the flux.
limit - true if the flux is upper limit.

setFlux100

public void setFlux100(float flux,
                       boolean limit)
Sets the flux at 100 um.
Parameters:
flux - the flux.
limit - true if the flux is upper limit.

setVariability

public void setVariability(int variability)
Sets the variability.
Parameters:
variability - the variability.

formatFlux

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