artisynth.core.probes

Class TRCReader

java.lang.Object

artisynth.core.probes.TRCReader

public class TRCReader
extends java.lang.Object

Reads a TRC (Track-Row-Column) marker data file. This file format is defined by the Motion Analysis Corporation and described in the appendix of the manual for their EVaRT software.

Once read, marker data is exposed via a MarkerMotionData structure.

Constructor Summary

Constructors

Constructor and Description
TRCReader(java.io.File file) Creates a TRCReader for the indicated file.
TRCReader(java.io.InputStream is) Creates a TRCReader for an specified input stream.
TRCReader(java.lang.String filePath) Creates a TRCReader for the indicated file path.

Method Summary

Modifier and Type	Method and Description
void	close() If the reader was created with an input stream instead of a file, closes the input stream.
PositionInputProbe	createInputProbe(java.lang.String name, java.util.Collection<? extends Point> points, boolean useTargetProps, double startTime, double stopTime) Constructs a PositionInputProbe for the specified points based on the TRC data.
static PositionInputProbe	createInputProbe(java.lang.String name, java.util.Collection<? extends Point> points, java.io.File trcFile, boolean useTargetProps) Constructs a PositionInputProbe for the specified points based on data in the supplied TRC file.
static PositionInputProbe	createInputProbeFromLabels(java.lang.String name, java.util.Collection<? extends Point> points, java.util.List<java.lang.String> labels, java.io.File trcFile, boolean useTargetProps) Constructs a PositionInputProbe for the specified points based on data in the supplied TRC file.
PositionInputProbe	createInputProbeUsingLabels(java.lang.String name, java.util.Collection<? extends Point> points, java.util.List<java.lang.String> labels, boolean useTargetProps, double startTime, double stopTime) Constructs a PositionInputProbe for the specified points based on the TRC data.
double	getFrameTime(int fidx) Returns the time of the fidx-th frame in the TRC data.
int	getMarkerIndex(java.lang.String label) Returns the index of the indicated marker in the TRC data.
java.util.ArrayList<java.lang.String>	getMarkerLabels() Returns a list of the marker labels in the TRC data, or an empty list if readData() has not yet been called.
Point3d	getMarkerPosition(int fidx, int midx) Returns the position of the midx-th marker in the fidx-th frame of the TRC data.
Point3d	getMarkerPosition(int fidx, java.lang.String label) Returns the position of the named marker in the fidx-th frame of the TRC data.
java.util.ArrayList<Point3d>	getMarkerPositions(int fidx) Returns all the marker positions in the fidx-th frame of the TRC data.
void	getMarkerPositions(VectorNd mpos, int fidx) Returns all the marker positions in the fidx-th frame of the TRC data, loading the data into the composite vector mpos.
MarkerMotionData	getMotionData()
int	getNumFrames() Deprecated. Use numFrames() instead.
int	getNumMarkers() Deprecated. Use numMarkers() instead.
static void	main(java.lang.String[] args)
int	numFrames() Returns the number of frames in the TRC data, or 0 if readData() has not yet been called.
int	numMarkers() Returns the number of markers in the TRC data, or 0 if readData() has not yet been called.
void	readData() Reads the TRC data from the file or input stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

TRCReader

public TRCReader(java.io.InputStream is)

Creates a TRCReader for an specified input stream.

Parameters:

is - inout stream for reading the TRC data

TRCReader

public TRCReader(java.io.File file)
          throws java.io.IOException

Creates a TRCReader for the indicated file.

Parameters:

file - TRC file to be read

Throws:

java.io.IOException

TRCReader

public TRCReader(java.lang.String filePath)
          throws java.io.IOException

Creates a TRCReader for the indicated file path.

Parameters:

filePath - path name of the TRC file to be read

Throws:

java.io.IOException

Method Detail

getMotionData

public MarkerMotionData getMotionData()

getNumFrames

public int getNumFrames()

Deprecated. Use numFrames() instead.

numFrames

public int numFrames()

Returns the number of frames in the TRC data, or 0 if readData() has not yet been called.

Returns:

number of frames read

getNumMarkers

public int getNumMarkers()

Deprecated. Use numMarkers() instead.

numMarkers

public int numMarkers()

Returns the number of markers in the TRC data, or 0 if readData() has not yet been called.

Returns:

number of markers

getMarkerLabels

public java.util.ArrayList<java.lang.String> getMarkerLabels()

Returns a list of the marker labels in the TRC data, or an empty list if readData() has not yet been called.

Returns:

list of marker labels

getFrameTime

public double getFrameTime(int fidx)

Returns the time of the fidx-th frame in the TRC data. Note that fidx is 0-based, and so will be one less than the corresponding frame number in the data. An exception will be thrown if if readData() has not yet been called.

Returns:

frame time at index fidx

getMarkerPosition

public Point3d getMarkerPosition(int fidx,
                                 int midx)

Returns the position of the midx-th marker in the fidx-th frame of the TRC data. Note that midx and fidx are both 0-based, and so fidx will be one less than the corresponding frame number in the data. An exception will be thrown if readData() has not yet been called.

Returns:

position of marker idx in frame fidx. Should not be modified.

getMarkerPosition

public Point3d getMarkerPosition(int fidx,
                                 java.lang.String label)

Returns the position of the named marker in the fidx-th frame of the TRC data. Note that fidx is 0-based, and so will be one less than the corresponding frame number in the data. null will be returned if the marker is not found or readData() has not yet been called.

Returns:

position of marker idx in frame fidx. Should not be modified.

getMarkerPositions

public java.util.ArrayList<Point3d> getMarkerPositions(int fidx)

Returns all the marker positions in the fidx-th frame of the TRC data. Note that fidx is 0-based, and so will be one less than the corresponding frame number in the data. An exception will be thrown if readData() has not yet been called.

Returns:

all marker positions for frame fidx. Should not be modified.

getMarkerPositions

public void getMarkerPositions(VectorNd mpos,
                               int fidx)

Returns all the marker positions in the fidx-th frame of the TRC data, loading the data into the composite vector mpos. If necessary, mpos will be resized to 3 m, where m is the number of markers. Note that fidx is 0-based, and so will be one less than the corresponding frame number in the data. An exception will be thrown if readData() has not yet been called.

Parameters:

mpos - returns all marker positions for frame fidx. Is resized if necessary.

getMarkerIndex

public int getMarkerIndex(java.lang.String label)

Returns the index of the indicated marker in the TRC data. -1 will be returned if the marker is not found or readData() has not yet been called.

Parameters:

label - name of the desired marker

Returns:

index of the marker within the data

readData

public void readData()
              throws java.io.IOException

Reads the TRC data from the file or input stream. Must be called after the reader is created in order actually read in the data.

Throws:

java.io.IOException

close

public void close()

If the reader was created with an input stream instead of a file, closes the input stream. (Streams created for files are closed automatically inside readData.

main

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

createInputProbeUsingLabels

public PositionInputProbe createInputProbeUsingLabels(java.lang.String name,
                                                      java.util.Collection<? extends Point> points,
                                                      java.util.List<java.lang.String> labels,
                                                      boolean useTargetProps,
                                                      double startTime,
                                                      double stopTime)

Constructs a PositionInputProbe for the specified points based on the TRC data. The argument labels gives the labels of the TRC marker data that should be used for each point; if labels is null, then each point's name is used instead. If the specified label (or point name) is not found in the TRC data, an exception is thrown.

If the first TRC frame does not have a time of 0, this initial time will be subtracted from the time for the probe data (so that the probe data will begin at time 0).

Parameters:

name - if non-null, gives the name of the probe

points - points to be controlled by the probe

labels - if non-null, gives labels of the TRC marker data that should be used for the points.

useTargetProps - if true, causes the probe to bind to the point's targetPosition property instead of position

startTime - start time of the probe

stopTime - stop time of the probe

createInputProbe

public PositionInputProbe createInputProbe(java.lang.String name,
                                           java.util.Collection<? extends Point> points,
                                           boolean useTargetProps,
                                           double startTime,
                                           double stopTime)

Constructs a PositionInputProbe for the specified points based on the TRC data. The data for each of the n points is taken from the data for the first n markers, regardless of their labels. The number of markers in the TRC data must therefore equal or exceed n. If the first TRC frame does not have a time of 0, this initial time will be subtracted from the time for the probe data (so that the probe data will begin at time 0).

Parameters:

name - if non-null, gives the name of the probe

points - points to be controlled by the probe

useTargetProps - if true, causes the probe to bind to the point's targetPosition property instead of position

startTime - start time of the probe

stopTime - stop time of the probe

createInputProbeFromLabels

public static PositionInputProbe createInputProbeFromLabels(java.lang.String name,
                                                            java.util.Collection<? extends Point> points,
                                                            java.util.List<java.lang.String> labels,
                                                            java.io.File trcFile,
                                                            boolean useTargetProps)
                                                     throws java.io.IOException

Constructs a PositionInputProbe for the specified points based on data in the supplied TRC file. The start time is set to 0 and the stop time is inferred from the TRC data. Otherwise the probe is constructed in the same manner as described for createInputProbeUsingLabels(String,Collection,List,boolean,double,double).

Parameters:

name - if non-null, gives the name of the probe

points - points to be controlled by the probe

labels - if non-null, gives labels of the TRC marker data that should be used for the points.

trcFile - TRC file providing the probe data.

useTargetProps - if true, causes the probe to bind to the point's targetPosition property instead of position

Throws:

java.io.IOException

createInputProbe

public static PositionInputProbe createInputProbe(java.lang.String name,
                                                  java.util.Collection<? extends Point> points,
                                                  java.io.File trcFile,
                                                  boolean useTargetProps)
                                           throws java.io.IOException

Constructs a PositionInputProbe for the specified points based on data in the supplied TRC file. The start time is set to 0 and the stop time is inferred from the TRC data. Otherwise the probe is constructed in the same manner as described for createInputProbe(String,Collection,boolean,double,double).

Parameters:

name - if non-null, gives the name of the probe

points - points to be controlled by the probe

trcFile - TRC file providing the probe data.

useTargetProps - if true, causes the probe to bind to the point's targetPosition property instead of position

Throws:

java.io.IOException