Package adams.data.spectrumimage

Class AmplitudeRatio

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spectrumimage.AbstractSpectrumImageGenerator

adams.data.spectrumimage.AbstractSpectrumImageGeneratorWithRange

adams.data.spectrumimage.AmplitudeRatio

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable

public class AmplitudeRatio
extends AbstractSpectrumImageGeneratorWithRange

Generates a square image (width is number of wave numbers) with the pixels being the ratio for each possible amplitude pair.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.data.spectrumimage.AbstractSpectrumImageGeneratorWithRange

m_MaxAmplitude, m_MinAmplitude

Fields inherited from class adams.data.spectrumimage.AbstractSpectrumImageGenerator

m_ImageType

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
AmplitudeRatio()

Method Summary

Modifier and Type	Method	Description
protected BufferedImage	doGenerate(Spectrum spectrum)	Converts the spectrum into an image.
protected float	getDefaultMinAmplitude()	Returns the default minimum amplitude.
protected Float	getLowerMaxAmplitude()	Returns the lower bound for the maximum amplitude.
protected Float	getLowerMinAmplitude()	Returns the lower bound for the minimum amplitude.
String	globalInfo()	Returns a string describing the object.

Methods inherited from class adams.data.spectrumimage.AbstractSpectrumImageGeneratorWithRange

check, defineOptions, getDefaultMaxAmplitude, getMaxAmplitude, getMinAmplitude, getUpperMaxAmplitude, getUpperMinAmplitude, maxAmplitudeTipText, minAmplitudeTipText, rangeCheck, setMaxAmplitude, setMinAmplitude

Methods inherited from class adams.data.spectrumimage.AbstractSpectrumImageGenerator

generate, getImageType, imageTypeTipText, newImage, setImageType, setPixel

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

AmplitudeRatio

public AmplitudeRatio()

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

getDefaultMinAmplitude

protected float getDefaultMinAmplitude()

Returns the default minimum amplitude.

Overrides:

getDefaultMinAmplitude in class AbstractSpectrumImageGeneratorWithRange

Returns:

the minimum

getLowerMinAmplitude

protected Float getLowerMinAmplitude()

Returns the lower bound for the minimum amplitude.

Overrides:

getLowerMinAmplitude in class AbstractSpectrumImageGeneratorWithRange

Returns:

the lower bound, null if unbounded

getLowerMaxAmplitude

protected Float getLowerMaxAmplitude()

Returns the lower bound for the maximum amplitude.

Overrides:

getLowerMaxAmplitude in class AbstractSpectrumImageGeneratorWithRange

Returns:

the lower bound, null if unbounded

doGenerate

protected BufferedImage doGenerate(Spectrum spectrum)

Converts the spectrum into an image.

Specified by:

doGenerate in class AbstractSpectrumImageGenerator

Parameters:

spectrum - the spectrum to convert

Returns:

the generated image