net.aerith.misao.xml
Class XmlInformation

java.lang.Object
  |
  +--net.aerith.misao.xml.IONode
        |
        +--net.aerith.misao.xml.relaxer.XmlInformation
              |
              +--net.aerith.misao.xml.XmlInformation

public class XmlInformation

extends XmlInformation

implements XmlDBRecord

The XmlInformation is an application side implementation of the class that the relaxer generated automatically.

See Also:

Serialized Form

Fields inherited from class net.aerith.misao.xml.relaxer.XmlInformation

astrometricError, astrometry, baseCatalog, center, chip, date, distortionField, exposure, filter, fov, image, instruments, limitingMag, magnitudeCorrection, magnitudeTranslationFormula, note, observer, parentRNode, path, photometricError, photometry, pixelSize, rContext, reversedImage, rotation, sbigImage, sizeValue, starCount, unofficial, upperLimitMag

Constructor Summary

XmlInformation()
Constructs an XmlInformation.

XmlInformation(XmlInformation info)
Clones the XmlInformation object.

Method Summary

XmlReport	cloneEmptyReport() Clones this XmlInformation object, and creates an empty XmlReport object with it.
XmlDBRecord	create() Creates an empty XmlDBRecord object.
double	getAstrometricErrorInArcsec() Gets the astrometric error in arcsec.
double	getAstrometricErrorInPixel() Gets the astrometric error in pixel.
AstrometrySetting	getAstrometrySetting() Gets the astrometry setting.
ChartMapFunction	getChartMapFunction() Gets the chart map function.
DistortionField	getDistortion() Gets the distortion field.
double	getFieldRadiusInDegree() Gets the field radius in degree, the radius of the circumcircle of the image field.
java.lang.String	getID() Gets the ID.
java.io.File	getImageFile(FileManager file_manager) Gets the image file.
KeyAndValue[]	getKeyAndValues() Gets an array of keys and values to output.
JulianDay	getMidDate() Gets the midst date and time of the exposure.
PhotometrySetting	getPhotometrySetting() Gets the photometry setting.
double	getProperUpperLimitMag() Gets the proper upper-limit magnitude.
boolean	isReversedImage() Returns true if the reversed image property is set.
boolean	isSbigImage() Returns true if the SBIG ST-4/6 image property is set.
Position	mapCoordinatesToXY(Coor coor) Maps the specified R.A.
Coor	mapXYToCoordinates(Position position) Maps the specified (x,y) position to the R.A.
boolean	overlaps(XmlInformation info) Returns true when the specified image overlaps on this image.
void	setAstrometricError(AstrometricError err) Sets the astrometric error.
void	setDistortionField(DistortionField df) Sets the distortion field.
void	setFormattedLimitingMag(double mag) Formats the limiting magnitude and sets.
void	setFormattedUpperLimitMag(double mag) Formats the upper-limit magnitude and sets.
void	setInformation(Size image_size, ChartMapFunction cmf) Sets the information of an image.
void	setMagnitudeTranslationFormula(MagnitudeTranslationFormula mag_formula) Sets the magnitude translation formula.
void	setPhotometricError(PhotometricError err) Sets the photometric error.
void	setReversedImage() Sets the reversed image property.
void	setSbigImage() Sets the SBIG ST-4/6 image property.

Methods inherited from class net.aerith.misao.xml.relaxer.XmlInformation

getAstrometricError, getAstrometry, getBaseCatalog, getCenter, getChip, getDate, getDistortionField, getExposure, getFilter, getFov, getImage, getInstruments, getLimitingMag, getMagnitudeCorrection, getMagnitudeTranslationFormula, getNote, getObserver, getParentRNode, getPath, getPhotometricError, getPhotometry, getPixelSize, getRContext, getRContextResolved, getReversedImage, getRNodes, getRotation, getSbigImage, getSize, getStarCount, getUnofficial, getUpperLimitMag, init, isMatch, isMatch, isMatchHungry, makeElement, setAstrometricError, setAstrometry, setBaseCatalog, setCenter, setChip, setDate, setDistortionField, setExposure, setFilter, setFov, setImage, setInstruments, setLimitingMag, setMagnitudeCorrection, setMagnitudeTranslationFormula, setNote, setObserver, setParentRNode, setPath, setPhotometricError, setPhotometry, setPixelSize, setRContext, setReversedImage, setRotation, setSbigImage, setSize, setStarCount, setUnofficial, setup, setup, setup, setUpperLimitMag

Methods inherited from class net.aerith.misao.xml.IONode

read, read, translateFrom, translateTo, write, write

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Constructor Detail

XmlInformation

public XmlInformation()

Constructs an XmlInformation.

XmlInformation

public XmlInformation(XmlInformation info)

Clones the XmlInformation object.

Parameters:

info - the information object.

Method Detail

cloneEmptyReport

public XmlReport cloneEmptyReport()

Clones this XmlInformation object, and creates an empty XmlReport object with it.

Returns:

the empty XML report document.

create

public XmlDBRecord create()

Creates an empty XmlDBRecord object. This method must be overrided by the subclass.

Specified by:

create in interface XmlDBRecord

Returns:

the new empty object.

getID

public java.lang.String getID()

Gets the ID.

Specified by:

getID in interface XmlDBRecord

Returns:

the ID.

setInformation

public void setInformation(Size image_size,
                           ChartMapFunction cmf)

Sets the information of an image.

Parameters:

image_size - the size of the image.

cmf - the chart map function.

getImageFile

public java.io.File getImageFile(FileManager file_manager)

Gets the image file. In general, it returns a file at the specified relative path of the specified file manager. If it does not exist, it returns a file at the specified relative path from the directory where the XML report document is stored. In the latter case, the XML file path must be recorded in the element.

Parameters:

file_manager - the file manager.

Returns:

the image file.

mapCoordinatesToXY

public Position mapCoordinatesToXY(Coor coor)

Maps the specified R.A. and Decl. to the (x,y) position.

Parameters:

coor - the R.A. and Decl.

Returns:

the (x,y) position.

mapXYToCoordinates

public Coor mapXYToCoordinates(Position position)

Maps the specified (x,y) position to the R.A. and Decl.

Parameters:

position - the position.

Returns:

the R.A. and Decl.

overlaps

public boolean overlaps(XmlInformation info)

Returns true when the specified image overlaps on this image.

Parameters:

info - another image information.

Returns:

true when the specified image overlaps on this image.

getMidDate

public JulianDay getMidDate()

Gets the midst date and time of the exposure.

Returns:

the midst date and time of the exposure.

getChartMapFunction

public ChartMapFunction getChartMapFunction()

Gets the chart map function.

Returns:

the chart map function.

getFieldRadiusInDegree

public double getFieldRadiusInDegree()

Gets the field radius in degree, the radius of the circumcircle of the image field.

Returns:

the field radius in degree.

setFormattedLimitingMag

public void setFormattedLimitingMag(double mag)

Formats the limiting magnitude and sets.

Parameters:

mag - the limiting magnitude.

getProperUpperLimitMag

public double getProperUpperLimitMag()

Gets the proper upper-limit magnitude. When the upper-limit magnitude is not recorded, it returns the limiting magnitude.

Returns:

the proper upper-limit magnitude.

setFormattedUpperLimitMag

public void setFormattedUpperLimitMag(double mag)

Formats the upper-limit magnitude and sets.

Parameters:

mag - the upper-limit magnitude.

getAstrometricErrorInArcsec

public double getAstrometricErrorInArcsec()

Gets the astrometric error in arcsec.

Returns:

the astrometric error in arcsec.

getAstrometricErrorInPixel

public double getAstrometricErrorInPixel()

Gets the astrometric error in pixel.

Returns:

the astrometric error in pixel.

setAstrometricError

public void setAstrometricError(AstrometricError err)

Sets the astrometric error.

Parameters:

err - the astrometric error.

setPhotometricError

public void setPhotometricError(PhotometricError err)

Sets the photometric error.

Parameters:

err - the photometric error.

getAstrometrySetting

public AstrometrySetting getAstrometrySetting()

Gets the astrometry setting.

Returns:

the astrometry setting.

getPhotometrySetting

public PhotometrySetting getPhotometrySetting()

Gets the photometry setting.

Returns:

the photometry setting.

setDistortionField

public void setDistortionField(DistortionField df)

Sets the distortion field.

Parameters:

df - the distortion field.

getDistortion

public DistortionField getDistortion()

Gets the distortion field.

Returns:

the distortion field.

setMagnitudeTranslationFormula

public void setMagnitudeTranslationFormula(MagnitudeTranslationFormula mag_formula)

Sets the magnitude translation formula.

Parameters:

mag_formula - the magnitude translation formula.

isReversedImage

public boolean isReversedImage()

Returns true if the reversed image property is set.

Returns:

true if the reversed image property is set.

setReversedImage

public void setReversedImage()

Sets the reversed image property.

isSbigImage

public boolean isSbigImage()

Returns true if the SBIG ST-4/6 image property is set.

Returns:

true if the SBIG ST-4/6 image property is set.

setSbigImage

public void setSbigImage()

Sets the SBIG ST-4/6 image property.

getKeyAndValues

public KeyAndValue[] getKeyAndValues()

Gets an array of keys and values to output.

Returns:

an array of keys and values to output.