Package PamView.symbol.modifier

Class PeakFreqModifier

java.lang.Object

PamView.symbol.modifier.SymbolModifier

PamView.symbol.modifier.PeakFreqModifier

public class PeakFreqModifier
extends SymbolModifier

Peak frequency symbol modifier. Colours a symbol by it's peak frequency.

Author:

Jamie Macaulay

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PEAK_FREQ_MODIFIER_NAME

Fields inherited from class PamView.symbol.modifier.SymbolModifier

symbolModifierParams

Constructor Summary

Constructors

Constructor	Description
PeakFreqModifier(PamSymbolChooser symbolChooser)

Method Summary

Modifier and Type	Method	Description
void	checkColourArray()	Check the correct colour array is being used and, if not, change it.
PamDialogPanel	getDialogPanel()
SymbolModifierPane	getOptionsPane()	Get the JavaFX symbol options pane that has options for the symbol pane.
SymbolData	getSymbolData(GeneralProjector projector, PamDataUnit dataUnit)	This is the symbol data to use if this modifier were to change everything.
SymbolModifierParams	getSymbolModifierParams()	Get the symbol modifier parameters associated with the symbol modifier.
SymbolData	modifySymbol(SymbolData symbolData, GeneralProjector projector, PamDataUnit dataUnit)	Modify the symbol.
void	setSymbolModifierParams(SymbolModifierParams symbolModifierParams)	Set the symbol modifier paramters.

Methods inherited from class PamView.symbol.modifier.SymbolModifier

canModify, getModifierOptionsMenu, getModifyableBits, getName, getSymbolChooser, getToolTipText, setName, setSelectionBit, setToolTipText

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PEAK_FREQ_MODIFIER_NAME

public static final String PEAK_FREQ_MODIFIER_NAME

See Also:

• Constant Field Values

Constructor Details

PeakFreqModifier

public PeakFreqModifier(PamSymbolChooser symbolChooser)

Method Details

modifySymbol

public SymbolData modifySymbol(SymbolData symbolData,
 GeneralProjector projector,
 PamDataUnit dataUnit)

Description copied from class: SymbolModifier

Modify the symbol. In it's basic form it calls getSymbolData to get a totally fresh symbol, then copies over only the bits of information specified in modifyBits

Overrides:

modifySymbol in class SymbolModifier

Returns:

modified symbol. Must never be null.

getSymbolData

public SymbolData getSymbolData(GeneralProjector projector,
 PamDataUnit dataUnit)

Description copied from class: SymbolModifier

This is the symbol data to use if this modifier were to change everything. the Symbolchooser will actually be calling the modifySymbol function, which calls this, then based on which bits are set for modification, will transfer over the appropriate information.

Must be able to respond to a null projector and dataUnit for tree vies.

Specified by:

getSymbolData in class SymbolModifier

Returns:

checkColourArray

public void checkColourArray()

Check the correct colour array is being used and, if not, change it.

getOptionsPane

public SymbolModifierPane getOptionsPane()

Description copied from class: SymbolModifier

Get the JavaFX symbol options pane that has options for the symbol pane.

Overrides:

getOptionsPane in class SymbolModifier

Returns:

the symbol options pane.

getDialogPanel

public PamDialogPanel getDialogPanel()

Overrides:

getDialogPanel in class SymbolModifier

getSymbolModifierParams

public SymbolModifierParams getSymbolModifierParams()

Description copied from class: SymbolModifier

Get the symbol modifier parameters associated with the symbol modifier.

Note that this function should create a new instance of the settings class if the settings class is null. This allows subclasses to override this function to return custom parameter objects.

Overrides:

getSymbolModifierParams in class SymbolModifier

Returns:

the symbol modifier parameters.

setSymbolModifierParams

public void setSymbolModifierParams(SymbolModifierParams symbolModifierParams)

Description copied from class: SymbolModifier

Set the symbol modifier paramters.

Overrides:

setSymbolModifierParams in class SymbolModifier

Parameters:

symbolModifierParams - - the symbol modifiers paramters.