CHANGELOG

v1.1.15 (2025-02-03)

Bug Fixes

  • Feedback addressed by Archer & Jenny(commit ea97a0a) - Used pillow for image import and clarified skimage is not required to run the package (fe7059e)

  • Feedback addressed by Archer - Shortened printed RGB arrays in tutorial by displaying only the first 3 rows and columns (b8ba6c6)

v1.1.14 (2025-02-03)

Bug Fixes

  • Feedback addressed by Archer - Updated image loading instructions to use Pillow in README, added Pillow to Poetry dependencies (9cd1fd0)

v1.1.13 (2025-02-03)

Bug Fixes

  • Feedback addressed by Hankun Xiao - Peer Review feedback on adding reference to color encoding in the intro tutorial (8bc04e9)

  • Feedback addressed by Hankun Xiao - Peer Review feedback on adding tutorial on export images to local disk (cd0b66a)

Build System

  • Change html theme to rtd (from press) as press has minial updates (17511cd)

Documentation

  • Clarify the usage of imported libaries, remove redundant imgs,and change load image function (ea97a0a)

  • Update examples section to meet numpy style for API reference (d5f67db)

v1.1.12 (2025-02-03)

Bug Fixes

  • Feedback addressed by Jenny - TA feedback on tackle a lot of error cases by breaking down test functions (8ab15e1)

v1.1.11 (2025-02-03)

Bug Fixes

  • Change to private function and add note to docstring for consistency across all functions (6eeb5ff)

v1.1.10 (2025-02-03)

Bug Fixes

  • Feedback addressed by Hankun Xiao - Peer Review feedback on improve PCA Image Compression funtion docstring and tutorial by adding function algorithm and use case (a95b197)

v1.1.9 (2025-02-03)

Bug Fixes

  • Additional feedback from team members incorporated (72038bb)

  • Feedback addressed by Jenny - TA feedback to break frame_image to intermediate functions for easier review (4c6dc57)

v1.1.8 (2025-02-03)

Bug Fixes

  • Feedback addressed by Inder - Agam’s feedback to ensure that image size does not stay the same regardless of image dimensions (866cd7e)

  • Feedback addressed by Inder - Shannon’s feedback to address tutorial typo where directions talk about white border but gray border is being used in function (b1bb017)

v1.1.7 (2025-02-03)

Bug Fixes

  • Feedback addressed by Archer - Added a note in the README to guide users to the documentation for examples (e4f2f58)

v1.1.6 (2025-02-03)

Bug Fixes

  • Feedback addressed by Jenny - peer review feedback to fix grammor mistake in seam_carve docs (9c009ca)

  • Feedback addressed by Jenny - peer review feedback to include arguments of function in tutorial (on top of docstring) (6bc2a72)

  • Feedback addressed by Jenny - TA and peer review feedback to break down functions into intermediate functions for easier review (d25f614)

  • Feedback addressed by Jenny on peer review CHANGELOG.md version order (d5d0fc3)

v1.1.5 (2025-02-02)

Bug Fixes

  • Feedback addressed by Archer - Added missing pytest coverage badge in response to Agam’s review (864eb8f)

  • Feedback addressed by Archer - Added missing Python version and CI/CD workflow status badges in response to Ximin’s review (88f8c5f)

Refactoring

  • Added underscore to intermediate function names and updated docstrings (d1bb0a1)

v1.1.4 (2025-02-02)

Bug Fixes

  • Feedback addressed by Inder - Agam’s & Green-zy’s feedback to amend pooling tutorial where min pooling was described but mean pooling was used in the function (416fd86)

v1.1.3 (2025-02-02)

Bug Fixes

  • Feedback addressed by Inder - Shannon’s feedback to include edge cases that have unique image shapes such as 1x100 and 100x1 (ed95781)

  • Feedback addressed by Inder - TA feedback to break reposition_image to intermediate functions for easier review (f463262)

v1.1.2 (2025-01-31)

Bug Fixes

  • Feedback addressed by Archer - Milestone 1 feedback on Software package project structure (simplify user import) (d6ad822)

v1.1.1 (2025-01-29)

Bug Fixes

  • Fixed the typo in title for image reposition (6f148d1)

  • Try to fix NoSuchKernel (816b36c)

  • Try to install ipykernel inside poetry environment (caec9f5)

Build System

  • Changelog update to reflect delete of release (397f182)

  • Updated ci-cd.yml for RELEASE_TOKEN (2762745)

Documentation

  • Rewrite the python ecosystem part in README.md (43e5ec1)

v1.1.0 (2025-01-26)

Bug Fixes

  • Try installing skimage via pip without poetry (d8b2dae)

  • Update the notebook names in index.md (c8e3c46)

  • Use consecutive headings in CONDUCT.md (3ca1fcf)

Documentation

  • Add docstrings for class Utility (36280a1)

  • Add documentation status badge (f7c3d9f)

  • Add instructions on reducing both height and width of the image (b29a33d)

  • Add instructions on reducing only the height of the image (87aef37)

  • Add instructions on reducing only the width of the image (c61cdb0)

  • Add link to image libary (dde99c1)

  • Add links to plotting and numpy library (18804e6)

  • Add some instructions on how to check the original height and width of the image, and some final remarks (e5046f5)

  • Add tutorial framework to example.ipynb (fbb8e01)

  • Add UserWarning suppression for clearer demonstration to the users (931095c)

  • Check docstring format and fix a typo (6bd503d)

  • Docstring style update for rendering (69ef2d4)

  • Edited draft fix (21bd3dc)

  • Final example update (9a0fa53)

  • Fix a header level in pca_compression.ipynb (6e68712)

  • Fix formatting and syntax issue (6a18e6f)

  • Fix merge conflict (d8530e0)

  • Fix render error (74ce9a6)

  • Frame_image.ipynb (f4c6a88)

  • Full initial draft tutorial (a4a42ba)

  • Import necessary libraries and add image preparation instructions (66d81e7)

  • Initial draft of tutorial (8241083)

  • Initial set up (0f6d2ee)

  • Initial set up (f815a79)

  • Initial set up (e4dc910)

  • Modulate_image tutorial heading level adjusted for consistency (7ad073e)

  • Redraft of intro tutorial for consistent messaging and flow (0210ce9)

  • Remove duplicate placeholder (7bd3be8)

  • Remove duplicate placeholder (3a10b6f)

  • Rerun after func update (1134e1b)

  • Rgb vs. grayscale conversion part tutorial completed (11f6a2f)

  • Section heading adjustment (e59b149)

  • Set up edited initial draft (c8c1e49)

  • Split the example notebook into individual ones to avoid future merge conflicts (54636b3)

  • Title update to be more informative (42b19b1)

  • Tutorial rename with prefix for easier consolidation, fix heading level for pca (550d0f7)

  • Tutorial section header updates for consistency (dc190fe)

  • Tutorial title and final example updated (1d91f66)

  • Update framework and set up in index.md (38e94b9)

  • Update per review comments (2d80d64)

  • Update tutorial with more explanation and example and rename (2dacb64)

  • Use a new example of a rocket launching image (46cc5a0)

Features

  • Clean up redundant return statements (267d701)

  • Color conversion using luminosity method for easier validation with human eye (bb8b131)

  • Update function for more flexibility in customization (2ac1a01)

  • Updated ch_extract outputs so that it can be displayed as image (f655674)

Testing

  • Test output to reflect func change (cd421a8)

  • Update test cases accordingly to reflect ch_extract output change (f17b885)

v1.0.0 (2025-01-18)

Bug Fixes

  • Address the issue that poetry cannot be correctly installed (cac2ac5)

  • Leave out the test case for single pixel image (25fd801)

  • Switch back to direct calling of input checker to ensure full test coverage (6f01557)

Build System

  • Branch merge with latest main to avoid further merge conflicts (8fae32c)

  • Fix merge conflict between two branches (8056457)

  • Function argument sequential order adjusted (ad09981)

  • Function restructure so can operate in sequential order (d90869e)

  • Pyproject.toml update to run pytest (14bc2a0)

  • Resolve conflicts in pyproject.toml (b7d4e4f)

  • Update _input_checker part 4 structure as discussed (6286a03)

  • Update function name to reflect master (c64acc8)

  • Update project.toml to test util function (78a5083)

  • Updates to minimize merge conflicts (a7984c5)

  • Updates to minimize merge conflicts (5c40b52)

Documentation

  • Add reference to DSCI 512 lab for input_1 image source (fcdbc9f)

  • Delete unused functions and update the usage in README.md (932fbb3)

Features

  • Add _input_checker to function (85ceb85)

  • Add as-is option for mode for better flexibility (6425a0a)

  • Add checker for correct image format (75d7f12)

  • Add checker for correct range of color values (2e1d8cc)

  • Add code for function frame_image (65ca456)

  • Add default behavior when ch_extract input is empty (f900328)

  • Add validation checks for inputs (34e2a00)

  • Add warning for no change made with extract or swap (b3aa3fb)

  • Add warnings for edge values of arguments (112cf4a)

  • Align function input name (bd02011)

  • Complete the seam carving functions (0cc8db0)

  • Fix frame_image.py code typo (aa4fd10)

  • Fix image slicing so works for 0 border size when inside padding (1b61d92)

  • Function reorder (3802a89)

  • Function unused commented code cleaned up and add in _input_checker (0b114c7)

  • Function update on error and warning msgs (a67719a)

  • Revert back to original grayscale conversion method (4b8f86f)

  • Update for a potential situation (b0d4b36)

  • Updated data color range function to return no boolean exp when passed (e716b07)

  • Updated frame_image.py to check for arguments (942150f)

Testing

  • Accorded changes when viewing the test file (02cb59b)

  • Add edge cases (54b81ee)

  • Add error cases (5f1dab6)

  • Add expected test cases (e0e6eac)

  • Add expected, edge, and error cases for frame_image.py (0787274)

  • Add some basic checks from input checker (color range checks do not apply) (1ef6856)

  • Add unit test cases for color range validation (9c57e26)

  • Add unit test cases for iamge format validation (6bcf1db)

  • Add warnings to edge cases (7dba571)

  • Fix any issues with test cases per pytest runs (62a28b6)

  • Fix code error (369ed5c)

  • Fix fixture for sample data img_array (2f22dca)

  • Fix random np array input as int between 0 and 255 (1f6c275)

  • Fix regex error mismatch (749c63a)

  • Fix some error cases input and ensure all test cases pass (83fc32b)

  • Fix the failed error test cases (109507c)

  • Refactor tests using pytest.mark.parametrize; add several edge cases and error cases. (69e0058)

  • Replace assert_array_almost_equal with assert_array_equal for exact comparison (88b5c23)

  • Separate test functions with multiple warnings (c91a54a)

  • Test expected shape update to reflect func change (12b1487)

  • Test output convert back to simple average (3e581ab)

  • Two new edge cases added (d3cd9f0)

  • Update expected test cases (d10f60d)

  • Updated tests to reflect func change and utilized mark.parametrize (089af6d)

  • Use the try and except framework for the expected and edge cases. (7ef28a8)

  • Write error cases for seam carving function (3acf006)

  • Write test data and code for edge cases, modify some test images, fix the path problem in pytest (08226c1)

  • Write test data and code for expected test cases of seam carving function, add matplotlib in poetry (04049a5)

v0.0.1 (2025-01-10)

Build System

  • Deleted empty .py files and add load_image.py for testing purpose only (ac76eeb)

  • Docstring for function to be used for unit testing only added (07dfd57)

  • Load_image.py commentary added (for unit testing only) (1180eda)

Documentation

  • Minor formatting fix to CONTRIBUTING.md (0c003b7)

  • Reordered the functions and added usage for the reposition function (f72ca50)

  • Revised CONTRIBUTING.md with formatting and wording updates (91301d9)

  • Tailored CONDUCT.md for team project & sw package (0a859b0)

  • Updated CONDUCT.md contact (b5746df)

  • Updated CONDUCT.md contact grammar (eb6c022)

  • Updated CONDUCT.md contact trial 2 (4d1fc9f)

  • Updated CONDUCT.md formatting (c0518ed)

  • Updated CONTRIBUTING.md to reflect collaboration strategy (1fb7dda)

  • Updated import of reposition_image (74d51f2)

  • Updated package functions usage in README.md (9f12633)

  • Updated README.md to include contributors (aaf4daf)

  • Updated README.md to reflect load and display image (e7abee6)

Features

  • Add color conversion function documentation (72244c6)

  • Add documentation for energy computation and seam-finding functions (917f770)

  • Add documentation for seam removing and seam carving functions (a340976)

  • Add image padding function documentation (4c5eefe)

  • Add utility functions for image loading and display in sharpedge.py (b4a39fc)