GifFrameBlock Class
Summary: Gif frame block.
Module: aspose.imaging.fileformats.gif.blocks
Full Name: aspose.imaging.fileformats.gif.blocks.GifFrameBlock
Inheritance: IObjectWithBounds, IRasterImageArgb32PixelLoader, IRasterImageRawDataLoader, IHasXmpData, IHasMetadata, IGifBlock, IAnimationFrame, RasterCachedImage
Aspose.Imaging Version: 24.7.0
Constructors
Properties
Name | Type | Access | Description |
---|---|---|---|
EXTENSION_LABEL [static] | int | r | Block extension label. |
IMAGE_DESCRIPTOR_SIZE [static] | int | r | The image descriptor size. |
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 | Gets the image bits per pixel count. |
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. |
container | Image | r | Gets the Image container. |
control_block | GifGraphicsControlBlock | r | Gets the graphics control block associated with this block. |
data_stream_container | StreamContainer | r | Gets the object’s data stream. |
disposal_method | AnimationDisposalMethods | r | Gets the disposal method. |
disposed | bool | r | Gets a value indicating whether this instance is disposed. |
file_format | FileFormat | r | Gets a value of file format |
flags | byte | r/w | Gets or sets the flags. |
frame_left | int | r | Gets the left. |
frame_time | int | r/w | Gets or sets the duration. |
frame_top | int | r | Converts to p. |
gif_frame_bits_per_pixel | byte | r/w | Gets or sets the GIF frame bits per pixel. |
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 frame block has transparent color. |
height | int | r | Gets the image height. |
horizontal_resolution | double | r/w | Gets or sets the horizontal resolution, in pixels per inch, of this RasterImage. |
image_opacity | float | r | Gets opacity of this image. |
interlaced | bool | r/w | Gets or sets a value indicating whether this GifFrameBlock is interlaced. |
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_interlaced | bool | r | Gets a value indicating whether this image instance is interlaced. |
is_palette_sorted | bool | r/w | Gets or sets a value indicating whether color palette is sorted. |
is_raw_data_available | bool | r | Gets a value indicating whether raw data loading is supported. |
left | ushort | r/w | Gets or sets the left image location. |
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 | 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. |
top | ushort | r/w | Gets or sets the top image location. |
transparent_color | Color | r/w | Gets the transparent color of frame block. |
update_xmp_data | bool | r/w | Gets or sets a value indicating whether to update the XMP metadata. |
use_alpha_blending | bool | r | Gets a value indicating whether [use alpha blending]. |
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 | Gets the image width. |
xmp_data | XmpPacketWrapper | r/w | Gets or sets Xmp data. |
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_flags(color_palette, is_palette_sorted, is_gif_frame_interlaced) | Creates the flags. |
create_from_file_left_top(path, left, top) | Initializes a new instance of the GifFrameBlock class. |
create_from_file_left_top_pal_sorted_interlaced_code_size(path, left, top, is_palette_sorted, is_gif_frame_interlaced, lzw_code_size) | Initializes a new instance of the GifFrameBlock class. |
create_from_image(image) | Initializes a new instance of the GifFrameBlock class. |
create_from_image_left_top(image, left, top) | Initializes a new instance of the GifFrameBlock class. |
create_from_image_left_top_pal_sorted_interlaced_code_size(image, left, top, is_palette_sorted, is_gif_frame_interlaced, lzw_code_size) | Initializes a new instance of the GifFrameBlock class. |
create_from_stream(stream) | Initializes a new instance of the GifFrameBlock class. |
create_from_stream_left_top(stream, left, top) | Initializes a new instance of the GifFrameBlock class. |
create_from_stream_left_top_pal_sorted_interlaced_code_size(stream, left, top, is_palette_sorted, is_gif_frame_interlaced, lzw_code_size) | Initializes a new instance of the GifFrameBlock 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_color_palette(frame_palette, container_palette) | Gets the associated color palette. |
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_full_frame() | Gets the full frame. |
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) | Resize current frame using full frame approach. |
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: GifFrameBlock(image)
GifFrameBlock(image)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
image | RasterImage | The image to initialize frame pixel and palette data with. |
Constructor: GifFrameBlock(image, left, top)
GifFrameBlock(image, left, top)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
image | RasterImage | The image to initialize frame pixel and palette data with. |
left | ushort | The left image position. |
top | ushort | The top image position. |
Constructor: GifFrameBlock(image, left, top, is_palette_sorted, is_gif_frame_interlaced, lzw_code_size)
GifFrameBlock(image, left, top, is_palette_sorted, is_gif_frame_interlaced, lzw_code_size)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
image | RasterImage | The image to initialize frame pixel and palette data with. |
left | ushort | The left image position. |
top | ushort | The top image position. |
is_palette_sorted | bool | if set to |
is_gif_frame_interlaced | bool | if set to |
lzw_code_size | byte | The bits per pixel. |
Constructor: GifFrameBlock(left, top, width, height)
GifFrameBlock(left, top, width, height)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
left | ushort | The left image position. |
top | ushort | The top image position. |
width | ushort | The image width. |
height | ushort | The image height. |
Constructor: GifFrameBlock(left, top, width, height, color_palette, is_palette_sorted, is_gif_frame_interlaced, bits_per_pixel)
GifFrameBlock(left, top, width, height, color_palette, is_palette_sorted, is_gif_frame_interlaced, bits_per_pixel)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
left | ushort | The left image position. |
top | ushort | The top image position. |
width | ushort | The image Width. |
height | ushort | The image Height. |
color_palette | IColorPalette | The color palette. |
is_palette_sorted | bool | if set to |
is_gif_frame_interlaced | bool | if set to |
bits_per_pixel | byte | The bits per pixel. |
Constructor: GifFrameBlock(path)
GifFrameBlock(path)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
path | string | The path to load an image from and initialize frame pixel and palette data with. |
Constructor: GifFrameBlock(path, left, top)
GifFrameBlock(path, left, top)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
path | string | The path to load an image from and initialize frame pixel and palette data with. |
left | ushort | The left image position. |
top | ushort | The top image position. |
Constructor: GifFrameBlock(path, left, top, is_palette_sorted, is_gif_frame_interlaced, lzw_code_size)
GifFrameBlock(path, left, top, is_palette_sorted, is_gif_frame_interlaced, lzw_code_size)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
path | string | The path to load an image from and initialize frame pixel and palette data with. |
left | ushort | The left image position. |
top | ushort | The top image position. |
is_palette_sorted | bool | if set to |
is_gif_frame_interlaced | bool | if set to |
lzw_code_size | byte | The bits per pixel. |
Constructor: GifFrameBlock(stream)
GifFrameBlock(stream)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
stream | _io.BufferedRandom | The stream to load an image from and initialize frame pixel and palette data with. |
Constructor: GifFrameBlock(stream, left, top)
GifFrameBlock(stream, left, top)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
stream | _io.BufferedRandom | The stream to load an image from and initialize frame pixel and palette data with. |
left | ushort | The left image position. |
top | ushort | The top image position. |
Constructor: GifFrameBlock(stream, left, top, is_palette_sorted, is_gif_frame_interlaced, lzw_code_size)
GifFrameBlock(stream, left, top, is_palette_sorted, is_gif_frame_interlaced, lzw_code_size)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
stream | _io.BufferedRandom | The stream to load an image from and initialize frame pixel and palette data with. |
left | ushort | The left image position. |
top | ushort | The top image position. |
is_palette_sorted | bool | if set to |
is_gif_frame_interlaced | bool | if set to |
lzw_code_size | byte | The bits per pixel. |
Constructor: GifFrameBlock(width, height)
GifFrameBlock(width, height)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
width | ushort | The image width. |
height | ushort | The image height. |
See also:
Example # 1: This example shows how to create a GIF image and save it to a file.
Example # 2: This example shows how to create a GIF image with a custom palette and save i…
Example # 3: The following example shows how to compose an animated GIF image from individ…
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_flags(color_palette, is_palette_sorted, is_gif_frame_interlaced) [static]
create_flags(color_palette, is_palette_sorted, is_gif_frame_interlaced)
Creates the flags.
Parameters:
Parameter | Type | Description |
---|---|---|
color_palette | IColorPalette | The color palette. |
is_palette_sorted | bool | if set to |
is_gif_frame_interlaced | bool | if set to |
Returns
Type | Description |
---|---|
byte | The created flags. |
Method: create_from_file_left_top(path, left, top) [static]
create_from_file_left_top(path, left, top)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
path | string | The path to load an image from and initialize frame pixel and palette data with. |
left | ushort | The left image position. |
top | ushort | The top image position. |
Returns
Type | Description |
---|---|
GifFrameBlock |
Method: create_from_file_left_top_pal_sorted_interlaced_code_size(path, left, top, is_palette_sorted, is_gif_frame_interlaced, lzw_code_size) [static]
create_from_file_left_top_pal_sorted_interlaced_code_size(path, left, top, is_palette_sorted, is_gif_frame_interlaced, lzw_code_size)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
path | string | The path to load an image from and initialize frame pixel and palette data with. |
left | ushort | The left image position. |
top | ushort | The top image position. |
is_palette_sorted | bool | if set to |
is_gif_frame_interlaced | bool | if set to |
lzw_code_size | byte | The bits per pixel. |
Returns
Type | Description |
---|---|
GifFrameBlock |
Method: create_from_image(image) [static]
create_from_image(image)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
image | RasterImage | The image to initialize frame pixel and palette data with. |
Returns
Type | Description |
---|---|
GifFrameBlock |
Method: create_from_image_left_top(image, left, top) [static]
create_from_image_left_top(image, left, top)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
image | RasterImage | The image to initialize frame pixel and palette data with. |
left | ushort | The left image position. |
top | ushort | The top image position. |
Returns
Type | Description |
---|---|
GifFrameBlock |
Method: create_from_image_left_top_pal_sorted_interlaced_code_size(image, left, top, is_palette_sorted, is_gif_frame_interlaced, lzw_code_size) [static]
create_from_image_left_top_pal_sorted_interlaced_code_size(image, left, top, is_palette_sorted, is_gif_frame_interlaced, lzw_code_size)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
image | RasterImage | The image to initialize frame pixel and palette data with. |
left | ushort | The left image position. |
top | ushort | The top image position. |
is_palette_sorted | bool | if set to |
is_gif_frame_interlaced | bool | if set to |
lzw_code_size | byte | The bits per pixel. |
Returns
Type | Description |
---|---|
GifFrameBlock |
Method: create_from_stream(stream) [static]
create_from_stream(stream)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
stream | _io.BufferedRandom | The stream to load an image from and initialize frame pixel and palette data with. |
Returns
Type | Description |
---|---|
GifFrameBlock |
Method: create_from_stream_left_top(stream, left, top) [static]
create_from_stream_left_top(stream, left, top)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
stream | _io.BufferedRandom | The stream to load an image from and initialize frame pixel and palette data with. |
left | ushort | The left image position. |
top | ushort | The top image position. |
Returns
Type | Description |
---|---|
GifFrameBlock |
Method: create_from_stream_left_top_pal_sorted_interlaced_code_size(stream, left, top, is_palette_sorted, is_gif_frame_interlaced, lzw_code_size) [static]
create_from_stream_left_top_pal_sorted_interlaced_code_size(stream, left, top, is_palette_sorted, is_gif_frame_interlaced, lzw_code_size)
Initializes a new instance of the GifFrameBlock class.
Parameters:
Parameter | Type | Description |
---|---|---|
stream | _io.BufferedRandom | The stream to load an image from and initialize frame pixel and palette data with. |
left | ushort | The left image position. |
top | ushort | The top image position. |
is_palette_sorted | bool | if set to |
is_gif_frame_interlaced | bool | if set to |
lzw_code_size | byte | The bits per pixel. |
Returns
Type | Description |
---|---|
GifFrameBlock |
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_color_palette(frame_palette, container_palette) [static]
get_color_palette(frame_palette, container_palette)
Gets the associated color palette.
Parameters:
Parameter | Type | Description |
---|---|---|
frame_palette | IColorPalette | The frame palette. |
container_palette | IColorPalette | The container palette. |
Returns
Type | Description |
---|---|
IColorPalette | The color palette. |
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_full_frame()
get_full_frame()
Gets the full frame.
Returns
Type | Description |
---|---|
RasterImage | he RasterImage with full frame |
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_diff | byte | Allowed difference in old color to be able to widen replaced color tone. |
new_color | Color |
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 |
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)
Resize current frame using full frame approach.
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. |
Examples
This example shows how to create a GIF image and save it to a file.
from aspose.imaging.fileformats.gif.blocks import GifFrameBlock
from aspose.imaging.fileformats.gif import GifImage
from aspose.imaging.brushes import SolidBrush
from aspose.imaging import Graphics, Color
# Create a GIF Frame block of 100x100 px.
with GifFrameBlock(100, 100) as firstBlock:
# Fill the entire block in red.
gr = Graphics(firstBlock)
brush = SolidBrush(Color.red)
gr.fill_rectangle(brush, firstBlock.bounds)
with GifImage(firstBlock) as gifImage:
gifImage.save("output.gif")
This example shows how to create a GIF image with a custom palette and save it to a file.
from aspose.imaging.fileformats.gif.blocks import GifFrameBlock
from aspose.imaging.fileformats.gif import GifImage
from aspose.imaging.brushes import SolidBrush
from aspose.imaging import Graphics, Color, ColorPaletteHelper
# Create a GIF Frame block of 100x100 px.
with GifFrameBlock(100, 100) as firstBlock:
# Fill the entire block in red.
gr = Graphics(firstBlock)
brush = SolidBrush(Color.red)
gr.fill_rectangle(brush, firstBlock.bounds)
# Use 4-bit palette to reduce the image size. The quality can get worse.
palette = ColorPaletteHelper.create_4_bit()
with GifImage(firstBlock, palette) as gifImage:
gifImage.save("output.gif")
The following example shows how to compose an animated GIF image from individual GIF blocks.
from aspose.imaging.fileformats.gif.blocks import GifFrameBlock
from aspose.imaging.fileformats.gif import GifImage
from aspose.imaging.brushes import SolidBrush
from aspose.imaging import Graphics, Color
# Create a GIF image 100 x 100 px.
# The first block is fully black by default.
with GifFrameBlock(100, 100) as firstBlock:
with GifImage(firstBlock) as gifImage:
# The first circle is red
brush1 = SolidBrush(Color.red)
# The second circle is black
brush2 = SolidBrush(Color.black)
# Gradually increase the angle of the red arc shape.
for angle in range(10, 361, 10):
block = GifFrameBlock(100, 100)
gr = Graphics(block)
gr.fill_pie(brush1, block.bounds, 0, angle)
gifImage.add_block(block)
# Gradually increase the angle of the black arc and wipe out the red arc.
for angle in range(10, 361, 10):
block = GifFrameBlock(100, 100)
gr = Graphics(block)
gr.fill_pie(brush2, block.bounds, 0, angle)
gr.fill_pie(brush1, block.bounds, angle, 360 - angle)
gifImage.add_block(block)
gifImage.save("animated_radar.gif")