artisynth.core.probes

Class TRCWriter

java.lang.Object

artisynth.core.probes.TRCWriter

public class TRCWriter
extends java.lang.Object

Writes 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.

At present, the source data for writing the file must be a numeric probe that contains position data for a set of points.

Constructor Summary

Constructors

Constructor and Description
TRCWriter(java.io.File file) Creates a TRCWriter for the indicated file.
TRCWriter(java.lang.String filePath) Creates a TRCWriter for the indicated file path.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getNumberFormat() Queries the explict format for floating point data written by this writer.
java.lang.String	getUnitsString() Queries the string representing units in this writer.
void	setNumberFormat(java.lang.String str) Sets an explicit format for floating point data written by this writer.
void	setUnitsString(java.lang.String str) Sets the string representing units in this writer.
static void	write(java.io.File file, NumericProbeBase probe, java.util.List<java.lang.String> labels) Writes a TRC file based on the contents of a given numeric probe, which is assumed to contain point position data.
static void	write(java.lang.String filepath, NumericProbeBase probe, java.util.List<java.lang.String> labels) Writes a TRC file based on the contents of a given numeric probe, which is assumed to contain point position data.
void	writeData(NumericProbeBase probe, java.util.List<java.lang.String> labels) Writes the file based on the contents of a position input probe.

Methods inherited from class java.lang.Object

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

Constructor Detail

TRCWriter

public TRCWriter(java.io.File file)

Creates a TRCWriter for the indicated file.

Parameters:

file - TRC file to be written

TRCWriter

public TRCWriter(java.lang.String filePath)

Creates a TRCWriter for the indicated file path.

Parameters:

filePath - path name of the TRC file to be written

Method Detail

getUnitsString

public java.lang.String getUnitsString()

Queries the string representing units in this writer.

Returns:

string representing units

setUnitsString

public void setUnitsString(java.lang.String str)

Sets the string representing units in this writer. The default is "mm".

Parameters:

str - string representing units

getNumberFormat

public java.lang.String getNumberFormat()

Queries the explict format for floating point data written by this writer. If no explicit format has been set (by setNumberFormat(java.lang.String)) null is returned.

Returns:

floating point format

setNumberFormat

public void setNumberFormat(java.lang.String str)

Sets an explicit format for floating point data written by this writer. str should be a number string used for specifying NumberFormat. If str is null, the explicit format is removed and the format is inferred from the data.

Parameters:

str - string describing the number format

writeData

public void writeData(NumericProbeBase probe,
                      java.util.List<java.lang.String> labels)
               throws java.io.IOException

Writes the file based on the contents of a position input probe. The marker data is provided by the position data of each point associated with the probe. "position data" is any property that has a dimension of three and the name "position" or "targetPosition". Also, each point may be associated with only one such property.

The marker count and data rate is inferred from the probe. If labels is non-null, it provides labels for the marker data within the file and should have a length equal to the number of points. Otherwise, if labels is null, labels are determined from the names of the points, or when these are null, by appending "mkr" to $k+1$, where $k$ is the zero-based index of the marker.

Parameters:

probe - probe containing the marker data

labels - if non-null, provides labels for the TRC markers

Throws:

java.io.IOException

write

public static void write(java.io.File file,
                         NumericProbeBase probe,
                         java.util.List<java.lang.String> labels)
                  throws java.io.IOException

Writes a TRC file based on the contents of a given numeric probe, which is assumed to contain point position data. The marker count, labels and data rate is inferred from the probe and the labels argument, as described for writeData(artisynth.core.probes.NumericProbeBase, java.util.List<java.lang.String>).

Parameters:

file - TRC file to be created

probe - numeric probe containing the data

labels - if non-null, provides labels for the TRC markers

Throws:

java.io.IOException

write

public static void write(java.lang.String filepath,
                         NumericProbeBase probe,
                         java.util.List<java.lang.String> labels)
                  throws java.io.IOException

Writes a TRC file based on the contents of a given numeric probe, which is assumed to contain point position data. The marker count, labels and data rate is inferred from the probe and the labels argument, as described for writeData(artisynth.core.probes.NumericProbeBase, java.util.List<java.lang.String>).

Parameters:

filepath - path name of the TRC file to be created

probe - numeric probe containing the data

labels - if non-null, provides labels for the TRC markers

Throws:

java.io.IOException