Skip to content

Commit

Permalink
Added page for Ocean's LineDetector demo app
Browse files Browse the repository at this point in the history
Summary:
This is just another page introducing one of several Ocean demo apps.

allow-large-files

Reviewed By: janherling, enpe

Differential Revision: D59524493

fbshipit-source-id: 502276ca05e297ee02679c2f5bbda936abd0b578
  • Loading branch information
Daniel Scharstein authored and facebook-github-bot committed Jul 10, 2024
1 parent 37e7319 commit c69f70d
Show file tree
Hide file tree
Showing 2 changed files with 115 additions and 0 deletions.
115 changes: 115 additions & 0 deletions website/docs/demoapps/crossplatformapps/line_detector.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
---
title: Line Detector
sidebar_position: 8
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

## Description

Many computer vision tasks utilize edges and line segments detected in images, for tasks such as vanishing point estimation, scene parsing, structure from motion in feature-poor environments, and many others.

The [LineDetector](https://github.com/facebookresearch/ocean/tree/v1.0.0/impl/application/ocean/demo/cv/detector/linedetector) demo app showcases the capabilities of Ocean in detecting lines across various environments, particularly in urban settings.

<div class="center-images">
<img src={require('@site/static/img/docs/demoapps/crossplatformapps/line_detector.jpg').default} alt="Image: The line detector, input left, output right" height="400" className="center-image"/>
</div>


### Platform Independence
The LineDetector demo app is versatile and platform-independent, making it accessible on a wide range of devices including iOS, Android, Windows, and macOS.

### Core Functionality
At the heart of the LineDetector demo app is the [`LineDetectorWrapper`](https://github.com/facebookresearch/ocean/blob/v1.0.0/impl/application/ocean/demo/cv/detector/linedetector/LineDetectorWrapper.cpp#L43) class.
This class is allows processing the input from various frame mediums such as static images, webcams, movies, or built-in cameras on phones.

#### Default Detection Method: ULFLineDetector
By default, the app employs the [`ULFLineDetector`](https://github.com/facebookresearch/ocean/blob/v1.0.0/impl/ocean/cv/detector/LineDetectorULF.h#L33) (Urban Line Finder), which is specifically tailored for detecting straight lines in urban landscapes. The ULFLineDetector operates in two main phases:

- **Edge Detection**: Initially, the algorithm identifies all pixels that belong to edges within the image, including "step edges" and "bar edges".
- **Line Formation**: Subsequently, consecutive edge pixels of the same type are aggregated to form straight line segments.

Most existing edge and line detectors are designed to detect "step edges" in intensity, i.e., locations where the intensity differs on both sides of the edge. In urban scenes, however, "bar edges" are equally prevalent, i.e., thin lines whose intensity differs from the constant surrounding intensity (e.g., cracks between surface tiles, window grids, or wires in the sky). Existing edge and line detectors often fail to detect such edges, or yield a double response.

In contrast, ULF is designed to detect both bar edges and step edges. The algorithm makes a horizontal and a vertical pass over the image. In each pass it detects evidence for bar edges and step edges in the scanning direction, and then groups detected points into lines in the orthogonal direction. The method runs approximately 3 times as fast as OpenCV's popular LSD detector and finds lines in urban and indoor scenes more reliably.

The ULFLineDetector is equipped with [multiple edge detectors](https://github.com/facebookresearch/ocean/blob/v1.0.0/impl/ocean/cv/detector/LineDetectorULF.h#L80), each offering a balance between performance and accuracy.
This allows users to choose an edge detector that best fits their needs.

In its default setting, the demo app executes a step edge detector and a bar edge detector.
The detected lines are then visualized using a [color coding](https://github.com/facebookresearch/ocean/blob/v1.0.0/impl/application/ocean/demo/cv/detector/linedetector/LineDetectorWrapper.cpp#L247) indicating the type of edge detected: red/green for positive/negative step edges, and white/gray for positive/negative bar edges.


#### Alternative Detection Technique: Hough Line Detector

For users interested in exploring different line detection methodologies, the demo app also includes the [Hough line detector](https://github.com/facebookresearch/ocean/blob/v1.0.0/impl/ocean/cv/detector/LineDetectorHough.h#L42).
By leveraging the [`USE_ULF_DETECTOR`](https://github.com/facebookresearch/ocean/blob/v1.0.0/impl/application/ocean/demo/cv/detector/linedetector/LineDetectorWrapper.cpp#L41) macro, users can easily switch between the ULFLineDetector and the Hough line detector.


### Explore and Experiment
The LineDetector demo app is designed for developers, researchers, and enthusiasts to explore line detection technologies.
Users can experiment with the app's features by adjusting parameters and testing different ULF edge detectors to see how changes affect line detection results.
This flexibility allows for a hands-on approach to understanding and optimizing performance. Users are also encouraged to develop their own enhancements and contribute to the broader Ocean community.


## Building

<Tabs groupId="target-os" queryString>

<TabItem value="android" label="Android" default>
Ensure the [third-party libraries have been built for Android](https://github.com/facebookresearch/ocean/blob/v1.0.0/building_for_android.md#2-building-the-third-party-libraries) for all of the required Android ABIs. Let's assume the base location for third-party libraries is `${HOME}/install_ocean_thirdparty`, i.e., the Android versions will be located in `${HOME}/install_ocean_thirdparty/android_${ANDROID_ABI}...`.

```bash
# Define this so that Gradle (and CMake) can find the third-party libraries.
export OCEAN_THIRDPARTY_PATH="${HOME}/install_ocean_thirdparty"

# Change into the directory with the Gradle config of this project
cd ${OCEAN_DEVELOPMENT_PATH}/build/gradle/application/ocean/demo/cv/detector/linedetector/android

# In ./app/build.gradle.kts, ensure that only those Android ABIs are enabled for which the corresponding third-party libraries have been built. Otherwise, your build will fail, cf. the [general build instructions](https://github.com/facebookresearch/ocean/blob/v1.0.0/building_for_android.md#4-building-the-ocean-android-demotest-apps).

# Build the debug and release APK of this
./gradlew assemble

# Install the desired APK
adb install app/build/outputs/apk/debug/app-debug.apk
adb install app/build/outputs/apk/release/app-release.apk
```

By default, the log output will be displayed on the screen of the phone as well as in the Android logs, which can be displayed using:

```bash
adb logcat -s Ocean
```

</TabItem>

<TabItem value="ios" label="iOS">
Ensure the [third-party libraries have been built for iOS](https://github.com/facebookresearch/ocean/blob/v1.0.0/building_for_ios.md#2-building-the-third-party-libraries). Then follow the general [setup for building iOS apps using XCode](https://github.com/facebookresearch/ocean/blob/v1.0.0/building_for_ios.md#4-building-the-ocean-ios-demotest-apps). Once the generation of the XCode project is complete, open it and search for `application_ocean_demo_cv_detector_linedetector_ios` in the scheme at the top. Then hit `CMD-R` to build, install, and run the app and follow the instructions.
</TabItem>

<TabItem value="macos" label="macOS">
Ensure the [third-party libraries have been built for macOS](https://github.com/facebookresearch/ocean/blob/v1.0.0/building_for_macos.md#2-building-the-third-party-libraries). Then follow the instructions to build the Ocean code base. Let's assume you're building Ocean with the release build config:

```bash
cd ${OCEAN_DEVELOPMENT_PATH}

# Build the third-party libraries
./build/cmake/build_thirdparty_linuxunix.sh -c release -l static -b "${HOME}/build_ocean_thirdparty" -i "${HOME}/install_ocean_thirdparty"

# Build and install Ocean
./build/cmake/build_ocean_linuxunix.sh -c release -l static -b "${HOME}/build_ocean" -i "${HOME}/install_ocean" -t "${HOME}/install_ocean_thirdparty"

# Execute the demo app (a bundle)
open ${HOME}/install_ocean/macos_static_Release/bin/application_ocean_demo_cv_detector_linedetector_osx.app
```

Alternatively, [generate a XCode project for Ocean](https://github.com/facebookresearch/ocean/blob/v1.0.0/building_for_macos.md#4-building-the-ocean-ios-demotest-apps) and search for `application_ocean_demo_cv_detector_linedetector_osx` in the schemes at the top. Then hit `CMD-R` to build and run the app.
</TabItem>

<TabItem value="win" label="Windows">
TODO
</TabItem>

</Tabs>
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 c69f70d

Please sign in to comment.