PsdImage Class

Summary: Defines the PsdImage class that provides the ability to load, edit, save PSD files as well as
update properties, add watermarks, perform graphics operations or convert one file format to another.
Aspose.PSD supports import as a layer and export to the following formats:
Png, Jpeg, Jpeg2000, Gif, Bmp, Tiff, Psd, Psb along with export to Pdf with selectable text

Module: aspose.psd.fileformats.psd

Full Name: aspose.psd.fileformats.psd.PsdImage

Inheritance: IObjectWithBounds, IRasterImageArgb32PixelLoader, IRasterImageRawDataLoader, RasterCachedImage

Aspose.PSD Version: 24.9.0

Constructors

Name	Description
PsdImage(path)	Initializes a new instance of the PsdImage class from specified path from raster image (not psd image in path). Used to initialize psd image with default parameters - Color mode - rgb, 4 channels, 8 bit per channel, Compression - Raw.
PsdImage(path, color_mode, channel_bit_depth, channels, psd_version, compression)	Initializes a new instance of the PsdImage class from specified path from raster image (not psd image in path) with constructor parameters.
PsdImage(raster_image)	Initializes a new instance of the PsdImage class from existing raster image (not psd image) with RGB color mode with 4 channels 8 bit/channel and no compression.
PsdImage(raster_image, color_mode, channel_bit_depth, channels, psd_version, compression)	Initializes a new instance of the PsdImage class from existing raster image (not psd image) with constructor parameters.
PsdImage(stream)	Initializes a new instance of the PsdImage class from specified path from raster image (not psd image in stream). Used to initialize psd image with default parameters - Color mode - rgb, 4 channels, 8 bit per channel, Compression - Raw.
PsdImage(stream, color_mode, channel_bit_depth, channels, psd_version, compression)	Initializes a new instance of the PsdImage class from specified path from raster image (not psd image in stream) with constructor parameters.
PsdImage(width, height)	Initializes a new instance of the PsdImage class with specified width and height. Used to initialize empty psd image.
PsdImage(width, height, color_palette, color_mode, channel_bit_depth, channels, psd_version, compression)	Initializes a new instance of the PsdImage class with specified width,height, paletter, color mode, channels count and channels bit-length and specified compression mode parameters. Used to initialize empty psd image.

Properties

Name	Type	Access	Description
DEFAULT_VERSION [static]	int	r	The default PSD version.
active_layer	Layer	r/w	Gets or sets the active layer.
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_channel	int	r	Gets the bits per channel.
bits_per_pixel	int	r	Gets the image bits per pixel count.
bounds	Rectangle	r	Gets the object bounds.
buffer_size_hint	int	r/w	Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
channels_count	int	r	Gets the PSD channels count.
cmyk_color_profile	StreamSource	r/w	Gets or sets the CMYK color profile for CMYK PSD images. Must be in pair with RgbColorProfile for correct color conversion.
color_mode	ColorModes	r/w	Gets or sets the color mode.
compression	CompressionMethod	r	Gets the compression method.
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
global_angle	int	r/w	Gets or sets the global angle.
global_layer_mask_info	GlobalLayerMaskInfo	r	Gets the global layer mask info.
global_layer_resources	LayerResource[]	r/w	Gets or sets the global layer resources.
gray_color_profile	StreamSource	r/w	Gets or sets the GRAY (monochrome) color profile for Grayscale PSD images.
has_alpha	bool	r	Gets or sets the vertical resolution, in pixels per inch, of this RasterImage.
has_background_color	bool	r/w	Gets or sets a value indicating whether image has background color.
has_transparency_data	bool	r/w	Gets or sets a value indicating whether first alpha channel contains the transparency data for the merged result when specifying layers data.
has_transparent_color	bool	r/w	Gets a value indicating whether image has transparent color.
height	int	r	Gets the image height.
horizontal_resolution	double	r/w	Gets or sets the horizontal resolution, in pixels per inch, of this PsdImage.
image_opacity	float	r	Gets opacity of this image.
image_resources	ResourceBlock[]	r/w	Gets or sets the PSD image resources.
interrupt_monitor	InterruptMonitor	r/w	Gets or sets the interrupt monitor.
is_cached	bool	r	Gets a value indicating whether image data is cached currently.
is_flatten	bool	r	Gets a value indicating whether psd image is flattened.
is_raw_data_available	bool	r	Gets a value indicating whether raw data loading is supported.
layers	Layer[]	r/w	Gets or sets the PSD layers.
linked_layers_manager	LinkedLayersManager	r	Gets the linked layers manager.
palette	IColorPalette	r/w	Gets or sets the color palette. The color palette is not used when pixels are represented directly.
premultiply_components	bool	r/w	Gets or sets a value indicating whether the image components must be premultiplied.
raw_custom_color_converter	IColorConverter	r/w	Gets or sets the custom color converter
raw_data_format	PixelDataFormat	r	Gets the raw data format.
raw_data_settings	RawDataSettings	r	Gets the current raw data settings. Note when using these settings the data loads without conversion.
raw_fallback_index	int	r/w	Gets or sets the fallback index to use when palette index is out of bounds
raw_indexed_color_converter	IIndexedColorConverter	r/w	Gets or sets the indexed color converter
raw_line_size	int	r	Gets the raw line size in bytes.
rgb_color_profile	StreamSource	r/w	Gets or sets the RGB color profile for CMYK PSD images. Must be in pair with CmykColorProfile for correct color conversion.
size	Size	r	Gets the object size.
smart_object_provider	SmartObjectProvider	r	Gets the smart object provider.
timeline	Timeline	r	Gets the PsdImage.timeline of this PsdImage.
transparent_color	Color	r/w	Gets the image transparent color.
update_xmp_data	bool	r/w	Gets or sets a value indicating whether to update the XMP metadata.
use_palette	bool	r	Gets a value indicating whether the image palette is used.
use_raw_data	bool	r/w	Gets or sets a value indicating whether to use raw data loading when the raw data loading is available.
version	int	r/w	Gets or sets the version.
vertical_resolution	double	r/w	Gets or sets the vertical resolution, in pixels per inch, of this PsdImage.
width	int	r	Gets the image width.
xmp_data	XmpPacketWrapper	r/w	Gets or sets the XMP metadata.

Methods

Name	Description
add_black_white_adjustment_layer()	Adds the black white adjustment layer.
add_brightness_contrast_adjustment_layer(brightness, contrast)	Adds the brightness/contrast adjustment layer.
add_channel_mixer_adjustment_layer()	Adds the channel mixer adjustment layer with default parameters
add_color_balance_adjustment_layer()	Adds the color balance adjustment layer.
add_curves_adjustment_layer()	Adds the Curves Adjustment layer.
add_exposure_adjustment_layer(exposure, offset, gamma_correction)	Adds the exposure adjustment layer.
add_gradient_map_adjustment_layer()	Adds GradientMap Adjustment layer.
add_hue_saturation_adjustment_layer()	Adds the hue/saturation adjustment layer.
add_invert_adjustment_layer()	Adds an invert adjustment layer.
add_layer(layer)	Adds the layer.
add_layer_group(group_name, index, start_behaviour)	Adds the layer group.
add_levels_adjustment_layer()	Adds the Levels adjustment layer.
add_photo_filter_layer(color)	Adds the PhotoFilter layer.
add_posterize_adjustment_layer()	Adds Posterize Adjustment layer.
add_regular_layer()	Adds a new regular layer.
add_selective_color_adjustment_layer()	Adds the selective color adjustment layer.
add_shape_layer()	Add empty Shape layer. Without paths. They should be added to shape layer before save.
add_text_layer(text, rect)	Adds a new Text layer.
add_threshold_adjustment_layer()	Adds the Threshold adjustment layer.
add_vibrance_adjustment_layer()	Adds the Vibrance adjustment layer.
adjust_brightness(brightness)	Adjust of a brightness for image.
adjust_contrast(contrast)	Image contrasting
adjust_gamma(gamma)	Gamma-correction of an image.
adjust_gamma(gamma_red, gamma_green, gamma_blue)	Gamma-correction of an image.
binarize_bradley(brightness_difference)	Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding
binarize_bradley(brightness_difference, window_size)	Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding
binarize_fixed(threshold)	Binarization of an image with predefined threshold
binarize_otsu()	Binarization of an image with Otsu thresholding
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 .
can_save(options)	Determines whether image can be saved to the specified file format represented by the passed save options.
convert(new_options)	Converts this image format to the one specified in options.
create(image_options, width, height)	Creates a new image using the specified create options.
crop(left_shift, right_shift, top_shift, bottom_shift)
crop(rectangle)	Cropping the image.
dither(dithering_method, bits_count)	Performs dithering on the current image.
dither(dithering_method, bits_count, custom_palette)	Performs dithering on the current image.
filter(rectangle, options)	Filters the specified rectangle.
flatten_image()	Flattens all layers.
get_argb_32_pixel(x, y)	Gets an image 32-bit ARGB pixel.
get_default_argb_32_pixels(rectangle)	Gets the default 32-bit ARGB pixels array.
get_default_options(args)	Gets the default options.
get_default_pixels(rectangle, partial_pixel_loader)	Gets the default pixels array using partial pixel loader.
get_default_raw_data(rectangle, partial_raw_data_loader, raw_data_settings)	Gets the default raw data array using partial pixel loader.
get_default_raw_data(rectangle, raw_data_settings)	Gets the default raw data array.
get_file_format(file_path)	Gets the file format.
get_file_format(stream)	Gets the file format.
get_fitting_rectangle(rectangle, pixels, width, height)	Gets rectangle which fits the current image.
get_fitting_rectangle(rectangle, width, height)	Gets rectangle which fits the current image.
get_modify_date(use_default)	Gets the date and time the resource image was last modified.
get_original_options()	Gets the options based on the original file settings. This can be helpful to keep bit-depth and other parameters of the original image unchanged. For example, if we load a black-white PNG image with 1 bit per pixel and then save it using the DataStreamSupporter.save(file_path) method, the output PNG image with 8-bit per pixel will be produced. To avoid it and save PNG image with 1-bit per pixel, use this method to get corresponding saving options and pass them to the Image.save(file_path, options) method as the second parameter.
get_pixel(x, y)	Gets an image pixel. Performance Warning: Avoid using this method to iterate over all image pixels as it can lead to significant performance issues. For more efficient pixel manipulation, use the LoadArgb32Pixels method to retrieve the entire pixel array simultaneously.
get_proportional_height(width, height, new_width)	Gets a proportional height.
get_proportional_width(width, height, new_height)	Gets a proportional width.
get_skew_angle()
grayscale()	Transformation of an image to its grayscale representation
load(file_path)	Loads a new image from the specified file.
load(file_path, load_options)	Loads a new image from the specified file.
load(stream)	Loads a new image from the specified stream.
load(stream, load_options)	Loads a new image from the specified stream.
load_argb_32_pixels(rectangle)	Loads 32-bit ARGB pixels.
load_argb_64_pixels(rectangle)	Loads 64-bit ARGB pixels.
load_cmyk_32_pixels(rectangle)	Loads pixels in CMYK format.
load_cmyk_pixels(rectangle)	Loads pixels in CMYK format. This method is deprecated. Please use more effective the RasterImage.load_cmyk_32_pixels(rectangle) method.
load_partial_argb_32_pixels(rectangle, partial_pixel_loader)	Loads 32-bit ARGB pixels partially (by blocks).
load_partial_pixels(desired_rectangle, pixel_loader)	Loads pixels partially by packs.
load_pixels(rectangle)	Loads pixels.
load_raw_data(rectangle, dest_image_bounds, raw_data_settings, raw_data_loader)	Loads raw data.
load_raw_data(rectangle, raw_data_settings, raw_data_loader)	Loads raw data.
merge_layers(bottom_layer, top_layer)	Merges the layers.
normalize_angle()
normalize_angle(resize_proportionally, background_color)
read_argb_32_scan_line(scan_line_index)	Reads the whole scan line by the specified scan line index.
read_scan_line(scan_line_index)	Reads the whole scan line by the specified scan line index.
replace_color(old_color, old_color_diff, new_color)	Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
replace_color(old_color_argb, old_color_diff, new_color_argb)	Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
replace_non_transparent_colors(new_color)	Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges. Note: if you use it on images without transparency, all colors will be replaced with a single one.
replace_non_transparent_colors(new_color_argb)	Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges. Note: if you use it on images without transparency, all colors will be replaced with a single one.
resize(new_width, new_height)	Resizes the image. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.
resize(new_width, new_height, resize_type)	Resizes the image.
resize(new_width, new_height, settings)	Resizes the image.
resize_height_proportionally(new_height)	Resizes the height proportionally.
resize_height_proportionally(new_height, resize_type)	Resizes the height proportionally.
resize_height_proportionally(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.
rotate(angle)	Rotate image around the center.
rotate(angle, resize_proportionally, background_color)	Rotate image around the center.
rotate_flip(rotate_flip_type)	Rotates, flips, or rotates and flips the image.
save()	Saves the image data to the underlying stream.
save(file_path)	Saves the object’s data to the specified file location.
save(file_path, options)	Saves the object’s data to the specified file location in the specified file format according to save options.
save(file_path, options, bounds_rectangle)	Saves the object’s data to the specified file location in the specified file format according to save options.
save(file_path, over_write)	Saves the object’s data to the specified file location.
save(stream)	Saves the object’s data to the specified stream.
save(stream, options_base)	Saves the image’s data to the specified stream in the specified file format according to save options.
save(stream, options_base, bounds_rectangle)	Saves the image’s data to the specified stream in the specified file format according to save options.
save_argb_32_pixels(rectangle, pixels)	Saves the 32-bit ARGB pixels.
save_cmyk_32_pixels(rectangle, pixels)
save_cmyk_pixels(rectangle, pixels)
save_pixels(rectangle, pixels)	Saves pixels (format specific method).
save_raw_data(data, data_offset, rectangle, raw_data_settings)	Saves the raw data.
set_argb_32_pixel(x, y, argb_32_color)	Sets an image 32-bit ARGB pixel for the specified position.
set_palette(palette, update_colors)	Sets the image palette.
set_pixel(x, y, color)	Sets an image pixel for the specified position.
set_resolution(dpi_x, dpi_y)	Sets the resolution for this PsdImage.
to_bitmap()
write_argb_32_scan_line(scan_line_index, argb_32_pixels)	Writes the whole scan line to the specified scan line index.
write_scan_line(scan_line_index, pixels)	Writes the whole scan line to the specified scan line index.

Constructor: PsdImage(path)

 PsdImage(path) 

Initializes a new instance of the PsdImage class from specified path from raster image (not psd image in path). Used to initialize psd image with default parameters - Color mode - rgb, 4 channels, 8 bit per channel, Compression - Raw.

Parameters:

Parameter	Type	Description
path	string	The path to load pixel and palette data from and initialize with.

Constructor: PsdImage(path, color_mode, channel_bit_depth, channels, psd_version, compression)

 PsdImage(path, color_mode, channel_bit_depth, channels, psd_version, compression) 

Initializes a new instance of the PsdImage class from specified path from raster image (not psd image in path) with constructor parameters.

Parameters:

Parameter	Type	Description
path	string	The path to load pixel and palette data from and initialize with.
color_mode	ColorModes	The color mode.
channel_bit_depth	short	The PSD bit depth per channel.
channels	short	The PSD channels count.
psd_version	int	The PSD version.
compression	CompressionMethod	The compression to use.

Constructor: PsdImage(raster_image)

 PsdImage(raster_image) 

Initializes a new instance of the PsdImage class from existing raster image (not psd image) with RGB color mode with 4 channels 8 bit/channel and no compression.

Parameters:

Parameter	Type	Description
raster_image	RasterImage	The image to load pixel and palette data from and initialize with.

Constructor: PsdImage(raster_image, color_mode, channel_bit_depth, channels, psd_version, compression)

 PsdImage(raster_image, color_mode, channel_bit_depth, channels, psd_version, compression) 

Initializes a new instance of the PsdImage class from existing raster image (not psd image) with constructor parameters.

Parameters:

Parameter	Type	Description
raster_image	RasterImage	The image to load pixel and palette data from and initialize with.
color_mode	ColorModes	The color mode.
channel_bit_depth	short	The PSD bit depth per channel.
channels	short	The PSD channels count.
psd_version	int	The PSD version.
compression	CompressionMethod	The compression to use.

Constructor: PsdImage(stream)

 PsdImage(stream) 

Initializes a new instance of the PsdImage class from specified path from raster image (not psd image in stream). Used to initialize psd image with default parameters - Color mode - rgb, 4 channels, 8 bit per channel, Compression - Raw.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to load pixel and palette data from and initialize with.

Constructor: PsdImage(stream, color_mode, channel_bit_depth, channels, psd_version, compression)

 PsdImage(stream, color_mode, channel_bit_depth, channels, psd_version, compression) 

Initializes a new instance of the PsdImage class from specified path from raster image (not psd image in stream) with constructor parameters.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to load pixel and palette data from and initialize with.
color_mode	ColorModes	The color mode.
channel_bit_depth	short	The PSD bit depth per channel.
channels	short	The PSD channels count.
psd_version	int	The PSD version.
compression	CompressionMethod	The compression to use.

Constructor: PsdImage(width, height)

 PsdImage(width, height) 

Initializes a new instance of the PsdImage class with specified width and height. Used to initialize empty psd image.

Parameters:

Parameter	Type	Description
width	int	The image width.
height	int	The image height.

Constructor: PsdImage(width, height, color_palette, color_mode, channel_bit_depth, channels, psd_version, compression)

 PsdImage(width, height, color_palette, color_mode, channel_bit_depth, channels, psd_version, compression) 

Initializes a new instance of the PsdImage class with specified width,height, paletter, color mode, channels count and channels bit-length and specified compression mode parameters. Used to initialize empty psd image.

Parameters:

Parameter	Type	Description
width	int	The image width.
height	int	The image height.
color_palette	IColorPalette	The color palette.
color_mode	ColorModes	The color mode.
channel_bit_depth	short	The PSD bit depth per channel.
channels	short	The PSD channels count.
psd_version	int	The PSD version.
compression	CompressionMethod	The compression to use.

Method: add_black_white_adjustment_layer()

 add_black_white_adjustment_layer() 

Adds the black white adjustment layer.

Returns

Type	Description
BlackWhiteAdjustmentLayer	The created black white adjustment layer.

Method: add_brightness_contrast_adjustment_layer(brightness, contrast)

 add_brightness_contrast_adjustment_layer(brightness, contrast) 

Adds the brightness/contrast adjustment layer.

Parameters:

Parameter	Type	Description
brightness	int	The brightness.
contrast	int	The contrast.

Returns

Type	Description
BrightnessContrastLayer	Created brightness/contrast layer

Method: add_channel_mixer_adjustment_layer()

 add_channel_mixer_adjustment_layer() 

Adds the channel mixer adjustment layer with default parameters

Returns

Type	Description
ChannelMixerLayer	Added Channel Mixer Layer

Method: add_color_balance_adjustment_layer()

 add_color_balance_adjustment_layer() 

Adds the color balance adjustment layer.

Returns

Type	Description
ColorBalanceAdjustmentLayer	A newly created color balance layer.

Method: add_curves_adjustment_layer()

 add_curves_adjustment_layer() 

Adds the Curves Adjustment layer.

Returns

Type	Description
CurvesLayer	Created CurvesLayer Layer

Method: add_exposure_adjustment_layer(exposure, offset, gamma_correction)

 add_exposure_adjustment_layer(exposure, offset, gamma_correction) 

Adds the exposure adjustment layer.

Parameters:

Parameter	Type	Description
exposure	float	The exposure.
offset	float	The offset.
gamma_correction	float	The gamma correction.

Returns

Type	Description
ExposureLayer	Created Exposure Adjustment Layer

Method: add_gradient_map_adjustment_layer()

 add_gradient_map_adjustment_layer() 

Adds GradientMap Adjustment layer.

Returns

Type	Description
GradientMapLayer	GradientMap instance.

Method: add_hue_saturation_adjustment_layer()

 add_hue_saturation_adjustment_layer() 

Adds the hue/saturation adjustment layer.

Returns

Type	Description
HueSaturationLayer	A newly created hue/saturation layer.

Method: add_invert_adjustment_layer()

 add_invert_adjustment_layer() 

Adds an invert adjustment layer.

Returns

Type	Description
InvertAdjustmentLayer	The created invert layer

Method: add_layer(layer)

 add_layer(layer) 

Adds the layer.

Parameters:

Parameter	Type	Description
layer	Layer	The layer.

Method: add_layer_group(group_name, index, start_behaviour)

 add_layer_group(group_name, index, start_behaviour) 

Adds the layer group.

Parameters:

Parameter	Type	Description
group_name	string	Name of the group.
index	int	The index of the layer to insert after.
start_behaviour	bool	if set to true [start behaviour] than group will be in open state on start up, otherwise in minimized state.

Returns

Type	Description
LayerGroup	Opening group layer

Method: add_levels_adjustment_layer()

 add_levels_adjustment_layer() 

Adds the Levels adjustment layer.

Returns

Type	Description
LevelsLayer	A newly created Levels layer

Method: add_photo_filter_layer(color)

 add_photo_filter_layer(color) 

Adds the PhotoFilter layer.

Parameters:

Parameter	Type	Description
color	Color	The color.

Returns

Type	Description
PhotoFilterLayer	Created PhotoFilter Layer

Method: add_posterize_adjustment_layer()

 add_posterize_adjustment_layer() 

Adds Posterize Adjustment layer.

Returns

Type	Description
PosterizeLayer	PosterizeLayer instance.

Method: add_regular_layer()

 add_regular_layer() 

Adds a new regular layer.

Returns

Type	Description
Layer	Created regular layer.

Method: add_selective_color_adjustment_layer()

 add_selective_color_adjustment_layer() 

Adds the selective color adjustment layer.

Returns

Type	Description
SelectiveColorLayer	The created selective color adjustment layer.

Method: add_shape_layer()

 add_shape_layer() 

Add empty Shape layer.
Without paths. They should be added to shape layer before save.

Returns

Type	Description
ShapeLayer	ShapeLayer instance.

Method: add_text_layer(text, rect)

 add_text_layer(text, rect) 

Adds a new Text layer.

Parameters:

Parameter	Type	Description
text	string	The layer’s text.
rect	Rectangle	The layer’s rectangle.

Returns

Type	Description
TextLayer	Created text layer.

Method: add_threshold_adjustment_layer()

 add_threshold_adjustment_layer() 

Adds the Threshold adjustment layer.

Returns

Type	Description
ThresholdLayer	The created Threshold adjustment layer.

Method: add_vibrance_adjustment_layer()

 add_vibrance_adjustment_layer() 

Adds the Vibrance adjustment layer.

Returns

Type	Description
VibranceLayer	A newly created Vibrance layer.

Method: adjust_brightness(brightness)

 adjust_brightness(brightness) 

Adjust of a brightness for image.

Parameters:

Parameter	Type	Description
brightness	int	Brightness value.

Method: adjust_contrast(contrast)

 adjust_contrast(contrast) 

Image contrasting

Parameters:

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

Method: adjust_gamma(gamma)

 adjust_gamma(gamma) 

Gamma-correction of an image.

Parameters:

Parameter	Type	Description
gamma	float	Gamma for red, green and blue channels coefficient

Method: adjust_gamma(gamma_red, gamma_green, gamma_blue)

 adjust_gamma(gamma_red, gamma_green, gamma_blue) 

Gamma-correction of an image.

Parameters:

Parameter	Type	Description
gamma_red	float	Gamma for red channel coefficient
gamma_green	float	Gamma for green channel coefficient
gamma_blue	float	Gamma for blue channel coefficient

Method: binarize_bradley(brightness_difference)

 binarize_bradley(brightness_difference) 

Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding

Parameters:

Parameter	Type	Description
brightness_difference	double	The brightness difference between pixel and the average of an s x s window of pixels centered around this pixel.

Method: binarize_bradley(brightness_difference, window_size)

 binarize_bradley(brightness_difference, window_size) 

Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding

Parameters:

Parameter	Type	Description
brightness_difference	double	The brightness difference between pixel and the average of an s x s window of pixels centered around this pixel.
window_size	int	The size of s x s window of pixels centered around this pixel

Method: binarize_fixed(threshold)

 binarize_fixed(threshold) 

Binarization of an image with predefined threshold

Parameters:

Parameter	Type	Description
threshold	byte	Threshold value. If corresponding gray value of a pixel is greater than threshold, a value of 255 will be assigned to it, 0 otherwise.

Method: can_load(file_path) [static]

 can_load(file_path) 

Determines whether image can be loaded from the specified file path.

Parameters:

Parameter	Type	Description
file_path	string	The file path.

Returns

Type	Description
bool	true if image can be loaded from the specified file; otherwise, false.

Method: can_load(file_path, load_options) [static]

 can_load(file_path, load_options) 

Determines whether image can be loaded from the specified file path and optionally using the specified open options.

Parameters:

Parameter	Type	Description
file_path	string	The file path.
load_options	LoadOptions	The load options.

Returns

Type	Description
bool	true if image can be loaded from the specified file; otherwise, false.

Method: can_load(stream) [static]

 can_load(stream) 

Determines whether image can be loaded from the specified stream.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to load from.

Returns

Type	Description
bool	true if image can be loaded from the specified stream; otherwise, false.

Method: can_load(stream, load_options) [static]

 can_load(stream, load_options) 

Determines whether image can be loaded from the specified stream and optionally using the specified .

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_save(options)

 can_save(options) 

Determines whether image can be saved to the specified file format represented by the passed save options.

Parameters:

Parameter	Type	Description
options	ImageOptionsBase	The save options to use.

Returns

Type	Description
bool	true if image can be saved to the specified file format represented by the passed save options; otherwise, false.

Method: convert(new_options)

 convert(new_options) 

Converts this image format to the one specified in options.

Parameters:

Parameter	Type	Description
new_options	PsdOptions	The new options.

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: crop(rectangle)

 crop(rectangle) 

Cropping the image.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle.

Method: dither(dithering_method, bits_count)

 dither(dithering_method, bits_count) 

Performs dithering on the current image.

Parameters:

Parameter	Type	Description
dithering_method	DitheringMethod	The dithering method.
bits_count	int	The final bits count for dithering.

Method: dither(dithering_method, bits_count, custom_palette)

 dither(dithering_method, bits_count, custom_palette) 

Performs dithering on the current image.

Parameters:

Parameter	Type	Description
dithering_method	DitheringMethod	The dithering method.
bits_count	int	The final bits count for dithering.
custom_palette	IColorPalette	The custom palette for dithering.

Method: filter(rectangle, options)

 filter(rectangle, options) 

Filters the specified rectangle.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle.
options	FilterOptionsBase	The options.

Method: get_argb_32_pixel(x, y)

 get_argb_32_pixel(x, y) 

Gets an image 32-bit ARGB pixel.

Parameters:

Parameter	Type	Description
x	int	The pixel x location.
y	int	The pixel y location.

Returns

Type	Description
int	The 32-bit ARGB pixel for the specified location.

Method: get_default_argb_32_pixels(rectangle)

 get_default_argb_32_pixels(rectangle) 

Gets the default 32-bit ARGB pixels array.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to get pixels for.

Returns

Type	Description
int	The default pixels array.

Method: get_default_options(args)

 get_default_options(args) 

Gets the default options.

Parameters:

Parameter	Type	Description
args	object	The arguments.

Returns

Type	Description
ImageOptionsBase	Default options

Method: get_default_pixels(rectangle, partial_pixel_loader)

 get_default_pixels(rectangle, partial_pixel_loader) 

Gets the default pixels array using partial pixel loader.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to get pixels for.
partial_pixel_loader	IPartialArgb32PixelLoader	The partial pixel loader.

Method: get_default_raw_data(rectangle, partial_raw_data_loader, raw_data_settings)

 get_default_raw_data(rectangle, partial_raw_data_loader, raw_data_settings) 

Gets the default raw data array using partial pixel loader.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to get pixels for.
partial_raw_data_loader	IPartialRawDataLoader	The partial raw data loader.
raw_data_settings	RawDataSettings	The raw data settings.

Method: get_default_raw_data(rectangle, raw_data_settings)

 get_default_raw_data(rectangle, raw_data_settings) 

Gets the default raw data array.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to get raw data for.
raw_data_settings	RawDataSettings	The raw data settings.

Returns

Type	Description
byte	The default raw data array.

Method: get_file_format(file_path) [static]

 get_file_format(file_path) 

Gets the file format.

Parameters:

Parameter	Type	Description
file_path	string	The file path.

Returns

Type	Description
FileFormat	The determined file format.

Method: get_file_format(stream) [static]

 get_file_format(stream) 

Gets the file format.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream.

Returns

Type	Description
FileFormat	The determined file format.

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

 get_fitting_rectangle(rectangle, pixels, width, height) 

Gets rectangle which fits the current image.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to get fitting rectangle for.
pixels	int	The 32-bit ARGB pixels.
width	int	The object width.
height	int	The object height.

Returns

Type	Description
Rectangle	The fitting rectangle or exception if no fitting rectangle can be found.

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

 get_fitting_rectangle(rectangle, width, height) 

Gets rectangle which fits the current image.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to get fitting rectangle for.
width	int	The object width.
height	int	The object height.

Returns

Type	Description
Rectangle	The fitting rectangle or exception if no fitting rectangle can be found.

Method: get_modify_date(use_default)

 get_modify_date(use_default) 

Gets the date and time the resource image was last modified.

Parameters:

Parameter	Type	Description
use_default	bool	if set to true uses the information from FileInfo as default value.

Returns

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

Method: get_original_options()

 get_original_options() 

Gets the options based on the original file settings.
This can be helpful to keep bit-depth and other parameters of the original image unchanged.
For example, if we load a black-white PNG image with 1 bit per pixel and then save it using the
DataStreamSupporter.save(file_path) method, the output PNG image with 8-bit per pixel will be produced.
To avoid it and save PNG image with 1-bit per pixel, use this method to get corresponding saving options and pass them
to the Image.save(file_path, options) method as the second parameter.

Returns

Type	Description
ImageOptionsBase	The options based on the original file settings.

Method: get_pixel(x, y)

 get_pixel(x, y) 

Gets an image pixel.
Performance Warning: Avoid using this method to iterate over all image pixels as it can lead to significant performance issues.
For more efficient pixel manipulation, use the LoadArgb32Pixels method to retrieve the entire pixel array simultaneously.

Parameters:

Parameter	Type	Description
x	int	The pixel x location.
y	int	The pixel y location.

Returns

Type	Description
Color	The pixel color for the specified location.

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

 get_proportional_height(width, height, new_width) 

Gets a proportional height.

Parameters:

Parameter	Type	Description
width	int	The width.
height	int	The height.
new_width	int	The new width.

Returns

Type	Description
int	The proportional height.

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

 get_proportional_width(width, height, new_height) 

Gets a proportional width.

Parameters:

Parameter	Type	Description
width	int	The width.
height	int	The height.
new_height	int	The new height.

Returns

Type	Description
int	The proportional width.

Method: get_skew_angle()

 get_skew_angle() 

Returns

Type	Description
float

Method: load(file_path) [static]

 load(file_path) 

Loads a new image from the specified file.

Parameters:

Parameter	Type	Description
file_path	string	The file path to load image from.

Returns

Type	Description
Image	The loaded image.

Method: load(file_path, load_options) [static]

 load(file_path, load_options) 

Loads a new image from the specified file.

Parameters:

Parameter	Type	Description
file_path	string	The file path to load image from.
load_options	LoadOptions	The load options.

Returns

Type	Description
Image	The loaded image.

Method: load(stream) [static]

 load(stream) 

Loads a new image from the specified stream.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to load image from.

Returns

Type	Description
Image	The loaded image.

Method: load(stream, load_options) [static]

 load(stream, load_options) 

Loads a new image from the specified stream.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to load image from.
load_options	LoadOptions	The load options.

Returns

Type	Description
Image	The loaded image.

Method: load_argb_32_pixels(rectangle)

 load_argb_32_pixels(rectangle) 

Loads 32-bit ARGB pixels.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to load pixels from.

Returns

Type	Description
int	The loaded 32-bit ARGB pixels array.

Method: load_argb_64_pixels(rectangle)

 load_argb_64_pixels(rectangle) 

Loads 64-bit ARGB pixels.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to load pixels from.

Returns

Type	Description
long	The loaded 64-bit ARGB pixels array.

Method: load_cmyk_32_pixels(rectangle)

 load_cmyk_32_pixels(rectangle) 

Loads pixels in CMYK format.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to load pixels from.

Returns

Type	Description
int	The loaded CMYK pixels presentes as 32-bit inateger values.

Method: load_cmyk_pixels(rectangle)

 load_cmyk_pixels(rectangle) 

Loads pixels in CMYK format.
This method is deprecated. Please use more effective the RasterImage.load_cmyk_32_pixels(rectangle) method.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to load pixels from.

Returns

Type	Description
CmykColor[]	The loaded CMYK pixels array.

Method: load_partial_argb_32_pixels(rectangle, partial_pixel_loader)

 load_partial_argb_32_pixels(rectangle, partial_pixel_loader) 

Loads 32-bit ARGB pixels partially (by blocks).

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to load pixels from.
partial_pixel_loader	IPartialArgb32PixelLoader	The partial pixel loader.

Method: load_partial_pixels(desired_rectangle, pixel_loader)

 load_partial_pixels(desired_rectangle, pixel_loader) 

Loads pixels partially by packs.

Parameters:

Parameter	Type	Description
desired_rectangle	Rectangle	The desired rectangle.
pixel_loader	IPartialPixelLoader	The pixel loader.

Method: load_pixels(rectangle)

 load_pixels(rectangle) 

Loads pixels.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to load pixels from.

Returns

Type	Description
Color[]	The loaded pixels array.

Method: load_raw_data(rectangle, dest_image_bounds, raw_data_settings, raw_data_loader)

 load_raw_data(rectangle, dest_image_bounds, raw_data_settings, raw_data_loader) 

Loads raw data.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to load raw data from.
dest_image_bounds	Rectangle	The dest image bounds.
raw_data_settings	RawDataSettings	The raw data settings to use for loaded data. Note if data is not in the format specified then data conversion will be performed.
raw_data_loader	IPartialRawDataLoader	The raw data loader.

Method: load_raw_data(rectangle, raw_data_settings, raw_data_loader)

 load_raw_data(rectangle, raw_data_settings, raw_data_loader) 

Loads raw data.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to load raw data from.
raw_data_settings	RawDataSettings	The raw data settings to use for loaded data. Note if data is not in the format specified then data conversion will be performed.
raw_data_loader	IPartialRawDataLoader	The raw data loader.

Method: merge_layers(bottom_layer, top_layer)

 merge_layers(bottom_layer, top_layer) 

Merges the layers.

Parameters:

Parameter	Type	Description
bottom_layer	Layer	The bottom layer.
top_layer	Layer	The top layer.

Returns

Type	Description
Layer	Bottom layer after the merge

Method: read_argb_32_scan_line(scan_line_index)

 read_argb_32_scan_line(scan_line_index) 

Reads the whole scan line by the specified scan line index.

Parameters:

Parameter	Type	Description
scan_line_index	int	Zero based index of the scan line.

Returns

Type	Description
int	The scan line 32-bit ARGB color values array.

Method: read_scan_line(scan_line_index)

 read_scan_line(scan_line_index) 

Reads the whole scan line by the specified scan line index.

Parameters:

Parameter	Type	Description
scan_line_index	int	Zero based index of the scan line.

Returns

Type	Description
Color[]	The scan line pixel color values array.

Method: replace_color(old_color, old_color_diff, new_color)

 replace_color(old_color, old_color_diff, new_color) 

Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.

Parameters:

Parameter	Type	Description
old_color	Color
old_color_diff	byte	Allowed difference in old color to be able to widen replaced color tone.
new_color	Color

Method: replace_color(old_color_argb, old_color_diff, new_color_argb)

 replace_color(old_color_argb, old_color_diff, new_color_argb) 

Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.

Parameters:

Parameter	Type	Description
old_color_argb	int	Old color ARGB value to be replaced.
old_color_diff	byte	Allowed difference in old color to be able to widen replaced color tone.
new_color_argb	int	New color ARGB value to replace old color with.

Method: replace_non_transparent_colors(new_color)

 replace_non_transparent_colors(new_color) 

Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges.
Note: if you use it on images without transparency, all colors will be replaced with a single one.

Parameters:

Parameter	Type	Description
new_color	Color

Method: replace_non_transparent_colors(new_color_argb)

 replace_non_transparent_colors(new_color_argb) 

Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges.
Note: if you use it on images without transparency, all colors will be replaced with a single one.

Parameters:

Parameter	Type	Description
new_color_argb	int	New color ARGB value to replace non transparent colors with.

Method: resize(new_width, new_height)

 resize(new_width, new_height) 

Resizes the image. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.

Parameters:

Parameter	Type	Description
new_width	int	The new width.
new_height	int	The new height.

Method: resize(new_width, new_height, resize_type)

 resize(new_width, new_height, resize_type) 

Resizes the image.

Parameters:

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

Method: resize(new_width, new_height, settings)

 resize(new_width, new_height, settings) 

Resizes the image.

Parameters:

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

Method: resize_height_proportionally(new_height)

 resize_height_proportionally(new_height) 

Resizes the height proportionally.

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_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: rotate(angle)

 rotate(angle) 

Rotate image around the center.

Parameters:

Parameter	Type	Description
angle	float	The rotate angle in degrees. Positive values will rotate clockwise.

Method: rotate(angle, resize_proportionally, background_color)

 rotate(angle, resize_proportionally, background_color) 

Rotate image around the center.

Parameters:

Parameter	Type	Description
angle	float	The rotate angle in degrees. Positive values will rotate clockwise.
resize_proportionally	bool	if set to true you will have your image size changed according to rotated rectangle (corner points) projections in other case that leaves dimensions untouched and only internal image contents are rotated.
background_color	Color	Color of the background.

Method: rotate_flip(rotate_flip_type)

 rotate_flip(rotate_flip_type) 

Rotates, flips, or rotates and flips the image.

Parameters:

Parameter	Type	Description
rotate_flip_type	RotateFlipType	The rotate flip type.

Method: save(file_path)

 save(file_path) 

Saves the 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.

Method: save(file_path, options)

 save(file_path, options) 

Saves the object’s data to the specified file location in the specified file format according to save options.

Parameters:

Parameter	Type	Description
file_path	string	The file path.
options	ImageOptionsBase	The options.

Method: save(file_path, options, bounds_rectangle)

 save(file_path, options, bounds_rectangle) 

Saves the object’s data to the specified file location in the specified file format according to save options.

Parameters:

Parameter	Type	Description
file_path	string	The file path.
options	ImageOptionsBase	The options.
bounds_rectangle	Rectangle	The destination image bounds rectangle. Set the empty rectangle for use sourse bounds.

Method: save(file_path, over_write)

 save(file_path, over_write) 

Saves the object’s data to the specified file location.

Parameters:

Parameter	Type	Description
file_path	string	The file path to save the object’s data to.
over_write	bool	if set to true over write the file contents, otherwise append will occur.

Method: save(stream)

 save(stream) 

Saves the object’s data to the specified stream.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to save the object’s data to.

Method: save(stream, options_base)

 save(stream, options_base) 

Saves the image’s data to the specified stream in the specified file format according to save options.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to save the image’s data to.
options_base	ImageOptionsBase	The save options.

Method: save(stream, options_base, bounds_rectangle)

 save(stream, options_base, bounds_rectangle) 

Saves the image’s data to the specified stream in the specified file format according to save options.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to save the image’s data to.
options_base	ImageOptionsBase	The save options.
bounds_rectangle	Rectangle	The destination image bounds rectangle. Set the empty rectangle for use source bounds.

Method: save_argb_32_pixels(rectangle, pixels)

 save_argb_32_pixels(rectangle, pixels) 

Saves the 32-bit ARGB pixels.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to save pixels to.
pixels	int	The 32-bit ARGB pixels array.

Method: save_pixels(rectangle, pixels)

 save_pixels(rectangle, pixels) 

Saves pixels (format specific method).

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to save pixels to.
pixels	Color[]	The 32-bit ARGB pixels array.

Method: save_raw_data(data, data_offset, rectangle, raw_data_settings)

 save_raw_data(data, data_offset, rectangle, raw_data_settings) 

Saves the raw data.

Parameters:

Parameter	Type	Description
data	byte	The raw data.
data_offset	int	The starting raw data offset.
rectangle	Rectangle	The raw data rectangle.
raw_data_settings	RawDataSettings	The raw data settings the data is in.

Method: set_argb_32_pixel(x, y, argb_32_color)

 set_argb_32_pixel(x, y, argb_32_color) 

Sets an image 32-bit ARGB pixel for the specified position.

Parameters:

Parameter	Type	Description
x	int	The pixel x location.
y	int	The pixel y location.
argb_32_color	int	The 32-bit ARGB pixel for the specified position.

Method: set_palette(palette, update_colors)

 set_palette(palette, update_colors) 

Sets the image palette.

Parameters:

Parameter	Type	Description
palette	IColorPalette	The palette to set.
update_colors	bool	if set to true colors will be updated according to the new palette; otherwise color indexes remain unchanged. Note that unchanged indexes may crash the image on loading if some indexes have no corresponding palette entries.

Method: set_pixel(x, y, color)

 set_pixel(x, y, color) 

Sets an image pixel for the specified position.

Parameters:

Parameter	Type	Description
x	int	The pixel x location.
y	int	The pixel y location.
color	Color	The pixel color for the specified position.

Method: set_resolution(dpi_x, dpi_y)

 set_resolution(dpi_x, dpi_y) 

Sets the resolution for this PsdImage.

Parameters:

Parameter	Type	Description
dpi_x	double	The horizontal resolution, in dots per inch, of the RasterImage.
dpi_y	double	The vertical resolution, in dots per inch, of the RasterImage.

Method: to_bitmap()

 to_bitmap() 

Returns

Type	Description
aspose.pydrawing.Bitmap

Method: write_argb_32_scan_line(scan_line_index, argb_32_pixels)

 write_argb_32_scan_line(scan_line_index, argb_32_pixels) 

Writes the whole scan line to the specified scan line index.

Parameters:

Parameter	Type	Description
scan_line_index	int	Zero based index of the scan line.
argb_32_pixels	int	The 32-bit ARGB colors array to write.

Method: write_scan_line(scan_line_index, pixels)

 write_scan_line(scan_line_index, pixels) 

Writes the whole scan line to the specified scan line index.

Parameters:

Parameter	Type	Description
scan_line_index	int	Zero based index of the scan line.
pixels	Color[]	The pixel colors array to write.