Package org.opensourcephysics.tools

Class DatasetCurveFitter

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.opensourcephysics.tools.DatasetCurveFitter

public class DatasetCurveFitter
extends javax.swing.JPanel

A panel that displays and controls functional curve fits to a Dataset.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DatasetCurveFitter.MinimizeMultiVarFunction	A function whose value is the total deviation squared between a multivariable function and a set of data points.
class	DatasetCurveFitter.MinimizeUserFunction	A function whose value is the total deviation squared between a user function and a set of data points.

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

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

java.awt.Container.AccessibleAWTContainer

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

javax.swing.JComponent.AccessibleJComponent

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

javax.swing.JPanel.AccessibleJPanel

Field Summary

Fields inherited from class java.awt.Component

accessibleContext, 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

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Constructor Summary

Constructors

Constructor	Description
DatasetCurveFitter(Dataset data, FitBuilder builder)	Constructs a DatasetCurveFitter for the specified Dataset.

Method Summary

Modifier and Type	Method	Description
void	addFitFunction(KnownFunction f, boolean addToFitBuilder)	Adds a fit function.
protected UserFunction	createClone(KnownFunction f, java.lang.String name)
protected void	createGUI()	Creates the GUI.
void	doLinearRegression(double[] xd, double[] yd, boolean isLinearFit)	Determines the Pearson correlation and linear fit parameter SEs.
double	fit(KnownFunction fit)	Fits a fit function to the current data.
protected javax.swing.JDialog	getColorDialog()	Gets a color dialog for the plotted curve fit drawer
Dataset	getData()	Gets the data.
FunctionDrawer	getDrawer()	Gets the function drawer.
KnownFunction	getFitFunction(java.lang.String name)	Gets a fit function by name.
protected java.lang.String	getLineFitName()	Gets the name of the line fit function.
java.awt.Dimension	getMinimumSize()
java.util.Map<java.lang.String,java.lang.Double>	getSelectedFitParameters()	Gets the selected fit parameters.
double	getUncertainty(int paramIndex)	Gets the estimated uncertainty (standard error or other) of a best fit parameter.
java.lang.String	getUncertaintyString(int paramIndex)	Returns a string of the uncertainty with appropriate formatting.
protected void	refreshFitDropDown()	Refreshes the fitDropDown.
protected void	refreshFitMap()	Refreshes the fit map with localized names.
protected void	refreshGUI()	Refreshes the GUI.
void	refreshStatusBar()	Refreshes the parent tab's status bar
protected void	replaceFit(java.lang.String oldName, java.lang.String newName, KnownFunction newFit)	Replaces an existing fit function with a new one.
protected void	selectFit(java.lang.String name)	Selects a named fit.
void	setActive(boolean active)	Sets the active flag.
void	setAutofit(boolean auto)	Sets the autofit flag.
void	setColor(java.awt.Color newColor)	Sets the color.
void	setData(Dataset data)	Sets the dataset.
protected void	setDataToolTab(DataToolTab tab)
static void	setDefaultFitFunctions(java.util.ArrayList<KnownFunction> functions)	Sets the default fit functions.
protected void	setFontLevel(int level)	Sets the font level.
protected void	setParameterValue(int row, double value)	Sets the value of a parameter.

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, 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, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, 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, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class java.lang.Object

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

Constructor Detail

DatasetCurveFitter

public DatasetCurveFitter(Dataset data,
                          FitBuilder builder)

Constructs a DatasetCurveFitter for the specified Dataset.

Parameters:

data - the dataset

builder - the FitBuilder used for constructing custom fits

Method Detail

getDrawer

public FunctionDrawer getDrawer()

Gets the function drawer.

Returns:

the drawer

getData

public Dataset getData()

Gets the data.

Returns:

the dataset

setData

public void setData(Dataset data)

Sets the dataset.

Parameters:

data - the dataset

setColor

public void setColor(java.awt.Color newColor)

Sets the color.

Parameters:

newColor - the color

setAutofit

public void setAutofit(boolean auto)

Sets the autofit flag.

Parameters:

auto - true to autofit

setActive

public void setActive(boolean active)

Sets the active flag.

Parameters:

active - true

fit

public double fit(KnownFunction fit)

Fits a fit function to the current data.

Parameters:

fit - the function to fit

Returns:

the rms deviation

addFitFunction

public void addFitFunction(KnownFunction f,
                           boolean addToFitBuilder)

Adds a fit function.

Parameters:

f - the fit function to add

addToFitBuilder - ignored--all fits are added to the fit builder

refreshStatusBar

public void refreshStatusBar()

Refreshes the parent tab's status bar

getUncertainty

public double getUncertainty(int paramIndex)

Gets the estimated uncertainty (standard error or other) of a best fit parameter. Returns Double.NaN if uncertainty is unknown or is not best fit.

Parameters:

paramIndex - the parameter index

Returns:

the estimated uncertainty in the parameter

getUncertaintyString

public java.lang.String getUncertaintyString(int paramIndex)

Returns a string of the uncertainty with appropriate formatting.

Parameters:

paramIndex - the parameter index

Returns:

the uncertainty string

getFitFunction

public KnownFunction getFitFunction(java.lang.String name)

Gets a fit function by name.

Parameters:

name - the name

Returns:

the fit function, or null if none found

getSelectedFitParameters

public java.util.Map<java.lang.String,java.lang.Double> getSelectedFitParameters()

Gets the selected fit parameters.

Returns:

a map of parameter names to values

getMinimumSize

public java.awt.Dimension getMinimumSize()

Overrides:

getMinimumSize in class javax.swing.JComponent

createGUI

protected void createGUI()

Creates the GUI.

refreshGUI

protected void refreshGUI()

Refreshes the GUI.

refreshFitDropDown

protected void refreshFitDropDown()

Refreshes the fitDropDown.

refreshFitMap

protected void refreshFitMap()

Refreshes the fit map with localized names.

getLineFitName

protected java.lang.String getLineFitName()

Gets the name of the line fit function.

Returns:

the name of the line function (polynomial degree 1)

setDataToolTab

protected void setDataToolTab(DataToolTab tab)

setFontLevel

protected void setFontLevel(int level)

Sets the font level.

Parameters:

level - the level

setParameterValue

protected void setParameterValue(int row,
                                 double value)

Sets the value of a parameter.

Parameters:

row - the row number

value - the value

selectFit

protected void selectFit(java.lang.String name)

Selects a named fit.

Parameters:

name - the name of the fit function

createClone

protected UserFunction createClone(KnownFunction f,
                                   java.lang.String name)

doLinearRegression

public void doLinearRegression(double[] xd,
                               double[] yd,
                               boolean isLinearFit)

Determines the Pearson correlation and linear fit parameter SEs.

Parameters:

xd - double[]

yd - double[]

isLinearFit - true if linear fit (sets uncertainties to slope and intercept SE)

replaceFit

protected void replaceFit(java.lang.String oldName,
                          java.lang.String newName,
                          KnownFunction newFit)

Replaces an existing fit function with a new one.

Parameters:

oldName - the (localized) name of the existing fit function

newName - the (localized) new name of the function

newFit - the new fit function

getColorDialog

protected javax.swing.JDialog getColorDialog()

Gets a color dialog for the plotted curve fit drawer

setDefaultFitFunctions

public static void setDefaultFitFunctions(java.util.ArrayList<KnownFunction> functions)

Sets the default fit functions. Instances of DatasetCurveFitter instantiated AFTER this call will make these fits available to the user.

Parameters:

functions - the fit functions