EpsImage Class
Contents
[
Hide
]Summary: The API for Encapsulated PostScript (EPS) image file format support offers
robust capabilities for manipulating compositions comprising text, graphics,
and images. With features such as bitmap preview image handling, orientation
flipping, bounding box retrieval for illustration bounds, resizing, rotating
images, and adding preview images, this API ensures seamless processing
and integration of EPS files into various applications with precision and
versatility.
Module: aspose.imaging.fileformats.eps
Full Name: aspose.imaging.fileformats.eps.EpsImage
Inheritance: IObjectWithBounds, IObjectWithSizeF, VectorImage
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 | Access the precise bit depth of the image effortlessly with this property. Retrieve the bits per pixel count, providing crucial insights into the image’s color depth and aiding in optimizing processing tasks. Ideal for applications requiring fine-grained control over image manipulation and analysis. |
| bounding_box | RectangleF | r | Accessing the original bounding box in device-independent points, this property provides crucial geometric information about the EpsImage dimensions. By retrieving this data, users can accurately assess the image’s size and aspect ratio, facilitating precise layout and positioning in various applications. |
| bounding_box_px | Rectangle | r | This property returns the original bounding box of the EpsImage instance in pixels, providing essential geometric data for accurate rendering and manipulation. With this information, users can ensure precise placement and sizing /// of EPS images in their projects, enhancing overall visual presentation and quality. |
| bounds | Rectangle | r | Gets the object bounds. |
| buffer_size_hint | int | r/w | Gets or sets the buffer size hint which is defined max allowed size for all internal buffers. |
| container | Image | r | Gets the Image container. |
| creation_date | datetime | r | Retrieving the creation date from EPS Document Structuring Conventions (DSC) comments, this property provides essential metadata indicating the EPS file’s inception. By accessing this information, users gain insights into the file’s origin and chronology, enhancing file management and organization. |
| creator | string | r | This property offers access to the creator information sourced from EPS Document Structuring Conventions (DSC) comments found within the EPS file. Understanding the creator details provides insights into the software or tool used to generate the EPS file, facilitating compatibility assessment across various platforms and applications. |
| data_stream_container | StreamContainer | r | Gets the object’s data stream. |
| disposed | bool | r | Gets a value indicating whether this instance is disposed. |
| eps_type | EpsType | r | Access and interpret the subtype value of your EPS image, streamlining your workflow and enhancing compatibility across platforms. Ideal for optimizing EPS subtype retrieval in your projects with precision and efficiency. |
| file_format | FileFormat | r | Access the file format of your image with this property. Retrieve essential information about the format of your image file, facilitating compatibility and efficient processing. Ideal for identifying the format of your image files for seamless integration into your projects. |
| has_background_color | bool | r/w | Gets or sets a value indicating whether image has background color. |
| has_raster_preview | bool | r | Discover the presence of a raster preview effortlessly with this property. Access the boolean value indicating whether the EpsImage instance includes a raster preview, empowering your image processing tasks with clarity and efficiency. Ideal for streamlining workflow decisions based on the presence or absence of raster previews in EPS images. |
| height | int | r | Gets the image height. |
| height_f | float | r | Access the height of the image using this property. Obtain the image’s height with ease, enabling seamless layout adjustments, aspect ratio calculations, and precise rendering across different screen resolutions and display environments. |
| interrupt_monitor | InterruptMonitor | r/w | Gets or sets the interrupt monitor. |
| is_cached | bool | r | This property provides a convenient way to check if the object’s data is currently cached, eliminating the need for additional data reading. It offers a quick and efficient method to determine if the required information is readily available, optimizing performance and reducing resource overhead in data-intensive operations. |
| palette | IColorPalette | r/w | Gets or sets the color palette. The color palette is not used when pixels are represented directly. |
| post_script_version | string | r | This property retrieves the PostScript version associated with the EpsImage instance. It offers insight into the specific PostScript language version utilized within the EPS file, aiding in compatibility assessment and facilitating seamless integration with PostScript-compatible environments. |
| preview_image_count | int | r | Access the number of preview images available with ease. This property allows you to effortlessly retrieve the count of preview images associated with your file, enabling efficient management and navigation of your image previews. Ideal for optimizing your workflow and organizing your image assets effectively. |
| preview_images | Image[] | r | Retrieve the preview images associated with your file. This property provides seamless access to the collection of preview images, allowing you to efficiently browse and manage them as needed. Ideal for quickly previewing and selecting the right image for your project. |
| size | Size | r | Gets the object size. |
| size_f | SizeF | r | Gets the object size, in inches. |
| title | string | r | This property retrieves the title extracted from the EPS Document Structuring Conventions (DSC) comments embedded within the EPS file. It provides valuable metadata about the content of the EPS file, aiding in document organization and identification within compatible software applications. |
| use_palette | bool | r | Gets a value indicating whether the image palette is used. |
| width | int | r | Gets the image width. |
| width_f | float | r | Retrieve the width of the image with this convenient property. Obtain the image’s width effortlessly, facilitating precise layout calculations, scaling operations, and dimension-related tasks within your application. Ideal for ensuring accurate rendering and display of images across various platforms and devices. |
Methods
| Name | Description |
|---|---|
| cache_data() | This method does nothing as the current implementation of the EpsImage class does not involve caching data. While it may not perform any action, understanding this behavior is crucial for developers working with EPS images, ensuring efficient resource management and optimal performance within their applications. |
| 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. |
| crop(left_shift, right_shift, top_shift, bottom_shift) | Crop image with shifts. |
| crop(rectangle) | Crops the specified rectangle. |
| get_default_options(args) | Retrieve default options effortlessly to streamline image processing tasks. Access preconfigured settings to expedite workflow and ensure consistent output quality without manual configuration. |
| get_embedded_images() | Gets the embedded images. |
| 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_preview_image(format) | Retrieves the existing preview image in the specified format or returns None if none is found. This method offers flexibility in accessing preview images tailored to specific formats, optimizing compatibility and resource management within applications. |
| get_preview_images() | Accesses the preview images linked to the EpsImage instance, allowing seamless retrieval for inspection or utilization in applications. This method provides convenient access to preview images, enhancing user interaction with the image data. |
| 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_background() | Removes the background. |
| remove_background(settings) | Removes the background. |
| 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 specified new width. |
| resize(new_width, new_height, settings) | Resizes the image with extended options. |
| resize_by_settings(new_width, new_height, settings) | Resizes the image. |
| resize_by_type(new_width, new_height, resize_type) | Resizes the image. |
| resize_height_proportionally(new_height) | Resizes the height proportionally. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used. |
| resize_height_proportionally(new_height, resize_type) | Resizes the height proportionally. |
| resize_height_proportionally(new_height, settings) | Resizes the height proportionally. |
| resize_height_proportionally_settings(new_height, settings) | Resizes the height proportionally. |
| resize_width_proportionally(new_width) | Resizes the width proportionally. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used. |
| resize_width_proportionally(new_width, resize_type) | Resizes the width proportionally. |
| resize_width_proportionally(new_width, settings) | Resizes the width proportionally. |
| resize_width_proportionally_settings(new_width, settings) | Resizes the width proportionally. |
| rotate(angle) | Rotate image around the center. |
| rotate_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 data. |
| save(stream, options_base) | Saves the image’s data to the specified stream in the specified file format according to save options. |
| save(stream, options_base, bounds_rectangle) | Saves the image’s data to the specified stream in the specified file format according to save options. |
| save_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) | Customize image palettes to achieve unique color schemes and enhance visual appeal. Tailor colors for specific effects and optimize image quality across different platforms and devices with ease. |
Method: can_load(file_path) [static]
can_load(file_path)
Determines whether image can be loaded from the specified file path.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path. |
Returns
| Type | Description |
|---|---|
| bool |
Method: can_load(file_path, load_options) [static]
can_load(file_path, load_options)
Determines whether image can be loaded from the specified file path and optionally using the specified open options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path. |
| load_options | LoadOptions | The load options. |
Returns
| Type | Description |
|---|---|
| bool |
Method: can_load(stream) [static]
can_load(stream)
Determines whether image can be loaded from the specified stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load from. |
Returns
| Type | Description |
|---|---|
| bool |
Method: can_load(stream, load_options) [static]
can_load(stream, load_options)
Determines whether image can be loaded from the specified stream and optionally using the specified loadOptions.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load from. |
| load_options | LoadOptions | The load options. |
Returns
| Type | Description |
|---|---|
| bool |
Method: can_load_stream(stream) [static]
can_load_stream(stream)
Determines whether image can be loaded from the specified stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load from. |
Returns
| Type | Description |
|---|---|
| bool |
Method: can_load_stream_with_options(stream, load_options) [static]
can_load_stream_with_options(stream, load_options)
Determines whether image can be loaded from the specified stream and optionally using the specified loadOptions.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to load from. |
| load_options | LoadOptions | The load options. |
Returns
| Type | Description |
|---|---|
| bool |
Method: can_load_with_options(file_path, load_options) [static]
can_load_with_options(file_path, load_options)
Determines whether image can be loaded from the specified file path and optionally using the specified open options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path. |
| load_options | LoadOptions | The load options. |
Returns
| Type | Description |
|---|---|
| bool |
Method: can_save(options)
can_save(options)
Determines whether image can be saved to the specified file format represented by the passed save options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | ImageOptionsBase | The save options to use. |
Returns
| Type | Description |
|---|---|
| bool |
Method: create(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 |
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 |
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 |
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 |
Returns
| Type | Description |
|---|---|
| Image | The Image as IMultipageImage |
Method: crop(left_shift, right_shift, top_shift, bottom_shift)
crop(left_shift, right_shift, top_shift, bottom_shift)
Crop image with shifts.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| left_shift | int | The left shift. |
| right_shift | int | The right shift. |
| top_shift | int | The top shift. |
| bottom_shift | int | The bottom shift. |
Method: crop(rectangle)
crop(rectangle)
Crops the specified rectangle.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rectangle | The rectangle. |
Method: get_default_options(args)
get_default_options(args)
Retrieve default options effortlessly to streamline image processing tasks. Access
preconfigured settings to expedite workflow and ensure consistent output quality
without manual configuration.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| args | object | The arguments. |
Returns
| Type | Description |
|---|---|
| ImageOptionsBase | Default options |
Method: get_embedded_images()
get_embedded_images()
Gets the embedded images.
Returns
| Type | Description |
|---|---|
| EmbeddedImage[] | Array of images |
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_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_preview_image(format)
get_preview_image(format)
Retrieves the existing preview image in the specified format or
returns None if none is found. This method offers flexibility in
accessing preview images tailored to specific formats, optimizing compatibility and
resource management within applications.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| format | EpsPreviewFormat | The EPS preview image format. |
Returns
| Type | Description |
|---|---|
| Image | The exisiting preview image or None. |
Method: get_preview_images()
get_preview_images()
Accesses the preview images linked to the EpsImage instance, allowing
seamless retrieval for inspection or utilization in applications. This method
provides convenient access to preview images, enhancing user interaction with the
image data.
Returns
| Type | Description |
|---|---|
| list[Image] | The preview images. |
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. |
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_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: remove_background(settings)
remove_background(settings)
Removes the background.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| settings | RemoveBackgroundSettings | The settings. |
Method: resize(new_width, new_height)
resize(new_width, new_height)
Resizes the image. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
| new_height | int | The new height. |
Method: resize(new_width, new_height, resize_type)
resize(new_width, new_height, resize_type)
Resizes the specified new width.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
| new_height | int | The new height. |
| resize_type | ResizeType | Type of the resize. |
See also:
Example # 1: Resize EPS image and export it to PNG format.
Method: resize(new_width, new_height, settings)
resize(new_width, new_height, settings)
Resizes the image with extended options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
| new_height | int | The new height. |
| settings | ImageResizeSettings | The resize settings. |
Method: resize_by_settings(new_width, new_height, settings)
resize_by_settings(new_width, new_height, settings)
Resizes the image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
| new_height | int | The new height. |
| settings | ImageResizeSettings | The resize settings. |
Method: resize_by_type(new_width, new_height, resize_type)
resize_by_type(new_width, new_height, resize_type)
Resizes the image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
| new_height | int | The new height. |
| resize_type | ResizeType | The resize type. |
Method: resize_height_proportionally(new_height)
resize_height_proportionally(new_height)
Resizes the height proportionally. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_height | int | The new height. |
Method: resize_height_proportionally(new_height, resize_type)
resize_height_proportionally(new_height, resize_type)
Resizes the height proportionally.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_height | int | The new height. |
| resize_type | ResizeType | Type of the resize. |
Method: resize_height_proportionally(new_height, settings)
resize_height_proportionally(new_height, settings)
Resizes the height proportionally.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_height | int | The new height. |
| settings | ImageResizeSettings | The image resize settings. |
Method: resize_height_proportionally_settings(new_height, settings)
resize_height_proportionally_settings(new_height, settings)
Resizes the height proportionally.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_height | int | The new height. |
| settings | ImageResizeSettings | The image resize settings. |
Method: resize_width_proportionally(new_width)
resize_width_proportionally(new_width)
Resizes the width proportionally. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
Method: resize_width_proportionally(new_width, resize_type)
resize_width_proportionally(new_width, resize_type)
Resizes the width proportionally.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
| resize_type | ResizeType | Type of the resize. |
Method: resize_width_proportionally(new_width, settings)
resize_width_proportionally(new_width, settings)
Resizes the width proportionally.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
| settings | ImageResizeSettings | The image resize settings. |
Method: resize_width_proportionally_settings(new_width, settings)
resize_width_proportionally_settings(new_width, settings)
Resizes the width proportionally.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| new_width | int | The new width. |
| settings | ImageResizeSettings | The image resize settings. |
Method: rotate(angle)
rotate(angle)
Rotate image around the center.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| angle | float | The rotate angle in degrees. Positive values will rotate clockwise. |
Method: rotate_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. |
Method: save(file_path)
save(file_path)
Saves the image to the specified file location.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path to save the image to. |
Method: save(file_path, options)
save(file_path, options)
Saves the object’s data to the specified file location in the specified file format according to save options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path. |
| options | ImageOptionsBase | The options. |
Method: save(file_path, options, bounds_rectangle)
save(file_path, options, bounds_rectangle)
Saves the object’s data to the specified file location in the specified file format according to save options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path. |
| options | ImageOptionsBase | The options. |
| bounds_rectangle | Rectangle | The destination image bounds rectangle. Set the empty rectangle for use sourse bounds. |
Method: save(file_path, over_write)
save(file_path, over_write)
Saves the object’s data to the specified file location.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| file_path | string | The file path to save the object’s data to. |
| over_write | bool | if set to |
Method: save(stream)
save(stream)
Saves the data.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | _io.BufferedRandom | The stream to save 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_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)
Customize image palettes to achieve unique color schemes and enhance visual appeal.
Tailor colors for specific effects and optimize image quality across different
platforms and devices with ease.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| palette | IColorPalette | The palette to set. |
| update_colors | bool | if set to |
Examples
Convert EPS image to PNG using PostScript rendering.
import aspose.pycore as aspycore
from aspose.imaging import Image
from aspose.imaging.fileformats.eps import EpsImage, EpsPreviewFormat
from aspose.imaging.imageoptions import PngOptions
with aspycore.as_of(Image.load("Sample.eps"), EpsImage) as image:
obj_init = EpsRasterizationOptions()
obj_init.page_width = 500
obj_init.page_height = 500
obj_init.preview_to_export = EpsPreviewFormat.POST_SCRIPT_RENDERING
options = PngOptions()
obj_init2.vector_rasterization_options = obj_init
# Render raster image using the PostScript
image.save("Sample.png", options)
Convert EPS image to PDF using PostScript rendering.
from aspose.imaging import Image, PdfComplianceVersion
from aspose.imaging.imageoptions import PdfOptions
from aspose.imaging.fileformats.pdf import PdfCoreOptions
with Image.load("Sample.eps") as image:
options = PdfOptions()
options.pdf_core_options = PdfCoreOptions()
options.pdf_core_options.pdf_compliance = PdfComplianceVersion.PDF_A1B # Set required PDF compliance
image.save("Sample.pdf", options)
Resize EPS image and export it to PNG format.
from aspose.imaging import Image, ResizeType
from aspose.imaging.imageoptions import PngOptions
# Load EPS image
with Image.load("AstrixObelix.eps") as image:
# Resize the image using the Mitchell cubic interpolation method
image.resize(400, 400, ResizeType.MITCHELL)
# Export image to PNG format
image.save("ExportResult.png", PngOptions())