net.aerith.misao.util.star
Class DetectedStar

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.util.star.DetectedStar

public class DetectedStar
extends CatalogStar

The DetectedStar is a wrapper catalog star class of the StarImage.


Field Summary
protected  double astrometric_error
          The astrometric error in arcsec.
 
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
DetectedStar()
          Constructs an empty DetectedStar.
DetectedStar(DetectedStar detected_star)
          Constructs a DetectedStar.
DetectedStar(StarImage star_image, double pos_error)
          Constructs a DetectedStar.
 
Method Summary
 java.lang.String getCatalogCategory()
          Gets the category 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.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.
 double getPositionErrorInArcsec()
          Gets the mean error of position in arcsec.
 java.lang.String getStarFolder()
          Gets the folder string of the star.
 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, getCatalogAcronym, getCatalogCode, getCatalogNamesWithMagnitudeSystem, getCatalogNameWithMagnitudeSystem, getCoorAccuracy, getCoorString, getCoorStringWithoutUnit, getDate, getDefaultProperty, 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, getName, getOutputString, getOutputStringsWithXY, getOutputStringWithoutName, getOutputStringWithXY, getPair, getPositionString, getPxfString, getPxfStringsWithXY, getPxfStringWithXY, getRA, getVsnetName, 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

astrometric_error

protected double astrometric_error
The astrometric error in arcsec.
Constructor Detail

DetectedStar

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

DetectedStar

public DetectedStar(StarImage star_image,
                    double pos_error)
Constructs a DetectedStar.
Parameters:
star_image - the StarImage object.
pos_error - the astrometric error in arcsec.

DetectedStar

public DetectedStar(DetectedStar detected_star)
Constructs a DetectedStar.
Parameters:
detected_star - the DetectedStar object.
Method Detail

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.

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.

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.