Upcoming Release v1.0.0

[BrianPugh]

v1.0.0 will be released on Jan 2, 2025. Below is the current changelog of master. Please give feedback on any feature requests or bugs discovered. Thanks!

This release contains many bug fixes that probably breaks existing code (assuming calling code has mitigations but some of the bugs mentioned below).

Breaking Changes

• Drop Python <=3.8 support.
• Fix flipped image in horizon (and dict and list) image mentioned in a big bug in c2e #11 by @BrianPugh in e2c and c2e tests; fix flipped image issue mentioned in #11 #28.
  • If you are flipping cube faces in your code, make sure to verify your inputs/outputs as they will have siltently changed!
  • Previously horizon image would look like:
    
    Now it looks like:
    
• All functions should now have expected output dtypes based on their input image dtypes. E.g. if a uint8 image is provided, the returned warped image is now a uint8.
• Replace assert with appropriate exceptions. AssertionErrors are now either ValueError or TypeError with more helpful messagse. by @BrianPugh in Replace asserts with appropriate exceptions. #24
• The convert360 CLI has been re-done to be more intuitive to use by @BrianPugh in CLI Revamp. #30.
  • See CLI Migration in the PR.
  • The CLI now appropriately handles single-channel images.

Bug Fixes (non-breaking)

• Fix np.bool NumPy v1.20 deprecation error. by @kikefdezl in Fix np.bool NumPy 1.20 deprecation error. #20
• fix e2p() parameter fov_deg for scalar values. Previously the code was just broken and would raise a NameError by @BrianPugh in fix e2p() parameter fov_deg for scalar values. #25
• fix wrong variable checked in cube_dict2h in 20c5210.

Features

• Significant speed ups if opencv is installed. Minor speedup optimizations all around. By @BrianPugh in Speed Optimizations. #38
  • Additional speed ups when processing multiple same-resolution images by caching intermediate calculations. By @swell-d in caching speeds up batch processing #40
• Allow e2c e2p c2e to operate on 2D arrays. by @BrianPugh in Allow e2c e2p c2e to operate on 2D arrays. #29
  • Fix single channel png e2p by @nikste in Fix single channel png e2p #18
• Type-Hinting by @BrianPugh in improved type-hinting, docstrings. #27
• Add more interpolation modes up to order 5. by @BrianPugh in Add more interpolation modes up to order 5. #31
• Make the standard py360convert.__version__ available.

Admin/Misc

• migrate to poetry; use pre-commit; initial linting; add github actions by @BrianPugh in migrate to poetry; use pre-commit; initial linting; add github actions #23
• remove mutable default in function signature. by @BrianPugh in remove mutable default in function signature. #26
• Coordinate system docstrings by @risiair in Phi s #13

New Contributors

• @kikefdezl made their first contribution in Fix np.bool NumPy 1.20 deprecation error. #20
• @nikste made their first contribution in Fix single channel png e2p #18
• @BrianPugh made their first contribution in migrate to poetry; use pre-commit; initial linting; add github actions #23
• @risiair made their first contribution in Phi s #13

Full Changelog: v_0.1.0...v1.0.0

[BrianPugh]

v1.0.0 is now available on pypi! Please report any issues in a new thread. Thanks!