NumericProbeBase (Artisynth API documentation)

java.lang.Object
- artisynth.core.modelbase.ModelComponentBase
- - artisynth.core.modelbase.ModelAgentBase
  - - artisynth.core.probes.Probe
    - - artisynth.core.probes.NumericProbeBase

All Implemented Interfaces:

Displayable, HasState, ModelAgent, ModelComponent, PostScannable, java.lang.Cloneable, HasProperties, HierarchyNode, Scannable

Direct Known Subclasses:

NumericDataFunctionProbe, NumericInputProbe, NumericOutputProbe
```
public abstract class NumericProbeBase
extends Probe
implements Displayable
```

Nested Class Summary
- Nested classes/interfaces inherited from class artisynth.core.probes.Probe
  Probe.ExportProps, Probe.ImportExportFileInfo
- Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent
  ModelComponent.NavpanelVisibility

Field Summary

Fields
Modifier and Type Field and Description

static double EXPLICIT_TIME

static PropertyList myProps

NumericProbePanel mySmallDisplay
- Fields inherited from class artisynth.core.probes.Probe
  useOldSaveMethod, writeStartStopTimeInSeconds
- Fields inherited from class artisynth.core.modelbase.ModelComponentBase
  enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Fields
Modifier and Type	Field and Description
`static double`	`EXPLICIT_TIME`
`static PropertyList`	`myProps`
`NumericProbePanel`	`mySmallDisplay`

Constructor Summary

Constructors
Constructor and Description

NumericProbeBase()

Constructors
Constructor and Description
`NumericProbeBase()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addData(ReaderTokenizer rtok, double timeStep)`
`abstract void`	`apply(double t)` Called at time `t` to apply this probe
`void`	`applyDefaultDisplayRanges()`
`void`	`clearData()`
`java.lang.Object`	`clone()`
`void`	`createNumericList(int vsize)`
`void`	`decreaseDisplayRanges()` Decrease the display range of each numeric probe panel.
`void`	`dispose()` Remove resources used by this agent.
`void`	`export(java.io.File file, Probe.ExportProps props)`
`PropertyList`	`getAllPropertyInfo()` Returns a list giving static information about all properties exported by this object.
`Property[]`	`getAttachedProperties()`
`VectorNd`	`getData(double sec)`
`double`	`getDefaultDisplayMax()`
`double`	`getDefaultDisplayMin()`
`double[]`	`getDefaultDisplayRange()`
`javax.swing.JPanel`	`getDisplay(int w, int h, boolean isLargeDisplay)`
`NumericProbeDriver[]`	`getDrivers()`
`Probe.ImportExportFileInfo[]`	`getExportFileInfo()`
`Probe.ExportProps`	`getExportProps(java.lang.String ext)`
`java.lang.String`	`getFormat()`
`Interpolation`	`getInterpolation()` Returns the interpolation method for this numeric input probe.
`Interpolation.Order`	`getInterpolationOrder()` Returns the interpolation order for this numeric probe.
`LegendDisplay`	`getLegend()`
`java.lang.String`	`getMatlabName()`
`double[]`	`getMinMaxValues()`
`NumericList`	`getNumericList()`
`int`	`getOrderedTraceIndex(int order)`
`PlotTraceInfo`	`getPlotTraceInfo(int idx)`
`double[]`	`getRange()`
`static double[]`	`getRange(NumericList list)`
`java.awt.Color`	`getTraceColor(int idx)`
`java.lang.String`	`getTraceLabel(int idx)`
`PlotTraceManager`	`getTraceManager()`
`double[][]`	`getValues()` Returns the values of this probe as a two dimensional array of doubles.
`java.util.LinkedHashMap<java.lang.String,NumericProbeVariable>`	`getVariables()`
`int`	`getVsize()`
`void`	`importData(java.io.File file, boolean explicitTime, boolean overlay)` Still being implemented
`void`	`importText(java.io.File file, boolean explicitTime, boolean overlay, char separator)` Still being implemented
`void`	`increaseDisplayRanges()` Increase the display range of each numeric probe panel.
`boolean`	`isCloneable()`
`boolean`	`isEmpty()`
`boolean`	`isPrintable()`
`boolean`	`isSmallDisplayVisible()`
`boolean`	`isTraceVisible(int idx)`
`static boolean`	`isValidVariableName(java.lang.String name)`
`boolean`	`isWritable()` Returns `true` if this component should in fact be written to secondary storage.
`boolean`	`loadFromMatlab(MatlabInterface mi, java.lang.String matlabName)`
`void`	`print(double sec)`
`void`	`read(java.io.File file, boolean setTimes)` Reads the start and stop times, scale value, and data for this probe from an ascii file.
`boolean`	`removeDisplay(javax.swing.JPanel display)`
`void`	`removeLegend()`
`void`	`resetTraceColors()`
`void`	`resetTraceOrder()`
`void`	`saveToMatlab(MatlabInterface mi, java.lang.String matlabName)`
`void`	`scaleNumericList(double s)` Scales the values of a numberic probe.
`void`	`setDefaultDisplayRange(double[] minmax)`
`void`	`setDefaultDisplayRange(double min, double max)`
`void`	`setFormat(java.lang.String fmtStr)`
`void`	`setInterpolation(Interpolation method)` Sets the interpolation method for this numeric input probe.
`void`	`setInterpolationOrder(Interpolation.Order order)` Sets the interpolation order for this numeric probe.
`void`	`setLegend(LegendDisplay legend)`
`void`	`setLegendLabels(java.util.List<java.lang.String> labels)`
`void`	`setScale(double s)`
`void`	`setSmallDisplayVisible(boolean visible)`
`void`	`setTraceColor(int idx, java.awt.Color color)`
`void`	`setTraceLabel(int idx, java.lang.String label)`
`void`	`setTraceOrder(int[] indices)` Sets a new ordering for the plot traces.
`void`	`setTraceVisible(int idx, boolean visible)`
`void`	`setValues(double[][] vals)` Sets the values of this numeric probe from a two dimensional array of doubles.
`void`	`smoothWithMovingAverage(int winSize)` Smooths the values in this probe by applying a mean average filter over a moving window of specified size.
`void`	`smoothWithSavitzkyGolay(int winSize, int deg)` Smooths the values in this probe by applying Savitzky-Golay smoothing over a moving window of specified size.
`void`	`swapPlotTraceOrder(PlotTraceInfo pti0, PlotTraceInfo pti1)`
`void`	`updateDisplays()`
`void`	`updateDisplays(NumericProbePanel notToUpdate)`
`void`	`updateDisplaysForPropertyChanges()` Update displays if associated properties (like interpolation) have changed.
`void`	`updateDisplaysWithoutAutoRanging()` Update displays with auto-ranging suppressed.
`void`	`writeText(java.io.File file, java.lang.String fmtStr, java.lang.String separator, boolean includeTime)`

Methods inherited from class artisynth.core.modelbase.ModelAgentBase
finalize, getModel, initialize, isActive, setActive, setModel, setModelFromComponent, write

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

Methods inherited from interface artisynth.core.modelbase.ModelComponent
connectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, getSoftReferences, isFixed, isMarked, isSelected, notifyParentOfChange, setFixed, setMarked, setNumber, setParent, setSelected, setWritable, updateReferences

Methods inherited from interface artisynth.core.modelbase.PostScannable
postscan

- Field Detail
  - EXPLICIT_TIME
```
public static final double EXPLICIT_TIME
```
    See Also:
    
    Constant Field Values
  - mySmallDisplay
```
public NumericProbePanel mySmallDisplay
```
  - myProps
```
public static PropertyList myProps
```
- Constructor Detail
  - NumericProbeBase
```
public NumericProbeBase()
```
- Method Detail
  - getAllPropertyInfo
```
public PropertyList getAllPropertyInfo()
```
    Description copied from interface: HasProperties
    
    Returns a list giving static information about all properties exported by this object.
    
    Specified by:
    
    getAllPropertyInfo in interface HasProperties
    
    Overrides:
    
    getAllPropertyInfo in class Probe
    
    Returns:
    
    static information for all exported properties
  - getValues
```
public double[][] getValues()
```
    Returns the values of this probe as a two dimensional array of doubles. This facilitates reading the values into a matlab array. The array is arranged so that each knot point corresponds to a row, the first column gives the time values, and the remaining columns give the knot point values.
    
    Returns:
    
    Values of this numeric probe
  - setValues
```
public void setValues(double[][] vals)
```
    Sets the values of this numeric probe from a two dimensional array of doubles. This facilitates settings the values from a matlab array. The arrangement of the array is described in getValues().
    
    Parameters:
    
    vals - Values used to set this numeric probe
  - apply
```
public abstract void apply(double t)
```
    Description copied from class: Probe
    
    Called at time t to apply this probe
    
    Specified by:
    
    apply in class Probe
    
    Parameters:
    
    t - time at which probe is being applied
  - getDisplay
```
public javax.swing.JPanel getDisplay(int w,
                                     int h,
                                     boolean isLargeDisplay)
```
    Specified by:
    
    getDisplay in interface Displayable
  - removeDisplay
```
public boolean removeDisplay(javax.swing.JPanel display)
```
    Specified by:
    
    removeDisplay in interface Displayable
  - getVsize
```
public int getVsize()
```
  - createNumericList
```
public void createNumericList(int vsize)
```
  - clearData
```
public void clearData()
```
  - updateDisplays
```
public void updateDisplays()
```
    Specified by:
    
    updateDisplays in interface Displayable
  - setSmallDisplayVisible
```
public void setSmallDisplayVisible(boolean visible)
```
  - isSmallDisplayVisible
```
public boolean isSmallDisplayVisible()
```
  - updateDisplays
```
public void updateDisplays(NumericProbePanel notToUpdate)
```
  - updateDisplaysForPropertyChanges
```
public void updateDisplaysForPropertyChanges()
```
    Update displays if associated properties (like interpolation) have changed.
  - updateDisplaysWithoutAutoRanging
```
public void updateDisplaysWithoutAutoRanging()
```
    Update displays with auto-ranging suppressed. This is for situations where data is changed in the display itself (knot points being dragged) and auto-ranging would cause problems with the usre interaction.
  - setInterpolation
```
public void setInterpolation(Interpolation method)
```
    Sets the interpolation method for this numeric input probe.
    
    Parameters:
    
    method - interpolation method.
  - getInterpolation
```
public Interpolation getInterpolation()
```
    Returns the interpolation method for this numeric input probe.
    
    Returns:
    
    interpolation method
    
    See Also:
    
    setInterpolation(maspack.interpolation.Interpolation)
  - setInterpolationOrder
```
public void setInterpolationOrder(Interpolation.Order order)
```
    Sets the interpolation order for this numeric probe.
    
    Parameters:
    
    order - new interpolation order
  - getInterpolationOrder
```
public Interpolation.Order getInterpolationOrder()
```
    Returns the interpolation order for this numeric probe.
    
    Returns:
    
    interpolation order
  - setFormat
```
public void setFormat(java.lang.String fmtStr)
```
  - getFormat
```
public java.lang.String getFormat()
```
  - isCloneable
```
public boolean isCloneable()
```
    Overrides:
    
    isCloneable in class Probe
  - getDefaultDisplayMax
```
public double getDefaultDisplayMax()
```
  - getDefaultDisplayMin
```
public double getDefaultDisplayMin()
```
  - setDefaultDisplayRange
```
public void setDefaultDisplayRange(double min,
                                   double max)
```
  - setDefaultDisplayRange
```
public void setDefaultDisplayRange(double[] minmax)
```
  - increaseDisplayRanges
```
public void increaseDisplayRanges()
```
    Increase the display range of each numeric probe panel.
  - decreaseDisplayRanges
```
public void decreaseDisplayRanges()
```
    Decrease the display range of each numeric probe panel.
  - applyDefaultDisplayRanges
```
public void applyDefaultDisplayRanges()
```
  - getDefaultDisplayRange
```
public double[] getDefaultDisplayRange()
```
  - getMinMaxValues
```
public double[] getMinMaxValues()
```
  - isEmpty
```
public boolean isEmpty()
```
  - getRange
```
public static double[] getRange(NumericList list)
```
  - getRange
```
public double[] getRange()
```
  - scaleNumericList
```
public void scaleNumericList(double s)
```
    Scales the values of a numberic probe. Method added by Chad. author: Chad Scales the values of a numberic probe.
    
    Parameters:
    
    s - scale factor the parameter by which to scale the values.
  - setScale
```
public void setScale(double s)
```
    Overrides:
    
    setScale in class Probe
  - getNumericList
```
public NumericList getNumericList()
```
  - getVariables
```
public java.util.LinkedHashMap<java.lang.String,NumericProbeVariable> getVariables()
```
  - getDrivers
```
public NumericProbeDriver[] getDrivers()
```
  - getAttachedProperties
```
public Property[] getAttachedProperties()
```
  - smoothWithMovingAverage
```
public void smoothWithMovingAverage(int winSize)
```
    Smooths the values in this probe by applying a mean average filter over a moving window of specified size. This window is centered on each data point, and is reduced in size near the end values to ensure a symmetric fit. The end values themselves are not changed.
    
    Parameters:
    
    winSize - size of the averaging window. The value should be odd; if it is even, it will be incremented internally to be odd. The method does nothing if the value is is less than 1. Finally, winSize will be reduced if necessary to fit the number of data points.
  - smoothWithSavitzkyGolay
```
public void smoothWithSavitzkyGolay(int winSize,
                                    int deg)
```
    Smooths the values in this probe by applying Savitzky-Golay smoothing over a moving window of specified size. Savitzky-Golay smoothing works by fitting the data values in the window to a polynomial of degree deg, and then using this to recompute the value in the middle of the window. The polynomial is also used to interpolate the first and last winSize/2 values, since it is not possible to center the window on these.
    
    Parameters:
    
    deg - degree of the smoothing polynomial. Must be at least 1.
    
    winSize - size of the averaging window. The value must be >= deg+1 and should also be odd; if it is even, it will be incremented internally to be odd. Finally, winSize will be reduced if necessary to fit the number of data points.
  - isValidVariableName
```
public static boolean isValidVariableName(java.lang.String name)
```
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Overrides:
    
    clone in class ModelComponentBase
    
    Throws:
    
    java.lang.CloneNotSupportedException
  - isPrintable
```
public boolean isPrintable()
```
    Overrides:
    
    isPrintable in class Probe
  - getData
```
public VectorNd getData(double sec)
```
  - print
```
public void print(double sec)
```
    Overrides:
    
    print in class Probe
  - setLegendLabels
```
public void setLegendLabels(java.util.List<java.lang.String> labels)
```
  - getPlotTraceInfo
```
public PlotTraceInfo getPlotTraceInfo(int idx)
```
  - getOrderedTraceIndex
```
public int getOrderedTraceIndex(int order)
```
  - setTraceOrder
```
public void setTraceOrder(int[] indices)
```
    Sets a new ordering for the plot traces. This is specified by an array giving the indices of the plot traces in the order they should be plotted.
  - swapPlotTraceOrder
```
public void swapPlotTraceOrder(PlotTraceInfo pti0,
                               PlotTraceInfo pti1)
```
  - resetTraceOrder
```
public void resetTraceOrder()
```
  - setTraceVisible
```
public void setTraceVisible(int idx,
                            boolean visible)
```
  - isTraceVisible
```
public boolean isTraceVisible(int idx)
```
  - setTraceColor
```
public void setTraceColor(int idx,
                          java.awt.Color color)
```
  - getTraceColor
```
public java.awt.Color getTraceColor(int idx)
```
  - resetTraceColors
```
public void resetTraceColors()
```
  - getTraceManager
```
public PlotTraceManager getTraceManager()
```
  - setTraceLabel
```
public void setTraceLabel(int idx,
                          java.lang.String label)
```
  - getTraceLabel
```
public java.lang.String getTraceLabel(int idx)
```
  - getLegend
```
public LegendDisplay getLegend()
```
  - setLegend
```
public void setLegend(LegendDisplay legend)
```
  - removeLegend
```
public void removeLegend()
```
  - dispose
```
public void dispose()
```
    Remove resources used by this agent. Should be overridden by sub-classes as necessary.
    
    Specified by:
    
    dispose in interface ModelAgent
    
    Overrides:
    
    dispose in class ModelAgentBase
  - getMatlabName
```
public java.lang.String getMatlabName()
```
  - saveToMatlab
```
public void saveToMatlab(MatlabInterface mi,
                         java.lang.String matlabName)
                  throws MatlabInterfaceException
```
    Throws:
    
    MatlabInterfaceException
  - loadFromMatlab
```
public boolean loadFromMatlab(MatlabInterface mi,
                              java.lang.String matlabName)
                       throws MatlabInterfaceException
```
    Throws:
    
    MatlabInterfaceException
  - isWritable
```
public boolean isWritable()
```
    Description copied from class: ModelComponentBase
    
    Returns true if this component should in fact be written to secondary storage. This gives subclasses control over whether or not they are actually written out.
    
    Specified by:
    
    isWritable in interface Scannable
    
    Overrides:
    
    isWritable in class ModelComponentBase
    
    Returns:
    
    true if this component should be written to secondary storage.
  - addData
```
public void addData(ReaderTokenizer rtok,
                    double timeStep)
             throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - read
```
public void read(java.io.File file,
                 boolean setTimes)
          throws java.io.IOException
```
    Reads the start and stop times, scale value, and data for this probe from an ascii file. The following information should be provided in order, separated by white space:
    - start time (either seconds or nanoseconds, as described below). Ignored if setTimes is false.
    - stop time (either seconds or nanoseconds, as described below) Ignored if setTimes is false.
    - scale value (floating point number; nominal value is 1) Ignored if setTimes is false.
    - interpolation order ("step", "linear", or "cubic")
    - number of data values n at each knot point (an integer)
    - either the knot point time step (floating point number, in seconds), OR the keyword "explicit", indicating that knot time values are to be given explicitly
    - the knot point data, with each knot point specified by n numbers, preceeded (if explicit time has been specified) by the corresponding time value (in seconds).
    The start and stop times can be indicated in either seconds or nanoseconds. The former is assumed if the value is a double with a decimal point. For example, the following input
```
 2.0 10.0 1.2
 linear 2 explicit
 0.0 2.0 2.0
 1.1 4.0 3.0
 3.0 0.0 1.0
 
```
    specifies a probe with a start and stop time of 2 and 10 seconds, respectively, a scale value of 1.2, linear interpolation, 2 values at each knot point, and three knot points at times 0.0, 1.1, and 3.0. If knot time is given implicitly by a time setp, then time is assumed to start at 0. The following input
```
 2000000000 3000000000 2.5
 step 2 2.0
 2.0 2.0
 4.0 3.0
 0.0 1.0
 
```
    specifies a probe with a start and stop time of 2 and 3 seconds, respectively, a scale value of 2.5, step interpolation, 2 values at each knot point, and three knot points with times of 0, 2.0, and 4.0 (given implicity by a step size of 2.0).
    The character '#' is a comment character, causing all subsequent input up to the next new line to be ignored.
    Parameters:
    
    file - File from which to read the probe information
    
    setTimes - if true, sets the start time, stop time, and scale values to those indicated at the head of the file. If false, these values are ignored.
    
    Throws:
    
    java.io.IOException - if an I/O or format error occurred.
  - writeText
```
public void writeText(java.io.File file,
                      java.lang.String fmtStr,
                      java.lang.String separator,
                      boolean includeTime)
               throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - importText
```
public void importText(java.io.File file,
                       boolean explicitTime,
                       boolean overlay,
                       char separator)
                throws java.io.IOException
```
    Still being implemented
    
    Throws:
    
    java.io.IOException
  - getExportFileInfo
```
public Probe.ImportExportFileInfo[] getExportFileInfo()
```
    Overrides:
    
    getExportFileInfo in class Probe
  - getExportProps
```
public Probe.ExportProps getExportProps(java.lang.String ext)
```
    Overrides:
    
    getExportProps in class Probe
  - export
```
public void export(java.io.File file,
                   Probe.ExportProps props)
            throws java.io.IOException
```
    Overrides:
    
    export in class Probe
    
    Throws:
    
    java.io.IOException
  - importData
```
public void importData(java.io.File file,
                       boolean explicitTime,
                       boolean overlay)
                throws java.io.IOException
```
    Still being implemented
    
    Overrides:
    
    importData in class Probe
    
    Throws:
    
    java.io.IOException

Class NumericProbeBase

Nested Class Summary

Nested classes/interfaces inherited from class artisynth.core.probes.Probe

Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent

Field Summary

Fields inherited from class artisynth.core.probes.Probe

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

Constructor Summary

Method Summary

Methods inherited from class artisynth.core.probes.Probe

Methods inherited from class artisynth.core.modelbase.ModelAgentBase

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

Methods inherited from class java.lang.Object

Methods inherited from interface artisynth.core.modelbase.ModelComponent

Methods inherited from interface artisynth.core.modelbase.PostScannable

Field Detail

EXPLICIT_TIME

mySmallDisplay

myProps

Constructor Detail

NumericProbeBase

Method Detail

getAllPropertyInfo

getValues

setValues

apply

getDisplay

removeDisplay

getVsize

createNumericList

clearData

updateDisplays

setSmallDisplayVisible

isSmallDisplayVisible

updateDisplays

updateDisplaysForPropertyChanges

updateDisplaysWithoutAutoRanging

setInterpolation

getInterpolation

setInterpolationOrder

getInterpolationOrder

setFormat

getFormat

isCloneable

getDefaultDisplayMax

getDefaultDisplayMin

setDefaultDisplayRange

setDefaultDisplayRange

increaseDisplayRanges

decreaseDisplayRanges

applyDefaultDisplayRanges

getDefaultDisplayRange

getMinMaxValues

isEmpty

getRange

getRange

scaleNumericList

setScale

getNumericList

getVariables

getDrivers

getAttachedProperties

smoothWithMovingAverage

smoothWithSavitzkyGolay

isValidVariableName

clone

isPrintable

getData

print

setLegendLabels

getPlotTraceInfo

getOrderedTraceIndex

setTraceOrder

swapPlotTraceOrder

resetTraceOrder

setTraceVisible

isTraceVisible

setTraceColor

getTraceColor

resetTraceColors