Skip to content

Commit 6052c6d

Browse files
authored
Fix c3dfileadapters docs (#2676)
* Fix doxygen comment that includes Python and Matlab code snippets * Add snippet for retrieval of individual tables from C3DFileAdapter * Update C3DFileAdapter.h Use variable not class name to invoke read, and use single quotes * Update C3DFileAdapter.h Update Matlab code snippet per PR review. * Update C3DFileAdapter.h Change quotes in Matalb snippet
1 parent 6917f51 commit 6052c6d

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

OpenSim/Common/C3DFileAdapter.h

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,29 +68,37 @@ class OSIMCOMMON_API C3DFileAdapter : public FileAdapter {
6868
C3DFileAdapter c3dFileAdapter;
6969
c3dFileAdapter.setLocationForForceExpression(C3DFileAdapter::ForceLocation::CenterOfPressure);
7070
auto tables = c3dFileAdapter.read("myData.c3d");
71+
auto markersTable = c3dFileAdapter.getMarkersTable(tables);
72+
auto forcesTable = c3dFileAdapter.getForcesTable(tables);
7173
\endcode
7274
7375
<b>Python example</b>
7476
\code{.py}
7577
import opensim
76-
C3DFileAdapter c3dFileAdapter;
78+
c3dFileAdapter = opensim.C3DFileAdapter()
7779
c3dFileAdapter.setLocationForForceExpression(opensim.C3DFileAdapter.ForceLocation_CenterOfPressure);
7880
tables = c3dFileAdapter.read("myData.c3d")
81+
markersTable = c3dFileAdapter.getMarkersTable(tables)
82+
forcesTable = c3dFileAdapter.getForcesTable(tables)
7983
\endcode
8084
8185
<b>Java example</b>
8286
\code{.java}
8387
C3DFileAdapter c3dFileAdapter = new C3DFileAdapter();
8488
c3dFileAdapter.setLocationForForceExpression(C3DFileAdapter.ForceLocation.CenterOfPressure);
8589
tables = c3dFileAdapter.read("myData.c3d");
86-
90+
TimeSeriesTableVec3 markersTable = c3dFileAdapter.getMarkersTable(tables);
91+
TimeSeriesTableVec3 forcesTable = c3dFileAdapter.getForcesTable(tables);
92+
8793
\endcode
8894
8995
<b>MATLAB example</b>
9096
\code{.m}
91-
C3DFileAdapter c3dFileAdapter;
97+
c3dFileAdapter = C3DFileAdapter();
9298
c3dFileAdapter.setLocationForForceExpression(1);
93-
tables = C3DFileAdapter.read("myData.c3d");
99+
tables = c3dFileAdapter.read('myData.c3d');
100+
markersTable = c3dFileAdapter.getMarkersTable(tables);
101+
forcesTable = c3dFileAdapter.getForcesTable(tables);
94102
\endcode
95103
*/
96104
enum class ForceLocation {

0 commit comments

Comments
 (0)