net.aerith.misao.util.star
Class StarImage

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

public class StarImage

extends Star

The StarImage/code> represents a detected star which consists of (x,y) position, R.A. and Decl., magnitude, and some values obtained at star detection. They are expressed in float data.

Field Summary

protected int	area The area_size;
protected boolean	output_coordinates True if the R.A.
protected float	peak The peak value.
protected float	value The amount of pixel values.

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

StarImage()
Constructs an empty StarImage.

StarImage(StarImage star_image)
Constructs a copy StarImage.

Method Summary

void	enableOutputCoordinates() Sets the flag so that R.A.
int	getArea() Gets the area size.
KeyAndValue[]	getKeyAndValues() Gets an array of keys and values to output.
java.lang.String	getOutputString() Returns a string representation of the state of this object.
double	getPeak() Gets the peak value.
java.lang.String	getPxfString() Returns a string representation of the state of this object for PXF output.
double	getRadius() Gets the radius.
double	getValue() Gets the amount of pixel values.
protected java.lang.String	paramString() Returns a raw string representation of the state of this object, for debugging use.
void	setArea(int new_area) Sets the area size.
void	setKeyAndValue(KeyAndValue key_and_value) Sets the value of the specified key.
void	setPeak(double new_peak) Sets the peak value.
void	setValue(double new_value) Sets the amount of pixel values.
java.lang.String	toString() Returns a string representation of the state of this object, for debugging use.

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

equals, getColor, getCoor, getCoorString, getCoorStringWithoutUnit, getDecl, getItemDelimiter, getKeyAndValueDelimiter, getName, getOutputStringsWithXY, getOutputStringWithoutName, getOutputStringWithXY, getPair, getPositionString, getPxfStringsWithXY, getPxfStringWithXY, getRA, getVsnetName, mapCoordinatesToXY, mapCoordinatesToXY, mapXYToCoordinates, mapXYToCoordinates, setColor, setCoor, setPair

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

getMag, getOutputStrings, setMag

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

value

protected float value

The amount of pixel values.

peak

protected float peak

The peak value.

area

protected int area

The area_size;

output_coordinates

protected boolean output_coordinates

True if the R.A. and Decl. are set properly.

Constructor Detail

StarImage

public StarImage()

Constructs an empty StarImage. All member fields are set as 0.

StarImage

public StarImage(StarImage star_image)

Constructs a copy StarImage.

Method Detail

enableOutputCoordinates

public void enableOutputCoordinates()

Sets the flag so that R.A. and Decl. are also output.

getValue

public double getValue()

Gets the amount of pixel values.

Returns:

the amount of pixel values.

setValue

public void setValue(double new_value)

Sets the amount of pixel values.

Parameters:

new_value - the new amount of pixel values.

getPeak

public double getPeak()

Gets the peak value.

Returns:

the peak value.

setPeak

public void setPeak(double new_peak)

Sets the peak value.

Parameters:

new_peak - the new peak value.

getArea

public int getArea()

Gets the area size.

Returns:

the area size.

setArea

public void setArea(int new_area)

Sets the area size.

Parameters:

new_area - the new area size.

getRadius

public double getRadius()

Gets the radius.

Returns:

the radius.

getKeyAndValues

public KeyAndValue[] getKeyAndValues()

Gets an array of keys and values to output. When the R.A. and Decl. are not set properly, the magnitude will not be 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.

getOutputString

public java.lang.String getOutputString()

Returns a string representation of the state of this object. When the R.A. and Decl. are not set properly, the name, R.A. and Decl. and the magnitude will not be output.

Overrides:

getOutputString in class Star

Returns:

a string representation of the state of this object.

getPxfString

public java.lang.String getPxfString()

Returns a string representation of the state of this object for PXF output. In the case of StarImage, the name of this star will not be output.

Overrides:

getPxfString in class Star

Returns:

a string representation of the state of this object.

paramString

protected java.lang.String paramString()

Returns a raw string representation of the state of this object, for debugging use. It should be invoked from toString method of the subclasses.

Overrides:

paramString in class StarPosition

Returns:

a string representation of the state of this object.

toString

public java.lang.String toString()

Returns a string representation of the state of this object, for debugging use.

Overrides:

toString in class StarPosition

Returns:

a string representation of the state of this object.