rocca

Class RoccaSpecPopUp

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

rocca.RoccaSpecPopUp

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class RoccaSpecPopUp
extends javax.swing.JPanel

Author:

Michael Oswald

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field and Description
static int	AXIS_SIZE
static boolean	CONTOUROFF constant indicating the contour should be turned off
static boolean	CONTOURON constant indicating the contour should be turned on
static boolean	RETURNFLOAT constant indicating the getXPosition or getYPosition method should return a float
static boolean	RETURNINT constant indicating the getXPosition or getYPosition method should return an int

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
RoccaSpecPopUp(double[][] d, java.lang.String title) Dummy constructor - only used to test display
RoccaSpecPopUp(RoccaProcess roccaProcess, FFTDataBlock fftDataBlock, double boxBotFreq, double boxTopFreq, PamRawDataBlock rawData, SpectrogramDisplay display, int channel)

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Point[]	getContour()
boolean	getContourState()
double[][]	getData()
java.io.File	getDataBlockFilename(RoccaContourDataBlock rcdb, java.lang.String ext) Generates a filename for the wav clip and the csv file containing the contour points, based on the filename template stored in RoccaParameters
SpectrogramPanel	getDataPanel()
java.awt.Point	getDragPoint()
RoccaAxis	getFreqAxis()
double[]	getFreqBins()
double	getHighPassFreq()
double	getLowPassFreq()
static int	getNumDetections()
long[]	getTimeBins()
java.util.ArrayList<java.awt.Point>	getUserPoints()
static void	incNumDetections()
static void	main(java.lang.String[] args) Method for testing RoccaSpecPopUp
void	run() Launch this RoccaSpecPopUp in its own JFrame.
boolean	saveContourPoints() Saves the contour points in the datablock in a csv file.
boolean	saveContourStats() Saves all contour stats to the contour stats summary file, as defined in the Rocca Parameters.
void	setInitialPosition() Sets the initial position of the vertical scrollbar to center the user- selected area in the display window
static void	setNumDetections(int numDetections)
boolean	showPeaks()
boolean	tracingNow()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

AXIS_SIZE

public static final int AXIS_SIZE

See Also:

Constant Field Values

CONTOUROFF

public static final boolean CONTOUROFF

constant indicating the contour should be turned off

See Also:

Constant Field Values

CONTOURON

public static final boolean CONTOURON

constant indicating the contour should be turned on

See Also:

Constant Field Values

RETURNINT

public static final boolean RETURNINT

constant indicating the getXPosition or getYPosition method should return an int

See Also:

Constant Field Values

RETURNFLOAT

public static final boolean RETURNFLOAT

constant indicating the getXPosition or getYPosition method should return a float

See Also:

Constant Field Values

Constructor Detail

RoccaSpecPopUp

public RoccaSpecPopUp(double[][] d,
              java.lang.String title)

Dummy constructor - only used to test display

Parameters:

d -

title -

RoccaSpecPopUp

public RoccaSpecPopUp(RoccaProcess roccaProcess,
              FFTDataBlock fftDataBlock,
              double boxBotFreq,
              double boxTopFreq,
              PamRawDataBlock rawData,
              SpectrogramDisplay display,
              int channel)

Parameters:

roccaProcess -

fftDataBlock -

startFreq -

endFreq -

rawData -

display -

channel -

Method Detail

saveContourPoints

public boolean saveContourPoints()

Saves the contour points in the datablock in a csv file. Saves the time and peak frequency of each point, along with the duty cycle, energy, and windows RMS

Note that this method has now (as of 2012/08/12) been duplicated in RoccaProcess in order to accomodate data from the Whistle & Moan detector. It should be deleted from RoccaSpecPopUp at some point in the future

Parameters:

roccaContourDataBlock - the datablock containing the selected whistle contour

Returns:

saveContourPoints boolean indicating success or failure

getDataBlockFilename

public java.io.File getDataBlockFilename(RoccaContourDataBlock rcdb,
                                java.lang.String ext)

Generates a filename for the wav clip and the csv file containing the contour points, based on the filename template stored in RoccaParameters

Parameters:

rcdb - The RoccaContourDataBlock containing the data to save

ext - The filename extension (wav or csv)

Returns:

A File

saveContourStats

public boolean saveContourStats()

Saves all contour stats to the contour stats summary file, as defined in the Rocca Parameters. If the file does not exist, it is created and a header line is written. If it does exist, data is appended to the end. Each contour is 1 row. Note that the last few columns contain the random forest votes, and so the number of columns depends on how many species are in the classifier. This won't be a problem if the same classifier is always used, but if a different classifier with a different number of species is tried out the number of columns from one row to the next will not match. More importantly, the order of the species from one row to the next might not match and you would never know unless you remember. For this reason, instead of saving the species names as the column headers (which would only be accurate for the classifier selected when the file had been created), the species names are written in the row AFTER the tree votes. The classifier name is also saved, for reference. While this is awkward, at least results from different classifiers can be interpreted properly without having to guess which vote is for which species

Note that this method has now (as of 2012/08/12) been duplicated in RoccaProcess in order to accomodate data from the Whistle & Moan detector. It should be deleted from RoccaSpecPopUp at some point in the future

Returns:

boolean indicating whether or not the save was successful

run

public void run()

Launch this RoccaSpecPopUp in its own JFrame.

setInitialPosition

public void setInitialPosition()

Sets the initial position of the vertical scrollbar to center the user- selected area in the display window

showPeaks

public boolean showPeaks()

getContour

public java.awt.Point[] getContour()

getData

public double[][] getData()

getDragPoint

public java.awt.Point getDragPoint()

tracingNow

public boolean tracingNow()

getUserPoints

public java.util.ArrayList<java.awt.Point> getUserPoints()

Returns:

the userPoints

getContourState

public boolean getContourState()

getNumDetections

public static int getNumDetections()

setNumDetections

public static void setNumDetections(int numDetections)

incNumDetections

public static void incNumDetections()

getFreqBins

public double[] getFreqBins()

getTimeBins

public long[] getTimeBins()

getDataPanel

public SpectrogramPanel getDataPanel()

getFreqAxis

public RoccaAxis getFreqAxis()

getHighPassFreq

public double getHighPassFreq()

getLowPassFreq

public double getLowPassFreq()

main

public static void main(java.lang.String[] args)

Method for testing RoccaSpecPopUp

Requires a csv file containing the FFT data to be displayed, with no header. Size of file is hard-coded in the specData variable. Note that this is commented out, along with the Csvreader import, because it was throwing an error when compiled. To use this test, uncomment the reader section and the csvreader import at the top.