====== Hawkeye Processing Log File  ======

==== Overview ====
When the **Manage_Hawkeye_Processing** pipeline command runs, it creates a log file containing information about the signals created and any commands that failed during pipeline processing.

**Purpose:** This documentation explains the log file contents, which display real-time information each time the processing pipeline runs, allowing users to identify which signals were created and which failed.
----

==== Manage_Hawkeye_Processing ====
The following pipeline needs to be run in order for the log file to be created. 
<code>
Manage_Hawkeye_Processing
/ROOT_FOLDER=
! /ACTION=
! /TAGS=ACTION
/PROJECT=BATTING
/OUTPUT_DATA_FORMAT=XML
! /IMPORT_ANALOG_FILES=FALSE
! /MERGE_THEIA3D_FILES=FALSE
! /MERGE_THEIA3D_AND_OTHER_FILES=FALSE
/PRIMARY_SESSION_FOLDER=
! /PRIMARY_FILE_MASK=
! /PRIMARY_MODEL_MASK=
! /THEIA3D_PREFIX=
! /THEIA3D_SUBJECT_TAG=
! /OTHER3D_SESSION_FOLDER=
! /OTHER3D_FILE_MASK=
! /OTHER3D_MODEL_MASK=
! /OTHER3D_MODEL_TEMPLATE_MASK=
! /OTHER3D_PREFIX=
! /OTHER3D_SUBJECT_TAG=
! /NUMBER_OF_SESSION_FILES_ALLOWED=
! /GCVSPL_VARIANCE=
! /RECREATE_EVENTS=TRUE
! /QA_FORCE_ASSIGNMENTS=TRUE
! /OPEN_CMZ_LIBRARY=FALSE
! /SAVE_DEFAULT_CMZ_FILES=TRUE
! /REPORT_COMMAND=FALSE
! /REPORT_INFO=FALSE
! /REPORT_ERROR=FALSE
! /REPORT_WARNING=FALSE
/INPUT_FOLDER_STRUCTURE_PRIMARY=SESSION
! /INPUT_FOLDER_STRUCTURE_SECONDARY=DEFAULT
! /INPUT_FOLDER_STRUCTURE_STATIC=DEFAULT
! /VISUAL3D_PIPELINE_POST_MERGE=
! /VISUAL3D_PIPELINE_PREMERGE=
;
</code>
----
====Log File====
**Log File Naming & Location**\\
The log file name is the CMZ file name, date file was created, concatenated with "_log" : **CMZ file name_date_log.txt**. The log file will be saved in the same file directory as the created CMZ after running the pipeline. 
\\
\\
**Contents**\\
The log file will contain all the signal commands that were run, including model based signals and metric signals. 

For example, a command that ran successfully and created the correct signal, below the command will be list of the signals created (if multiple C3D files are being processed there will be a list of the same signals created for each file).\\
This line shows the right hip angle was created as a LINK_MODEL_BASED signal, since there is only 1 this means that there is only one file being processed: **LINK_MODEL_BASED::ORIGINAL::123456:RHIP_ANGLE**\\

<code>
Compute_Model_Based_Data
/RESULT_NAME=RHIP_ANGLE
/SUBJECT_TAG=ALL_SUBJECTS
/FUNCTION=JOINT_ANGLE
/SEGMENT=RTH
/REFERENCE_SEGMENT=RPV
/RESOLUTION_COORDINATE_SYSTEM=
;
!	LINK_MODEL_BASED::ORIGINAL::123456:RHIP_ANGLE
</code>
If using a command like Signal_Magnitude, the command might be run on various signals within 1 file, a list will be created showing which signals the command outputted successfully for each file being processed. Seen below a magnitude of the back hip speed and front hip speed was successfully created. 
<code>
Signal_Magnitude
/SIGNAL_TYPES=DERIVED
/SIGNAL_FOLDER=BAT
/SIGNAL_NAMES=BHIP_SPEED+FHIP_SPEED
/RESULT_TYPES=LINK_MODEL_BASED
/RESULT_FOLDERS=BAT
/RESULT_NAME=BHIP_SPEED+FHIP_SPEED
/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
;
!	DERIVED::BAT::123456:BHIP_SPEED
!	DERIVED::BAT::123456:FHIP_SPEED
!	
</code>


If a signal is failed to be created, ****FAILED**** will be shown, example shown below.
<code>
Event_Maximum
/RESULT_EVENT_NAME=PEAK_KNEE_ANGVEL
/SIGNAL_TYPES=LINK_MODEL_BASED
/SIGNAL_FOLDER=BAT
/SIGNAL_NAMES=FKNEE_ANGVEL
/SIGNAL_COMPONENTS=X
/EVENT_SEQUENCE=SWING
/EVENT_INSTANCE=1
/FRAME_WINDOW=20
;
!	********* FAILED ***************
</code>