TgaImage Class
Contents
[
Hide
]Summary: Manipulate TGA raster image files with our API, tailored for the TARGA
(Truevision Advanced Raster Adapter) format, enabling seamless loading and
customization. Easily update public properties such as author, timestamp,
image ID, and software version, while using various bits per pixel settings,
alpha channel and color transparency. Additionally, you can export TGA images
to other popular raster formats, ensuring compatibility for your projects.
Module: aspose.imaging.fileformats.tga
Full Name: aspose.imaging.fileformats.tga.TgaImage
Inheritance: IObjectWithBounds, IRasterImageArgb32PixelLoader, IRasterImageRawDataLoader, IHasXmpData, IHasMetadata, RasterCachedImage
Aspose.Imaging Version: 24.7.0
Constructors
| Name | Description |
|---|---|
| TgaImage(path) | Initializes a new TgaImage object using the provided file path for loading the image content. This constructor efficiently initializes the image instance, allowing seamless access to TGA image files, simplifying integration into your application workflow. |
| TgaImage(raster_image) | Create a new instance of the TgaImage class by providing a raster image object. This constructor facilitates the direct integration of existing raster images into the TGA image format, streamlining the conversion process for enhanced compatibility within your software systems. |
| TgaImage(stream) | Initialize a new instance of the TgaImage class using a stream to load the image. This constructor allows for seamless integration of image data from streams, facilitating efficient handling and processing of TGA images within your software applications. |
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| author_comments | string | r/w | Retrieves or sets the comments provided by the author of the image. These comments often contain valuable information, such as descriptions, annotations, or additional context about the image. By accessing or modifying the Author Comments property, developers can enhance the metadata associated with the image, providing users with valuable insights and context regarding its content or creation. This is an ASCII field consisting of 324 bytes which are organized as four lines of 80 characters, each followed by a null terminator. |
| author_name | string | r/w | Retrieves or sets the name of the author associated with the image. This property allows developers to access or modify the author’s name metadata, providing valuable information about the creator of the image. By utilizing the Author Name property, users can easily identify the individual responsible for creating or contributing to the image, enhancing its overall metadata and providing valuable context for viewers. This field is a total of 40 ASCII characters for the name. If the field is used, it should contain the name of the person who created the image (author). |
| auto_adjust_palette | bool | r/w | Gets or sets a value indicating whether automatic adjust palette. |
| background_color | Color | r/w | Retrieves or sets the background color of the image. This property allows you to specify the color used for the image background, ensuring consistency and enhancing visual presentation. It is particularly useful for scenarios where the image is displayed on a background with a different color or when rendering the image onto another canvas. |
| bits_per_pixel | int | r | Retrieve the bits per pixel value, providing essential information about the image’s color depth. This property serves as a crucial metric for understanding the level of detail and color richness present in the image, aiding developers in optimizing processing algorithms and resource allocation for efficient image manipulation and rendering tasks. |
| 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. |
| bytes_per_pixel | int | r | Obtain the bytes per pixel value, which denotes the amount of memory occupied by each pixel in the image. This property serves as a crucial metric for memory management and optimization, aiding developers in efficiently allocating resources and processing image data |
| container | Image | r | Gets the Image container. |
| data_stream_container | StreamContainer | r | Gets the object’s data stream. |
| date_time_stamp | datetime | r/w | Gets or sets Date/Time Stamp. This field defines the value for the date and time that the image was saved. Even though operating systems typically time- and date-stamp files, this feature is provided because the operating system may change the time and date stamp if the file is copied. By using this area, you are guaranteed an unmodified region for date and time recording. |
| disposed | bool | r | Gets a value indicating whether this instance is disposed. |
| file_format | FileFormat | r | Get crucial information about the file format of the image represented by this instance of TgaImage. Understanding the file format is essential for compatibility checks and ensuring seamless integration within software systems, enabling efficient processing and manipulation of images. |
| gamma_value_denominator | ushort | r | Retrieves the denominator part of the gamma value, an integral factor in determining color representation within images. For images lacking gamma correction, this value should be 1.0, ensuring accurate color rendering. Appreciating and leveraging this parameter is fundamental for upholding color fidelity and achieving precise image visualization. |
| gamma_value_numerator | ushort | r | Gets the numerator part of the gamma value, which is essential for accurate color representation in images. In images without gamma correction, this value should be 1.0. Understanding and utilizing this value is crucial for maintaining color fidelity and ensuring accurate image rendering. |
| has_alpha | bool | r | Retrieve a boolean value indicating whether the TgaImage includes an alpha channel, facilitating transparency effects. This property provides essential information for handling image composition and rendering, assisting developers in implementing diverse visual effects and compositing operations. |
| has_background_color | bool | r/w | Retrieves or sets a value indicating whether the image contains a background color. This property is useful for determining whether the image includes a distinct background color separate from the foreground content. It enables you to customize image processing or rendering based on the presence or absence of a background color. |
| has_color_map | bool | r | Retrieve whether this TgaImage instance contains a color map. Understanding the presence of a color map is crucial for accurate interpretation and manipulation of the image’s color data. |
| has_transparent_color | bool | r/w | Retrieves or sets a boolean value indicating whether the image contains a transparent color. This property is essential for identifying whether the image supports transparency, helping you to implement appropriate handling of transparency-related operations such as blending, compositing, or masking. |
| height | int | r | Obtain the height of the image encapsulated by this TgaImage instance. This property furnishes developers with critical details concerning the image’s vertical dimensions, enabling seamless integration and manipulation of images within their software solutions. |
| horizontal_resolution | double | r/w | Gets or sets the horizontal resolution, in pixels per inch, of this RasterImage. |
| image_id | string | r/w | Gets or sets the unique identifier associated with the image. This ID serves as a reference point for identifying and distinguishing the image from others within a system or application. By setting or retrieving the Image ID, you can manage and track images effectively, facilitating organized image management and retrieval processes. This optional field contains identifying information about the image. The maximum length for this field is 255 bytes. |
| 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_gray_scale | bool | r | Obtain a boolean value indicating whether the TgaImage represents a gray-scale image. This property is crucial for distinguishing between color and gray-scale images, aiding developers in applying appropriate processing and rendering techniques based on the image’s color characteristics. |
| is_raw_data_available | bool | r | Gets a value indicating whether raw data loading is supported. |
| job_name_or_id | string | r/w | Retrieves or sets the job name or ID associated with the image. This property enables you to access or modify metadata related to the specific job or project associated with the image. By utilizing the Job Name/ID property, users can easily identify the project or task to which the image pertains, facilitating organization and management of image assets within larger workflows or projects. |
| job_time | datetime | r/w | Retrieves or sets the timestamp indicating the job time associated with the image. This property allows developers to access or modify the time metadata related to the specific job or project associated with the image. |
| palette | IColorPalette | r/w | Gets or sets the color palette. The color palette is not used when pixels are represented directly. |
| pixel_aspect_ratio_denominator | ushort | r | Retrieves the denominator part of the Pixel Aspect Ratio, a crucial factor in determining the visual aspect of pixels within the image. This value is essential for preserving accurate pixel representation and aspect ratios throughout various image rendering and processing operations, ensuring high-quality visual output. |
| pixel_aspect_ratio_numerator | ushort | r | Retrieves the numerator component of the Pixel Aspect Ratio, which influences the visual aspect of pixels within the image. Understanding and manipulating this value is essential for achieving accurate pixel representation and aspect ratios in image rendering and processing. |
| 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 | Gets the raw data format. |
| 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 | Gets the raw line size in bytes. |
| size | Size | r | Gets the object size. |
| software_id | string | r/w | Manages the software identification (ID) associated with the image, allowing for up to 40 ASCII characters. This property serves as a means to uniquely identify the software utilized in creating or processing the image, providing valuable metadata for organizational and informational purposes. |
| software_version | string | r/w | Retrieves or sets the software version associated with the image. The accepted length for the version string is typically 3 to 4 characters. This property is useful for tracking the software used to create or manipulate the image and can provide valuable context for image processing and compatibility checks. |
| software_version_letter | char | r/w | Retrieves or sets the letter component of the software version associated with the image. This property represents an additional detail within the software version string and can be useful for finer version differentiation. |
| software_version_number | ushort | r/w | Retrieves or sets the numeric component of the software version associated with the image. This property represents the numerical part of the software version string, providing important information about the version of the software used to create or modify the image. |
| transparent_color | Color | r/w | Retrieves or sets the key color associated with the image. This property allows you to access or modify the color designated as the key color for specific image processing tasks or effects. Utilizing the Key Color property enables users to apply color-based operations such as chroma keying or color replacement, enhancing image manipulation capabilities and creative possibilities. The Key Color can be thought of as the ‘background color’ or ‘transparent color’. This is the color of the ‘non image’ area of the screen, and the same color that the screen would be cleared to if erased in the application. |
| 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 | Gets or sets the vertical resolution, in pixels per inch, of this RasterImage. |
| width | int | r | Retrieve the width of the image represented by this TgaImage instance. This property provides developers with essential information about the image dimensions, facilitating various image manipulation and processing tasks within their software applications. |
| x_origin | ushort | r/w | Gets or sets absolute horizontal coordinate for the lower left corner of the image as it is positioned on a display device having an origin at the lower left of the screen(e.g., the TARGA series). |
| xmp_data | XmpPacketWrapper | r/w | Gets or sets Xmp data. |
| y_origin | ushort | r/w | Gets or sets absolute vertical coordinate for the lower left corner of the image as it is positioned on a display device having an origin at the lower left of the screen(e.g., the TARGA series). |
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. |
| clone() | Produces a duplicate of the current instance, generating a new object that clones all attributes and properties of the original. This method facilitates the creation of identical copies, ensuring data integrity and preserving the state of the current instance without affecting the original object. |
| clone(tga_image) | Replicate the properties of another TgaImage object, creating a new instance with identical attributes. This operation ensures the preservation of data integrity and facilitates the duplication of image properties without altering the source object. |
| 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_image(raster_image) | Initializes a new instance of the TgaImage class. |
| create_from_stream(stream) | Initializes a new instance of the TgaImage class. |
| crop(left_shift, right_shift, top_shift, bottom_shift) | Crop the image by specifying shifts for the left, right, top, and bottom boundaries. This method allows you to trim the image by moving its boundaries independently along the horizontal and vertical axes. By adjusting these shifts, you can precisely control which portions of the image to retain, effectively cropping it to the desired dimensions. |
| crop(rectangle) | Crop the image to a specified region. This method allows you to define a rectangular area within the image to retain, discarding the rest. This operation is useful for focusing on specific content within the image or removing unwanted portions. |
| 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() | Gets the options based on the original file settings. This can be helpful to keep bit-depth and other parameters of the original image unchanged. 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. |
| remove_metadata() | Removes this image instance metadata by setting this IHasXmpData.xmp_data value to None. |
| 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) | Rotates the image around its center by a specified angle while maintaining resize proportionality and preserving the background color. This method allows for precise image manipulation, ensuring that the rotation maintains visual balance and consistency with the specified background color. It’s ideal for tasks where accurate rotation around the center is necessary, such as orientation correction or artistic adjustments. |
| rotate_flip(rotate_flip_type) | The “RotateFlip” method enables rotating and flipping operations on the image. It offers versatile functionality for manipulating image orientation, allowing users to perform rotations and flips according to their requirements, facilitating efficient image processing tasks within software applications. |
| 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) | The save data. |
| 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: TgaImage(path)
TgaImage(path)
Initializes a new TgaImage object using the provided file path for
loading the image content. This constructor efficiently initializes the image
instance, allowing seamless access to TGA image files, simplifying integration
into your application workflow.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | string | The path to load an image. |
Constructor: TgaImage(raster_image)
TgaImage(raster_image)
Create a new instance of the TgaImage class by providing a raster
image object. This constructor facilitates the direct integration of existing
raster images into the TGA image format, streamlining the conversion process for
enhanced compatibility within your software systems.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| raster_image | RasterImage | The raster image. |
See also:
Example # 1: Loading of the PNG image, conversion of it to the TgaImage and saving as a TG…
Constructor: TgaImage(stream)
TgaImage(stream)
Initialize a new instance of the TgaImage class using a stream to
load the image. This constructor allows for seamless integration of image data
from streams, facilitating efficient handling and processing of TGA images within
your software applications.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load an image. |
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: clone()
clone()
Produces a duplicate of the current instance, generating a new object that clones
all attributes and properties of the original. This method facilitates the
creation of identical copies, ensuring data integrity and preserving the state of
the current instance without affecting the original object.
Returns
| Type | Description |
|---|---|
| TgaImage | Returns a new object that is a copy of the current instance. |
Method: clone(tga_image)
clone(tga_image)
Replicate the properties of another TgaImage object, creating a
new instance with identical attributes. This operation ensures the preservation
of data integrity and facilitates the duplication of image properties without
altering the source object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| tga_image | TgaImage | Other TgaImage |
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_image(raster_image) [static]
create_from_image(raster_image)
Initializes a new instance of the TgaImage class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| raster_image | RasterImage | The raster image. |
Returns
| Type | Description |
|---|---|
| TgaImage |
Method: create_from_stream(stream) [static]
create_from_stream(stream)
Initializes a new instance of the TgaImage class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load an image. |
Returns
| Type | Description |
|---|---|
| TgaImage |
Method: crop(left_shift, right_shift, top_shift, bottom_shift)
crop(left_shift, right_shift, top_shift, bottom_shift)
Crop the image by specifying shifts for the left, right, top, and bottom
boundaries. This method allows you to trim the image by moving its boundaries
independently along the horizontal and vertical axes. By adjusting these shifts,
you can precisely control which portions of the image to retain, effectively
cropping it to the desired dimensions.
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)
Crop the image to a specified region. This method allows you to define a
rectangular area within the image to retain, discarding the rest. This operation
is useful for focusing on specific content within the image or removing unwanted
portions.
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()
Gets the options based on the original file settings.
This can be helpful to keep bit-depth and other parameters of the original image unchanged.
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)
Rotates the image around its center by a specified angle while maintaining resize
proportionality and preserving the background color. This method allows for
precise image manipulation, ensuring that the rotation maintains visual balance
and consistency with the specified background color. It’s ideal for tasks where
accurate rotation around the center is necessary, such as orientation correction
or artistic adjustments.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| angle | float | The rotate angle in degrees. Positive values will rotate clockwise. |
| resize_proportionally | bool | if set to according to rotated rectangle (corner points) projections in other case that leaves dimensions untouched and only internal image contents are rotated. |
| background_color | Color | Color of the background. |
Method: rotate_flip(rotate_flip_type)
rotate_flip(rotate_flip_type)
The “RotateFlip” method enables rotating and flipping operations on the image. It
offers versatile functionality for manipulating image orientation, allowing users
to perform rotations and flips according to their requirements, facilitating
efficient image processing tasks within software applications.
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)
The save data.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream. |
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. |
Examples
Saving of the JPG image as a TGA image.
from aspose.imaging import Image
from aspose.imaging.imageoptions import TgaOptions
with Image.load("test.jpg") as image:
image.save("test.tga"", TgaOptions())
Loading of the PNG image, conversion of it to the TgaImage and saving as a TGA image.
from aspose.pycore import as_of
from aspose.imaging import Image, RasterImage
from aspose.imaging.fileformats.tga import TgaImage
with as_of(Image.load("test.png"), RasterImage) as image:
with TgaImage(image) as tgaImage:
tgaImage.save("test.tga")