SpectrogramDisplay

java.lang.Object
- Layout.PamFramePlots
- - userDisplay.UserFramePlots
  - - Spectrogram.SpectrogramDisplay

All Implemented Interfaces:: java.util.EventListener, javax.swing.event.InternalFrameListener, DisplayPanelContainer, LoadObserver, PamObserver, SpectrogramParametersUser

public class SpectrogramDisplay
extends UserFramePlots
implements PamObserver, LoadObserver, javax.swing.event.InternalFrameListener, DisplayPanelContainer, SpectrogramParametersUser

Field Summary
- Fields inherited from class userDisplay.UserFramePlots
  FRAME_TYPE_RADAR, FRAME_TYPE_SPECTROGRAM
- Fields inherited from interface Layout.DisplayPanelContainer
  DRAW_BORDER

Constructor Summary

Constructors
Constructor and Description

SpectrogramDisplay(UserDisplayControl userDisplayControl, SpectrogramParameters spectrogramParameters)

Constructors
Constructor and Description
`SpectrogramDisplay(UserDisplayControl userDisplayControl, SpectrogramParameters spectrogramParameters)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`calcFrequencyRangeDisplay()` Checks the frequency range range to be displayed.
`void`	`createAllImages()` Called whenever the display size changes so that buffered images can be recreated.
`ColourArray`	`getColourArray()`
`double`	`getCurrentXPixel()` Get the current X pixel in screen (not image) coordinates.
`long`	`getCurrentXTime()` Get the current time, i.e.
`int`	`getDisplayWidth()`
`FFTDataBlock`	`getFFTDataBlock()`
`int`	`getFrameType()`
`int`	`getFrozenImageWidth()` Width of the window thats being drawn on - not the number of pixels, though these may often be the same.
`int`	`getImageHeight()`
`java.lang.String`	`getName()`
`java.lang.String`	`getObserverName()`
`PamObserver`	`getObserverObject()`
`long`	`getRequiredDataHistory(PamObservable o, java.lang.Object arg)` Required data history depends on what's happening with the mouse.
`FFTDataBlock`	`getSourceFFTDataBlock()`
`PamRawDataBlock`	`getSourceRawDataBlock()`
`SpectrogramParameters`	`getSpectrogramParameters()`
`double`	`getXDuration()` get the display duration in milliseconds
`void`	`internalFrameClosing(javax.swing.event.InternalFrameEvent e)`
`void`	`masterClockUpdate(long milliSeconds, long sampleNumber)`
`void`	`noteNewSettings()`
`void`	`notifyModelChanged(int changeType)`
`void`	`PamToStart()`
`void`	`panelNotify(int noteType)` notification from a display panel that it's necessary to perform some action - such as redrawing axis.
`void`	`playViewerSound()` Should receive play commands from the top toolbar.
`void`	`removeObservable(PamObservable o)` called when an Observable (PamDataBlock) is removed from the system
`void`	`repaintAll()`
`void`	`setAmplitudeParams()` Called when amplitude range is changed on the hiding amplitude range slider.
`void`	`setLoadStatus(int loadState)`
`void`	`setParams(SpectrogramParameters newParameters, boolean fullLayout)`
`void`	`setSampleRate(float sampleRate, boolean notify)` New sample rate
`void`	`setSettings()`
`void`	`setSpectrogramParameters(SpectrogramParameters spectrogramParameters)`
`void`	`specMouseOffline(Spectrogram.SpectrogramDisplay.SpectrogramPanel spectrogramPanel, java.awt.Point point)` Called when the spectrogrammouse is moved or pressed in viewer mode.
`void`	`update(PamObservable obs, PamDataUnit newData)` Informs the PamObserver that new data have been added to the Observable class
`boolean`	`wrapDisplay()`

Methods inherited from class userDisplay.UserFramePlots
getUserFrameParameters, internalFrameActivated, internalFrameClosed, internalFrameDeactivated, internalFrameDeiconified, internalFrameIconified, internalFrameOpened, setUserFrameParameters

Methods inherited from class Layout.PamFramePlots
checkDualDisplay, getAxisPanel, getCopyMenuItem, getEastPanel, getFrame, getLeftPlotPanel, getNorthPanel, getPlotPanel, getRightPlotPanel, getSouthPanel, getWestPanel, repaint, setAxisPanel, setEastPanel, setFrame, setLeftPlotPanel, setNorthPanel, setPlotPanel, setRightPlotPanel, setSouthPanel, setWestPanel

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.swing.event.InternalFrameListener
internalFrameActivated, internalFrameClosed, internalFrameDeactivated, internalFrameDeiconified, internalFrameIconified, internalFrameOpened

- Constructor Detail
  - SpectrogramDisplay
```
public SpectrogramDisplay(UserDisplayControl userDisplayControl,
                  SpectrogramParameters spectrogramParameters)
```
- Method Detail
  - getObserverObject
```
public PamObserver getObserverObject()
```
    Specified by:
    
    getObserverObject in interface PamObserver
    
    Returns:
    the actual observer. In most cases concrete classes will just return 'this' in response. The exception is the Threaded observer, which will return the single thread observer.
  - getName
```
public java.lang.String getName()
```
    Overrides:
    
    getName in class UserFramePlots
  - setAmplitudeParams
```
public void setAmplitudeParams()
```
    Called when amplitude range is changed on the hiding amplitude range slider.
  - calcFrequencyRangeDisplay
```
public void calcFrequencyRangeDisplay()
```
    Checks the frequency range range to be displayed.
  - setParams
```
public void setParams(SpectrogramParameters newParameters,
             boolean fullLayout)
```
  - repaintAll
```
public void repaintAll()
```
  - getFrozenImageWidth
```
public int getFrozenImageWidth()
```
    Width of the window thats being drawn on - not the number of pixels, though these may often be the same.
    
    Returns:
    the width of the final rendered image in pixels
  - getDisplayWidth
```
public int getDisplayWidth()
```
    Returns:
    With of the display panels in pixels.
  - getImageHeight
```
public int getImageHeight()
```
    Returns:
    half the fft length. Always draw the full image then select a portion as it's rendered onto the screen (if zoomed).
  - createAllImages
```
public void createAllImages()
```
    Called whenever the display size changes so that buffered images can be recreated.
  - setSampleRate
```
public void setSampleRate(float sampleRate,
                 boolean notify)
```
    Description copied from interface: PamObserver
    
    New sample rate
    
    Specified by:
    
    setSampleRate in interface PamObserver
    
    notify - Notify other PamObservers and PamObservables in the chain.
  - masterClockUpdate
```
public void masterClockUpdate(long milliSeconds,
                     long sampleNumber)
```
    Specified by:
    
    masterClockUpdate in interface PamObserver
  - PamToStart
```
public void PamToStart()
```
  - getRequiredDataHistory
```
public long getRequiredDataHistory(PamObservable o,
                          java.lang.Object arg)
```
    Required data history depends on what's happening with the mouse. If the mouse is doing nothing and there are no SpectrogramMarkObservers then no data needs to be stored for drawing the spectrogram. If there are mark observers and the mouse is up, then make sure that at least one screen full of data is always in memory (both FFT data and Raw wave data). If the mouse is down, then keep the maximum of either one screen full of from whenever the mouse was pressed - the use may hold it down for a long time !
    
    Specified by:
    
    getRequiredDataHistory in interface PamObserver
    
    Parameters:
    o - PamObservable class requiring the data
    arg - optional argument from PamObservable
    
    Returns:
    time in milliseconds requried by data held in PamObservable
    See Also:
    SpectrogramMarkObserver
  - getObserverName
```
public java.lang.String getObserverName()
```
    Specified by:
    
    getObserverName in interface PamObserver
  - update
```
public void update(PamObservable obs,
          PamDataUnit newData)
```
    Description copied from interface: PamObserver
    
    Informs the PamObserver that new data have been added to the Observable class
    
    Specified by:
    
    update in interface PamObserver
    
    Parameters:
    obs - Reference to the Observable (a PamDataBlock)
    newData - Reference to the new PamDataUnit
  - setLoadStatus
```
public void setLoadStatus(int loadState)
```
    Specified by:
    
    setLoadStatus in interface LoadObserver
  - setSettings
```
public void setSettings()
```
  - getSpectrogramParameters
```
public SpectrogramParameters getSpectrogramParameters()
```
    Specified by:
    
    getSpectrogramParameters in interface SpectrogramParametersUser
  - setSpectrogramParameters
```
public void setSpectrogramParameters(SpectrogramParameters spectrogramParameters)
```
    Specified by:
    
    setSpectrogramParameters in interface SpectrogramParametersUser
  - getFFTDataBlock
```
public FFTDataBlock getFFTDataBlock()
```
    Specified by:
    
    getFFTDataBlock in interface SpectrogramParametersUser
  - specMouseOffline
```
public void specMouseOffline(Spectrogram.SpectrogramDisplay.SpectrogramPanel spectrogramPanel,
                    java.awt.Point point)
```
    Called when the spectrogrammouse is moved or pressed in viewer mode.
    
    Parameters:
    spectrogramPanel -
    point -
  - notifyModelChanged
```
public void notifyModelChanged(int changeType)
```
    Specified by:
    
    notifyModelChanged in class UserFramePlots
  - internalFrameClosing
```
public void internalFrameClosing(javax.swing.event.InternalFrameEvent e)
```
    Specified by:
    
    internalFrameClosing in interface javax.swing.event.InternalFrameListener
    
    Overrides:
    
    internalFrameClosing in class UserFramePlots
  - noteNewSettings
```
public void noteNewSettings()
```
    Specified by:
    
    noteNewSettings in interface PamObserver
  - removeObservable
```
public void removeObservable(PamObservable o)
```
    Description copied from interface: PamObserver
    
    called when an Observable (PamDataBlock) is removed from the system
    
    Specified by:
    
    removeObservable in interface PamObserver
  - getCurrentXPixel
```
public double getCurrentXPixel()
```
    Get the current X pixel in screen (not image) coordinates.
    In viewer mode, this is always 0; in normal operation, the following rules apply:
    If it's wrapping, then the current pixel is the current imagePos scaled by the ratio of the panel width to the image width.
    If it's scrolling, then it's just the panel width.
    
    Specified by:
    
    getCurrentXPixel in interface DisplayPanelContainer
  - getCurrentXTime
```
public long getCurrentXTime()
```
    Get the current time, i.e. the time at the cursor in milliseconds. If there is a frozen image, this is the time of the when it was frozen.
    
    Specified by:
    
    getCurrentXTime in interface DisplayPanelContainer
  - wrapDisplay
```
public boolean wrapDisplay()
```
    Specified by:
    
    wrapDisplay in interface DisplayPanelContainer
    
    Returns:
    true if the display wraps (rather than scrolls).
  - getXDuration
```
public double getXDuration()
```
    Description copied from interface: DisplayPanelContainer
    
    get the display duration in milliseconds
    
    Specified by:
    
    getXDuration in interface DisplayPanelContainer
    
    Returns:
    the display length in milliseconds.
  - panelNotify
```
public void panelNotify(int noteType)
```
    Description copied from interface: DisplayPanelContainer
    
    notification from a display panel that it's necessary to perform some action - such as redrawing axis.
    
    Specified by:
    
    panelNotify in interface DisplayPanelContainer
  - getFrameType
```
public int getFrameType()
```
    Specified by:
    
    getFrameType in class UserFramePlots
  - getSourceFFTDataBlock
```
public FFTDataBlock getSourceFFTDataBlock()
```
  - getSourceRawDataBlock
```
public PamRawDataBlock getSourceRawDataBlock()
```
  - playViewerSound
```
public void playViewerSound()
```
    Should receive play commands from the top toolbar.
  - getColourArray
```
public ColourArray getColourArray()
```
    Returns:
    the colourArray

Class SpectrogramDisplay

Field Summary

Fields inherited from class userDisplay.UserFramePlots

Fields inherited from interface Layout.DisplayPanelContainer

Constructor Summary

Method Summary

Methods inherited from class userDisplay.UserFramePlots

Methods inherited from class Layout.PamFramePlots

Methods inherited from class java.lang.Object

Methods inherited from interface javax.swing.event.InternalFrameListener

Constructor Detail

SpectrogramDisplay

Method Detail

getObserverObject

getName

setAmplitudeParams

calcFrequencyRangeDisplay

setParams

repaintAll

getFrozenImageWidth

getDisplayWidth

getImageHeight

createAllImages

setSampleRate

masterClockUpdate

PamToStart

getRequiredDataHistory

getObserverName

update

setLoadStatus

setSettings

getSpectrogramParameters

setSpectrogramParameters

getFFTDataBlock

specMouseOffline

notifyModelChanged

internalFrameClosing

noteNewSettings

removeObservable

getCurrentXPixel

getCurrentXTime

wrapDisplay

getXDuration

panelNotify

getFrameType

getSourceFFTDataBlock

getSourceRawDataBlock

playViewerSound

getColourArray