Google Summer of Code: Adding RAFT Optical Flow Model using ONNX Format (#197)

* RAFT ONNX GSoC

* use only opencv instead of onnx

* correct typo in help display message of demo.py

* add video functionality

* Add some clarity to README.md

Author: Aser-Abdelfatah

models/optical_flow_estimation_raft/BSD-3-LICENSE.txt

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020, princeton-vl
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

models/optical_flow_estimation_raft/MITLICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jeong-gi Kwak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

models/optical_flow_estimation_raft/README.md

@@ -0,0 +1,68 @@
+# RAFT
+This model is originally created by Zachary Teed and Jia Deng of Princeton University. The source code for the model is at [their repository on GitHub](https://github.com/princeton-vl/RAFT), and the original [research paper](https://arxiv.org/abs/2003.12039) is published on [Arxiv](https://arxiv.org/abs/2003.12039). The model was converted to ONNX by [PINTO0309](https://github.com/PINTO0309) in his [model zoo](https://github.com/PINTO0309/PINTO_model_zoo/tree/main/252_RAFT). The ONNX model has several variations depending on the training dataset and input dimesnions. The model used in this demo is trained on Sintel dataset with input size of 360 $\times$ 480.
+
+
+## Demo
+
+Run any of the following commands to try the demo:
+
+```shell
+# run on camera input
+python demo.py
+
+# run on two images and visualize result
+python demo.py --input1 /path/to/image1 --input2 /path/to/image2 -vis
+
+# run on two images and save result
+python demo.py --input1 /path/to/image1 --input2 /path/to/image2 -s
+
+# run on two images and both save and visualize result
+python demo.py --input1 /path/to/image1 --input2 /path/to/image2 -s -vis
+
+# run on one video and visualize result
+python demo.py --video /path/to/video -vis
+
+# run on one video and save result
+python demo.py --video /path/to/video -s
+
+# run on one video and both save and visualize result
+python demo.py --video /path/to/video -s -vis
+
+# get help regarding various parameters
+python demo.py --help
+```
+
+While running on video, you can press q anytime to stop. The model demo runs on camera input, video input, or takes two images to compute optical flow across frames. The save and vis arguments of the shell command are only valid in the case of using video or two images as input. To run a different variation of the model, such as a model trained on a different dataset or with a different input size, refer to [RAFT ONNX in PINTO Model Zoo](https://github.com/PINTO0309/PINTO_model_zoo/tree/main/252_RAFT) to download your chosen model. And if your chosen model has different input shape from 360 $\times$ 480, **change the input shape in raft.py line 15 to the new input shape**. Then, add the model path to the --model argument of the shell command, such as in the following example commands:
+
+```shell
+# run on camera input
+python demo.py --model /path/to/model
+# run on two images
+python demo.py --input1 /path/to/image1 --input2 /path/to/image2 --model /path/to/model
+# run on video
+python demo.py --video /path/to/video  --model /path/to/model
+```
+
+### Example outputs
+The visualization argument displays both image inputs as well as out result.
+
+![Visualization example](./example_outputs/vis.png)
+
+The save argument saves the result only.
+
+![Output example](./example_outputs/result.jpg)
+
+
+
+## License
+
+The original RAFT model is under [BSD-3-Clause license](./BSD-3-LICENSE.txt). <br />
+The conversion of the RAFT model to the ONNX format by [PINTO0309](https://github.com/PINTO0309/PINTO_model_zoo/tree/main/252_RAFT) is under [MIT License](./MITLICENSE.txt). <br />
+Some of the code in demo.py and raft.py is adapted from [ibaiGorordo's repository](https://github.com/ibaiGorordo/ONNX-RAFT-Optical-Flow-Estimation/tree/main) under [BSD-3-Clause license](./BSD-3-LICENSE.txt).<br />
+
+## Reference
+
+- https://arxiv.org/abs/2003.12039
+- https://github.com/princeton-vl/RAFT
+- https://github.com/ibaiGorordo/ONNX-RAFT-Optical-Flow-Estimation/tree/main
+- https://github.com/PINTO0309/PINTO_model_zoo/tree/main/252_RAFT