Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Schellenberg3 committed Nov 15, 2023
1 parent 7bbfafe commit 051987a
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
*.stl binary
*.png binary

* text=auto eol=lf
*.{cmd,[cC][mM][dD]} text eol=crlf
Expand Down
46 changes: 43 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,45 @@
# ForgeScan
# 🔥🔨 ForgeScan 🤖📸

The ForgeScan project is targeted for autonomous sensing in environments requiring quick, iterative, and approximate or focused geometric measurements using vision sensors. Based on a user's configuration, this project will generate a computation representation and autonomously select the next best view until the representation is satisfactory. The system will utilize any prior information provided and users may specify areas which require particular attention.
ForgeScan is a library for developing voxelized reconstructions and next-best view selection policies.

This project is still in early development and subject to major changes. Consider is pre-alpha.
Autonomous robotics systems rely on digital reconstructions of environments and objects to make
decisions. Whether navigating in an evolving space or interacting with a new object, a system must
first observe its surroundings.

<p align="center">
<img src="./doc/images/ReconstructionTasks.png"
alt="Components of a Reconstruction Task"
width=400/>
</p>
<p align="center">
<img src="./doc/images/MappingAndScanning.png"
alt="Mapping and scanning are examples of reconstruction tasks"
width=500/>
</p>

ForgeScan breaks this process into three components: data representations, with focus on voxel data
structures; next-best view selection algorithms; and distance measurements, from sensors depth
cameras.

This project is still in early development and subject to major changes. **This is still primarily
a research tool in its alpha version.** An updated library based on this will be released soon.


## Getting Started

Project documentation is available [here](schellenberg3.github.io/ForgeScan/).

Docker files are [provided](./docker/README.md) with a description and documentation of the
packages required for developing this code on linux systems[^1].

The following collaboration diagram depicts how the `Manager` class, containing the reconstruction
data representation and implements view selection policies, interacts with simulated depth cameras
and overall system.

<p align="center">
<img src="./doc/images/CollaborationDiagram.png"
alt="Components of a Reconstruction Task"
width=700/>
</p>

[^1]: The code will compile on windows if the same packages are installed.
Binary file added doc/images/CollaborationDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/MappingAndScanning.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/ReconstructionTasks.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 051987a

Please sign in to comment.