Image Class

Summary: The image is the base class for all type of images.

Full Name: aspose.imaging.Image

Inheritance: IObjectWithBounds, DataStreamSupporter

Properties

Name	Type	Access	Description
auto_adjust_palette	bool	r/w	Gets or sets a value indicating whether automatic adjust palette.
background_color	Color	r/w	Gets or sets a value for the background color.
bits_per_pixel	int	r	Gets the image bits per pixel count.
bounds	Rectangle	r	Gets the image 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.
data_stream_container	StreamContainer	r	Gets the object’s data stream.
disposed	bool	r	Gets a value indicating whether this instance is disposed.
file_format	FileFormat	r	Gets a value of file format
has_background_color	bool	r/w	Gets or sets a value indicating whether image has background color.
height	int	r	Gets the image height.
interrupt_monitor	InterruptMonitor	r/w	Gets or sets the interrupt monitor.
is_cached	bool	r	Gets a value indicating whether object’s data is cached currently and no data reading is required.
palette	IColorPalette	r/w	Gets or sets the color palette. The color palette is not used when pixels are represented directly.
size	Size	r	Gets the image size.
use_palette	bool	r	Gets a value indicating whether the image palette is used.
width	int	r	Gets the image width.

Methods

Name	Description
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(files)	Creates the specified files.
create(files, throw_exception_on_load_error)	Creates 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.
get_default_options(args)	Gets the default options.
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_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_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.
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_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.
remove_metadata()	Removes metadata.
resize(new_width, new_height)	Resizes the image. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.
resize(new_width, new_height, resize_type)	Resizes the image.
resize(new_width, new_height, settings)	Resizes the image.
resize_by_settings(new_width, new_height, settings)	Resizes the image.
resize_by_type(new_width, new_height, resize_type)	Resizes the image.
resize_height_proportionally(new_height)	Resizes the height proportionally. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.
resize_height_proportionally(new_height, resize_type)	Resizes the height proportionally.
resize_height_proportionally(new_height, settings)	Resizes the height proportionally.
resize_height_proportionally_settings(new_height, settings)	Resizes the height proportionally.
resize_width_proportionally(new_width)	Resizes the width proportionally. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.
resize_width_proportionally(new_width, resize_type)	Resizes the width proportionally.
resize_width_proportionally(new_width, settings)	Resizes the width proportionally.
resize_width_proportionally_settings(new_width, settings)	Resizes the width proportionally.
rotate_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_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_palette(palette, update_colors)	Sets the image palette.

Property: use_palette

Gets a value indicating whether the image palette is used.

See also:

Example # 1: Determine if the palette is used by the image.

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.

See also:

Example # 1: This example determines whether image can be loaded from a file.

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.

See also:

Example # 1: This example determines whether image can be loaded from a file stream.

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.

See also:

Example # 1: This example shows how to determine whether image can be saved to the specifi…

Method: create(files) [static]

 create(files)

Creates 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 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.

See also:

Example # 1: This example creates a new Image file at some disk location as specified by S…

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: 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_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.

See also:

Example # 1: This example shows how to determine the image format without loading the enti…

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.

See also:

Example # 1: This example shows how to determine the image format without loading the enti…

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_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_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: 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.

See also:

Example # 1: This example demonstrates the loading of an existing Image file into an insta…

Method: load(file_path, load_options) [static]

 load(file_path, load_options)

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.

See also:

Example # 1: This example demonstrates the use of a file stream objects to load an existin…

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_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)

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: 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.

See also:

Example # 1: The following example shows how to resize a metafile (WMF and EMF).

Method: resize(new_width, new_height, resize_type)

 resize(new_width, new_height, resize_type)

Resizes the image.

Parameters:

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

Method: resize(new_width, new_height, settings)

 resize(new_width, new_height, settings)

Resizes the image.

Parameters:

Parameter	Type	Description
new_width	int	The new width.
new_height	int	The new height.
settings	ImageResizeSettings	The resize settings.

See also:

Example # 1: This example loads an image and resizes it using various resizing 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.

See also:

Example # 1: This example loads an image and resizes it proportionally using various resiz…

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.

See also:

Example # 1: This example loads an image and resizes it proportionally using various resiz…

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_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	Type of the rotate flip.

See also:

Example # 1: This example demonstrates the use of Rotate operation on an image. Example lo…

Example # 2: This example loads an image, rotates it by 90 degrees clockwise and optionall…

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.

See also:

Example # 1: This example shows the simple steps to save an Image. To demonstrate this ope…

Example # 2: The following example loads a BMP image from a file, then saves the image to …

Example # 3: The following example shows how to save an entire BMP image or part of it to …

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.

See also:

Example # 1: The following example loads a BMP image from a file, then saves a rectangular…

Example # 2: The following example shows how to save an entire BMP image or part of it to …

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.

See also:

Example # 1: This example shows the process of saving an Image to MemoryStream. To demonst…

Example # 2: The following example loads an image from a file, then saves the image to a P…

Example # 3: The following example shows how to save an entire BMP image or part of it to …

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.

See also:

Example # 1: The following example loads an image from a file, then saves a rectangular pa…

Example # 2: The following example shows how to save an entire BMP image or part of it to …

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_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.

Examples

This example demonstrates the loading of an existing Image file into an instance of aspose.imaging.Image using file path specified


from aspose.imaging import Image
# Create Image instance and initialize it with an existing image file from disk location
with Image.load(r"C:\temp\sample.bmp") as image:
	# do some image processing
	pass

This example creates a new Image file at some disk location as specified by Source property of the BmpOptions instance. Several properties for BmpOptions instance are set before creating the actual image. Especially the Source property, that refers to the actual disk location in this case.


from aspose.imaging import Image
from aspose.imaging.imageoptions import BmpOptions
from aspose.imaging.sources import FileCreateSource

#Create an instance of `BmpOptions` and set its various properties
with BmpOptions() as bmp_options:
	bmp_options.bits_per_pixel = 24

	#Create an instance of `FileCreateSource` and assign it as `source` for the instance of `BmpOptions`
	#Second `Boolean` parameter determines if the file to be created is_temporal or not
	bmp_options.source = FileCreateSource(r"C:\temp\output.bmp", False)

	#Create an instance of Image and initialize it with instance of BmpOptions by calling Create method
	with Image.create(bmp_options, 500, 500) as image:
		#do some image processing
		# save all changes
		image.save()

This example demonstrates the use of a file stream objects to load an existing Image file


from aspose.imaging import Image

# Create an instance of FileStream
with open(r"C:\temp\sample.bmp", "rb"):
	#Create an instance of Image class and load an existing file through FileStream object by calling Load method
	with Image.load(stream) as image:
		#do some image processing.
		pass

This example demonstrates the use of Rotate operation on an image. Example loads an existing image file from some disk location and performs the `Rotate` operation on the image according to the value of enumeration `aspose.imaging.RotateFlipType`


from aspose.imaging import Image, RotateFlipType
#Create an instance of image class and initialize it with an existing image file through File path
with Image.load(r"C:\temp\sample.bmp") as image:
	# rotate the image at 180 degree about X axis
	image.rotate_flip(RotateFlipType.ROTATE_180_FLIP_X)
	# save all changes.
	image.save()

This example shows the simple steps to save an Image. To demonstrate this operation, we load an existing file from some disk location, performs `rotate` operation on the image and save the image in PSD format using file path


from aspose.imaging import Image, RotateFlipType
from aspose.imaging.imageoptions import PsdOptions
from os.path import join as path_join

directory = "c:\\temp"

#Create an instance of image class and initialize it with an existing file through File path
with Image.load(path_join(directory, "sample.bmp")) as image:
	#Rotate the image at 180 degree about X axis
	image.rotate_flip(RotateFlipType.ROTATE_180_FLIP_X)
	#Save the Image as PSD to File Path with default PsdOptions settings
	image.save(path_join(directory, "output.psd"), PsdOptions())

This example shows the process of saving an Image to MemoryStream. To demonstrate this operation, example loads an existing file from some disk location, performs `rotate` operation on the image and save the image in PSD format

from aspose.imaging import Image, RotateFlipType
from aspose.imaging.imageoptions import PsdOptions
from aspose.imaging.extensions import StreamExtensions as stream_ext

#Create an instance of MemoryStream
with stream_ext.create_memory_stream() as stream:
	#Create an instance of image class and initialize it with an existing file through File path
	with Image.load(r"C:\temp\sample.bmp") as image:
		#Rotate the image at 180 degree about X axis
		image.rotate_flip(RotateFlipType.ROTATE_180_FLIP_X)
		#Save the Image as PSD to MemoryStream with default PsdOptions settings
		image.save(stream, PsdOptions())

This example determines whether image can be loaded from a file.


from aspose.imaging import Image

# Use an absolute path to the file
can_load: bool = Image.can_load(r"c:\temp\sample.gif")

This example determines whether image can be loaded from a file stream.


from aspose.imaging import Image
from aspose.imaging.extensions import StreamExtensions as strm_ext
import os.path import join

directory = r"c:\temp"

canLoad = False

# Use a file stream
with open(join(directory, "sample.bmp"), "rb"):
	canLoad = Image.can_load(stream)

print(f"Can load the file: {canLoad}")

# The following data is not a valid image stream, so CanLoad returns false.
imageData = [0, 0, 0, 0, 0, 0, 0, 0]
with strm_ext.create_memory_stream_from_bytes(imageData) as stream:
	canLoad = Image.can_load(stream)

print(f"Can load the byte buffer: {canLoad}")

This example shows how to determine the image format without loading the entire image from a file.


from aspose.imaging import Image
from os.path import join as path_join

directory = "c:\\temp\\"

# Use an absolute path to the file
file_format = Image.get_file_format(path_join(directory, "sample.gif"))
print(f"The file format is {file_format}")

This example shows how to determine the image format without loading the entire image from a file stream.


from aspose.imaging import Image
from aspose.imaging.extensions import StreamExtensions as strm_ex
from os.path import join as path_join

directory = "c:\\temp\\"

# Use a file stream
with open(path_join(directory, "sample.bmp"), "rb") as stream:
	file_format = Image.get_file_format(stream)
	print(f"The file format is {file_format}")

# The following data is not a valid image stream, so get_file_format returns FileFormat.UNKNOWN
imageData = bytearray([0, 0, 0, 0, 0, 0, 0, 0])
with strm_ex.create_memory_stream_from_bytes(imageData) as stream:
	file_format = Image.get_file_format(stream)
	print(f"The file format is {file_format}")

This example shows how to determine whether image can be saved to the specified file format represented by the passed save options.


from aspose.imaging import Image
from aspose.imaging.imageoptions import JpegOptions
from os.path import join as path_join

directory = "c:\\temp\\"

with Image.load(path_join(directory, "sample.gif")) as image:
	saveOptions = JpegOptions()
	saveOptions.quality = 50
	# Determine whether the image can be saved to jpeg
	canSave: bool = image.can_save(saveOptions)
	print(canSave)

This example loads an image and resizes it using various resizing settings.

from aspose.imaging import Image, ImageResizeSettings, ResizeType, ImageFilterType,\
	ColorQuantizationMethod
from os.path import join as path_join

directory = "c:\\temp\\"

resizeSettings = ImageResizeSettings()

# The adaptive algorithm based on weighted and blended rational function and lanczos3 interpolation.
resizeSettings.mode = ResizeType.ADAPTIVE_RESAMPLE
# The small rectangular filter
resizeSettings.filter_type = ImageFilterType.SMALL_RECTANGULAR
# The number of colors in the palette.
resizeSettings.entries_count = 256
# The color quantization is not used
resizeSettings.color_quantization_method = ColorQuantizationMethod.NONE

# The euclidean method
resizeSettings.ColorCompareMethod = ColorCompareMethod.Euclidian;

with Image.load(path_join(directory, "sample.gif")) as image:
	# Scale down by 2 times using adaptive resampling.
	image.resize(image.width // 2, image.height // 2, resizeSettings)
	image.save(path_join(directory, "downsample.adaptive.gif"))

This example loads an image and resizes it proportionally using various resizing methods. Only the width is specified, the height is calculated automatically.

from aspose.imaging import Image, ResizeType
from os.path import join as path_join

directory = "c:\\temp\\"

with Image.load(path_join(directory, "sample.gif")) as image:
	# Scale up by 2 times using Nearest Neighbour resampling.
	image.resize_width_proportionally(image.width * 2, ResizeType.NEAREST_NEIGHBOUR_RESAMPLE)
	image.save(path_join(directory, "upsample.nearestneighbour.gif"))

with Image.load(path_join(directory, "sample.gif")) as image:
	# Scale down by 2 times using Nearest Neighbour resampling.
	image.resize_width_proportionally(image.width // 2, ResizeType.NEAREST_NEIGHBOUR_RESAMPLE)
	image.save(path_join(directory, "downsample.nearestneighbour.gif"))

with Image.load(path_join(directory, "sample.gif")) as image:
	# Scale up by 2 times using Bilinear resampling.
	image.resize_width_proportionally(image.width * 2, ResizeType.BILINEAR_RESAMPLE)
	image.save(path_join(directory, "upsample.bilinear.gif"))

with Image.load(path_join(directory, "sample.gif")) as image:
	# Scale down by 2 times using Bilinear resampling.
	image.resize_width_proportionally(image.width // 2, ResizeType.BILINEAR_RESAMPLE);
	image.save(path_join(directory, "downsample.bilinear.gif"))

This example loads an image and resizes it proportionally using various resizing methods. Only the height is specified, the width is calculated automatically.


from aspose.imaging import Image, ResizeType
from os.path import join as path_join

directory = "c:\\temp\\"

with Image.load(path_join(directory, "sample.gif")) as image:
	# Scale up by 2 times using Nearest Neighbour resampling.
	image.resize_height_proportionally(image.height * 2, ResizeType.NEAREST_NEIGHBOUR_RESAMPLE)
	image.save(path_join(directory, "upsample.nearestneighbour.gif"))

with Image.load(path_join(directory, "sample.gif")) as image:
	# Scale down by 2 times using Nearest Neighbour resampling.
	image.resize_height_proportionally(image.height // 2, ResizeType.NEAREST_NEIGHBOUR_RESAMPLE)
	image.save(path_join(directory, "downsample.nearestneighbour.gif"))

with Image.load(path_join(directory, "sample.gif")) as image:
	# Scale up by 2 times using Bilinear resampling.
	image.resize_height_proportionally(image.height * 2, ResizeType.BILINEAR_RESAMPLE)
	image.save(path_join(directory, "upsample.bilinear.gif"))

with Image.load(path_join(directory, "sample.gif")) as image:
	# Scale down by 2 times using Bilinear resampling.
	image.resize_height_proportionally(image.height // 2, ResizeType.BILINEAR_RESAMPLE)
	image.save(path_join(directory, "downsample.bilinear.gif"))

This example loads an image, rotates it by 90 degrees clockwise and optionally flips the image horizontally and(or) vertically.


from aspose.imaging import Image, RotateFlipType
from os.path import join as path_join

directory = "c:\\temp\\"

rotateFlipTypes = [RotateFlipType.ROTATE_90_FLIP_NONE, RotateFlipType.ROTATE_90_FLIP_X,
				   RotateFlipType.ROTATE_90_FLIP_XY, RotateFlipType.ROTATE_90_FLIP_Y]

for rotateFlipType in rotateFlipTypes:
	# Rotate, flip and save to the output file.
	with Image.Load(path_join(directory, "sample.bmp")) as image:
		image.rotate_flip(rotateFlipType)
		image.save(path_join(directory, f"sample.{rotateFlipType}.bmp"))

The following example loads a BMP image from a file, then saves the image to a PNG file.

from aspose.imaging import Image
from aspose.imaging.imageoptions import PngOptions
from os.path import join as path_join

directory = r"c:\temp"

with Image.load(path_join(dir, "sample.bmp")) as image:
	# Save the entire image to a PNG file.
	save_options = PngOptions()
	image.save(path_join(dir, "output.png"), save_options)

The following example loads a BMP image from a file, then saves a rectangular part of the image to a PNG file.

from aspose.imaging import Image, Rectangle
from aspose.imaging.imageoptions import PngOptions
from os.path import join as path_join

directory = r"c:\temp"

with Image.load(path_join(dir, "sample.bmp")) as image:
	# Save the upper half of the image to a PNG file.
	save_options = PngOptions()
	bounds = Rectangle(0, 0, image.width, image.height // 2)
	image.save(path_join(dir, "output.png"), save_options, bounds)

The following example loads an image from a file, then saves the image to a PNG file stream.

from aspose.imaging import Image, Rectangle
from aspose.imaging.imageoptions import PngOptions
from os.path import join as path_join

directory = r"c:\temp"

with Image.load(path_join(dir, "sample.bmp")) as image:
	save_options = PngOptions()
	with open(path_join(dir, "output.png"), "w+b") as output_stream:
		# Save the entire image to a file stream.
		image.save(output_stream, save_options)

The following example loads an image from a file, then saves a rectangular part of the image to a PNG file stream.

from aspose.imaging import Image, Rectangle
from aspose.imaging.imageoptions import PngOptions
from os.path import join as path_join

directory = r"c:\temp"

with Image.load(path_join(dir, "sample.bmp")) as image:
	save_options = PngOptions()
	bounds = Rectangle(0, 0, image.width, image.height // 2)
	with open(path_join(dir, "output.png"), "w+b") as output_stream:
		# Save the upper half of the image to a file stream.
		image.save(output_stream, save_options, bounds)

The following example shows how to save an entire BMP image or part of it to a file or stream.


from os.path import join as path_join
from aspose.pycore import as_of
from aspose.imaging import Image, ColorPaletteHelper
from aspose.imaging.imageoptions import BmpOptions
from aspose.imaging.extensions import StreamExtensions as strm_ext

directory = "c:\\temp\\"
with Image.load(path_join(directory, "sample.bmp")) as image:
	bmpImage = as_of(image, BmpImage)
		
	# Convert to a black-white image
	bmpImage.binarize_otsu()

	# Save to the same location with default options.
	image.save()

	saveOptions = BmpOptions()

	# A palette contains only two colors: Black and White in this case.
	saveOptions.palette = ColorPaletteHelper.create_monochrome()

	# For all monochrome images (including black-white ones) it is enough to allocate 1 bit per pixel.
	saveOptions.bits_per_pixel = 1

	# Save to another location with the specified options.
	image.save(path_join(directory, "sample.bw.palettized.bmp"), saveOptions)

	# Save only the central part of the image.
	bounds = Rectangle(image.width // 4, image.height // 4, image.width // 2, image.height // 2)
	image.save(path_join(directory, "sample.bw.palettized.part.bmp"), saveOptions, bounds)

	# Save the entire image to a memory stream
	with strm_ext.create_memory_stream() as stream:
		image.save(stream, saveOptions);
		print("The size of the whole image in bytes:", stream.tell())

	# Save the central part of the image to a memory stream
	with strm_ext.create_memory_stream() as stream:
		image.save(stream, saveOptions, bounds)
		print("The size of the central part of the image in bytes: ", stream.tell())

#The output may look like this:
#The size of the whole image in bytes: 24062
#The size of the central part of the image in bytes: 6046

The following example shows how to resize a metafile (WMF and EMF).


import aspose.pycore as aspycore
from aspose.imaging import Image
from aspose.imaging.fileformats.emf import MetaImage
from os.path import join

dir_ = "c:\\temp"
file_names = ["image3.emf", "image4.wmf"]
for file_name in file_names:
	input_file_path = join(dir_, file_name)
	output_file_path = join(dir_, "Downscale_" + file_name)
	with aspycore.as_of(Image.load(input_file_path), MetaImage) as image:
		image.resize(image.width // 4, image.height // 4)
		image.save(output_file_path)

Determine if the palette is used by the image.


from aspose.imaging import Image

with Image.load("Sample.bmp") as image:
	if image.use_palette:
		print("The palette is used by the image")

IRasterImageRawDataLoader Class ImageAttributes Class

Image Class

Properties

Methods

Property: use_palette

Method: can_load(file_path) [static]

Method: can_load(file_path, load_options) [static]

Method: can_load(stream) [static]

Method: can_load(stream, load_options) [static]

Method: can_load_stream(stream) [static]

Method: can_load_stream_with_options(stream, load_options) [static]

Method: can_load_with_options(file_path, load_options) [static]

Method: can_save(options)

Method: create(files) [static]

Method: create(files, throw_exception_on_load_error) [static]

Method: create(image_options, width, height) [static]

Method: create(images) [static]

Method: create(images, dispose_images) [static]

Method: create(multipage_create_options) [static]

Method: get_default_options(args)

Method: get_file_format(file_path) [static]

Method: get_file_format(stream) [static]

Method: get_file_format_of_stream(stream) [static]

Method: get_fitting_rectangle(rectangle, pixels, width, height) [static]

Method: get_fitting_rectangle(rectangle, width, height) [static]

Method: get_original_options()

Method: get_proportional_height(width, height, new_width) [static]

Method: get_proportional_width(width, height, new_height) [static]

Method: get_serialized_stream(image_options, clipping_rectangle, page_number)

Method: load(file_path) [static]

Method: load(file_path, load_options) [static]

Method: load(stream) [static]

Method: load(stream, load_options) [static]

Method: load_stream(stream) [static]

Method: load_stream_with_options(stream, load_options) [static]

Method: load_with_options(file_path, load_options) [static]

Method: resize(new_width, new_height)

Method: resize(new_width, new_height, resize_type)

Method: resize(new_width, new_height, settings)

Method: resize_by_settings(new_width, new_height, settings)

Method: resize_by_type(new_width, new_height, resize_type)

Method: resize_height_proportionally(new_height)

Method: resize_height_proportionally(new_height, resize_type)

Method: resize_height_proportionally(new_height, settings)

Method: resize_height_proportionally_settings(new_height, settings)

Method: resize_width_proportionally(new_width)

Method: resize_width_proportionally(new_width, resize_type)

Method: resize_width_proportionally(new_width, settings)

Method: resize_width_proportionally_settings(new_width, settings)

Method: rotate_flip(rotate_flip_type)

Method: save(file_path)

Method: save(file_path, options)

Method: save(file_path, options, bounds_rectangle)

Method: save(file_path, over_write)

Method: save(stream)

Method: save(stream, options_base)

Method: save(stream, options_base, bounds_rectangle)

Method: save_to_stream(stream)

Method: save_to_stream_with_options(stream, options_base)

Method: save_to_stream_with_options_rect(stream, options_base, bounds_rectangle)

Method: save_with_options(file_path, options)

Method: save_with_options_rect(file_path, options, bounds_rectangle)

Method: set_palette(palette, update_colors)

Examples

This example demonstrates the loading of an existing Image file into an instance of aspose.imaging.Image using file path specified

This example creates a new Image file at some disk location as specified by Source property of the BmpOptions instance. Several properties for BmpOptions instance are set before creating the actual image. Especially the Source property, that refers to the actual disk location in this case.

This example demonstrates the use of a file stream objects to load an existing Image file

This example demonstrates the use of Rotate operation on an image. Example loads an existing image file from some disk location and performs the Rotate operation on the image according to the value of enumeration aspose.imaging.RotateFlipType

This example shows the simple steps to save an Image. To demonstrate this operation, we load an existing file from some disk location, performs rotate operation on the image and save the image in PSD format using file path

This example shows the process of saving an Image to MemoryStream. To demonstrate this operation, example loads an existing file from some disk location, performs rotate operation on the image and save the image in PSD format

This example determines whether image can be loaded from a file.

This example determines whether image can be loaded from a file stream.

This example shows how to determine the image format without loading the entire image from a file.

This example shows how to determine the image format without loading the entire image from a file stream.

This example shows how to determine whether image can be saved to the specified file format represented by the passed save options.

This example loads an image and resizes it using various resizing settings.

This example loads an image and resizes it proportionally using various resizing methods. Only the width is specified, the height is calculated automatically.

This example loads an image and resizes it proportionally using various resizing methods. Only the height is specified, the width is calculated automatically.

This example loads an image, rotates it by 90 degrees clockwise and optionally flips the image horizontally and(or) vertically.

The following example loads a BMP image from a file, then saves the image to a PNG file.

The following example loads a BMP image from a file, then saves a rectangular part of the image to a PNG file.

This example demonstrates the use of Rotate operation on an image. Example loads an existing image file from some disk location and performs the `Rotate` operation on the image according to the value of enumeration `aspose.imaging.RotateFlipType`

This example shows the simple steps to save an Image. To demonstrate this operation, we load an existing file from some disk location, performs `rotate` operation on the image and save the image in PSD format using file path

This example shows the process of saving an Image to MemoryStream. To demonstrate this operation, example loads an existing file from some disk location, performs `rotate` operation on the image and save the image in PSD format