Newer
Older
FRGC_PARSER
======================
This project reads in data from the frgc database on the MSU HPCC and allows a user
to export the data in a custom format.
-----------------------------------
To access data from the FRGC, create a class that inherets from "AbstractParser"
and create "write" method that outputs the data in your desired format.
The "AbstractParser" holds FRGC data in an instance variable called "registry".
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
Therefore your "write" method must use this registry variable when writing
the data.
The "registry" is a dictionary of items with individual registry IDs
as keys which map to a specific FrgcSession object. These registry IDs are not
to be confused with subject IDs, registry IDs are the numbers that map one
<presentation> from a signature-set to its <Recording> in the metadata file.
An FrgcSession object holds a session's:
- subject_ID
- image_filename
- image_file_format
- points_record (Record object)
The points_record is a custom Record object that holds a session's:
- capturedate
- points (list of tuples of the form: (point_name, x-coord, y-coord))
To use your new class to store data, create and instance of the class and call
the 'write' method.
CHANGING SIGNATURE-SETS
-----------------------------------
The 'registry' dictionary is created based on default paths to the Frgc database
unless you specify these paths with command line options.
No matter what script you run when using the frgc_parser, any C.L. options you
specify will be read in by the constants.py script.
These commands are:
-h, --help show this help message and exit
-n PATH, --nd1=PATH full path to directory CONTAINING the nd1 folder
-b PATH, --bee-dist=PATH full path of the BEE_DIST directory
-s PATH, --sig-set=PATH full path of the desired signature_set
-e NUM, --experiment=NUM FRGC experiment number to use [ex: 2.0.4]
-t TYPE, --experiment-type=TYPE FRGC experiment type (Orig, Qeury, Target, or Training)
If used, options -e and -t must always be used together and cannot be present
if the -s option is used.