Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added channel amount info to convert_to_grayscale methods in Image and ImageList #834

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/safeds/data/image/containers/_image.py
Original file line number Diff line number Diff line change
Expand Up @@ -429,6 +429,9 @@ def convert_to_grayscale(self) -> Image:
"""
Return a new `Image` that is converted to grayscale.

The new image will have the same amount of channels as the original image.
If you want to change the amount of channels used, please use the method [change_channel][safeds.data.image.containers._image.Image.change_channel].

The original image is not modified.

Returns
Expand Down
3 changes: 3 additions & 0 deletions src/safeds/data/image/containers/_image_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -876,6 +876,9 @@ def convert_to_grayscale(self) -> ImageList:
"""
Return a new `ImageList` with all images converted to grayscale.

The new image list will have the same amount of channels as the original image list.
If you want to change the amount of channels used, please use the method [change_channel][safeds.data.image.containers._image_list.ImageList.change_channel].

The original image list is not modified.

Returns
Expand Down