Skip to content

Commit

Permalink
Updated Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
robotastic committed Jun 11, 2024
1 parent 1004b64 commit 9f077b9
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 20 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright (c) 2020-2023 IQT Labs LLC, All Rights Reserved.
Copyright (c) 2020-2024 IQT Labs LLC, All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
31 changes: 12 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,39 +26,32 @@

<br />
<div align="center">
<a href="https://iqtlabs.org/">
<a href="https://iqt.org">
<img src="images/logo.png" alt="Logo" width="331" height="153"/>
</a>
</div>

<h1 align="center">EdgeTech Occlusion Mapper</h1>

This repo is designed to be part of a SkyScan system. SkyScan automatically points a Pan Tilt Zoom (PTZ) camera at an aircraft based on the location information broadcast in an ADS-B message. Occlusion Mapper lets you record that area around a Pan Tilt Zoom camera that is a blocked by something in the way, like a building or trees. It produces an array of Azimuth and Elevation values. This array provides what is the lowest possible elevation that can be used at a given azimuth.
This repo is designed to be part of a SkyScan system. SkyScan automatically points a Pan Tilt Zoom (PTZ) camera at an aircraft based on the location information broadcast in an ADS-B message. Occlusion Mapper lets you map out objects that are blocking the view of a PTZ camera so that they can be avoided. It produces an array of Azimuth and Elevation values. This array provides what is the lowest possible elevation that can be used at a given azimuth.


## Running Things
Occlusion Mapper is available as a Docker Image on Docker Hub. Unless you are looking on making modifications to the code, you can just use the Docker Image that is available there. The included [docker-compose](./docker-compose.yaml) file provides an example of how to use that file.
## Usage


The [occlusion-mapper.env](./occlusion-mapper.env) file provides the set of environment variables that need to be set. Save a copy this file as `.env` and then modify it for your local install. You will probably need to change the Project & Device names, along with the IP address for the camera.
Download the [SkyScan](https://github.com/IQTLabs/SkyScan) Repo. In that repo run: `docker compose -f docker-compose -occlusion.yaml`

If the container is running locally, navigate to: [http://localhost:5000](http://localhost:5000) in your browser.

## Usage

Launch the container using Docker Compose: `docker compose up`
Otherwise, if the container is running on another machine, navigate to that IP address with port 5000. For example: `http://192.168.1.111:5000`

If the container is running locally, navigate to: [http://localhost:5000](http://localhost:5000) in your browser.
This will bring up a rudimentary web interface that lets you control the camera and record different Azimuth/Elevation values. To map out the occlusions around your camera:

Otherwise, if the container is running on another machine, navigate to that IP address with port 5000. For example: `http://192.168.1.111:5000`
1. Starting at 0° azimuth, find the camera elevation where you begin to have a clear view of the sky in the middle of the screen.
1. Next hit the **Add Point** button to record this value. The Graph at the bottom of the screen should update with this value.
1. Move the camera to the right. If the center of the frame no longer lines up with where planes would begin to be visible, adjust the Elevation and then hit **Add Point**
1. Continue this process until you have arrive back at 0° azimuth

This will bring up a rudimentary web interface that lets you control the camera and record different Azimuth/Elevation values. To map out the ooclusions around your camera:

1. Starting at 0° azimuth, find the camera elevation where you begin to have a clear view of the sky in the middle of the screen.
1. Next hit the **Add Point** button to record this value. The Graph at the bottom of the screen should update with this value.
1. Move the camera to the right. If the center of the frame no longer lines up with where planes would begin to be visible, adjust the Elevation and then hit **Add Point**
1. Continue this process until you have arrive back at 0° azimuth



### Built With

Expand All @@ -68,7 +61,7 @@ This repo is designed to be part of a SkyScan system. SkyScan automatically poin

## License

Distributed under the [Apache 2.0](https://github.com/IQTLabs/edgetech-template/blob/main/LICENSE). See `LICENSE.txt` for more information.
Distributed under the [Apache 2.0](https://github.com/IQTLabs/edgetech-occlusion-mapper/blob/main/LICENSE). See `LICENSE.txt` for more information.

## Contact IQTLabs

Expand Down
Binary file modified images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9f077b9

Please sign in to comment.