PyOcclusion

PyOcclusion is a Python package for adding noise of occlusionary type to video files. There is a broad range of parameters for altering in order to achieve the desirded occlusion density, coverage percent, etc. The process is automated and requires no additional prescribing.

Here is an example of what can be done with PyOcclusion:

Statement Of Need

While most of the software tends to reduce noise in the file, there are many cases when people need to add noise in order to test the new visual model, recognition software, etc. However, most of software tends to generate Gaussian noise, Salt-and-Pepper Noise and so on. PyOcclusion gives an opportunity to overlay an occlusion on both image and video files. There is a broad variety of parameters for customizing occlusionary noise to achieve desired result.

Installation

PyOcclusion can be installed from PyPI:

pip install PyOcclusion

Once installed, package can be loaded as:

import PyOcclusion

Example

import PyOcclusion

# instantiate an editor

row_velocity = 20
column_velocity = 0
height_of_shape = 17
width_of_shape = 17
num = 500
height_of_frame = 1080
width_of_frame = 1920

editor = PyOcclusion.VideoEditor(row_velocity, column_velocity, height_of_shape, width_of_shape, num, height_of_frame, width_of_frame)

# generate new video

path_to_file = "./video.mp4"

path_to_new_file = "./newVideo.mp4"

editor.editVideo(path_to_file, path_to_new_file)

Documentation

General:

API

Usage Examples

Citation

The package can be cited as follows:

@software{Synytskyi_PyOcclusion_2024,
  author = {Synytskyi, Bohdan and Livingstone, Steven R},
  month = {08},
  title = {{PyOcclusion}},
  url = {https://github.com/BohdanSynytskyi/PyOcclusion},
  version = {1.0.0},
  year = {2024},
}