Package Spectrogram

Class SpectrogramProjector

java.lang.Object

PamView.GeneralProjector<TimeFrequencyPoint>

Spectrogram.SpectrogramProjector

public class SpectrogramProjector
extends GeneralProjector<TimeFrequencyPoint>

Spectrogram projector for overlaying data onto the spectrogram bitmap which will always be scaled 1:1 with regard to pixels per frequency or time bin.

Author:

Doug Gillespie

See Also:

• DirectDrawProjector

Nested Class Summary

Nested classes/interfaces inherited from class PamView.GeneralProjector

GeneralProjector.ParameterType, GeneralProjector.ParameterUnits

Field Summary

Fields inherited from class PamView.GeneralProjector

NPARAMETERS, viewer

Constructor Summary

Constructors

Constructor	Description
SpectrogramProjector(SpectrogramDisplay spectrogramDisplay)

Method Summary

Modifier and Type	Method	Description
double	dataToX(double d1, double d2)
double	dataToY(double d1, double frequency)
int	getChannel()
Coordinate3d	getCoord3d(double d1, double d2, double d3)	Function ultimately used by a PamDataBlock to convert it's own data, in whatever form that is in into screen coordinates.
Coordinate3d	getCoord3d(TimeFrequencyPoint data)	Same as getCoordinate3d but using the generic type
TimeFrequencyPoint	getDataPosition(PamCoordinate screenPos)	Do the exact opposite of getCoord3d and turn a screen position back into a data coordinate (e.g.
SpectrogramDisplay	getSpectrogramDisplay()
long	getTimeOffsetMillis()
void	setChannel(int channel)
void	setOffset(long timeOffsetMillis, int timeOffsetPixs)	Set the x and the time offset
void	setScales(double xScale, double yScale, int specWidth, int specHeight)

Methods inherited from class PamView.GeneralProjector

addHoverData, addHoverData, addHoverData, addHoverData, addHoverData, addHoverData, clearHoverList, findClosestDataUnitIndex, findClosestDataUnitIndex, getDataSelector, getHoverDataList, getHoverDataSynchroniser, getHoveredDataUnit, getHoverText, getHoverText, getMouseHoverAdapter, getPamSymbolChooser, getParameterTypes, getParameterUnits, getParmeterType, getParmeterUnits, getProjectorDrawingOptions, isViewer, setDataSelector, setPamSymbolChooser, setParmeterType, setParmeterUnits, setProjectorDrawingOptions

Methods inherited from class java.lang.Object

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

Constructor Details

SpectrogramProjector

public SpectrogramProjector(SpectrogramDisplay spectrogramDisplay)

Method Details

getTimeOffsetMillis

public long getTimeOffsetMillis()

Returns:

the timeOffsetMillis

setScales

public void setScales(double xScale,
 double yScale,
 int specWidth,
 int specHeight)

Parameters:

xScale - pixels per millisecond

yScale - 2/fftLength

specWidth - display width

specHeight - display height

setOffset

public void setOffset(long timeOffsetMillis,
 int timeOffsetPixs)

Set the x and the time offset

Parameters:

timeOffsetMillis - time offset in Java milliseconds

timeOffsetPixs - position in pixels

getCoord3d

public Coordinate3d getCoord3d(TimeFrequencyPoint data)

Description copied from class: GeneralProjector

Same as getCoordinate3d but using the generic type

Specified by:

getCoord3d in class GeneralProjector<TimeFrequencyPoint>

Parameters:

data - object extending PamCoordinate

Returns:

3d coordinate.

getCoord3d

public Coordinate3d getCoord3d(double d1,
 double d2,
 double d3)

Description copied from class: GeneralProjector

Function ultimately used by a PamDataBlock to convert it's own data, in whatever form that is in into screen coordinates.

Specified by:

getCoord3d in class GeneralProjector<TimeFrequencyPoint>

Parameters:

d1 - d2 and d3 are data representing whatever is appropriate for the concrete instance of the projector (e.g. Latitude, Longitude, depth, Time Frequency, etc)

Returns:

A 3 dimensional coordinate (realistically z is never currently used)

getDataPosition

public TimeFrequencyPoint getDataPosition(PamCoordinate screenPos)

Description copied from class: GeneralProjector

Do the exact opposite of getCoord3d and turn a screen position back into a data coordinate (e.g. a time / freq, a lat long, etc)/.

Specified by:

getDataPosition in class GeneralProjector<TimeFrequencyPoint>

Parameters:

screenPos - screen position

Returns:

data object.

dataToX

public double dataToX(double d1,
 double d2)

dataToY

public double dataToY(double d1,
 double frequency)

getSpectrogramDisplay

public SpectrogramDisplay getSpectrogramDisplay()

Returns:

the spectrogramDisplay

setChannel

public void setChannel(int channel)

Parameters:

channel - the channel to set

getChannel

public int getChannel()

Returns:

the channel