Package adams.data.io.input

Class FitsLibsReader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.input.AbstractDataContainerReader<ThreeWayData>

adams.data.io.input.AbstractThreeWayDataReader

adams.data.io.input.FitsLibsReader

All Implemented Interfaces:

adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.io.FileFormatHandler, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<adams.data.io.input.DataContainerReader>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.data.io.input.DataContainerReader<ThreeWayData>, Serializable, Comparable

public class FitsLibsReader
extends AbstractThreeWayDataReader

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_Unsigned	whether the data is unsigned.

Fields inherited from class adams.data.io.input.AbstractThreeWayDataReader

m_Format, m_Instrument, m_KeepFormat, m_Stopped, m_UseAbsoluteSource

Fields inherited from class adams.data.io.input.AbstractDataContainerReader

m_CreateDummyReport, m_Input, m_InputIsFile, m_Processed, m_ReadData

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
FitsLibsReader()

Method Summary

Modifier and Type	Method	Description
protected double	arrayToDouble(Object array, int index)	Turns the array value into a double.
void	defineOptions()	Adds options to the internal list of options.
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions()	Returns the extension(s) of the format.
boolean	getUnsigned()	Returns whether the numbers are to be interpreted as unsigned.
String	globalInfo()	Returns a string describing the object.
protected void	readData()	Performs the actual reading.
void	setUnsigned(boolean value)	Sets whether the numbers are to be interpreted as unsigned.
String	unsignedTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.io.input.AbstractThreeWayDataReader

checkData, createDummyReport, formatTipText, getDefaultFormat, getDefaultInstrument, getDefaultKeepFormat, getDefaultUseAbsoluteSource, getFormat, getInstrument, getKeepFormat, getReaders, getUseAbsoluteSource, instrumentTipText, keepFormatTipText, postProcessData, setFormat, setInstrument, setKeepFormat, setUseAbsoluteSource, stopExecution, useAbsoluteSourceTipText

Methods inherited from class adams.data.io.input.AbstractDataContainerReader

cleanUp, compareTo, createDummyReportTipText, destroy, doRead, equals, getAdditionalInformation, getCreateDummyReport, getDefaultFormatExtension, getInput, initialize, inputTipText, isInputFile, read, reset, setCreateDummyReport, setInput, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Unsigned

protected boolean m_Unsigned

whether the data is unsigned.

Constructor Detail

FitsLibsReader

public FitsLibsReader()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class AbstractThreeWayDataReader

setUnsigned

public void setUnsigned(boolean value)

Sets whether the numbers are to be interpreted as unsigned.

Parameters:

value - true if unsigned

getUnsigned

public boolean getUnsigned()

Returns whether the numbers are to be interpreted as unsigned.

Returns:

true if unsigned

unsignedTipText

public String unsignedTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getFormatDescription

public String getFormatDescription()

Returns a string describing the format (used in the file chooser).

Specified by:

getFormatDescription in interface adams.core.io.FileFormatHandler

Specified by:

getFormatDescription in class adams.data.io.input.AbstractDataContainerReader<ThreeWayData>

Returns:

a description suitable for displaying in the file chooser

getFormatExtensions

public String[] getFormatExtensions()

Returns the extension(s) of the format.

Specified by:

getFormatExtensions in interface adams.core.io.FileFormatHandler

Specified by:

getFormatExtensions in class adams.data.io.input.AbstractDataContainerReader<ThreeWayData>

Returns:

the extension (without the dot!)

arrayToDouble

protected double arrayToDouble(Object array,
                               int index)

Turns the array value into a double.

Parameters:

array - the array to obtain the value from

index - the index in the array

Returns:

the double value

readData

protected void readData()

Performs the actual reading.

Specified by:

readData in class adams.data.io.input.AbstractDataContainerReader<ThreeWayData>