imclab/unity3d-cameraopticalflow

GPU Optical Flow on camera (webcam, kinect, Black Magic...)

Unity3D-CameraOpticalFlow

CameraOpticalFlow is a GPU based optical flow system for unity.

OpticalFlow.cs

This script computes an optical flow on GPU side. It takes a RenderTexture as an input to analyze. The result is returned as a RenderTexture in an ARGBFloat format. You can grab the RenderTexture containing the OF from script by calling OpticalFlow.GetOpticalFlowMap()

OFTrailSystemUpdater.cs

This script compute an history trail from the optical flow. It grab the result from OpticalFlow.cs The results is return as a CustomRenderTexture in an ARGBFloat format. You could get the result of the OF from script by calling OFTrailSystemUpdater.GetOFTrail()

AverageVelocity.cs

This script compute the average velocity from the OF texture. Please note: this computation can be pretty intensive as it loop over all the pixel of the image. Use it with a lower resolution defined by the var resolution The result can be grab using AverageVelocity.GetAverageVelocity() The AverageVelocity.GetAverageVelocity() function return a Vector3 discribing the average velocity in XY component and the max magnitude in the Z component (if needed for normalization)

Install Package

This package uses the scoped registry feature to import dependent packages. Please add the following sections to the package manifest file (Packages/manifest.json).

To the scopedRegistries section:

{
    "name": "Bonjour-lab",
    "url": "https://registry.npmjs.com",
    "scopes": [
    "com.bonjour-lab"
    ]
}

To the dependencies section:

"com.bonjour-lab.opticalflow": "1.0.3",

After changes, the manifest file should look like below:

{
  "scopedRegistries": [
    {
      "name": "Bonjour-lab",
      "url": "https://registry.npmjs.com",
      "scopes": [
        "com.bonjour-lab"
      ]
    }
  ],
  "dependencies": {
    "com.bonjour-lab.opticalflow": "1.0.3",
    ...

Tested on

• Unity 2020 & 2019