Jpeg2000Image Class
Contents
[
Hide
]Summary: Efficiently manipulate JPEG2000 (JP2) image files with our API, supporting
a range of bits per pixel depths and seamless processing of XMP metadata
containing essential image information. With capabilities for lossless compression,
ensure optimal image quality while maintaining file integrity, empowering you to
tailor JP2 images to your exact specifications with ease.
Module: aspose.imaging.fileformats.jpeg2000
Full Name: aspose.imaging.fileformats.jpeg2000.Jpeg2000Image
Inheritance: IObjectWithBounds, IRasterImageArgb32PixelLoader, IRasterImageRawDataLoader, RasterCachedImage
Aspose.Imaging Version: 24.5.0
Constructors
| Name | Description |
|---|---|
| Jpeg2000Image(image) | Instantiate a new Jpeg2000Image class with a raster image. This constructor facilitates the creation of a JPEG2000 image from an existing raster image, offering seamless integration and conversion between different image formats. |
| Jpeg2000Image(path) | Start working with the Jpeg2000Image class by initializing a new instance with the path to the image you want to load. This constructor enables easy access to JPEG2000 images, simplifying the process of loading and handling image files. By providing the file path, you can quickly begin processing and manipulating JPEG2000 images in your application. |
| Jpeg2000Image(path, bits_per_pixel) | Get started easily with the Jpeg2000Image class by creating a new instance with both the file path and the desired bits per pixel parameter. This constructor allows for fine-tuning the image loading process, ensuring compatibility with various image formats and quality settings. With this flexibility, you can efficiently manage and manipulate JPEG2000 images according to your specific requirements. |
| Jpeg2000Image(raster_image, bits_per_pixel) | Initialize a fresh Jpeg2000Image instance with a raster image and bits per pixel parameters. This constructor enables precise control over the quality and size of the resulting JPEG2000 image, making it ideal for scenarios where customization is crucial. |
| Jpeg2000Image(stream) | Easily initialize a new instance of the Jpeg2000Image class by providing a stream object. This constructor simplifies the process of loading JPEG2000 images directly from streams, offering flexibility and convenience for handling image data from various sources. |
| Jpeg2000Image(stream, bits_per_pixel) | Initialize a new instance of the Jpeg2000Image class with a stream to load the image, along with bits per pixel parameters. This constructor offers flexibility by allowing you to specify both the image data source and the desired bits per pixel, providing finer control over the image loading process. |
| Jpeg2000Image(width, height) | Create a new instance of the Jpeg2000Image class, specifying the width and height parameters. This constructor allows you to initialize a JPEG2000 image with specific dimensions, which is useful for scenarios where you need to create an image of a certain size programmatically. |
| Jpeg2000Image(width, height, bits_count) | Create a new instance of the Jpeg2000Image class with parameters for width, height, and bits count. This constructor allows for the creation of JPEG2000 images with specific dimensions and bit depths, providing flexibility for various imaging needs. |
| Jpeg2000Image(width, height, options) | Instantiate a new Jpeg2000Image object, providing the width, height, and image options parameters. This constructor allows for the creation of JPEG2000 images with specific dimensions and additional options, offering flexibility in image generation. |
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| auto_adjust_palette | bool | r/w | Gets or sets a value indicating whether automatic adjust palette. |
| background_color | Color | r/w | Gets or sets a value for the background color. |
| bits_per_pixel | int | r | This property returns the depth of the image, measured in bits per pixel (bpp). It indicates the amount of color information stored in each pixel of the image. Understanding the image depth is crucial for determining the color fidelity and quality of the image. With this information, users can gauge the level of detail and richness of colors present in the image. |
| bounds | Rectangle | r | Gets the object bounds. |
| buffer_size_hint | int | r/w | Gets or sets the buffer size hint which is defined max allowed size for all internal buffers. |
| codec | Jpeg2000Codec | r | This property retrieves the JPEG2000 codec associated with the image. The JPEG2000 codec is responsible for encoding and decoding the image data in the JPEG2000 format, providing efficient compression while maintaining high image quality. Accessing this codec can be useful for performing advanced image processing operations or optimizing image compression settings tailored to specific requirements. |
| comments | string | r/w | This property allows for retrieving or updating the comments associated with the image. Comments provide additional information about the image content, such as annotations, descriptions, or metadata. Modifying these comments can be useful for organizing and categorizing images, as well as conveying important details to viewers or users. |
| container | Image | r | Gets the Image container. |
| data_stream_container | StreamContainer | r | Gets the object’s data stream. |
| disposed | bool | r | Gets a value indicating whether this instance is disposed. |
| file_format | FileFormat | r | Retrieve the format of the image file. This property provides information about the file format of the image. Utilize this property to determine the format of the image file programmatically, facilitating appropriate handling and processing based on the file’s format. |
| has_alpha | bool | r | Gets a value indicating whether this instance has alpha. |
| has_background_color | bool | r/w | Gets or sets a value indicating whether image has background color. |
| has_transparent_color | bool | r/w | Gets a value indicating whether image has transparent color. |
| height | int | r | This property retrieves the height of the image in pixels. It serves as essential information for understanding the image’s vertical dimensions, aiding in various image manipulation tasks like resizing, cropping, and rendering. Accessing this property allows users to ascertain the image’s vertical size, enabling precise layout and display in applications. |
| horizontal_resolution | double | r/w | This property allows you to retrieve or modify the horizontal resolution of the RasterImage, measured in pixels per inch (PPI). Adjusting this resolution can impact the size and quality of the image when printed or displayed. By setting the horizontal resolution, users can optimize the image for specific output devices or applications, ensuring the best possible visual results. |
| image_opacity | float | r | Gets opacity of this image. |
| interrupt_monitor | InterruptMonitor | r/w | Gets or sets the interrupt monitor. |
| is_cached | bool | r | Gets a value indicating whether image data is cached currently. |
| is_raw_data_available | bool | r | Gets a value indicating whether raw data loading is supported. |
| palette | IColorPalette | r/w | Gets or sets the color palette. The color palette is not used when pixels are represented directly. |
| premultiply_components | bool | r/w | Gets or sets a value indicating whether the image components must be premultiplied. |
| raw_custom_color_converter | IColorConverter | r/w | Gets or sets the custom color converter |
| raw_data_format | PixelDataFormat | r | This property retrieves the raw data format of the image. It provides information about how the pixel data is stored in memory. Use this property to understand the underlying data format of the image, which can be crucial for various image processing operations like color conversion, compression, or decompression. |
| raw_data_settings | RawDataSettings | r | Gets the current raw data settings. Note when using these settings the data loads without conversion. |
| raw_fallback_index | int | r/w | Gets or sets the fallback index to use when palette index is out of bounds |
| raw_indexed_color_converter | IIndexedColorConverter | r/w | Gets or sets the indexed color converter |
| raw_line_size | int | r | This property retrieves the size of a single line of raw image data in bytes. It indicates the amount of memory occupied by a single row of pixels in the image’s raw data format. Understanding the raw line size is essential for tasks such as memory allocation, data manipulation, and image processing algorithms that operate on individual image lines. |
| size | Size | r | Gets the object size. |
| transparent_color | Color | r/w | Gets the image transparent color. |
| update_xmp_data | bool | r/w | Gets or sets a value indicating whether to update the XMP metadata. |
| use_palette | bool | r | Gets a value indicating whether the image palette is used. |
| use_raw_data | bool | r/w | Gets or sets a value indicating whether to use raw data loading when the raw data loading is available. |
| vertical_resolution | double | r/w | This property provides access to the vertical resolution of the RasterImage, measured in pixels per inch (PPI). Modifying this resolution can affect the quality and size of the image when printed or displayed. By adjusting the vertical resolution, users can optimize the image for different output devices or applications, ensuring optimal visual rendering. |
| width | int | r | This property returns the width of the image in pixels. It provides a fundamental piece of information about the image’s dimensions, crucial for various image processing tasks, including resizing, cropping, and rendering. |
| xmp_data | XmpPacketWrapper | r/w | Retrieve or modify the XMP metadata associated with the image. This property grants access to the Extensible Metadata Platform (XMP) information embedded within the image file, allowing for manipulation or extraction of metadata attributes such as author details, copyright information, and descriptive tags. Utilizing this property empowers you to manage and leverage metadata embedded within the image, enhancing interoperability and metadata-driven workflows in your image processing tasks. |
Methods
| Name | Description |
|---|---|
| adjust_brightness(brightness) | Adjust of a brightness for image. |
| adjust_contrast(contrast) | Image contrasting |
| adjust_gamma(gamma) | Gamma-correction of an image. |
| adjust_gamma(gamma_red, gamma_green, gamma_blue) | Gamma-correction of an image. |
| binarize_bradley(brightness_difference) | Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding |
| binarize_bradley(brightness_difference, window_size) | Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding |
| binarize_fixed(threshold) | Binarization of an image with predefined threshold |
| binarize_otsu() | Binarization of an image with Otsu thresholding |
| blend(origin, overlay, overlay_alpha) | Blends this image instance with the overlay image. |
| blend(origin, overlay, overlay_area, overlay_alpha) | Blends this image instance with the overlay image. |
| cache_data() | Caches the data and ensures no additional data loading will be performed from the underlying DataStreamSupporter.data_stream_container. |
| can_load(file_path) | Determines whether image can be loaded from the specified file path. |
| can_load(file_path, load_options) | Determines whether image can be loaded from the specified file path and optionally using the specified open options. |
| can_load(stream) | Determines whether image can be loaded from the specified stream. |
| can_load(stream, load_options) | Determines whether image can be loaded from the specified stream and optionally using the specified loadOptions. |
| can_load_stream(stream) | Determines whether image can be loaded from the specified stream. |
| can_load_stream_with_options(stream, load_options) | Determines whether image can be loaded from the specified stream and optionally using the specified loadOptions. |
| can_load_with_options(file_path, load_options) | Determines whether image can be loaded from the specified file path and optionally using the specified open options. |
| can_save(options) | Determines whether image can be saved to the specified file format represented by the passed save options. |
| create(image_options, width, height) | Creates a new image using the specified create options. |
| create(images) | Creates a new image using the specified images as pages |
| create(images, dispose_images) | Creates a new image the specified images as pages. |
| create_from_file_with_bpp(path, bits_per_pixel) | Initializes a new instance of the Jpeg2000Image class. |
| create_from_image(image) | Initializes a new instance of the Jpeg2000Image class. |
| create_from_image_with_bpp(raster_image, bits_per_pixel) | Initializes a new instance of the Jpeg2000Image class. |
| create_from_stream(stream) | Initializes a new instance of the Jpeg2000Image class. |
| create_from_stream_with_bpp(stream, bits_per_pixel) | Initializes a new instance of the Jpeg2000Image class. |
| create_with_width_height(width, height) | Initializes a new instance of the Jpeg2000Image class. |
| create_with_width_height_bitscount(width, height, bits_count) | Initializes a new instance of the Jpeg2000Image class. |
| create_with_width_height_options(width, height, options) | Initializes a new instance of the Jpeg2000Image class. |
| crop(left_shift, right_shift, top_shift, bottom_shift) | Crop image with shifts. |
| crop(rectangle) | Cropping the image. |
| dither(dithering_method, bits_count) | Performs dithering on the current image. |
| dither(dithering_method, bits_count, custom_palette) | Performs dithering on the current image. |
| filter(rectangle, options) | Filters the specified rectangle. |
| get_argb_32_pixel(x, y) | Gets an image 32-bit ARGB pixel. |
| get_default_argb_32_pixels(rectangle) | Gets the default 32-bit ARGB pixels array. |
| get_default_options(args) | Gets the default options. |
| get_default_pixels(rectangle, partial_pixel_loader) | Gets the default pixels array using partial pixel loader. |
| get_default_raw_data(rectangle, partial_raw_data_loader, raw_data_settings) | Gets the default raw data array using partial pixel loader. |
| get_default_raw_data(rectangle, raw_data_settings) | Gets the default raw data array. |
| get_file_format(file_path) | Gets the file format. |
| get_file_format(stream) | Gets the file format. |
| get_file_format_of_stream(stream) | Gets the file format. |
| get_fitting_rectangle(rectangle, pixels, width, height) | Gets rectangle which fits the current image. |
| get_fitting_rectangle(rectangle, width, height) | Gets rectangle which fits the current image. |
| get_modify_date(use_default) | Gets the date and time the resource image was last modified. |
| get_original_options() | Retrieve the image options based on the original file settings. This method is beneficial for maintaining the bit-depth and other parameters of the original image, ensuring consistency and preserving the integrity of the image data. Accessing these options facilitates seamless handling and processing of the image while retaining its original characteristics. For example, if we load a black-white PNG image with 1 bit per pixel and then save it using the DataStreamSupporter.save(file_path) method, the output PNG image with 8-bit per pixel will be produced. To avoid it and save PNG image with 1-bit per pixel, use this method to get corresponding saving options and pass them to the Image.save(file_path, options) method as the second parameter. |
| get_pixel(x, y) | Gets an image pixel. |
| get_proportional_height(width, height, new_width) | Gets a proportional height. |
| get_proportional_width(width, height, new_height) | Gets a proportional width. |
| get_serialized_stream(image_options, clipping_rectangle, page_number) | Converts to aps. |
| get_skew_angle() | Gets the skew angle. This method is applicable to scanned text documents, to determine the skew angle when scanning. |
| grayscale() | Transformation of an image to its grayscale representation |
| load(file_path) | Loads a new image from the specified file. |
| load(file_path, load_options) | Loads a new image from the specified file. |
| load(stream) | Loads a new image from the specified stream. |
| load(stream, load_options) | Loads a new image from the specified stream. |
| load_argb_32_pixels(rectangle) | Loads 32-bit ARGB pixels. |
| load_argb_64_pixels(rectangle) | Loads 64-bit ARGB pixels. |
| load_cmyk_32_pixels(rectangle) | Loads pixels in CMYK format. |
| load_cmyk_pixels(rectangle) | Loads pixels in CMYK format. This method is deprecated. Please use more effective the RasterImage.load_cmyk_32_pixels(rectangle) method. |
| load_partial_argb_32_pixels(rectangle, partial_pixel_loader) | Loads 32-bit ARGB pixels partially (by blocks). |
| load_partial_argb_64_pixels(rectangle, partial_pixel_loader) | Loads 64-bit ARGB pixels partially by packs. |
| load_partial_pixels(desired_rectangle, pixel_loader) | Loads pixels partially by packs. |
| load_pixels(rectangle) | Loads pixels. |
| load_raw_data(rectangle, dest_image_bounds, raw_data_settings, raw_data_loader) | Loads raw data. |
| load_raw_data(rectangle, raw_data_settings, raw_data_loader) | Loads raw data. |
| load_stream(stream) | Loads a new image from the specified stream. |
| load_stream_with_options(stream, load_options) | Loads a new image from the specified stream. |
| load_with_options(file_path, load_options) | Loads a new image from the specified file. |
| normalize_angle() | Normalizes the angle. This method is applicable to scanned text documents to get rid of the skewed scan. This method uses RasterImage.get_skew_angle() and RasterImage.rotate(angle) methods. |
| normalize_angle(resize_proportionally, background_color) | Normalizes the angle. This method is applicable to scanned text documents to get rid of the skewed scan. This method uses RasterImage.get_skew_angle() and RasterImage.rotate(angle, resize_proportionally, background_color) methods. |
| read_argb_32_scan_line(scan_line_index) | Reads the whole scan line by the specified scan line index. |
| read_scan_line(scan_line_index) | Reads the whole scan line by the specified scan line index. |
| replace_argb(old_color_argb, old_color_diff, new_color_argb) | Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges. |
| replace_color(old_color, old_color_diff, new_color) | Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges. |
| replace_color(old_color_argb, old_color_diff, new_color_argb) | Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges. |
| replace_non_transparent_colors(new_color) | Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges. Note: if you use it on images without transparency, all colors will be replaced with a single one. |
| replace_non_transparent_colors(new_color_argb) | Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges. Note: if you use it on images without transparency, all colors will be replaced with a single one. |
| resize(new_width, new_height) | Resizes the image. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used. |
| resize(new_width, new_height, resize_type) | Resizes the image. |
| resize(new_width, new_height, settings) | Resizes the image. |
| resize_by_settings(new_width, new_height, settings) | Resizes the image. |
| resize_by_type(new_width, new_height, resize_type) | Resizes the image. |
| resize_height_proportionally(new_height) | Resizes the height proportionally. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used. |
| resize_height_proportionally(new_height, resize_type) | Resizes the height proportionally. |
| resize_height_proportionally(new_height, settings) | Resizes the height proportionally. |
| resize_height_proportionally_settings(new_height, settings) | Resizes the height proportionally. |
| resize_width_proportionally(new_width) | Resizes the width proportionally. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used. |
| resize_width_proportionally(new_width, resize_type) | Resizes the width proportionally. |
| resize_width_proportionally(new_width, settings) | Resizes the width proportionally. |
| resize_width_proportionally_settings(new_width, settings) | Resizes the width proportionally. |
| rotate(angle) | Rotate image around the center. |
| rotate(angle, resize_proportionally, background_color) | Rotate image around the center. |
| rotate_flip(rotate_flip_type) | Rotates, flips, or rotates and flips the image. |
| save() | Saves the image data to the underlying stream. |
| save(file_path) | Saves the image to the specified file location. |
| save(file_path, options) | Saves the object’s data to the specified file location in the specified file format according to save options. |
| save(file_path, options, bounds_rectangle) | Saves the object’s data to the specified file location in the specified file format according to save options. |
| save(file_path, over_write) | Saves the object’s data to the specified file location. |
| save(stream) | Saves the object’s data to the specified stream |
| save(stream, options_base) | Saves the image’s data to the specified stream in the specified file format according to save options. |
| save(stream, options_base, bounds_rectangle) | Saves the image’s data to the specified stream in the specified file format according to save options. |
| save_argb_32_pixels(rectangle, pixels) | Saves the 32-bit ARGB pixels. |
| save_cmyk_32_pixels(rectangle, pixels) | Saves the pixels. |
| save_cmyk_pixels(rectangle, pixels) | Saves the pixels. This method is deprecated. Please use more effective the RasterImage.save_cmyk_32_pixels(rectangle, pixels) method. |
| save_pixels(rectangle, pixels) | Saves pixels (format specific method). |
| save_raw_data(data, data_offset, rectangle, raw_data_settings) | Saves the raw data. |
| save_to_stream(stream) | Saves the object’s data to the specified stream. |
| save_to_stream_with_options(stream, options_base) | Saves the image’s data to the specified stream in the specified file format according to save options. |
| save_to_stream_with_options_rect(stream, options_base, bounds_rectangle) | Saves the image’s data to the specified stream in the specified file format according to save options. |
| save_with_options(file_path, options) | Saves the object’s data to the specified file location in the specified file format according to save options. |
| save_with_options_rect(file_path, options, bounds_rectangle) | Saves the object’s data to the specified file location in the specified file format according to save options. |
| set_argb_32_pixel(x, y, argb_32_color) | Sets an image 32-bit ARGB pixel for the specified position. |
| set_palette(palette, update_colors) | Sets the image palette. |
| set_pixel(x, y, color) | Sets an image pixel for the specified position. |
| set_resolution(dpi_x, dpi_y) | Sets the resolution for this RasterImage. |
| write_argb_32_scan_line(scan_line_index, argb_32_pixels) | Writes the whole scan line to the specified scan line index. |
| write_scan_line(scan_line_index, pixels) | Writes the whole scan line to the specified scan line index. |
Constructor: Jpeg2000Image(image)
Jpeg2000Image(image)
Instantiate a new Jpeg2000Image class with a raster image. This
constructor facilitates the creation of a JPEG2000 image from an existing raster
image, offering seamless integration and conversion between different image formats.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| image | RasterImage | The image. |
Constructor: Jpeg2000Image(path)
Jpeg2000Image(path)
Start working with the Jpeg2000Image class by initializing a new
instance with the path to the image you want to load. This constructor enables easy
access to JPEG2000 images, simplifying the process of loading and handling image
files. By providing the file path, you can quickly begin processing and
manipulating JPEG2000 images in your application.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | string | The path to load image from and initialize pixel and palette data with. |
Constructor: Jpeg2000Image(path, bits_per_pixel)
Jpeg2000Image(path, bits_per_pixel)
Get started easily with the Jpeg2000Image class by creating a new
instance with both the file path and the desired bits per pixel parameter. This
constructor allows for fine-tuning the image loading process, ensuring
compatibility with various image formats and quality settings. With this
flexibility, you can efficiently manage and manipulate JPEG2000 images according to
your specific requirements.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | string | The path to load image from and initialize pixel and palette data with |
| bits_per_pixel | int | The bits per pixel. |
Constructor: Jpeg2000Image(raster_image, bits_per_pixel)
Jpeg2000Image(raster_image, bits_per_pixel)
Initialize a fresh Jpeg2000Image instance with a raster image and
bits per pixel parameters. This constructor enables precise control over the
quality and size of the resulting JPEG2000 image, making it ideal for scenarios
where customization is crucial.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| raster_image | RasterImage | The image to initialize pixel and palette data with. |
| bits_per_pixel | int | The bits per pixel. |
Constructor: Jpeg2000Image(stream)
Jpeg2000Image(stream)
Easily initialize a new instance of the Jpeg2000Image class by
providing a stream object. This constructor simplifies the process of loading
JPEG2000 images directly from streams, offering flexibility and convenience for
handling image data from various sources.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load image from and initialize pixel and palette data with. |
Constructor: Jpeg2000Image(stream, bits_per_pixel)
Jpeg2000Image(stream, bits_per_pixel)
Initialize a new instance of the Jpeg2000Image class with a stream to
load the image, along with bits per pixel parameters. This constructor offers
flexibility by allowing you to specify both the image data source and the desired
bits per pixel, providing finer control over the image loading process.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load image from and initialize pixel and palette data with. |
| bits_per_pixel | int | The bits per pixel. |
Constructor: Jpeg2000Image(width, height)
Jpeg2000Image(width, height)
Create a new instance of the Jpeg2000Image class, specifying the
width and height parameters. This constructor allows you to initialize a JPEG2000
image with specific dimensions, which is useful for scenarios where you need to
create an image of a certain size programmatically.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| width | int | The image width |
| height | int | The image height |
Constructor: Jpeg2000Image(width, height, bits_count)
Jpeg2000Image(width, height, bits_count)
Create a new instance of the Jpeg2000Image class with parameters for
width, height, and bits count. This constructor allows for the creation of JPEG2000
images with specific dimensions and bit depths, providing flexibility for various
imaging needs.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| width | int | The image width |
| height | int | The image height |
| bits_count | int | The bits count. |
Constructor: Jpeg2000Image(width, height, options)
Jpeg2000Image(width, height, options)
Instantiate a new Jpeg2000Image object, providing the width, height,
and image options parameters. This constructor allows for the creation of JPEG2000
images with specific dimensions and additional options, offering flexibility in
image generation.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| width | int | The image width |
| height | int | The image height |
| options | Jpeg2000Options | The options. |
Method: adjust_brightness(brightness)
adjust_brightness(brightness)
Adjust of a brightness for image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| brightness | int | Brightness value. |
Method: adjust_contrast(contrast)
adjust_contrast(contrast)
Image contrasting
Parameters:
| Parameter | Type | Description |
|---|---|---|
| contrast | float | Contrast value (in range [-100; 100]) |
Method: adjust_gamma(gamma)
adjust_gamma(gamma)
Gamma-correction of an image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| gamma | float | Gamma for red, green and blue channels coefficient |
Method: adjust_gamma(gamma_red, gamma_green, gamma_blue)
adjust_gamma(gamma_red, gamma_green, gamma_blue)
Gamma-correction of an image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| gamma_red | float | Gamma for red channel coefficient |
| gamma_green | float | Gamma for green channel coefficient |
| gamma_blue | float | Gamma for blue channel coefficient |
Method: binarize_bradley(brightness_difference)
binarize_bradley(brightness_difference)
Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding
Parameters:
| Parameter | Type | Description |
|---|---|---|
| brightness_difference | double | The brightness difference between pixel and the average of an s x s window of pixels centered around this pixel. |
Method: binarize_bradley(brightness_difference, window_size)
binarize_bradley(brightness_difference, window_size)
Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding
Parameters:
| Parameter | Type | Description |
|---|---|---|
| brightness_difference | double | The brightness difference between pixel and the average of an s x s window of pixels centered around this pixel. |
| window_size | int | The size of s x s window of pixels centered around this pixel |
Method: binarize_fixed(threshold)
binarize_fixed(threshold)
Binarization of an image with predefined threshold
Parameters:
| Parameter | Type | Description |
|---|---|---|
| threshold | byte | Threshold value. If corresponding gray value of a pixel is greater than threshold, a value of 255 will be assigned to it, 0 otherwise. |
Method: blend(origin, overlay, overlay_alpha)
blend(origin, overlay, overlay_alpha)
Blends this image instance with the overlay image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| origin | Point | The background image blending origin. |
| overlay | RasterImage | The overlay image. |
| overlay_alpha | byte | The overlay alpha. |
Method: blend(origin, overlay, overlay_area, overlay_alpha)
blend(origin, overlay, overlay_area, overlay_alpha)
Blends this image instance with the overlay image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| origin | Point | The background image blending origin. |
| overlay | RasterImage | The overlay image. |
| overlay_area | Rectangle | The overlay area. |
| overlay_alpha | byte | The overlay alpha. |
Method: can_load(file_path) [static]
can_load(file_path)
Determines whether image can be loaded from the specified file path.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path. |
Returns
| Type | Description |
|---|---|
| bool |
Method: can_load(file_path, load_options) [static]
can_load(file_path, load_options)
Determines whether image can be loaded from the specified file path and optionally using the specified open options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path. |
| load_options | LoadOptions | The load options. |
Returns
| Type | Description |
|---|---|
| bool |
Method: can_load(stream) [static]
can_load(stream)
Determines whether image can be loaded from the specified stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load from. |
Returns
| Type | Description |
|---|---|
| bool |
Method: can_load(stream, load_options) [static]
can_load(stream, load_options)
Determines whether image can be loaded from the specified stream and optionally using the specified loadOptions.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load from. |
| load_options | LoadOptions | The load options. |
Returns
| Type | Description |
|---|---|
| bool |
Method: can_load_stream(stream) [static]
can_load_stream(stream)
Determines whether image can be loaded from the specified stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load from. |
Returns
| Type | Description |
|---|---|
| bool |
Method: can_load_stream_with_options(stream, load_options) [static]
can_load_stream_with_options(stream, load_options)
Determines whether image can be loaded from the specified stream and optionally using the specified loadOptions.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load from. |
| load_options | LoadOptions | The load options. |
Returns
| Type | Description |
|---|---|
| bool |
Method: can_load_with_options(file_path, load_options) [static]
can_load_with_options(file_path, load_options)
Determines whether image can be loaded from the specified file path and optionally using the specified open options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path. |
| load_options | LoadOptions | The load options. |
Returns
| Type | Description |
|---|---|
| bool |
Method: can_save(options)
can_save(options)
Determines whether image can be saved to the specified file format represented by the passed save options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | ImageOptionsBase | The save options to use. |
Returns
| Type | Description |
|---|---|
| bool |
Method: create(image_options, width, height) [static]
create(image_options, width, height)
Creates a new image using the specified create options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| image_options | ImageOptionsBase | The image options. |
| width | int | The width. |
| height | int | The height. |
Returns
| Type | Description |
|---|---|
| Image | The newly created image. |
Method: create(images) [static]
create(images)
Creates a new image using the specified images as pages
Parameters:
| Parameter | Type | Description |
|---|---|---|
| images | Image[] | The images. |
Returns
| Type | Description |
|---|---|
| Image | The Image as IMultipageImage |
Method: create(images, dispose_images) [static]
create(images, dispose_images)
Creates a new image the specified images as pages.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| images | Image[] | The images. |
| dispose_images | bool | if set to |
Returns
| Type | Description |
|---|---|
| Image | The Image as IMultipageImage |
Method: create_from_file_with_bpp(path, bits_per_pixel) [static]
create_from_file_with_bpp(path, bits_per_pixel)
Initializes a new instance of the Jpeg2000Image class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | string | The path to load image from and initialize pixel and palette data with |
| bits_per_pixel | int | The bits per pixel. |
Returns
| Type | Description |
|---|---|
| Jpeg2000Image |
Method: create_from_image(image) [static]
create_from_image(image)
Initializes a new instance of the Jpeg2000Image class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| image | RasterImage | The image. |
Returns
| Type | Description |
|---|---|
| Jpeg2000Image |
Method: create_from_image_with_bpp(raster_image, bits_per_pixel) [static]
create_from_image_with_bpp(raster_image, bits_per_pixel)
Initializes a new instance of the Jpeg2000Image class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| raster_image | RasterImage | The image to initialize pixel and palette data with. |
| bits_per_pixel | int | The bits per pixel. |
Returns
| Type | Description |
|---|---|
| Jpeg2000Image |
Method: create_from_stream(stream) [static]
create_from_stream(stream)
Initializes a new instance of the Jpeg2000Image class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load image from and initialize pixel and palette data with. |
Returns
| Type | Description |
|---|---|
| Jpeg2000Image |
Method: create_from_stream_with_bpp(stream, bits_per_pixel) [static]
create_from_stream_with_bpp(stream, bits_per_pixel)
Initializes a new instance of the Jpeg2000Image class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load image from and initialize pixel and palette data with. |
| bits_per_pixel | int | The bits per pixel. |
Returns
| Type | Description |
|---|---|
| Jpeg2000Image |
Method: create_with_width_height(width, height) [static]
create_with_width_height(width, height)
Initializes a new instance of the Jpeg2000Image class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| width | int | The image width |
| height | int | The image height |
Returns
| Type | Description |
|---|---|
| Jpeg2000Image |
Method: create_with_width_height_bitscount(width, height, bits_count) [static]
create_with_width_height_bitscount(width, height, bits_count)
Initializes a new instance of the Jpeg2000Image class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| width | int | The image width |
| height | int | The image height |
| bits_count | int | The bits count. |
Returns
| Type | Description |
|---|---|
| Jpeg2000Image |
Method: create_with_width_height_options(width, height, options) [static]
create_with_width_height_options(width, height, options)
Initializes a new instance of the Jpeg2000Image class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| width | int | The image width |
| height | int | The image height |
| options | Jpeg2000Options | The options. |
Returns
| Type | Description |
|---|---|
| Jpeg2000Image |
Method: crop(left_shift, right_shift, top_shift, bottom_shift)
crop(left_shift, right_shift, top_shift, bottom_shift)
Crop image with shifts.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| left_shift | int | The left shift. |
| right_shift | int | The right shift. |
| top_shift | int | The top shift. |
| bottom_shift | int | The bottom shift. |
Method: crop(rectangle)
crop(rectangle)
Cropping the image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle. |
Method: dither(dithering_method, bits_count)
dither(dithering_method, bits_count)
Performs dithering on the current image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| dithering_method | DitheringMethod | The dithering method. |
| bits_count | int | The final bits count for dithering. |
Method: dither(dithering_method, bits_count, custom_palette)
dither(dithering_method, bits_count, custom_palette)
Performs dithering on the current image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| dithering_method | DitheringMethod | The dithering method. |
| bits_count | int | The final bits count for dithering. |
| custom_palette | IColorPalette | The custom palette for dithering. |
Method: filter(rectangle, options)
filter(rectangle, options)
Filters the specified rectangle.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle. |
| options | FilterOptionsBase | The options. |
Method: get_argb_32_pixel(x, y)
get_argb_32_pixel(x, y)
Gets an image 32-bit ARGB pixel.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | int | The pixel x location. |
| y | int | The pixel y location. |
Returns
| Type | Description |
|---|---|
| int | The 32-bit ARGB pixel for the specified location. |
Method: get_default_argb_32_pixels(rectangle)
get_default_argb_32_pixels(rectangle)
Gets the default 32-bit ARGB pixels array.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to get pixels for. |
Returns
| Type | Description |
|---|---|
| int | The default pixels array. |
Method: get_default_options(args)
get_default_options(args)
Gets the default options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| args | object | The arguments. |
Returns
| Type | Description |
|---|---|
| ImageOptionsBase | Default options |
Method: get_default_pixels(rectangle, partial_pixel_loader)
get_default_pixels(rectangle, partial_pixel_loader)
Gets the default pixels array using partial pixel loader.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to get pixels for. |
| partial_pixel_loader | IPartialArgb32PixelLoader | The partial pixel loader. |
Method: get_default_raw_data(rectangle, partial_raw_data_loader, raw_data_settings)
get_default_raw_data(rectangle, partial_raw_data_loader, raw_data_settings)
Gets the default raw data array using partial pixel loader.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to get pixels for. |
| partial_raw_data_loader | IPartialRawDataLoader | The partial raw data loader. |
| raw_data_settings | RawDataSettings | The raw data settings. |
Method: get_default_raw_data(rectangle, raw_data_settings)
get_default_raw_data(rectangle, raw_data_settings)
Gets the default raw data array.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to get raw data for. |
| raw_data_settings | RawDataSettings | The raw data settings. |
Returns
| Type | Description |
|---|---|
| byte | The default raw data array. |
Method: get_file_format(file_path) [static]
get_file_format(file_path)
Gets the file format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path. |
Returns
| Type | Description |
|---|---|
| FileFormat | The determined file format. |
Method: get_file_format(stream) [static]
get_file_format(stream)
Gets the file format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream. |
Returns
| Type | Description |
|---|---|
| FileFormat | The determined file format. |
Method: get_file_format_of_stream(stream) [static]
get_file_format_of_stream(stream)
Gets the file format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream. |
Returns
| Type | Description |
|---|---|
| FileFormat | The determined file format. |
Method: get_fitting_rectangle(rectangle, pixels, width, height) [static]
get_fitting_rectangle(rectangle, pixels, width, height)
Gets rectangle which fits the current image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to get fitting rectangle for. |
| pixels | int | The 32-bit ARGB pixels. |
| width | int | The object width. |
| height | int | The object height. |
Returns
| Type | Description |
|---|---|
| Rectangle | The fitting rectangle or exception if no fitting rectangle can be found. |
Method: get_fitting_rectangle(rectangle, width, height) [static]
get_fitting_rectangle(rectangle, width, height)
Gets rectangle which fits the current image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to get fitting rectangle for. |
| width | int | The object width. |
| height | int | The object height. |
Returns
| Type | Description |
|---|---|
| Rectangle | The fitting rectangle or exception if no fitting rectangle can be found. |
Method: get_modify_date(use_default)
get_modify_date(use_default)
Gets the date and time the resource image was last modified.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| use_default | bool | if set to |
Returns
| Type | Description |
|---|---|
| datetime | The date and time the resource image was last modified. |
Method: get_original_options()
get_original_options()
Retrieve the image options based on the original file settings. This method is
beneficial for maintaining the bit-depth and other parameters of the original
image, ensuring consistency and preserving the integrity of the image data.
Accessing these options facilitates seamless handling and processing of the image
while retaining its original characteristics.
For example, if we load a black-white PNG image with 1 bit per pixel and then save it using the
DataStreamSupporter.save(file_path) method, the output PNG image with 8-bit per pixel will be produced.
To avoid it and save PNG image with 1-bit per pixel, use this method to get corresponding saving options and pass them
to the Image.save(file_path, options) method as the second parameter.
Returns
| Type | Description |
|---|---|
| ImageOptionsBase | The options based on the original file settings. |
Method: get_pixel(x, y)
get_pixel(x, y)
Gets an image pixel.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | int | The pixel x location. |
| y | int | The pixel y location. |
Returns
| Type | Description |
|---|---|
| Color | The pixel color for the specified location. |
Method: get_proportional_height(width, height, new_width) [static]
get_proportional_height(width, height, new_width)
Gets a proportional height.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| width | int | The width. |
| height | int | The height. |
| new_width | int | The new width. |
Returns
| Type | Description |
|---|---|
| int | The proportional height. |
Method: get_proportional_width(width, height, new_height) [static]
get_proportional_width(width, height, new_height)
Gets a proportional width.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| width | int | The width. |
| height | int | The height. |
| new_height | int | The new height. |
Returns
| Type | Description |
|---|---|
| int | The proportional width. |
Method: get_serialized_stream(image_options, clipping_rectangle, page_number)
get_serialized_stream(image_options, clipping_rectangle, page_number)
Converts to aps.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| image_options | ImageOptionsBase | The image options. |
| clipping_rectangle | Rectangle | The clipping rectangle. |
| page_number | int[] | The page number. |
Returns
| Type | Description |
|---|---|
| _io.BufferedRandom | The serialized stream |
Method: get_skew_angle()
get_skew_angle()
Gets the skew angle.
This method is applicable to scanned text documents, to determine the skew angle when scanning.
Returns
| Type | Description |
|---|---|
| float | The skew angle, in degrees. |
Method: load(file_path) [static]
load(file_path)
Loads a new image from the specified file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path to load image from. |
Returns
| Type | Description |
|---|---|
| Image | The loaded image. |
Method: load(file_path, load_options) [static]
load(file_path, load_options)
Loads a new image from the specified file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path to load image from. |
| load_options | LoadOptions | The load options. |
Returns
| Type | Description |
|---|---|
| Image | The loaded image. |
Method: load(stream) [static]
load(stream)
Loads a new image from the specified stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load image from. |
Returns
| Type | Description |
|---|---|
| Image | The loaded image. |
Method: load(stream, load_options) [static]
load(stream, load_options)
Loads a new image from the specified stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load image from. |
| load_options | LoadOptions | The load options. |
Returns
| Type | Description |
|---|---|
| Image | The loaded image. |
Method: load_argb_32_pixels(rectangle)
load_argb_32_pixels(rectangle)
Loads 32-bit ARGB pixels.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to load pixels from. |
Returns
| Type | Description |
|---|---|
| int | The loaded 32-bit ARGB pixels array. |
Method: load_argb_64_pixels(rectangle)
load_argb_64_pixels(rectangle)
Loads 64-bit ARGB pixels.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to load pixels from. |
Returns
| Type | Description |
|---|---|
| long | The loaded 64-bit ARGB pixels array. |
Method: load_cmyk_32_pixels(rectangle)
load_cmyk_32_pixels(rectangle)
Loads pixels in CMYK format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to load pixels from. |
Returns
| Type | Description |
|---|---|
| int | The loaded CMYK pixels presentes as 32-bit inateger values. |
Method: load_cmyk_pixels(rectangle)
load_cmyk_pixels(rectangle)
Loads pixels in CMYK format.
This method is deprecated. Please use more effective the RasterImage.load_cmyk_32_pixels(rectangle) method.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to load pixels from. |
Returns
| Type | Description |
|---|---|
| CmykColor[] | The loaded CMYK pixels array. |
Method: load_partial_argb_32_pixels(rectangle, partial_pixel_loader)
load_partial_argb_32_pixels(rectangle, partial_pixel_loader)
Loads 32-bit ARGB pixels partially (by blocks).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to load pixels from. |
| partial_pixel_loader | IPartialArgb32PixelLoader | The partial pixel loader. |
Method: load_partial_argb_64_pixels(rectangle, partial_pixel_loader)
load_partial_argb_64_pixels(rectangle, partial_pixel_loader)
Loads 64-bit ARGB pixels partially by packs.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The desired rectangle. |
| partial_pixel_loader | IPartialArgb64PixelLoader | The 64-bit ARGB pixel loader. |
Method: load_partial_pixels(desired_rectangle, pixel_loader)
load_partial_pixels(desired_rectangle, pixel_loader)
Loads pixels partially by packs.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| desired_rectangle | Rectangle | The desired rectangle. |
| pixel_loader | IPartialPixelLoader | The pixel loader. |
Method: load_pixels(rectangle)
load_pixels(rectangle)
Loads pixels.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to load pixels from. |
Returns
| Type | Description |
|---|---|
| Color[] | The loaded pixels array. |
Method: load_raw_data(rectangle, dest_image_bounds, raw_data_settings, raw_data_loader)
load_raw_data(rectangle, dest_image_bounds, raw_data_settings, raw_data_loader)
Loads raw data.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to load raw data from. |
| dest_image_bounds | Rectangle | The dest image bounds. |
| raw_data_settings | RawDataSettings | The raw data settings to use for loaded data. Note if data is not in the format specified then data conversion will be performed. |
| raw_data_loader | IPartialRawDataLoader | The raw data loader. |
Method: load_raw_data(rectangle, raw_data_settings, raw_data_loader)
load_raw_data(rectangle, raw_data_settings, raw_data_loader)
Loads raw data.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to load raw data from. |
| raw_data_settings | RawDataSettings | The raw data settings to use for loaded data. Note if data is not in the format specified then data conversion will be performed. |
| raw_data_loader | IPartialRawDataLoader | The raw data loader. |
Method: load_stream(stream) [static]
load_stream(stream)
Loads a new image from the specified stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load image from. |
Returns
| Type | Description |
|---|---|
| Image | The loaded image. |
Method: load_stream_with_options(stream, load_options) [static]
load_stream_with_options(stream, load_options)
Loads a new image from the specified stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load image from. |
| load_options | LoadOptions | The load options. |
Returns
| Type | Description |
|---|---|
| Image | The loaded image. |
Method: load_with_options(file_path, load_options) [static]
load_with_options(file_path, load_options)
Loads a new image from the specified file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path to load image from. |
| load_options | LoadOptions | The load options. |
Returns
| Type | Description |
|---|---|
| Image | The loaded image. |
Method: normalize_angle(resize_proportionally, background_color)
normalize_angle(resize_proportionally, background_color)
Normalizes the angle.
This method is applicable to scanned text documents to get rid of the skewed scan.
This method uses RasterImage.get_skew_angle() and RasterImage.rotate(angle, resize_proportionally, background_color) methods.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| resize_proportionally | bool | if set to |
| background_color | Color | Color of the background. |
Method: read_argb_32_scan_line(scan_line_index)
read_argb_32_scan_line(scan_line_index)
Reads the whole scan line by the specified scan line index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| scan_line_index | int | Zero based index of the scan line. |
Returns
| Type | Description |
|---|---|
| int | The scan line 32-bit ARGB color values array. |
Method: read_scan_line(scan_line_index)
read_scan_line(scan_line_index)
Reads the whole scan line by the specified scan line index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| scan_line_index | int | Zero based index of the scan line. |
Returns
| Type | Description |
|---|---|
| Color[] | The scan line pixel color values array. |
Method: replace_argb(old_color_argb, old_color_diff, new_color_argb)
replace_argb(old_color_argb, old_color_diff, new_color_argb)
Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| old_color_argb | int | Old color ARGB value to be replaced. |
| old_color_diff | byte | Allowed difference in old color to be able to widen replaced color tone. |
| new_color_argb | int | New color ARGB value to replace old color with. |
Method: replace_color(old_color, old_color_diff, new_color)
replace_color(old_color, old_color_diff, new_color)
Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| old_color | Color | Old color to be replaced. |
| old_color_diff | byte | Allowed difference in old color to be able to widen replaced color tone. |
| new_color | Color | New color to replace old color with. |
Method: replace_color(old_color_argb, old_color_diff, new_color_argb)
replace_color(old_color_argb, old_color_diff, new_color_argb)
Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| old_color_argb | int | Old color ARGB value to be replaced. |
| old_color_diff | byte | Allowed difference in old color to be able to widen replaced color tone. |
| new_color_argb | int | New color ARGB value to replace old color with. |
Method: replace_non_transparent_colors(new_color)
replace_non_transparent_colors(new_color)
Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges.
Note: if you use it on images without transparency, all colors will be replaced with a single one.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_color | Color | New color to replace non transparent colors with. |
Method: replace_non_transparent_colors(new_color_argb)
replace_non_transparent_colors(new_color_argb)
Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges.
Note: if you use it on images without transparency, all colors will be replaced with a single one.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_color_argb | int | New color ARGB value to replace non transparent colors with. |
Method: resize(new_width, new_height)
resize(new_width, new_height)
Resizes the image. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
| new_height | int | The new height. |
Method: resize(new_width, new_height, resize_type)
resize(new_width, new_height, resize_type)
Resizes the image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
| new_height | int | The new height. |
| resize_type | ResizeType | The resize type. |
Method: resize(new_width, new_height, settings)
resize(new_width, new_height, settings)
Resizes the image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
| new_height | int | The new height. |
| settings | ImageResizeSettings | The resize settings. |
Method: resize_by_settings(new_width, new_height, settings)
resize_by_settings(new_width, new_height, settings)
Resizes the image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
| new_height | int | The new height. |
| settings | ImageResizeSettings | The resize settings. |
Method: resize_by_type(new_width, new_height, resize_type)
resize_by_type(new_width, new_height, resize_type)
Resizes the image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
| new_height | int | The new height. |
| resize_type | ResizeType | The resize type. |
Method: resize_height_proportionally(new_height)
resize_height_proportionally(new_height)
Resizes the height proportionally. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_height | int | The new height. |
Method: resize_height_proportionally(new_height, resize_type)
resize_height_proportionally(new_height, resize_type)
Resizes the height proportionally.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_height | int | The new height. |
| resize_type | ResizeType | Type of the resize. |
Method: resize_height_proportionally(new_height, settings)
resize_height_proportionally(new_height, settings)
Resizes the height proportionally.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_height | int | The new height. |
| settings | ImageResizeSettings | The image resize settings. |
Method: resize_height_proportionally_settings(new_height, settings)
resize_height_proportionally_settings(new_height, settings)
Resizes the height proportionally.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_height | int | The new height. |
| settings | ImageResizeSettings | The image resize settings. |
Method: resize_width_proportionally(new_width)
resize_width_proportionally(new_width)
Resizes the width proportionally. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
Method: resize_width_proportionally(new_width, resize_type)
resize_width_proportionally(new_width, resize_type)
Resizes the width proportionally.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
| resize_type | ResizeType | Type of the resize. |
Method: resize_width_proportionally(new_width, settings)
resize_width_proportionally(new_width, settings)
Resizes the width proportionally.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
| settings | ImageResizeSettings | The image resize settings. |
Method: resize_width_proportionally_settings(new_width, settings)
resize_width_proportionally_settings(new_width, settings)
Resizes the width proportionally.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
| settings | ImageResizeSettings | The image resize settings. |
Method: rotate(angle)
rotate(angle)
Rotate image around the center.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| angle | float | The rotate angle in degrees. Positive values will rotate clockwise. |
Method: rotate(angle, resize_proportionally, background_color)
rotate(angle, resize_proportionally, background_color)
Rotate image around the center.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| angle | float | The rotate angle in degrees. Positive values will rotate clockwise. |
| resize_proportionally | bool | if set to |
| background_color | Color | Color of the background. |
Method: rotate_flip(rotate_flip_type)
rotate_flip(rotate_flip_type)
Rotates, flips, or rotates and flips the image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rotate_flip_type | RotateFlipType | The rotate flip type. |
Method: save(file_path)
save(file_path)
Saves the image to the specified file location.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path to save the image to. |
Method: save(file_path, options)
save(file_path, options)
Saves the object’s data to the specified file location in the specified file format according to save options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path. |
| options | ImageOptionsBase | The options. |
Method: save(file_path, options, bounds_rectangle)
save(file_path, options, bounds_rectangle)
Saves the object’s data to the specified file location in the specified file format according to save options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path. |
| options | ImageOptionsBase | The options. |
| bounds_rectangle | Rectangle | The destination image bounds rectangle. Set the empty rectangle for use sourse bounds. |
Method: save(file_path, over_write)
save(file_path, over_write)
Saves the object’s data to the specified file location.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path to save the object’s data to. |
| over_write | bool | if set to |
Method: save(stream)
save(stream)
Saves the object’s data to the specified stream
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to save the object’s data to |
Method: save(stream, options_base)
save(stream, options_base)
Saves the image’s data to the specified stream in the specified file format according to save options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to save the image’s data to. |
| options_base | ImageOptionsBase | The save options. |
Method: save(stream, options_base, bounds_rectangle)
save(stream, options_base, bounds_rectangle)
Saves the image’s data to the specified stream in the specified file format according to save options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to save the image’s data to. |
| options_base | ImageOptionsBase | The save options. |
| bounds_rectangle | Rectangle | The destination image bounds rectangle. Set the empty rectangle for use source bounds. |
Method: save_argb_32_pixels(rectangle, pixels)
save_argb_32_pixels(rectangle, pixels)
Saves the 32-bit ARGB pixels.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to save pixels to. |
| pixels | int | The 32-bit ARGB pixels array. |
Method: save_cmyk_32_pixels(rectangle, pixels)
save_cmyk_32_pixels(rectangle, pixels)
Saves the pixels.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to save pixels to. |
| pixels | int | The CMYK pixels presented as the 32-bit integer values. |
Method: save_cmyk_pixels(rectangle, pixels)
save_cmyk_pixels(rectangle, pixels)
Saves the pixels.
This method is deprecated. Please use more effective the RasterImage.save_cmyk_32_pixels(rectangle, pixels) method.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to save pixels to. |
| pixels | CmykColor[] | The CMYK pixels array. |
Method: save_pixels(rectangle, pixels)
save_pixels(rectangle, pixels)
Saves pixels (format specific method).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle to save pixels to. |
| pixels | Color[] | The 32-bit ARGB pixels array. |
Method: save_raw_data(data, data_offset, rectangle, raw_data_settings)
save_raw_data(data, data_offset, rectangle, raw_data_settings)
Saves the raw data.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| data | byte | The raw data. |
| data_offset | int | The starting raw data offset. |
| rectangle | Rectangle | The raw data rectangle. |
| raw_data_settings | RawDataSettings | The raw data settings the data is in. |
Method: save_to_stream(stream)
save_to_stream(stream)
Saves the object’s data to the specified stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to save the object’s data to. |
Method: save_to_stream_with_options(stream, options_base)
save_to_stream_with_options(stream, options_base)
Saves the image’s data to the specified stream in the specified file format according to save options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to save the image’s data to. |
| options_base | ImageOptionsBase | The save options. |
Method: save_to_stream_with_options_rect(stream, options_base, bounds_rectangle)
save_to_stream_with_options_rect(stream, options_base, bounds_rectangle)
Saves the image’s data to the specified stream in the specified file format according to save options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to save the image’s data to. |
| options_base | ImageOptionsBase | The save options. |
| bounds_rectangle | Rectangle | The destination image bounds rectangle. Set the empty rectangle for use source bounds. |
Method: save_with_options(file_path, options)
save_with_options(file_path, options)
Saves the object’s data to the specified file location in the specified file format according to save options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path. |
| options | ImageOptionsBase | The options. |
Method: save_with_options_rect(file_path, options, bounds_rectangle)
save_with_options_rect(file_path, options, bounds_rectangle)
Saves the object’s data to the specified file location in the specified file format according to save options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path. |
| options | ImageOptionsBase | The options. |
| bounds_rectangle | Rectangle | The destination image bounds rectangle. Set the empty rectangle for use sourse bounds. |
Method: set_argb_32_pixel(x, y, argb_32_color)
set_argb_32_pixel(x, y, argb_32_color)
Sets an image 32-bit ARGB pixel for the specified position.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | int | The pixel x location. |
| y | int | The pixel y location. |
| argb_32_color | int | The 32-bit ARGB pixel for the specified position. |
Method: set_palette(palette, update_colors)
set_palette(palette, update_colors)
Sets the image palette.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| palette | IColorPalette | The palette to set. |
| update_colors | bool | if set to |
Method: set_pixel(x, y, color)
set_pixel(x, y, color)
Sets an image pixel for the specified position.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | int | The pixel x location. |
| y | int | The pixel y location. |
| color | Color | The pixel color for the specified position. |
Method: set_resolution(dpi_x, dpi_y)
set_resolution(dpi_x, dpi_y)
Sets the resolution for this RasterImage.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| dpi_x | double | The horizontal resolution, in dots per inch, of the RasterImage. |
| dpi_y | double | The vertical resolution, in dots per inch, of the RasterImage. |
Method: write_argb_32_scan_line(scan_line_index, argb_32_pixels)
write_argb_32_scan_line(scan_line_index, argb_32_pixels)
Writes the whole scan line to the specified scan line index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| scan_line_index | int | Zero based index of the scan line. |
| argb_32_pixels | int | The 32-bit ARGB colors array to write. |
Method: write_scan_line(scan_line_index, pixels)
write_scan_line(scan_line_index, pixels)
Writes the whole scan line to the specified scan line index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| scan_line_index | int | Zero based index of the scan line. |
| pixels | Color[] | The pixel colors array to write. |