Image
A container for image data.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
image_tensor
|
Tensor
|
The image data as tensor. |
required |
Methods:
Name | Description |
---|---|
add_noise |
Return a new |
adjust_brightness |
Return a new |
adjust_color_balance |
Return a new |
adjust_contrast |
Return a new |
blur |
Return a blurred version of the image. |
change_channel |
Return a new |
convert_to_grayscale |
Return a new |
crop |
Return a new |
find_edges |
Return a grayscale version of the image with the edges highlighted. |
flip_left_and_right |
Return a new |
flip_top_and_bottom |
Return a new |
from_bytes |
Create an image from bytes. |
from_file |
Create an image from a file. |
invert_colors |
Return a new |
resize |
Return a new |
rotate_left |
Return a new |
rotate_right |
Return a new |
sharpen |
Return a sharpened version of the image. |
to_jpeg_file |
Save the image as a JPEG file. |
to_png_file |
Save the image as a PNG file. |
Attributes:
Name | Type | Description |
---|---|---|
channel |
int
|
Get the number of channels of the image. |
height |
int
|
Get the height of the image in pixels. |
size |
ImageSize
|
Get the |
width |
int
|
Get the width of the image in pixels. |
Source code in src/safeds/data/image/containers/_image.py
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 |
|
channel
¶
Get the number of channels of the image.
Returns:
Name | Type | Description |
---|---|---|
channel |
int
|
The number of channels of the image. |
height
¶
Get the height of the image in pixels.
Returns:
Name | Type | Description |
---|---|---|
height |
int
|
The height of the image. |
size
¶
Get the ImageSize
of the image.
Returns:
Name | Type | Description |
---|---|---|
image_size |
ImageSize
|
The size of the image. |
width
¶
Get the width of the image in pixels.
Returns:
Name | Type | Description |
---|---|---|
width |
int
|
The width of the image. |
add_noise
¶
Return a new Image
with noise added to the image.
The original image is not modified.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
standard_deviation
|
float
|
The standard deviation of the normal distribution. Has to be bigger than or equal to 0. |
required |
Returns:
Name | Type | Description |
---|---|---|
result |
Image
|
The image with added noise. |
Raises:
Type | Description |
---|---|
OutOfBoundsError
|
If standard_deviation is smaller than 0. |
Source code in src/safeds/data/image/containers/_image.py
adjust_brightness
¶
Return a new Image
with an adjusted brightness.
The original image is not modified.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
factor
|
float
|
The brightness factor. 1.0 will not change the brightness. Below 1.0 will result in a darker image. Above 1.0 will resolut in a brighter image. Has to be bigger than or equal to 0 (black). |
required |
Returns:
Name | Type | Description |
---|---|---|
result |
Image
|
The Image with adjusted brightness. |
Raises:
Type | Description |
---|---|
OutOfBoundsError
|
If factor is smaller than 0. |
Source code in src/safeds/data/image/containers/_image.py
adjust_color_balance
¶
Return a new Image
with adjusted color balance.
The original image is not modified.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
factor
|
float
|
Has to be bigger than or equal to 0. If 0 <= factor < 1, make image greyer. If factor = 1, no changes will be made. If factor > 1, increase color balance of image. |
required |
Returns:
Name | Type | Description |
---|---|---|
image |
Image
|
The new, adjusted image. |
Raises:
Type | Description |
---|---|
OutOfBoundsError
|
If factor is smaller than 0. |
Source code in src/safeds/data/image/containers/_image.py
adjust_contrast
¶
Return a new Image
with adjusted contrast.
The original image is not modified.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
factor
|
float
|
If factor > 1, increase contrast of image. If factor = 1, no changes will be made. If factor < 1, make image greyer. Has to be bigger than or equal to 0 (gray). |
required |
Returns:
Name | Type | Description |
---|---|---|
image |
Image
|
New image with adjusted contrast. |
Raises:
Type | Description |
---|---|
OutOfBoundsError
|
If factor is smaller than 0. |
Source code in src/safeds/data/image/containers/_image.py
blur
¶
Return a blurred version of the image.
The original image is not modified.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
radius
|
int
|
Radius is directly proportional to the blur value. The radius is equal to the amount of pixels united in each direction. A radius of 1 will result in a united box of 9 pixels. |
required |
Returns:
Name | Type | Description |
---|---|---|
result |
Image
|
The blurred image. |
Raises:
Type | Description |
---|---|
OutOfBoundsError
|
If radius is smaller than 0 or equal or greater than the smaller size of the image. |
Source code in src/safeds/data/image/containers/_image.py
change_channel
¶
Return a new Image
that has the given number of channels.
The original image is not modified.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
channel
|
int
|
The new number of channels. 1 will result in a grayscale image. |
required |
Returns:
Name | Type | Description |
---|---|---|
result |
Image
|
The image with the given number of channels. |
Raises:
Type | Description |
---|---|
ValueError
|
if the given channel is not a valid channel option |
Source code in src/safeds/data/image/containers/_image.py
convert_to_grayscale
¶
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.
The original image is not modified.
Returns:
Name | Type | Description |
---|---|---|
result |
Image
|
The grayscale image. |
Source code in src/safeds/data/image/containers/_image.py
crop
¶
Return a new Image
that has been cropped to a given bounding rectangle.
The original image is not modified.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
x
|
int
|
the x coordinate of the top-left corner of the bounding rectangle |
required |
y
|
int
|
the y coordinate of the top-left corner of the bounding rectangle |
required |
width
|
int
|
the width of the bounding rectangle |
required |
height
|
int
|
the height of the bounding rectangle |
required |
Returns:
Name | Type | Description |
---|---|---|
result |
Image
|
The cropped image. |
Raises:
Type | Description |
---|---|
OutOfBoundsError
|
If x or y are below 0 or if width or height are below 1 |
Source code in src/safeds/data/image/containers/_image.py
find_edges
¶
Return a grayscale version of the image with the edges highlighted.
The original image is not modified.
Returns:
Name | Type | Description |
---|---|---|
result |
Image
|
The image with edges found. |
Source code in src/safeds/data/image/containers/_image.py
flip_left_and_right
¶
Return a new Image
where left and right sides are flipped along a vertical axis.
The original image is not modified.
Returns:
Name | Type | Description |
---|---|---|
result |
Image
|
The flipped image. |
Source code in src/safeds/data/image/containers/_image.py
flip_top_and_bottom
¶
Return a new Image
where top and bottom are flipped along a horizontal axis.
The original image is not modified.
Returns:
Name | Type | Description |
---|---|---|
result |
Image
|
The flipped image. |
Source code in src/safeds/data/image/containers/_image.py
from_bytes
¶
Create an image from bytes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data
|
bytes
|
The data of the image. |
required |
Returns:
Name | Type | Description |
---|---|---|
image |
Image
|
The image. |
Source code in src/safeds/data/image/containers/_image.py
from_file
¶
Create an image from a file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path
|
str | Path
|
The path to the image file. |
required |
Returns:
Name | Type | Description |
---|---|---|
image |
Image
|
The image. |
Raises:
Type | Description |
---|---|
FileNotFoundError
|
If the file of the path cannot be found |
Source code in src/safeds/data/image/containers/_image.py
invert_colors
¶
Return a new Image
with colors inverted.
The original image is not modified.
Returns:
Name | Type | Description |
---|---|---|
result |
Image
|
The image with inverted colors. |
Source code in src/safeds/data/image/containers/_image.py
resize
¶
Return a new Image
that has been resized to a given size.
The original image is not modified.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
new_width
|
int
|
the new width of the image |
required |
new_height
|
int
|
the new height of the image |
required |
Returns:
Name | Type | Description |
---|---|---|
result |
Image
|
The image with the given width and height. |
Raises:
Type | Description |
---|---|
OutOfBoundsError
|
If new_width or new_height are below 1 |
Source code in src/safeds/data/image/containers/_image.py
rotate_left
¶
Return a new Image
that is rotated 90 degrees counter-clockwise.
The original image is not modified.
Returns:
Name | Type | Description |
---|---|---|
result |
Image
|
The image rotated 90 degrees counter-clockwise. |
Source code in src/safeds/data/image/containers/_image.py
rotate_right
¶
Return a new Image
that is rotated 90 degrees clockwise.
The original image is not modified.
Returns:
Name | Type | Description |
---|---|---|
result |
Image
|
The image rotated 90 degrees clockwise. |
Source code in src/safeds/data/image/containers/_image.py
sharpen
¶
Return a sharpened version of the image.
The original image is not modified.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
factor
|
float
|
If factor > 1, increase the sharpness of the image. If factor = 1, no changes will be made. If factor < 1, blur the image. Has to be bigger than or equal to 0 (blurred). |
required |
Returns:
Name | Type | Description |
---|---|---|
result |
Image
|
The image sharpened by the given factor. |
Raises:
Type | Description |
---|---|
OutOfBoundsError
|
If factor is smaller than 0. |
Source code in src/safeds/data/image/containers/_image.py
to_jpeg_file
¶
Save the image as a JPEG file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path
|
str | Path
|
The path to the JPEG file. |
required |
Source code in src/safeds/data/image/containers/_image.py
to_png_file
¶
Save the image as a PNG file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path
|
str | Path
|
The path to the PNG file. |
required |