Vuba

Small release to add support for reading in 16 bit images.

Release for activation of zenodo DOI.

This is a small release containing bug fixes for the following:

*The logic to handle initiation of Writer did not resolve correctly in scenarios where a multi-image instance of Video was supplied to a movie instance of Writer. This would result in the default codec not being used and None being supplied to cv2.VideoWriter, with a somewhat ambigious exception being raised as a consequence.*

Additional notes

This also the first release with complete documentation and also includes integration, where possible, of ipython to execute the examples included in the docs.

Source changes

* Improved docstrings that follow numpy's format have now been added to all public classes, methods and functions in the source code. These are linked to the sphinx documentation in `vuba/docs` for the API reference.
* All source code is now formatted to follow the black code style.
* `BaseGUI.process` has now been changed to `BaseGUI.method` to avoid namespace conflicts.
* The image IO module has now been renamed to `imio` to avoid conflicts with the built-in `io` module.
* Index or slice parameters are now required for reading frames in `Video.read(...)` to stop cryptic behaviour of this method.
* The class `Writer` now requires the output string first, followed by an optional instance of `Video`. This re-ordering of arguments has been done to better reflect the functionality of this class. Additionally, the `fourcc` argument has been renamed to `codec`.
* Improved logic for handling of codecs if none are supplied to `Writer`.
* Addition of warnings to `Writer.write` to notify users when frames have been altered for successful encoding.
* Mask constructors now integrate the drawing functions **vuba** provides so that multiple shapes can be supplied to `rect_mask` and `circle_mask`.

Documentation

This the first release that has documentation, albeit partially complete. Documentation is now located in `docs/` and takes inspiration from `xarray's` documentation style and structure.

PyPi

Vuba 0.2.0 is now up on PyPi in the form of a pre-built wheel as well as source code.

Example scripts

Example scripts have now all been updated to run vuba instead of the now deprecated cvu.