BigTiffImage Class

Summary: With the BigTiffImage class you can effortlessly manipulate
BigTiff image format files. Our API offering seamless handling and customization
options, ensuring optimal processing of large-scale image data with versatile features
tailored to your specific requirements.

Module: aspose.imaging.fileformats.bigtiff

Full Name: aspose.imaging.fileformats.bigtiff.BigTiffImage

Inheritance: IObjectWithBounds, IRasterImageArgb32PixelLoader, IRasterImageRawDataLoader, IHasXmpData, IHasMetadata, IMultipageImage, IMultipageImageExt, IHasExifData, TiffImage

Constructors

Name	Description
BigTiffImage(frame)	Create a new instance of the BigTiffImage class by initializing it with a TiffFrame parameter. Ideal for developers seeking a convenient way to work with BigTiffImage objects, ensuring flexibility and ease of integration into their projects.
BigTiffImage(frames)	Begin utilizing the BigTiffImage class seamlessly by initializing a new instance with a list of TiffFrames parameter. Perfect for developers seeking a straightforward method to work with BigTiffImage objects containing multiple frames, ensuring efficiency of their projects.

Properties

Name	Type	Access	Description
active_frame	TiffFrame	r/w	Manage the active frame seamlessly, facilitating dynamic navigation and manipulation within the designated context. Empower your application to interact efficiently with multimedia content, enhancing user engagement and productivity.
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.
byte_order	TiffByteOrder	r/w	Toggle the byte order for TIFF files seamlessly, ensuring precise control over data interpretation. Empower your applications with the flexibility to adapt to diverse file specifications, enhancing compatibility and efficiency in data processing.
container	Image	r	Gets the Image container.
data_stream_container	StreamContainer	r	Gets the object’s data stream.
disposed	bool	r	Gets a value indicating whether this instance is disposed.
exif_data	ExifData	r/w	Access or modify EXIF data associated with the active frame seamlessly, empowering precise control over image metadata. Enhance your application’s capabilities by integrating this feature, ensuring accurate preservation and customization of essential image information.
file_format	FileFormat	r	Retrieve the file format value associated with the image. This property serves as a critical aspect of image metadata retrieval, allowing software applications to identify and interpret the format of the image data efficiently.
frames	TiffFrame[]	r	Retrieve an array of TiffFrame instances, enabling comprehensive access and manipulation of individual frames within the TIFF image. Harness the power of this array to streamline image processing workflows, ensuring precise control and optimization of visual content.
has_alpha	bool	r	Determine whether the image has an alpha channel, providing crucial information for rendering and compositing operations. Integrate this feature to optimize visual processing workflows, ensuring accurate representation and manipulation of transparent elements.
has_background_color	bool	r/w	Gets or sets a value indicating whether image has background color.
has_transparent_color	bool	r/w	Gets a value indicating whether image has transparent color.
height	int	r	Gets the object height.
horizontal_resolution	double	r/w	Retrieve the horizontal resolution of the specified Image in pixels per inch, facilitating precise adjustment and rendering capabilities. Access essential image metadata effortlessly, empowering streamlined image processing workflows for enhanced user experiences.
image_opacity	float	r	Gets opacity of this image.
interrupt_monitor	InterruptMonitor	r/w	Gets or sets the interrupt monitor.
is_cached	bool	r	Gets a value indicating whether image data is cached currently.
is_raw_data_available	bool	r	Gets a value indicating whether raw data loading is supported.
page_count	int	r	Retrieve the total count of pages within the specified document, facilitating efficient navigation and management of multi-page content. Incorporate this functionality to enhance user experience, enabling seamless access to comprehensive document structures.
pages	Image[]	r	Access the pages of the document seamlessly, enabling dynamic navigation and manipulation within the content structure. Empower your application with efficient access to individual pages, facilitating streamlined document processing and enhanced user interaction.
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	Indicate if components necessitate premultiplication, ensuring efficient handling of visual elements. Enhance rendering processes by toggling this property, streamlining graphic workflows for optimized performance.
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.
transparent_color	Color	r/w	Gets the image transparent color.
update_xmp_data	bool	r/w	Gets or sets a value indicating whether to update the XMP metadata.
use_palette	bool	r	Gets a value indicating whether the image palette is used.
use_raw_data	bool	r/w	Gets or sets a value indicating whether to use raw data loading when the raw data loading is available.
vertical_resolution	double	r/w	Access the vertical resolution of the designated Image in pixels per inch, enabling precise adjustments and rendering optimizations. Utilize essential image data effortlessly to streamline image processing workflows, ensuring superior quality and performance in your applications.
width	int	r	Gets the object width.
xmp_data	XmpPacketWrapper	r/w	Gets or sets Xmp data.

Methods

Name	Description
add(image)	Add the frames from the specified image seamlessly into the current frame, consolidating their content and enhancing compositional flexibility. Integrate this method to streamline frame management and manipulation within your application, facilitating efficient handling of multi-frame images.
add_frame(frame)	Incorporate the specified frame seamlessly into the image, expanding its content and versatility. Utilize this method to enhance image composition and management, empowering efficient handling of multi-frame images within your application.
add_frames(frames)	Integrate the array of frames seamlessly into the image, enriching its content and versatility. Utilize this method to enhance image composition and management, enabling efficient handling of multi-frame images within your application.
add_page(page)	Effortlessly expand your BigTiff image by adding a new page with this intuitive method. Perfect for developers seeking to dynamically enhance the content of their multi-page images.
adjust_brightness(brightness)	Implement brightness adjustment for the image, allowing the modification of overall luminance levels. Incorporate this method into your image processing workflow to enhance visibility and improve the visual quality of images within your application.
adjust_contrast(contrast)	Enhance the contrast of the Image instance, amplifying the differences between its light and dark areas. Integrate this functionality to improve the visual clarity and overall quality of the image within your application.
adjust_gamma(gamma)	Apply gamma correction to the image, adjusting pixel intensities to achieve desired color balance. Incorporate this method into your image processing workflow to enhance visual quality and improve the accuracy of subsequent analysis or display tasks within your application.
adjust_gamma(gamma_red, gamma_green, gamma_blue)	Perform gamma correction on the image using individual coefficients for red, green, and blue channels, allowing for fine-tuned adjustments of color balance and contrast. Integrate this method into your image processing pipeline to achieve precise control over color rendering and enhance visual fidelity within your application.
align_resolutions()	Implement the AlignResolutions helper method to synchronize horizontal and vertical resolutions, ensuring uniformity in image dimensions. This functionality facilitates streamlined image processing workflows by harmonizing resolution parameters, optimizing visual quality and consistency across various platforms and devices.
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)	Implement binarization on the image employing Bradley’s adaptive thresholding algorithm with integral image thresholding. This approach dynamically computes local thresholds based on the image’s neighborhood, enhancing adaptability to varying lighting conditions and ensuring robust segmentation for subsequent processing tasks within your application.
binarize_fixed(threshold)	Apply binarization to the image using a predefined threshold, converting it into a binary image with distinct foreground and background regions. Incorporate this method into your image processing workflow to facilitate segmentation and feature extraction tasks, enhancing the accuracy and efficiency of image analysis within your application.
binarize_otsu()	Utilize Otsu thresholding to perform binarization on the image, automatically determining the optimal threshold value based on the image’s histogram. Integrate this method into your image processing workflow to achieve effective segmentation and feature extraction, enhancing the accuracy and reliability of image analysis tasks within your application.
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 private.
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(files)	Creates the multipage image containing the specified files.
create(files, throw_exception_on_load_error)	Creates the multipage image containing the specified files.
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(multipage_create_options)	Creates the specified multipage create options.
create_from_files(files)	Creates the multipage image containing the specified files as lazy loading pages.
create_from_files(files, throw_exception_on_load_error)	Creates the multipage image containing the specified files as lazy loading pages.
create_from_images(images)	Creates a new image using the specified images as pages
create_from_images(images, dispose_images)	Creates a new image the specified images as pages.
create_with_frame(frame)	Initializes a new instance of the BigTiffImage class.
create_with_frames(frames)	Initializes a new instance of the BigTiffImage class.
crop(left_shift, right_shift, top_shift, bottom_shift)	Perform cropping on the image by specifying shifts in the left, right, top, and bottom directions. This method enables precise selection of the desired portion of the image, facilitating efficient removal of unwanted areas and focusing on essential content. Integrate this functionality into your image processing pipeline to enhance clarity and composition as needed within your application.
crop(rectangle)	Crop the image using a specified rectangular region, allowing precise selection of desired content. Integrate this method into your image processing workflow to efficiently remove unwanted areas and focus on essential details, enhancing the overall clarity and composition of the image.
dither(dithering_method, bits_count)	Performs dithering on the current image.
dither(dithering_method, bits_count, custom_palette)	Execute dithering on the current image to enhance its visual quality and reduce color banding artifacts. Integrate this method into your image processing workflow to ensure smoother transitions between colors, resulting in improved overall image appearance and clarity.
filter(rectangle, options)	Filter the content within the specified rectangle, applying a designated image processing filter to enhance or modify the selected region. Integrate this method into your image manipulation workflow to achieve targeted enhancements or transformations within your application.
get_argb_32_pixel(x, y)	Gets an image 32-bit ARGB pixel.
get_default_argb_32_pixels(rectangle)	Gets the default 32-bit ARGB pixels array.
get_default_options(args)	Gets the default options.
get_default_pixels(rectangle, partial_pixel_loader)	Gets the default pixels array using partial pixel loader.
get_default_raw_data(rectangle, partial_raw_data_loader, raw_data_settings)	Gets the default raw data array using partial pixel loader.
get_default_raw_data(rectangle, raw_data_settings)	Gets the default raw data array.
get_file_format(file_path)	Gets the file format.
get_file_format(stream)	Gets the file format.
get_file_format_of_stream(stream)	Gets the file format.
get_fitting_rectangle(rectangle, pixels, width, height)	Gets rectangle which fits the current image.
get_fitting_rectangle(rectangle, width, height)	Gets rectangle which fits the current image.
get_modify_date(use_default)	Gets the date and time the resource image was last modified.
get_original_options()	Retrieve options derived from the original file settings, facilitating seamless preservation of key parameters such as bit-depth and other essential attributes of the original image. Utilize this method to maintain fidelity and consistency in image processing tasks, ensuring optimal results without unnecessary alterations. 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()	Convert the image to its grayscale representation, transforming it into a single-channel image where each pixel represents intensity. Integrate this method into your image processing pipeline to simplify analysis and enhance compatibility with grayscale-based algorithms, facilitating various computer vision and image analysis tasks within your application.
insert_frame(index, frame_to_insert)	Insert the new frame at the specified index within the frame sequence, ensuring precise control over frame arrangement. Employ this method to manage frame sequences effectively, facilitating dynamic manipulation and organization of image content within your application.
load(file_path)	Loads a new image from the specified file path or URL. If filePath is a file path the method just opens the file. If filePath is an URL, the method downloads the file, stores it as a temporary one, and opens it.
load(file_path, load_options)	Loads a new image from the specified file path or URL. If filePath is a file path the method just opens the file. If filePath is an URL, the method downloads the file, stores it as a temporary one, and opens it.
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 path or URL. If filePath is a file path the method just opens the file. If filePath is an URL, the method downloads the file, stores it as a temporary one, and opens it.
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)	Utilize the NormalizeAngle method specifically designed for scanned text documents to rectify skewed scans, ensuring accurate alignment. Seamlessly integrate this functionality into your text processing workflows to enhance document readability and quality, improving overall efficiency in text recognition and analysis tasks. This method uses RasterImage.get_skew_angle() and TiffImage.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_frame(frame)	Efficiently remove the specified frame from the image sequence, facilitating streamlined frame management within your application. Integrate this functionality to enhance precision and flexibility in frame manipulation, ensuring seamless organization and presentation of image content.
remove_frame(index)	Removes the frame by its index.
remove_frame_by_index(index)	Removes the frame by its index.
remove_metadata()	Removes this image instance metadata by setting this IHasXmpData.xmp_data and IHasExifData.exif_data values 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_frame(index, frame_to_replace)	Substitute the frame at the designated position with another frame seamlessly, facilitating dynamic frame management within the image sequence. Integrate this method to enhance flexibility and precision in frame manipulation, ensuring optimal organization and presentation of image content within your application.
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)	Conduct a proportional resize operation on the image, preserving its aspect ratio while adjusting its dimensions. Employ this method to dynamically scale images within your application, ensuring consistent visual representation of content integrity. The proportional resize will resize each frame according to the ratio of newWidth/width and newHeight/height.
resize(new_width, new_height, settings)	Adjust the size of the image based on specified settings, allowing for precise control over dimensions, aspect ratio, and scaling behavior. Integrate this method into your image processing workflow to achieve customized resizing operations tailored to the specific requirements of your application.
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)	Conduct a proportional adjustment of the image’s height, preserving its aspect ratio for consistent visual integrity. Employ this method to dynamically resize images within your application, ensuring optimal display across diverse platforms and devices without compromising content quality.
resize_height_proportionally(new_height, settings)	Resizes the height proportionally.
resize_height_proportionally_settings(new_height, settings)	Resizes the height proportionally.
resize_proportional(new_width, new_height, resize_type)	Conduct a proportional resize operation on the image, preserving its aspect ratio while adjusting its dimensions. Employ this method to dynamically scale images within your application, ensuring consistent visual representation of content integrity. The proportional resize will resize each frame according to the ratio of newWidth/width and newHeight/height.
resize_width_proportionally(new_width)	Resizes the width proportionally. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.
resize_width_proportionally(new_width, resize_type)	Adjust the width of the image while maintaining its aspect ratio, ensuring proportional resizing for optimal visual presentation. Utilize this method to dynamically scale images within your application, facilitating consistent and aesthetically pleasing rendering across various display contexts.
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 the image around its center point by a specified angle, enabling precise orientation adjustments. Incorporate this functionality into your image processing pipeline to facilitate accurate transformations, ensuring optimal alignment and presentation of visual content within your application.
rotate_flip(rotate_flip_type)	Perform rotation, flipping, or a combination of both operations exclusively on the active frame. This method allows precise manipulation of individual frames within the image sequence, enhancing flexibility in image editing and composition within your application.
rotate_flip_all(rotate_flip)	Rotates the flip all.
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 the pixels internal main.
save_raw_data(data, data_offset, rectangle, raw_data_settings)	Saves the raw data.
save_to_stream(stream)	Saves image to 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)	Establishes the resolution for the specified RasterImage, enabling precise control over image rendering and display properties. Integrate this functionality to optimize visual output and ensure compatibility with diverse output devices and platforms, enhancing the overall user experience.
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: BigTiffImage(frame)

 BigTiffImage(frame) 

Create a new instance of the BigTiffImage class by initializing
it with a TiffFrame parameter. Ideal for developers seeking a convenient
way to work with BigTiffImage objects, ensuring flexibility and ease of integration
into their projects.

Parameters:

Parameter	Type	Description
frame	TiffFrame	The tiff frame to initialize image with.

Constructor: BigTiffImage(frames)

 BigTiffImage(frames) 

Begin utilizing the BigTiffImage class seamlessly by
initializing a new instance with a list of TiffFrames parameter.
Perfect for developers seeking a straightforward method to work with
BigTiffImage objects containing multiple frames, ensuring efficiency of their projects.

Parameters:

Parameter	Type	Description
frames	TiffFrame[]	The frames.

Method: add(image)

 add(image) 

Add the frames from the specified image seamlessly into the current frame,
consolidating their content and enhancing compositional flexibility. Integrate
this method to streamline frame management and manipulation within your
application, facilitating efficient handling of multi-frame images.

Parameters:

Parameter	Type	Description
image	TiffImage	The source image.

Method: add_frame(frame)

 add_frame(frame) 

Incorporate the specified frame seamlessly into the image, expanding its content
and versatility. Utilize this method to enhance image composition and management,
empowering efficient handling of multi-frame images within your application.

Parameters:

Parameter	Type	Description
frame	TiffFrame	The frame to add.

Method: add_frames(frames)

 add_frames(frames) 

Integrate the array of frames seamlessly into the image, enriching its content and
versatility. Utilize this method to enhance image composition and management,
enabling efficient handling of multi-frame images within your application.

Parameters:

Parameter	Type	Description
frames	TiffFrame[]	The frames array to add

Method: add_page(page)

 add_page(page) 

Effortlessly expand your BigTiff image by adding a new page with this intuitive method.
Perfect for developers seeking to dynamically enhance the content of their multi-page images.

Parameters:

Parameter	Type	Description
page	RasterImage	The page to add.

Method: adjust_brightness(brightness)

 adjust_brightness(brightness) 

Implement brightness adjustment for the image, allowing the
modification of overall luminance levels. Incorporate this method into your image
processing workflow to enhance visibility and improve the visual quality of
images within your application.

Parameters:

Parameter	Type	Description
brightness	int	Brightness value.

Method: adjust_contrast(contrast)

 adjust_contrast(contrast) 

Enhance the contrast of the Image instance,
amplifying the differences between its light and dark areas. Integrate this
functionality to improve the visual clarity and overall quality of the image
within your application.

Parameters:

Parameter	Type	Description
contrast	float	Contrast value (in range [-100; 100])

Method: adjust_gamma(gamma)

 adjust_gamma(gamma) 

Apply gamma correction to the image, adjusting pixel intensities to achieve
desired color balance. Incorporate this method into your image processing
workflow to enhance visual quality and improve the accuracy of subsequent
analysis or display tasks within your application.

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) 

Perform gamma correction on the image using individual coefficients for red,
green, and blue channels, allowing for fine-tuned adjustments of color balance
and contrast. Integrate this method into your image processing pipeline to
achieve precise control over color rendering and enhance visual fidelity within
your application.

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) 

Implement binarization on the image employing Bradley’s adaptive thresholding
algorithm with integral image thresholding. This approach dynamically computes
local thresholds based on the image’s neighborhood, enhancing adaptability to
varying lighting conditions and ensuring robust segmentation for subsequent
processing tasks within your application.

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) 

Apply binarization to the image using a predefined threshold, converting it into
a binary image with distinct foreground and background regions. Incorporate this
method into your image processing workflow to facilitate segmentation and feature
extraction tasks, enhancing the accuracy and efficiency of image analysis within
your application.

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	true if image can be loaded from the specified file; otherwise, false.

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	true if image can be loaded from the specified file; otherwise, false.

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	true if image can be loaded from the specified stream; otherwise, false.

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	true if image can be loaded from the specified stream; otherwise, false.

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	true if image can be loaded from the specified stream; otherwise, false.

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	true if image can be loaded from the specified stream; otherwise, false.

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	true if image can be loaded from the specified file; otherwise, false.

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	true if image can be saved to the specified file format represented by the passed save options; otherwise, false.

Method: create(files) [static]

 create(files) 

Creates the multipage image containing the specified files.

Parameters:

Parameter	Type	Description
files	string	The files.

Returns

Type	Description
Image	The multipage image

Method: create(files, throw_exception_on_load_error) [static]

 create(files, throw_exception_on_load_error) 

Creates the multipage image containing the specified files.

Parameters:

Parameter	Type	Description
files	string	The files.
throw_exception_on_load_error	bool	if set to true [throw exception on load error].

Returns

Type	Description
Image	The multipage image

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 true [dispose images].

Returns

Type	Description
Image	The Image as IMultipageImage

Method: create(multipage_create_options) [static]

 create(multipage_create_options) 

Creates the specified multipage create options.

Parameters:

Parameter	Type	Description
multipage_create_options	MultipageCreateOptions	The multipage create options.

Returns

Type	Description
Image	The multipage image

Method: create_from_files(files) [static]

 create_from_files(files) 

Creates the multipage image containing the specified files as lazy loading pages.

Parameters:

Parameter	Type	Description
files	string	The files.

Returns

Type	Description
Image	The multipage image

Method: create_from_files(files, throw_exception_on_load_error) [static]

 create_from_files(files, throw_exception_on_load_error) 

Creates the multipage image containing the specified files as lazy loading pages.

Parameters:

Parameter	Type	Description
files	string	The files.
throw_exception_on_load_error	bool	if set to true throw exception on load error.

Returns

Type	Description
Image	The multipage image

Method: create_from_images(images) [static]

 create_from_images(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_from_images(images, dispose_images) [static]

 create_from_images(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 true [dispose images].

Returns

Type	Description
Image	The Image as IMultipageImage

Method: create_with_frame(frame) [static]

 create_with_frame(frame) 

Initializes a new instance of the BigTiffImage class.

Parameters:

Parameter	Type	Description
frame	TiffFrame	The tiff frame to initialize image with.

Returns

Type	Description
BigTiffImage	A new BigTiffImage image that includes the frame.

Method: create_with_frames(frames) [static]

 create_with_frames(frames) 

Initializes a new instance of the BigTiffImage class.

Parameters:

Parameter	Type	Description
frames	TiffFrame[]	The frames.

Returns

Type	Description
BigTiffImage

Method: crop(left_shift, right_shift, top_shift, bottom_shift)

 crop(left_shift, right_shift, top_shift, bottom_shift) 

Perform cropping on the image by specifying shifts in the left, right, top, and
bottom directions. This method enables precise selection of the desired portion of
the image, facilitating efficient removal of unwanted areas and focusing on
essential content. Integrate this functionality into your image processing
pipeline to enhance clarity and composition as needed within your application.

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 using a specified rectangular region, allowing precise selection of
desired content. Integrate this method into your image processing workflow to
efficiently remove unwanted areas and focus on essential details, enhancing the
overall clarity and composition of 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) 

Execute dithering on the current image to enhance its visual quality and reduce
color banding artifacts. Integrate this method into your image processing workflow
to ensure smoother transitions between colors, resulting in improved overall image
appearance and clarity.

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) 

Filter the content within the specified rectangle, applying a designated image
processing filter to enhance or modify the selected region. Integrate this method
into your image manipulation workflow to achieve targeted enhancements or
transformations within your application.

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 true uses the information from FileInfo as default value.

Returns

Type	Description
datetime	The date and time the resource image was last modified.

Method: get_original_options()

 get_original_options() 

Retrieve options derived from the original file settings, facilitating seamless
preservation of key parameters such as bit-depth and other essential attributes of
the original image. Utilize this method to maintain fidelity and consistency in
image processing tasks, ensuring optimal results without unnecessary alterations.
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: insert_frame(index, frame_to_insert)

 insert_frame(index, frame_to_insert) 

Insert the new frame at the specified index within the frame sequence, ensuring
precise control over frame arrangement. Employ this method to manage frame
sequences effectively, facilitating dynamic manipulation and organization of image
content within your application.

Parameters:

Parameter	Type	Description
index	int	Index of new frame in list of frames
frame_to_insert	TiffFrame	The frame To Insert.

Method: load(file_path) [static]

 load(file_path) 

Loads a new image from the specified file path or URL.
If filePath is a file path the method just opens the file.
If filePath is an URL, the method downloads the file, stores it as a temporary one, and opens it.

Parameters:

Parameter	Type	Description
file_path	string	The file path or URL 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 path or URL.
If filePath is a file path the method just opens the file.
If filePath is an URL, the method downloads the file, stores it as a temporary one, and opens it.

Parameters:

Parameter	Type	Description
file_path	string	The file path or URL 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 path or URL.
If filePath is a file path the method just opens the file.
If filePath is an URL, the method downloads the file, stores it as a temporary one, and opens it.

Parameters:

Parameter	Type	Description
file_path	string	The file path or URL 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) 

Utilize the NormalizeAngle method specifically designed for scanned text documents
to rectify skewed scans, ensuring accurate alignment. Seamlessly
integrate this functionality into your text processing workflows to enhance
document readability and quality, improving overall efficiency in text recognition
and analysis tasks.
This method uses RasterImage.get_skew_angle() and TiffImage.rotate(angle, resize_proportionally, background_color) methods.

Parameters:

Parameter	Type	Description
resize_proportionally	bool	if set to true you will have your image size changed 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: 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: remove_frame(frame)

 remove_frame(frame) 

Efficiently remove the specified frame from the image sequence, facilitating
streamlined frame management within your application. Integrate this functionality
to enhance precision and flexibility in frame manipulation, ensuring seamless
organization and presentation of image content.

Parameters:

Parameter	Type	Description
frame	TiffFrame	The frame to remove.

Method: remove_frame(index)

 remove_frame(index) 

Removes the frame by its index.

Parameters:

Parameter	Type	Description
index	int	Index of frame to be removed.

Returns

Type	Description
TiffFrame	The removed frame.

Method: remove_frame_by_index(index)

 remove_frame_by_index(index) 

Removes the frame by its index.

Parameters:

Parameter	Type	Description
index	int	Index of frame to be removed.

Returns

Type	Description
TiffFrame	The removed frame.

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_frame(index, frame_to_replace)

 replace_frame(index, frame_to_replace) 

Substitute the frame at the designated position with another frame seamlessly,
facilitating dynamic frame management within the image sequence. Integrate this
method to enhance flexibility and precision in frame manipulation, ensuring
optimal organization and presentation of image content within your application.

Parameters:

Parameter	Type	Description
index	int	The zero based frame position.
frame_to_replace	TiffFrame	The frame to replace.

Returns

Type	Description
TiffFrame	The removed frame.

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) 

Conduct a proportional resize operation on the image, preserving its aspect ratio
while adjusting its dimensions. Employ this method to dynamically scale images
within your application, ensuring consistent visual representation of content
integrity.
The proportional resize will resize each frame according to the ratio of newWidth/width and newHeight/height.

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) 

Adjust the size of the image based on specified settings, allowing for precise
control over dimensions, aspect ratio, and scaling behavior. Integrate this
method into your image processing workflow to achieve customized resizing
operations tailored to the specific requirements of your application.

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) 

Conduct a proportional adjustment of the image’s height, preserving its aspect
ratio for consistent visual integrity. Employ this method to dynamically resize
images within your application, ensuring optimal display across diverse platforms
and devices without compromising content quality.

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_proportional(new_width, new_height, resize_type)

 resize_proportional(new_width, new_height, resize_type) 

Conduct a proportional resize operation on the image, preserving its aspect ratio
while adjusting its dimensions. Employ this method to dynamically scale images
within your application, ensuring consistent visual representation of content
integrity.
The proportional resize will resize each frame according to the ratio of newWidth/width and newHeight/height.

Parameters:

Parameter	Type	Description
new_width	int	The new width.
new_height	int	The new height.
resize_type	ResizeType	The resize type.

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) 

Adjust the width of the image while maintaining its aspect ratio, ensuring
proportional resizing for optimal visual presentation. Utilize this method to
dynamically scale images within your application, facilitating consistent and
aesthetically pleasing rendering across various display contexts.

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 the image around its center point by a specified angle, enabling precise
orientation adjustments. Incorporate this functionality into your image processing
pipeline to facilitate accurate transformations, ensuring optimal alignment and
presentation of visual content within your application.

Parameters:

Parameter	Type	Description
angle	float	The rotate angle in degrees. Positive values will rotate clockwise.
resize_proportionally	bool	if set to true you will have your image size changed 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) 

Perform rotation, flipping, or a combination of both operations exclusively on the
active frame. This method allows precise manipulation of individual frames within
the image sequence, enhancing flexibility in image editing and composition within
your application.

Parameters:

Parameter	Type	Description
rotate_flip_type	RotateFlipType	The rotate flip type.

Method: rotate_flip_all(rotate_flip)

 rotate_flip_all(rotate_flip) 

Rotates the flip all.

Parameters:

Parameter	Type	Description
rotate_flip	RotateFlipType	The rotate flip.

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 true over write the file contents, otherwise append will occur.

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 the pixels internal main.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle.
pixels	Color[]	The pixels.

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 image to stream

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom

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 true colors will be updated according to the new palette; otherwise color indexes remain unchanged. Note that unchanged indexes may crash the image on loading if some indexes have no corresponding palette entries.

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) 

Establishes the resolution for the specified RasterImage, enabling
precise control over image rendering and display properties. Integrate this
functionality to optimize visual output and ensure compatibility with diverse
output devices and platforms, enhancing the overall user experience.

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.