artisynth.core.probes

Class NumericControlProbe

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.ModelAgentBase

artisynth.core.probes.Probe

artisynth.core.probes.NumericProbeBase

artisynth.core.probes.NumericDataFunctionProbe

artisynth.core.probes.NumericControlProbe

All Implemented Interfaces:

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

Direct Known Subclasses:

FrameTrackingProbe, IKProbe, TransparencyProbe

public class NumericControlProbe
extends NumericDataFunctionProbe

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.FilePathSaveType, ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static double	EXPLICIT_TIME
static PropertyList	myProps

Fields inherited from class artisynth.core.probes.NumericProbeBase

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 inherited from interface artisynth.core.modelbase.CopyableComponent

COPY_REFERENCES, REST_POSITION

Constructor Summary

Constructors

Constructor and Description
NumericControlProbe()
NumericControlProbe(int vsize, double[] data, double timeStep, double startTime, double stopTime)
NumericControlProbe(int vsize, java.lang.String fileName)
NumericControlProbe(java.lang.String fileName)

Method Summary

Modifier and Type	Method and Description
void	addData(double[] data, double timeStep) Adds one or more data samples to internal data list. Samples can be evenly distributed with given time step or time of each sample can be explicitly set.
void	addData(double t, double[] v)
void	addData(double t, Vector v) Adds data to internal data list.
void	addData(double t, VectorNd v) Adds data to internal data list.
void	addData(java.io.File file, double timeStep)
void	addData(ReaderTokenizer rtok, double timeStep)
void	apply(double t) Interpolate data to specified time and set related properties values.
void	applyData(VectorNd vec, double t, double trel) Applies the current numeric data of this probe, as input in the argument vec, and uses it to update the simulation for either the current absolute time t or probe relative time trel.
java.lang.Object	clone()
ModelComponent	copy(int flags, java.util.Map<ModelComponent,ModelComponent> copyMap) Create a copy of this component.
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
boolean	getCopyReferences(java.util.List<ModelComponent> refs, ModelComponent ancestor) Collects external references which must also be copied in order to duplicate this component.
boolean	getExtendData() Returns true if data is to be extended past the last knot point
NumericList	getInput()
boolean	isInput() Returns true if this probe is an input probe, and false otherwise.
boolean	isSettable()
void	load() When called (perhaps by the Artsynth timeline), causes information about this probe to be loaded from the attached file.
void	loadEmpty()
void	postscan(java.util.Deque<ScanToken> tokens, CompositeComponent ancestor) Performs any required post-scanning for this component.
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.
void	save() When called (perhaps by the Artsynth timeline), causes information about this probe to be written to the attached file.
void	scan(ReaderTokenizer rtok, java.lang.Object ref) Scans this element from a ReaderTokenizer.
boolean	scanItem(ReaderTokenizer rtok, java.util.Deque<ScanToken> tokens)
void	setAttachedFileName(java.lang.String fileName)
void	setAttachedFileName(java.lang.String fileName, java.lang.String fmtStr)
void	setData(double sec)
void	setExtendData(boolean extend) Enables extension of data past the last knot point.
void	setVsize(int vsize)
void	write(java.io.PrintWriter pw, java.lang.String fmtStr) Writes the start and stop times, scale value, and data for this probe to a PrintWriter, using the format described for read(File).
void	writeItems(java.io.PrintWriter pw, NumberFormat fmt, CompositeComponent ancestor) Write probe attributes to a PrintWriter

Methods inherited from class artisynth.core.probes.NumericDataFunctionProbe

createState, getDataFunction, getInitialState, getState, hasState, isCloneable, isDuplicatable, setDataFunction, setState

Methods inherited from class artisynth.core.probes.NumericProbeBase

applyDefaultDisplayRanges, clearData, decreaseDisplayRanges, dispose, exportCsvData, exportCsvData, exportData, exportTextData, exportTextData, getAttachedProperties, getData, getData, getDefaultDisplayMax, getDefaultDisplayMin, getDefaultDisplayRange, getDisplay, getDrivers, getExportFileInfo, getExportProps, getFormat, getImportFileInfo, getInterpolation, getInterpolationOrder, getLegend, getMatlabName, getMinMaxValues, getNumericList, getOrderedTraceIndex, getPlotTraceInfo, getRotationRep, getRotationSubvecOffsets, getTraceColor, getTraceLabel, getTraceManager, getValues, getVariables, getVisibleMinMaxValues, getVisibleRange, getVisibleRange, getVsize, importCsvData, importData, importText, importTextData, increaseDisplayRanges, isDisplayable, isEmpty, isPrintable, isSmallDisplayVisible, isTraceVisible, isValidVariableName, isWritable, loadFromMatlab, print, removeDisplay, removeLegend, resetTraceColors, resetTraceOrder, saveToMatlab, scaleNumericList, setData, setData, setDefaultDisplayRange, setDefaultDisplayRange, setFormat, setInterpolation, setInterpolationOrder, setLegend, setLegendLabels, setScale, setSmallDisplayVisible, setTraceColor, setTraceLabel, setTraceOrder, setTraceVisible, setValues, setValues, smoothWithMovingAverage, smoothWithSavitzkyGolay, swapPlotTraceOrder, updateDisplays, updateDisplays, updateDisplaysForPropertyChanges, updateDisplaysWithoutAutoRanging, writeText

Methods inherited from class artisynth.core.probes.Probe

getAttachedFile, getAttachedFileName, getChildren, getClippedVirtualTime, getDefaultScale, getDefaultStartTime, getDefaultStopTime, getDefaultUpdateInterval, getDuration, getExportFile, getExportFileName, getFileFromPath, getImportFile, getImportFileName, getPathFromFile, getProperty, getScale, getStartTime, getStopTime, getTimelineTime, getTrack, getUpdateInterval, getVirtualTime, hasAttachedFile, hasChildren, isAttachedFileRelative, isEditable, isEventTime, isScalable, nextEventTime, setExportFileName, setImportFileName, setInterval, setName, setScalable, setStartStopTimes, setStartTime, setStopTime, setTrack, setUpdateInterval

Methods inherited from class artisynth.core.modelbase.ModelAgentBase

finalize, getModel, initialize, isActive, setActive, setModel, setModelFromComponent, write

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, connectToHierarchy, createTempFlag, disconnectFromHierarchy, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getSoftReferences, isFixed, isMarked, isScanning, isSelected, makeValidName, makeValidName, notifyParentOfChange, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, setFixed, setFlag, setMarked, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setScanning, setSelected, setWritable, updateReferences

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, setName, setNumber, setParent, setSelected, setWritable, updateReferences

Methods inherited from interface maspack.properties.HasProperties

getProperty

Methods inherited from interface maspack.properties.HierarchyNode

getChildren, hasChildren

Methods inherited from interface maspack.util.Scannable

isWritable, write

Field Detail

EXPLICIT_TIME

public static final double EXPLICIT_TIME

See Also:

Constant Field Values

myProps

public static PropertyList myProps

Constructor Detail

NumericControlProbe

public NumericControlProbe()

NumericControlProbe

public NumericControlProbe(java.lang.String fileName)
                    throws java.io.IOException

Throws:

java.io.IOException

NumericControlProbe

public NumericControlProbe(int vsize,
                           java.lang.String fileName)
                    throws java.io.IOException

Throws:

java.io.IOException

NumericControlProbe

public NumericControlProbe(int vsize,
                           double[] data,
                           double timeStep,
                           double startTime,
                           double stopTime)

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 NumericProbeBase

Returns:

static information for all exported properties

setExtendData

public void setExtendData(boolean extend)

Enables extension of data past the last knot point.

Parameters:

extend - true if data is to be extended past the last knot point

getExtendData

public boolean getExtendData()

Returns true if data is to be extended past the last knot point

Returns:

true if data is extended

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.

Overrides:

read in class NumericProbeBase

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.

write

public void write(java.io.PrintWriter pw,
                  java.lang.String fmtStr)
           throws java.io.IOException

Writes the start and stop times, scale value, and data for this probe to a PrintWriter, using the format described for read(File). The format used for producing floating point numbers can be controlled using a printf-style format string, details of which are described in NumberFormat.

Parameters:

pw - writer which accepts the output

fmtStr - printf-style format string (if set to null then "%g" will be assumed, which will produce full precision output).

Throws:

java.io.IOException - if an I/O error occurs.

setAttachedFileName

public void setAttachedFileName(java.lang.String fileName)

Overrides:

setAttachedFileName in class Probe

setAttachedFileName

public void setAttachedFileName(java.lang.String fileName,
                                java.lang.String fmtStr)

save

public void save()
          throws java.io.IOException

When called (perhaps by the Artsynth timeline), causes information about this probe to be written to the attached file.

Overrides:

save in class Probe

Throws:

java.io.IOException

See Also:

write(java.io.PrintWriter, java.lang.String)

loadEmpty

public void loadEmpty()

load

public void load()
          throws java.io.IOException

When called (perhaps by the Artsynth timeline), causes information about this probe to be loaded from the attached file.

Overrides:

load in class Probe

Throws:

java.io.IOException

addData

public void addData(java.io.File file,
                    double timeStep)
             throws java.io.IOException

Throws:

java.io.IOException

addData

public void addData(double[] data,
                    double timeStep)

Adds one or more data samples to internal data list.

Samples can be evenly distributed with given time step or time of each sample can be explicitly set. In this case, timeStep must have value of EXPLICIT_TIME and before every data sample must be its temporal information.
Internal data sample size of this input probe can be determined by NumericProbeBase.getVsize() method.

Parameters:

data - data array, which can contain multiple data samples

timeStep - time step in seconds or EXPLICIT_TIME if data contains explicitly set timestamps

addData

public void addData(double t,
                    VectorNd v)

Adds data to internal data list.

Parameters:

t - time in seconds

v - vector of values

Throws:

java.lang.IllegalArgumentException - if size of vector is not equal to NumericProbeBase.getVsize()

addData

public void addData(double t,
                    double[] v)

addData

public void addData(double t,
                    Vector v)

Adds data to internal data list.

Parameters:

t - time in seconds

v - vector of values

Throws:

java.lang.IllegalArgumentException - if size of vector is not equal to NumericProbeBase.getVsize()

addData

public void addData(ReaderTokenizer rtok,
                    double timeStep)
             throws java.io.IOException

Overrides:

addData in class NumericProbeBase

Throws:

java.io.IOException

applyData

public void applyData(VectorNd vec,
                      double t,
                      double trel)

Applies the current numeric data of this probe, as input in the argument vec, and uses it to update the simulation for either the current absolute time t or probe relative time trel. The size of vec will equal the vector size of the probe (as returned by NumericProbeBase.getVsize(). Probe relative time is determined from the probe's start time and scale factor using

 trel = (t - startTime)/scale 

.

Parameters:

vec - supplies the current numeric data

t - absolute time (seconds)

trel - probe relative time

apply

public void apply(double t)

Interpolate data to specified time and set related properties values.

Specified by:

apply in class NumericProbeBase

Parameters:

t - current time

isSettable

public boolean isSettable()

Overrides:

isSettable in class Probe

setData

public void setData(double sec)

Overrides:

setData in class Probe

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class NumericDataFunctionProbe

Throws:

java.lang.CloneNotSupportedException

getInput

public NumericList getInput()

scanItem

public boolean scanItem(ReaderTokenizer rtok,
                        java.util.Deque<ScanToken> tokens)
                 throws java.io.IOException

Throws:

java.io.IOException

scan

public void scan(ReaderTokenizer rtok,
                 java.lang.Object ref)
          throws java.io.IOException

Description copied from class: ModelComponentBase

Scans this element from a ReaderTokenizer. The expected text format is assumed to be compatible with that produced by write.

Specified by:

scan in interface ModelComponent

Specified by:

scan in interface Scannable

Overrides:

scan in class Probe

Parameters:

rtok - Tokenizer from which to scan the element

ref - optional reference object which can be used for resolving references to other objects

Throws:

java.io.IOException - if an I/O or formatting error occured

postscan

public void postscan(java.util.Deque<ScanToken> tokens,
                     CompositeComponent ancestor)
              throws java.io.IOException

Description copied from interface: PostScannable

Performs any required post-scanning for this component. This involves handling any information whose processing was deferred during the scan() method and stored in the token queue. The most common use of this method is to resolve the paths of component references, which may not have been created at the time of the initial scan() call.

Specified by:

postscan in interface PostScannable

Overrides:

postscan in class ModelComponentBase

Parameters:

tokens - token information that was stored during scan().

ancestor - ancestor component with respect to which reference component paths are defined.

Throws:

java.io.IOException - if an error is encountered (such as a reference to a non-existent component)

writeItems

public void writeItems(java.io.PrintWriter pw,
                       NumberFormat fmt,
                       CompositeComponent ancestor)
                throws java.io.IOException

Description copied from class: Probe

Write probe attributes to a PrintWriter

Parameters:

pw - writer to which components are written

fmt - format for floating point numbers

ancestor - ancestor component which respect to which references are expressed

Throws:

java.io.IOException - if an I/O error occurred

isInput

public boolean isInput()

Description copied from class: Probe

Returns true if this probe is an input probe, and false otherwise.

Overrides:

isInput in class Probe

Returns:

true if this is an input probe

setVsize

public void setVsize(int vsize)

getCopyReferences

public boolean getCopyReferences(java.util.List<ModelComponent> refs,
                                 ModelComponent ancestor)

Collects external references which must also be copied in order to duplicate this component. These references should exclude those which are contained within a specified component hierarchy. This method should return true if and only if CopyableComponent.isDuplicatable() returns true.

Parameters:

refs - list to which references are appended

ancestor - root node of the hierarchy from which references are to be excluded

Returns:

false if it is discovered that the component cannot be duplicated

copy

public ModelComponent copy(int flags,
                           java.util.Map<ModelComponent,ModelComponent> copyMap)

Description copied from interface: CopyableComponent

Create a copy of this component. If COPY_REFERENCES is set in flags, then any component referenced by this component should itself be set to a copy. This should be done first checking copyMap for an existing copy of the referenced component. If there is no existing copy, then a copy should be created by calling copy recursively and adding the new copy to copyMap.

Specified by:

copy in interface CopyableComponent

Overrides:

copy in class ModelComponentBase

Parameters:

flags - flags to control the copying

copyMap - map to possible existing instances of referenced components

Returns:

copy of this component