Differences

This shows you the differences between two versions of the page.

--- visual3d:documentation:definitions:file_formats:sql_database_definition [2024/06/19 12:47] – sgranger
+++ visual3d:documentation:definitions:file_formats:sql_database_definition [2024/07/17 15:45] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{the exporting of data from visual3d requires an external database with a predefined data structure.
+====== SQL Database Definition ======
+The exporting of data from Visual3D requires an external database with a predefined data structure.
 \\
-there are no restrictions as to which database system is used since connection to it is provided by odbc connections. c-motion’s sample code is provided using visual basic for application in microsoft’s access database system.
+There are no restrictions as to which database system is used since connection to it is provided by ODBC connections. C-Motion’s sample code is provided using Visual Basic for Application in Microsoft’s Access database system.
 \\
-the data structure is normalized to eliminate redundant data entry. the specific data values for signals, metrics, and analog data, however, are stored in a large single string that must be parsed prior to using the data for analysis purposes. this approach was necessary due to the inherent speed limitations a relational database has with storing tremendous amounts of data.
+The data structure is normalized to eliminate redundant data entry. The specific data values for signals, metrics, and analog data, however, are stored in a large single string that must be parsed prior to using the data for analysis purposes. This approach was necessary due to the inherent speed limitations a relational database has with storing tremendous amounts of data.
 \\
-note that some rdbms systems may need add-on modules or extensions to support transforms or pivot table capabilities. ms access has the functionality built-in, so some example code provided by c-motion may not transfer directly to other systems.)
+Note that some RDBMS systems may need add-on modules or extensions to support Transforms or Pivot Table capabilities. MS Access has the functionality built-in, so some example code provided by C-Motion may not transfer directly to other systems.)
 \\
-the picture below illustrates the how the visual3d signal and event tree structure maps to database tables. the patient info table is provided as a sample illustration on where the relationship to patient information may be managed. the blob table is where the raw data is stored after the exporting process is done, and a raw data table is provided for the parsed results. sample database definitions and sample routines for parsing and managing data are provided by c-motion.
+The picture below illustrates the how the Visual3D signal and event tree structure maps to database tables. The Patient Info table is provided as a sample illustration on where the relationship to patient information may be managed. The BLOB table is where the raw data is stored after the exporting process is done, and a Raw Data table is provided for the parsed results. Sample database definitions and sample routines for parsing and managing data are provided by C-Motion.
 \\
-exporting_data_to_a_relational_database_doc_27915504.jpg
+{{:Exporting_Data_to_a_Relational_Database_doc_27915504.jpg}}
 \\
-==== table structure definition ====
+=== Table Structure Definition ===
-the actual sql database tables loosely follow the visual3d data tree layout, and are defined below:
+The actual SQL database tables loosely follow the Visual3D data tree layout, and are defined below:
-|**table name**      |**description**                                                                                                                                                                                                                                   |**columns**                                                                                                                                                                                    |
+|**TABLE NAME**      |**DESCRIPTION**                                                                                                                                                                                                                                   |**COLUMNS**                                                                                                                                                                                    |
-|l0_cmo              |contains the cmo file names.                                                                                                                                                                                                                      |cmoid = integer, auto-incrementing index\\ cmoname = text\\ patientid = link to a patient table (optional)                                                                                     |
+|L0_cmo              |Contains the CMO file names.                                                                                                                                                                                                                      |cmoID = Integer, auto-incrementing index\\ cmoName = Text\\ PatientID = link to a patient table (optional)                                                                                     |
-|l1_c3dfile          |the c3d files contained in each cmo file.                                                                                                                                                                                                         |fileid = integer, auto-incrementing index\\ cmoid = link to l0_cmo (foreign key)\\ filename = text                                                                                             |
+|L1_c3dfile          |The C3D files contained in each CMO file.                                                                                                                                                                                                         |fileID = Integer, auto-incrementing index\\ cmoID = link to L0_cmo (foreign key)\\ fileName = Text                                                                                             |
-|l2_type             |the signal or data type in each c3d file.\\ (examples are: target, event, analog, link_model_based, etc.)                                                                                                                                         |typeid = integer, auto-incrementing index\\ fileid = link to l1_c3dfile\\ type_name = text\\ (beware the “type” or “typename” may be reserved words in some rdbms programs)                    |
+|L2_type             |The signal or data TYPE in each C3D file.\\ (Examples are: TARGET, EVENT, ANALOG, LINK_MODEL_BASED, etc.)                                                                                                                                         |typeID = Integer, auto-incrementing index\\ fileID = link to L1_c3dfile\\ type_Name = Text\\ (beware the “type” or “typename” may be reserved words in some RDBMS programs)                    |
-|l2_events           |events associated with a c3d file. it has event names, frame numbers, and timestamps. no tables link back to this one.                                                                                                                            |eventid = integer, auto-incrementing index\\ fileid = link to l1_c3dfile\\ event_label = text\\ event_time = float\\ description = text\\ frame = integer                                      |
+|L2_events           |Events associated with a C3D file. It has event names, frame numbers, and timestamps. No tables link back to this one.                                                                                                                            |eventID = Integer, auto-incrementing index\\ fileID = link to L1_c3dfile\\ event_label = text\\ event_time = float\\ description = text\\ frame = integer                                      |
-|l3_folder           |the folder names holding signals for each type. (example is original or processed.)                                                                                                                                                               |folderid = integer, auto-incrementing index\\ typeid = link to l2_type\\ foldername = text                                                                                                     |
+|L3_folder           |The folder names holding signals for each type. (Example is ORIGINAL or PROCESSED.)                                                                                                                                                               |folderID = Integer, auto-incrementing index\\ typeID = link to L2_type\\ folderName = text                                                                                                     |
-|l4_name             |signal names in each folder, (but not the data)                                                                                                                                                                                                   |dnameid = integer, auto-incrementing index\\ folderid = link to l3_folder\\ dataname = text\\ history = long text                                                                              |
+|L4_name             |Signal names in each folder, (but not the data)                                                                                                                                                                                                   |dnameID = Integer, auto-incrementing index\\ folderID = link to L3_folder\\ dataName = text\\ history = long text                                                                              |
-|l5_framedata        |all the actual data (after parsing) for each l4_name.\\ \\ each row has a label and a value for each motion capture frame. for example, frame 1 may have 3 rows for x, y, and z values. that is why a pivot table is needed for analysis purposes.|frameid = integer, auto-incrementing index\\ dnameid = link to l4_name\\ framenum = integer\\ frametime = float\\ stepval = integer (# datavalues per frame)\\ label = text\\ datavalue = float|
+|L5_framedata        |All the actual data (after parsing) for each L4_name.\\ \\ Each row has a label and a value for each motion capture frame. For example, frame 1 may have 3 rows for X, Y, and Z values. That is why a pivot table is needed for analysis purposes.|frameID = Integer, auto-incrementing index\\ dnameID = link to L4_name\\ framenum = integer\\ frameTime = float\\ stepVal = integer (# dataValues per frame)\\ label = text\\ dataValue = float|
-|l6_framedata        |all the actual data (before parsing) for each l4_name.\\ \\ one row per l4_row of consolidated data and labels stored as a blob (or large text string).                                                                                           |l6id = integer, auto-incrementing index\\ dnameid = link to l4_name\\ parsed = boolean (optional yes/no indicator)\\ bigdata = blob or long text                                               |
+|L6_framedata        |All the actual data (before parsing) for each L4_name.\\ \\ One row per L4_row of consolidated data and labels stored as a BLOB (or large text string).                                                                                           |L6ID = Integer, auto-incrementing index\\ dnameID = link to L4_name\\ parsed = Boolean (optional yes/no indicator)\\ bigdata = BLOB or long text                                               |
-|patient\\ (optional)|a sample patient table for linking to cmo's. the fields in the samples are derived from old vcm data definitions.                                                                                                                                 |vcm also has a patient codes cross-reference table.                                                                                                                                            |
+|Patient\\ (OPTIONAL)|A sample patient table for linking to CMO's. The fields in the samples are derived from old VCM data definitions.                                                                                                                                 |VCM also has a Patient Codes cross-reference table.                                                                                                                                            |
-**sample sql scripts** to create this table structure are available for sql server, mysql, and ms access.
+**Sample SQL scripts** to create this table structure are available for SQL Server, MySQL, and MS Access.
 \\
-==== parsing raw data ====
+=== Parsing Raw Data ===
-the data exported from visual3d into a database is too complex and dynamic for a rapid database transfer. the overhead associated with sql insert commands is quite high, even with optimization. for that reason, the data is formatted into a delimited structure to make intelligent post-process parsing possible. for each signal, a database row is created consisting of the signal identifier (i.e. foreign key) and a big string of raw data. the raw data - whether target data per frame, analog data, or calculated metrics – is retrieved and parsed into the following structure.
+The data exported from Visual3D into a database is too complex and dynamic for a rapid database transfer. The overhead associated with SQL Insert commands is quite high, even with optimization. For that reason, the data is formatted into a delimited structure to make intelligent post-process parsing possible. For each signal, a database row is created consisting of the signal identifier (i.e. foreign key) and a big string of raw data. The raw data - whether target data per frame, analog data, or calculated metrics – is retrieved and parsed into the following structure.
 \\
@@ Line 49: / Line 51: @@
-==== signal example ====
+=== Signal Example ===
-for a target signal called “lank” we would see a row in the database for the signal name in l4_name table with a system generated id called dnameid and a dataname. for example: 849 “lank”
+For a target signal called “LANK” we would see a row in the database for the signal name in L4_name table with a system generated ID called dnameID and a dataname. For example: 849 “LANK”
 \\
-in the l6_framedata table, we would then see the raw data associated with “lank” represented as a row containing a system generated id, the foreign key linking back to the l4_name table, and the data string. for example, for signal 849 (i.e. “lank”), we would see 10 frames of data like this:
+In the L6_framedata table, we would then see the raw data associated with “LANK” represented as a row containing a system generated ID, the foreign key linking back to the L4_name table, and the data string. For example, for signal 849 (i.e. “LANK”), we would see 10 frames of data like this:
 \\
-849 ^1@x@0.106221@y@0.292641@z@1.214349@residual@0.000000@camera\\
+849 ^1@X@0.106221@Y@0.292641@Z@1.214349@Residual@0.000000@Camera\\
-bits@0.000000^2@x@0.106105@y@0.292334@z@1.214423@residual@0.000000@camera\\
+bits@0.000000^2@X@0.106105@Y@0.292334@Z@1.214423@Residual@0.000000@Camera\\
-bits@0.000000^3@x@0.106000@y@0.292041@z@1.214490@residual@0.000000@camera\\
+bits@0.000000^3@X@0.106000@Y@0.292041@Z@1.214490@Residual@0.000000@Camera\\
-bits@0.000000^4@x@0.105904@y@0.291758@z@1.214550@residual@0.000000@camera\\
+bits@0.000000^4@X@0.105904@Y@0.291758@Z@1.214550@Residual@0.000000@Camera\\
-bits@0.000000^5@x@0.105815@y@0.291485@z@1.214604@residual@0.000000@camera\\
+bits@0.000000^5@X@0.105815@Y@0.291485@Z@1.214604@Residual@0.000000@Camera\\
-bits@0.000000^6@x@0.105729@y@0.291216@z@1.214653@residual@0.000000@camera\\
+bits@0.000000^6@X@0.105729@Y@0.291216@Z@1.214653@Residual@0.000000@Camera\\
-bits@0.000000^7@x@0.105646@y@0.290951@z@1.214699@residual@0.000000@camera\\
+bits@0.000000^7@X@0.105646@Y@0.290951@Z@1.214699@Residual@0.000000@Camera\\
-bits@0.000000^8@x@0.105563@y@0.290686@z@1.214741@residual@0.000000@camera\\
+bits@0.000000^8@X@0.105563@Y@0.290686@Z@1.214741@Residual@0.000000@Camera\\
-bits@0.000000^9@x@0.105480@y@0.290420@z@1.214782@residual@0.000000@camera\\
+bits@0.000000^9@X@0.105480@Y@0.290420@Z@1.214782@Residual@0.000000@Camera\\
-bits@0.000000^10@x@0.105395@y@0.290150@z@1.214822@residual@0.000000@camera bits@0.000000
+bits@0.000000^10@X@0.105395@Y@0.290150@Z@1.214822@Residual@0.000000@Camera bits@0.000000
 \\
-this approach makes parsing the data fairly straightforward using the built-in parsing tools of today’s programming languages. for example, in visual basic, using the split command and direct access object (dao) methods for managing databases, the code to parse and store the data into the l5_framedata table would look like:
+This approach makes parsing the data fairly straightforward using the built-in parsing tools of today’s programming languages. For example, In Visual Basic, using the SPLIT command and Direct Access Object (DAO) methods for managing databases, the code to parse and store the data into the L5_framedata table would look like:
 \\
@@ Line 75: / Line 77: @@
 <code>
-dim recset as dao.recordset
+Dim recset As DAO.Recordset
-dim frames() as string
+Dim frames() As String
-dim frameparts() as string
+Dim frameparts() As String
-dim sqlstr as string
+Dim SQLstr As String
-dim frametime as double
+Dim frametime As Double
-dim i as integer
+Dim i As Integer
-dim x as integer
+Dim x As Integer
-    ‘ get the unparsed data signals
+    ‘ Get the unparsed data signals
-    set recset = currentdb.openrecordset _
+    Set recset = CurrentDb.OpenRecordset _
-("select * from l6_framedata where parsed = false;", dbopendynaset)
+("Select * from l6_framedata where parsed = False;", dbOpenDynaset)
-    do while (not recset.eof)
+    Do While (Not recset.EOF)
-    ‘ parse out the frames for this signal – by the ^ delimiter
+    ‘ Parse out the frames for this signal – by the ^ delimiter
-frames = split(recset!bigdata, "^")
+frames = Split(recset!bigdata, "^")
-        for i = 1 to ubound(frames)
+        For i = 1 To UBound(frames)
-         ‘ parse out the data for the frame, delimited by @
+         ‘ Parse out the data for the frame, delimited by @
          ‘ where framepart(0) is always the frame number and then label-value pairs follow
-            frameparts = split(frames(i), "@")
+            frameparts = Split(frames(i), "@")
-        ‘ store each signal component
+        ‘ Store each signal component
-            for x = 1 to ubound(frameparts) step 2
+            For x = 1 To UBound(frameparts) Step 2
-                sqlstr = "insert into l5_framedata “
+                SQLstr = "INSERT into l5_framedata “
-         sqlstr = sqlstr & " (dnameid, framenum, label, datavalue) values "
+         SQLstr = SQLstr & " (dnameID, framenum, label, dataValue) VALUES "
-                sqlstr = sqlstr & "(" & recset!dnameid & ", " & frameparts(0)
+                SQLstr = SQLstr & "(" & recset!dnameID & ", " & frameparts(0)
-         sqlstr = sqlstr & ", '" & frameparts(x) & "', " & frameparts(x+1)
+         SQLstr = SQLstr & ", '" & frameparts(x) & "', " & frameparts(x+1)
-         sqlstr = sqlstr & ");"
+         SQLstr = SQLstr & ");"
-                docmd.runsql sqlstr
+                DoCmd.RunSQL SQLstr
-            next
+            Next
-        next
+        Next
-        recset.movenext
+        recset.MoveNext
-    loop
+    Loop
 </code>
 \\
-note that this routine could potentially take a very long time to run since a sql insert is performed for every component of every frame of data.
+Note that this routine could potentially take a very long time to run since a SQL INSERT is performed for every component of every frame of data.
 \\
-however, once parsed and inserted into the l5_framedata table, it is very easy and fast to access the data for analysis. this is where pivot tables play an important role. they permit the dynamic storage of data components to be managed since it is impossible to accommodate a data structure for every potential digital and analog motion capture related signal generator.
+However, once parsed and inserted into the L5_framedata table, it is very easy and fast to access the data for analysis. This is where pivot tables play an important role. They permit the dynamic storage of data components to be managed since it is impossible to accommodate a data structure for every potential digital and analog motion capture related signal generator.
 \\
-however, pivot tables can be avoided if only certain information, in a consistant format is needed, then new tables can be created to improve the speed of the parsing process.
+However, pivot tables can be avoided if only certain information, in a consistant format is needed, then new tables can be created to improve the speed of the parsing process.
-}}