net.aerith.misao.catalog.star
Class IcStar

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

public class IcStar

extends CatalogStar

The IcStar represents a star data of Index Catalogue (IC).

Field Summary

protected byte[]	mag_system The magnitude system code.
protected short	number The number.
protected float	size The size in arcmin.
protected boolean	size_limit True if the size is upper limit.
protected byte[]	type The 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

IcStar()
Constructs an empty IcStar.

IcStar(int number, Coor coor, java.lang.String type)
Constructs a IcStar with data read from the catalog file.

Method Summary

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	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	setKeyAndValue(KeyAndValue key_and_value) Sets the value of the specified key.
void	setMagSystem(java.lang.String mag_system) Sets the magnitude system.
void	setName(java.lang.String name) Sets the name of this star.
void	setSize(float size, boolean limit) Sets the size.

Methods inherited from class net.aerith.misao.util.star.CatalogStar

getAvailableMagnitudeSystems, getBMagnitude, getBVDifference, getCatalogFolderCode, 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 short number

The number.

type

protected byte[] type

The type.

size

protected float size

The size in arcmin. The -1 means no size is recorded.

size_limit

protected boolean size_limit

True if the size is upper limit.

mag_system

protected byte[] mag_system

The magnitude system code.

Constructor Detail

IcStar

public IcStar()

Constructs an empty IcStar. It is used in StarClass#newInstance to review the XML data.

IcStar

public IcStar(int number,
              Coor coor,
              java.lang.String type)

Constructs a IcStar with data read from the catalog file.

Parameters:

number - the star number.

coor - the R.A. and Decl.

type - the type.

Method Detail

getName

public java.lang.String getName()

Gets the name of this star. This method returns such a string as IC 1234.

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

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.

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.

setSize

public void setSize(float size,
                    boolean limit)

Sets the size.

Parameters:

size - the size in arcmin.

limit - true if the size is upper limit.

setMagSystem

public void setMagSystem(java.lang.String mag_system)

Sets the magnitude system.

Parameters:

mag_system - the magnitude system.

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.