Log files
==========


| Log files help analyze a flight for documentation or for trouble shooting purposes.
| There are two kinds of log files:

- log files for the individual project
- log files for each flight mission


.. _image-takings_file:

Image takings file
------------------

The file is stored within the TOPOFLIGHT project and is named ``<ProjectName>_ImageTakings.txt``. Each time SensorHandler reopens the same project, it adds a new header line before the image takings entries.

Here is an example of an image takings file:

.. image:: ../../pics/navigator/logfiles/NG_image_takings1.png
  :width: 700

...

.. image:: ../../pics/navigator/logfiles/NG_image_takings2.png
  :width: 700

| 

The file has the following structure:

.. list-table::
   :widths: 30 70
   :header-rows: 1

   * - Property name
     - Description
   * - LineID
     - :ref:`Flight line number <line-numbering>`
   * - SegmentID
     - :ref:`Flight line segment number <line-numbering>`
   * - ImageID
     - Image number
   * - FotoID
     - ID originating from the sensor (e.g. Ultracam photo ID)
   * - Event ID
     - GPS/IMU event ID
   * - Images per line
     - Number of images taken on flight line
   * - Index
     - deprecated
   * - date
     - Date the images where taken (YYMMDD)
   * - time
     - UTC time (hhmmss.sss)
   * - tick
     - Computer time in milliseconds since computer was started
   * - GPSWeek
     - GPS week timestamp
   * - GPSSec
     - GPS second (seconds since begin of the GPS week)
   * - long
     - Longitude of image location
   * - lat
     - Latitude of image location
   * - altitude
     - Altitude of image location
   * - Pitch
     - Pitch angle [degrees]
   * - Roll
     - Roll angle [degrees]
   * - Heading
     - Yaw angle [degrees]
   * - Sun angle
     - Angle of the sun at the time the image was taken [degrees]
   * - simulation
     - This field is used for various use cases:

       - 0 - standard case, image was taken while flying
       - 1 - the image was taken while NAVIGATOR was in simulation mode
       - 4 - as in 0 but marked to be retaken
       - 5 - as in 1 but marked to be retaken
       - 16 - as in 0 but camera not OK
       - 17 - as in 1 but camera not OK

   * - Sensor type
     - | UltraCams: *ucam*
       | Riegl: *Riegl*
       | all other cases: (empty)
   * - Image status
     - Status of the UltraCam image. It can be a combination of the following values:

       - 0 - ok
       - 1 - overexposure
       - 2 - underexposure
       - 4 - blurred
       - 8 - data issue

   * - Camera type
     - | UltraCams: Camera version name
       | all other cases: (empty)





Image taking sequence file
--------------------------

This file is similar to the :ref:`image-takings_file` and is stored in the project folder.
The main distinction lies in the file structure:

.. image:: ../../pics/navigator/logfiles/NG_image_taking_sequence.png

This file format is retained only for backward compatibility. |Navigation Software name| does not use it.

SOMAG giro mount log file
-------------------------

All gimbal data sent by the SOMAG mount is stored in a text file in the project folder. The file is named ``<ProjectName>-Gimbal-somag.txt``.
This file will only be populated if the SOMGA mount is controlled directly by SensorHandler.


Log files belonging to the flight mission
-----------------------------------------

As soon as SensorHandler is started it creates a log file to store the position, speed and sensor behavior. In case of an issue, this file has to be submitted to the support person.
The file has the following naming: ``YYMMDD-HHMM.txt``

**Example:**
The file ``200712-1009.txt`` was created on the 12th of July 2020 at 10:09 am. This was the time at which SensorHandler was started.


.. _accessing-log-files:

Accessing the log files
------------------------

.. topic:: Accessing the log files

    #. The log files can be found using the file explorer. The best way is to click on the **Log Files** button in SensorHandler:
      
       .. image::  ../../pics/navigator/logfiles/NG_log_files.png
        :width: 200
    
    #. After clicking the **Log Files** button the following dialog appears:

       .. image::  ../../pics/navigator/logfiles/NG_log_files1.png


.. rubric:: Project information

The path of the currently selected project is shown. Clicking on the **Open file path** button launches the file explorer to the project folder. There, the file ``ImageTakings.txt`` and
``ImageTakingsSequence.txt`` can be found.

.. image::  ../../pics/navigator/logfiles/NG_project_information.png


.. rubric:: Log file of track

.. image::  ../../pics/navigator/logfiles/NG_log_file_track.png


.. rubric:: Image Takings file of the project

Click this button to access the :ref:`image-takings_file`.

.. image::  ../../pics/navigator/logfiles/NG_image_takings_file.png


.. rubric:: Export log files

Click this button to export a selected flying date with the corresponding :ref:`image-takings_file` and mission log file to a zip compressed file.

.. image::  ../../pics/navigator/logfiles/NG_image_takings_file.png