> For the complete documentation index, see [llms.txt](https://docs.proofofputt.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.proofofputt.com/compatibility-and-limitations.md).

# Compatibility & Limitations

Product descriptions and forecasts are brainstorming and planning

### Example Equipment:

### Does <mark style="color:red;">**NOT**</mark>**&#x20;f**unction: Flat putting mats with no return track

<figure><img src="https://1708870994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgJs8TNKnmm8uWx45nTMq%2Fuploads%2FCNeQY5fcqDvUQ1LbFrSL%2FDNF.png?alt=media&amp;token=a03138ca-33a1-4de5-bfb3-9046a1679ea6" alt=""><figcaption></figcaption></figure>

### Compatible Options - Ramp and return track

<figure><img src="https://1708870994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgJs8TNKnmm8uWx45nTMq%2Fuploads%2F23lyS99GyFBoqU4sWNhq%2FMats.1.SKLZ.png?alt=media&amp;token=fe016bd0-c482-488f-899a-7d3713a323f0" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1708870994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgJs8TNKnmm8uWx45nTMq%2Fuploads%2FJHHHjjj3AWG76niyuU22%2FMats.3.KalraMay.png?alt=media&amp;token=0238af02-8a04-4918-bd42-b434655fedf4" alt=""><figcaption></figcaption></figure>

Equipment - Putting mats with a ramp and return track

* Common form factor,  various length and quality of mat, material of the ramp or track.
  * Unlikely to change for many years to come

## Examples of operation:&#x20;

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgJs8TNKnmm8uWx45nTMq%2Fuploads%2FS74jfAV5pG90SBWGZOqV%2FSetup.And.Gameplay.mp4?alt=media&token=5e78619f-124a-4250-8990-6f018e1b31e3>" %}

## How it works:

#### Return Track Indicates Either Miss - Catch or Make conditions.

The **PUTTING MAT ROI** is used to define the area between the **RAMP ROI** and the camera.

* Best practice is to extend the region a couple of inches beyond the actual mat in case the ball is rolling off the ramp sideways.
  * A **MISS - RETURN** occurs when a ball passes from the **RAMP ROI** back into the **PUTTING MAT ROI**
    * **MISS - RETURN** classification includes **RAMP entry  ROI** & **RAMP exit ROI**
      * The center of the ball rolling off the matt could trigger a **MISS - TIMEOUT**
* A **QUICK PUTT** is classified as a **MISS.**
  * It is triggered by the presence of a ball detected in the **LEFT OF PUTTING MAT ROI** before a ball has either reached the **PUTTING MAT ROI** or **RETURN TRACK ROI**
* A **TIMEOUT** is classified as a **MISS**, and is triggered by a ball not being detected in either the **RETURN TRACK ROI** or **PUTTING MAT ROI** in 3 seconds.
  * The ball has rolled off the putting mat entirely or gotten stuck inside the ramp

The **CATCH ROI** is an out of bounds area beyond the hole or around it, which funnels the ball through a tunnel under the **RAMP ROI**, releasing into the **RETURN TRACK ROI**.

* At the time of a ball being detected in the return track, it is classified as a **MISS - CATCH**, regardless if the ball falls backwards into the hole.
  * Else, if the ball did not enter the **CATCH ROI**, it is a **MAKE** and the whole quadrant in which the ball passes into the **HOLE ROI** is recorded.
    * MAKES classification includes Hole quadrant and **RAMP entry ROI**
  * It is important to consider the direction of putts when submitting coordinates for the **RAMP ROI:** Top left first, then top right, bottom right, and bottom left last.
    * These inform the orientation of the hole quadrants: **LOW, LEFT, TOP, RIGHT**
      * They also calculate SUB-ROI segments for the **RAMP ROI: LEFT, CENTER, RIGHT**
* The IGNORE ROI is the area where the return track extends and the surrounding area.
  * This prevents tracking issues when multiple balls are on the screen at a time

## Example Equipment:

### Does <mark style="color:red;">**NOT**</mark>**&#x20;f**unction: Flat putting mats with no return track

<figure><img src="https://1708870994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgJs8TNKnmm8uWx45nTMq%2Fuploads%2FCNeQY5fcqDvUQ1LbFrSL%2FDNF.png?alt=media&amp;token=a03138ca-33a1-4de5-bfb3-9046a1679ea6" alt=""><figcaption></figcaption></figure>

### Compatible Options - Ramp and return track

<figure><img src="https://1708870994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgJs8TNKnmm8uWx45nTMq%2Fuploads%2F23lyS99GyFBoqU4sWNhq%2FMats.1.SKLZ.png?alt=media&amp;token=fe016bd0-c482-488f-899a-7d3713a323f0" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1708870994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgJs8TNKnmm8uWx45nTMq%2Fuploads%2FJHHHjjj3AWG76niyuU22%2FMats.3.KalraMay.png?alt=media&amp;token=0238af02-8a04-4918-bd42-b434655fedf4" alt=""><figcaption></figcaption></figure>
