# Get3D Engine

## 1 Principles of Engine

Get3D Engine features a monitoring function for quickly checking engine status, utilization, and modifying settings. Users can adjust configurations such as the "job queue directory," "cache directory," "engine capabilities," and control the engine with "start/stop" options.

* <mark style="color:purple;background-color:purple;">**Job Queue Directory:**</mark> Defines the job path of the current project, the jobs submitted by the current project are stored under this path, waiting for the engine to accept the processing.
* <mark style="color:purple;background-color:purple;">**Cache Directory:**</mark> Stores temporary files during job processing, the path needs to be set to the local disk.

In the Get3D Mapper main interface, the **Job Queue Directory** is used to store submitted jobs. The Get3D Engine retrieves jobs submitted by Get3D Mapper from the **Job Queue Directory**. The engine reads job information (e.g., AT\_job/Reconstruction\_job), processes the jobs, and outputs the results.

<figure><img src="https://2468521665-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXWiwWKjbM3enZNnTnsmE%2Fuploads%2FX2CsaDMTYtqSrHAW8jnw%2Fimage.png?alt=media&#x26;token=724365a1-3cca-4974-a5c1-b09ea98d0f7e" alt=""><figcaption><p>Job Queue Setting</p></figcaption></figure>

<figure><img src="https://2468521665-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXWiwWKjbM3enZNnTnsmE%2Fuploads%2Fe7fsMovPhHw5Qd13qQGt%2Fimage.png?alt=media&#x26;token=f98d3a96-70bc-4c3d-ba9d-7f73da4bd0e0" alt=""><figcaption><p>Engine Setting</p></figcaption></figure>

## 2 Engine Monitoring Panel

The Engine Monitoring Panel at the bottom of Get3D Mapper displays the job queue and engine status.

<figure><img src="https://2468521665-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXWiwWKjbM3enZNnTnsmE%2Fuploads%2FCKZ6tPcl9Dx2MwSMMimi%2Fimage.png?alt=media&#x26;token=7339d6a3-98d2-4808-af13-7f90189cc733" alt=""><figcaption><p>Engine Monitoring Panel</p></figcaption></figure>

<table><thead><tr><th width="182">Function</th><th>Description</th><th data-hidden></th></tr></thead><tbody><tr><td>Job Queue Directory</td><td>Current job queue directory, where the project's jobs are stored.</td><td></td></tr><tr><td>Engines</td><td>The number of engines in the current job queue directory.</td><td></td></tr><tr><td>Running Engines</td><td>The number of running engines in the current job queue directory.</td><td></td></tr><tr><td>Refresh</td><td>Refresh engine status</td><td></td></tr><tr><td>Job Queue Setting</td><td>Set the job queue for project. Cannot be changed when engine is running.</td><td></td></tr><tr><td>Engine Setting</td><td>Set the job queue for the engine to receive jobs.</td><td></td></tr><tr><td>Start Local Engine</td><td>Start the local engine. </td><td></td></tr><tr><td>Local Engine</td><td><p>The status of the local engine includes four states: </p><p>None: Engine is not started.<br>Pending: Engine is waiting to accept jobs.</p><p>Running: Engine is processing jobs</p><p>Inconsistent path: The engine's job queue directory differs from the project job queue. </p></td><td></td></tr></tbody></table>

## 3 Get3D Engine Interface

Get3D Engine interface has two module: Engine Information and Engine Log

<figure><img src="https://2468521665-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXWiwWKjbM3enZNnTnsmE%2Fuploads%2FRLIQ9vbgI1zQ7qOGCrBr%2F8c12f73aacc7cd65d73a482721989066.png?alt=media&#x26;token=b25a7bfb-8864-4219-a038-7e3946f5f7ab" alt=""><figcaption><p>Get3D Engine Interface</p></figcaption></figure>

The Engine Information module contains host name, IP address, engine version, engine status, engine capability, job queue directory, cache directory, cache space, CPU utilization, memory utilization, and GPU memory utilization.

<table><thead><tr><th width="260">Function</th><th>Description</th></tr></thead><tbody><tr><td><strong>Host Name</strong></td><td>Device name</td></tr><tr><td><strong>IP Address</strong></td><td>Device IP address</td></tr><tr><td><strong>Engine Version</strong></td><td>Get3D Engine version</td></tr><tr><td><strong>Engine Status</strong></td><td>Stop(closed), Waiting(opened without accepting a task), Running(task running), Abnormal (exited abnormally)</td></tr><tr><td><strong>Engine Capability</strong></td><td>Set the engine capability, the engine only processes jobs with this processing capability. AT: extract points, matching, small block bundle, overall bundle; Reconstruction</td></tr><tr><td><strong>Job Queue Directory</strong></td><td>Set directory for engine to receive jobs</td></tr><tr><td><strong>Cache Directory</strong></td><td>Set engine cache directory</td></tr><tr><td><strong>Cache Space Remaining</strong></td><td>Project cache disk, used space/hard drive space</td></tr><tr><td><strong>CPU Utilization</strong></td><td>CPU usage percentage</td></tr><tr><td><strong>Memory Utilization</strong></td><td>Memory, used memory/node memory</td></tr><tr><td><strong>GPU Utilization</strong></td><td>Video memory, used video memory/node video memory</td></tr></tbody></table>

## 4 Get3D Engine Setting

The engine setting function is in the node information list, right-click to jump out, the setting function is shown in the figure below:

<figure><img src="https://2468521665-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXWiwWKjbM3enZNnTnsmE%2Fuploads%2FNz3HKeVHUXUND6yKQvGR%2F950362f691c554c2ab04d2cf76cf3d08.png?alt=media&#x26;token=112e29ce-a4a0-42e7-bc9e-5b0cae6b1218" alt=""><figcaption><p>Set Engine</p></figcaption></figure>

<table><thead><tr><th width="280">Function</th><th>Description</th></tr></thead><tbody><tr><td><strong>Refresh Engine Information</strong></td><td>Refresh engine CPU, memory, GPU utilization, engine status, cache directory space remaining information</td></tr><tr><td><strong>Modify Job Queue Directory</strong></td><td>Modify the job queue directory of engine</td></tr><tr><td><strong>Modify Cache Directory</strong></td><td>Modify the cache directory of project</td></tr><tr><td><strong>Set Engine Capabilities</strong></td><td>Acquire the capability to receive AT/reconstruction jobs</td></tr><tr><td><strong>Start Engine</strong></td><td>Start accepting jobs</td></tr><tr><td><strong>Stop Engine</strong></td><td>Stop accepting jobs</td></tr></tbody></table>
