com.aspose.imaging

Class RasterCachedMultipageImage

java.lang.Object

com.aspose.imaging.DisposableObject

com.aspose.imaging.DataStreamSupporter

com.aspose.imaging.Image

com.aspose.imaging.RasterImage

com.aspose.imaging.RasterCachedImage

com.aspose.imaging.RasterCachedMultipageImage

All Implemented Interfaces:

IMultipageImage, IObjectWithBounds, IRasterImageArgb32PixelLoader, IRasterImageRawDataLoader, com.aspose.internal.IPixelsSaver, com.aspose.internal.progressmanagement.IProgressEventHandler, com.aspose.internal.progressmanagement.IProgressInformer, com.aspose.ms.System.IDisposable, Closeable, AutoCloseable

Direct Known Subclasses:

ApngImage, DicomImage, DjvuImage, GifImage, TiffImage, WebPImage

public abstract class RasterCachedMultipageImage
extends RasterCachedImage
implements IMultipageImage

The raster multipage image

Code example:

The following example shows batch conversion before saving (exporting) Tiff images.

String fileName = "10MB_Tif.tif";
String inputFileName = fileName;

String outputFileNameTif = "output.tif";

//The possibility of batch conversion before saving (exporting) Tiff images is implemented.

try(com.aspose.imaging.fileformats.tiff.TiffImage tiffImage = (com.aspose.imaging.fileformats.tiff.TiffImage) com.aspose.imaging.Image.load(inputFileName))
{
    // Set batch operation for pages
    tiffImage.setPageExportingAction(new PageExportingAction()
    {
        @Override
        public void invoke(int pageIndex, Image page)
        {
            // Fires garbage collection to avoid unnecessary garbage storage from previous pages
            System.gc();

            ((com.aspose.imaging.RasterImage) page).rotate(90);
        }
    });

    tiffImage.save(outputFileNameTif);

    /* Attention! In batch mode all pages will be released in this line!
     If you want to further perform operations on the original image, you should reload it from the source to another instance. */
}

Method Summary

Modifier and Type	Method and Description
void	adjustBrightness(int brightness) Adjust of a brightness for image.
void	adjustContrast(float contrast) Image contrasting
void	adjustGamma(float gamma) Gamma-correction of an image.
void	adjustGamma(float gammaRed, float gammaGreen, float gammaBlue) Gamma-correction of an image.
void	binarizeBradley(double brightnessDifference) Binarization of an image using Bradley's adaptive thresholding algorithm using the integral image thresholding
void	binarizeBradley(double brightnessDifference, int windowSize) Binarization of an image using Bradley's adaptive thresholding algorithm using the integral image thresholding
void	binarizeFixed(byte threshold) Binarization of an image with predefined threshold
void	binarizeOtsu() Binarization of an image with Otsu thresholding
void	cacheData() Caches the data private.
void	crop(int leftShift, int rightShift, int topShift, int bottomShift) Crop image with shifts.
void	crop(Rectangle rectangle) Cropping the image.
void	dither(int ditheringMethod, int bitsCount, IColorPalette customPalette) Performs dithering on the current image.
void	filter(Rectangle rectangle, FilterOptionsBase options) Filters the specified rectangle.
Color	getBackgroundColor() Gets a value for the background color.
int	getBitsPerPixel() Gets the image bits per pixel count.
abstract Image	getDefaultPage() Deprecated. Please use getPages()[index]
int	getHeight() Gets the image height.
float	getImageOpacity() Gets opacity of this image.
abstract int	getPageCount() Gets the page count.
PageExportingAction	getPageExportingAction() Gets the page exporting action.
abstract Image[]	getPages() Gets the pages.
int	getWidth() Gets the image width.
XmpPacketWrapper	getXmpData() Gets XMP data from frame.
void	grayscale() Transformation of an image to its grayscale representation
boolean	hasAlpha() Gets a value indicating whether this instance has alpha.
boolean	hasTransparentColor() Gets a value indicating whether image has transparent color.
boolean	isCached() Gets a value indicating whether image data is cached currently.
void	normalizeAngle(boolean resizeProportionally, Color backgroundColor) Normalizes the angle.
void	replaceColor(int oldColorArgb, byte oldColorDiff, int newColorArgb) Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
void	replaceNonTransparentColors(int newColorArgb) Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges.
void	resize(int newWidth, int newHeight, ImageResizeSettings settings) Resizes the image.
void	resize(int newWidth, int newHeight, int resizeType) Resizes the image.
void	resizeHeightProportionally(int newHeight, int resizeType) Resizes the width proportionally.
void	resizeWidthProportionally(int newWidth, int resizeType) Resizes the width proportionally.
void	rotate(float angle, boolean resizeProportionally, Color backgroundColor) RasterCahcedMultipageImage.Rotate image around the center.
void	rotateFlip(int rotateFlipType) Rotates, flips, or rotates and flips all pages.
void	rotateFlipAll(int rotateFlip) Deprecated. Please use rotateFlip instead of this method.
void	setBackgroundColor(Color value) Sets a value for the background color.
void	setPageExportingAction(PageExportingAction value) Sets the page exporting action.
void	setXmpData(XmpPacketWrapper value) Sets XMP data from frame.

Methods inherited from class com.aspose.imaging.RasterImage

dither, getArgb32Pixel, getDefaultArgb32Pixels, getDefaultPixels, getDefaultRawData, getDefaultRawData, getHorizontalResolution, getModifyDate, getPixel, getPremultiplyComponents, getRawCustomColorConverter, getRawDataFormat, getRawDataSettings, getRawFallbackIndex, getRawIndexedColorConverter, getRawLineSize, getSkewAngle, getTransparentColor, getUpdateXmpData, getUseRawData, getVerticalResolution, isRawDataAvailable, isUsePalette, loadArgb32Pixels, loadArgb64Pixels, loadCmyk32Pixels, loadCmykPixels, loadPartialArgb32Pixels, loadPartialPixels, loadPixels, loadRawData, loadRawData, normalizeAngle, readArgb32ScanLine, readScanLine, replaceColor, replaceNonTransparentColors, rotate, saveArgb32Pixels, saveCmyk32Pixels, saveCmykPixels, savePixels, saveRawData, setArgb32Pixel, setHorizontalResolution, setPalette, setPixel, setPremultiplyComponents, setRawCustomColorConverter, setRawFallbackIndex, setRawIndexedColorConverter, setResolution, setTransparentColor, setTransparentColor, setUpdateXmpData, setUseRawData, setVerticalResolution, toBitmap, writeArgb32ScanLine, writeScanLine

Methods inherited from class com.aspose.imaging.Image

canLoad, canLoad, canLoad, canLoad, canSave, create, create, create, getBounds, getBufferSizeHint, getContainer, getDefaultOptions, getFileFormat, getFileFormat, getFileFormat, getFittingRectangle, getFittingRectangle, getInterruptMonitor, getOriginalOptions, getPalette, getProgressEventHandler, getProgressEventHandlerInfo, getProportionalHeight, getProportionalWidth, getSize, hasBackgroundColor, isAutoAdjustPalette, load, load, load, load, load, load, resize, resizeHeightProportionally, resizeHeightProportionally, resizeWidthProportionally, resizeWidthProportionally, save, save, save, save, save, save, save, save, setAutoAdjustPalette, setBackgroundColor, setBufferSizeHint, setInterruptMonitor, setPalette

Methods inherited from class com.aspose.imaging.DataStreamSupporter

getDataStreamContainer, save, save, save

Methods inherited from class com.aspose.imaging.DisposableObject

close, dispose, getDisposed

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getHeight

public int getHeight()

Gets the image height.

Value: The image height.

Specified by:

getHeight in interface IObjectWithBounds

Specified by:

getHeight in class Image

Returns:

the image height.

getWidth

public int getWidth()

Gets the image width.

Value: The image width.

Specified by:

getWidth in interface IObjectWithBounds

Specified by:

getWidth in class Image

Returns:

the image width.

getBitsPerPixel

public int getBitsPerPixel()

Gets the image bits per pixel count.

Value: The image bits per pixel count. <autogeneratedoc></autogeneratedoc>

Specified by:

getBitsPerPixel in class Image

Returns:

the image bits per pixel count.

isCached

public final boolean isCached()

Gets a value indicating whether image data is cached currently.

Value: true if image data is cached; otherwise, false.

Overrides:

isCached in class RasterCachedImage

Returns:

a value indicating whether image data is cached currently.

getPageCount

public abstract int getPageCount()

Gets the page count.

Value: The page count. <autogeneratedoc></autogeneratedoc>

Specified by:

getPageCount in interface IMultipageImage

Returns:

the page count.

getPages

public abstract Image[] getPages()

Gets the pages.

Value: The pages. <autogeneratedoc></autogeneratedoc>

Specified by:

getPages in interface IMultipageImage

Returns:

the pages.

getDefaultPage

@Deprecated
public abstract Image getDefaultPage()

Deprecated. Please use getPages()[index]

Gets the default page.

Specified by:

getDefaultPage in interface IMultipageImage

Returns:

the default page.

hasAlpha

public boolean hasAlpha()

Gets a value indicating whether this instance has alpha.

Value: true if this instance has alpha; otherwise, false.

Overrides:

hasAlpha in class RasterImage

Returns:

a value indicating whether this instance has alpha.

hasTransparentColor

public boolean hasTransparentColor()

Gets a value indicating whether image has transparent color.

Overrides:

hasTransparentColor in class RasterImage

Returns:

a value indicating whether image has transparent color.

getImageOpacity

public float getImageOpacity()

Gets opacity of this image.

Value: The opacity value between 0.0 (fully transparent) and 1.0 (fully opaque). <autogeneratedoc></autogeneratedoc>

Overrides:

getImageOpacity in class RasterImage

Returns:

opacity of this image.

getBackgroundColor

public Color getBackgroundColor()

Gets a value for the background color.

Overrides:

getBackgroundColor in class Image

Returns:

a value for the background color.

setBackgroundColor

public void setBackgroundColor(Color value)

Sets a value for the background color.

Overrides:

setBackgroundColor in class Image

Parameters:

value - a value for the background color.

getXmpData

public XmpPacketWrapper getXmpData()

Gets XMP data from frame.

Value: XMP packet data wrapper

Overrides:

getXmpData in class RasterImage

Returns:

XMP data from frame.

setXmpData

public void setXmpData(XmpPacketWrapper value)

Sets XMP data from frame.

Value: XMP packet data wrapper

Overrides:

setXmpData in class RasterImage

Parameters:

value - XMP data from frame.

getPageExportingAction

public PageExportingAction getPageExportingAction()

Gets the page exporting action. Please note that setting this method will automatically release page resources after it is executed. It will be executed just before each page is saved.

Value: The page exporting action.

Specified by:

getPageExportingAction in interface IMultipageImage

Returns:

the page exporting action.

setPageExportingAction

public void setPageExportingAction(PageExportingAction value)

Sets the page exporting action. Please note that setting this method will automatically release page resources after it is executed. It will be executed just before each page is saved.

Value: The page exporting action.

Specified by:

setPageExportingAction in interface IMultipageImage

Parameters:

value - the page exporting action.

adjustBrightness

public void adjustBrightness(int brightness)

Adjust of a brightness for image.

Overrides:

adjustBrightness in class RasterCachedImage

Parameters:

brightness - Brightness value.

adjustContrast

public void adjustContrast(float contrast)

Image contrasting

Overrides:

adjustContrast in class RasterCachedImage

Parameters:

contrast - Contrast value (in range [-100; 100])

adjustGamma

public void adjustGamma(float gammaRed,
                        float gammaGreen,
                        float gammaBlue)

Gamma-correction of an image.

Overrides:

adjustGamma in class RasterCachedImage

Parameters:

gammaRed - Gamma for red channel coefficient

gammaGreen - Gamma for green channel coefficient

gammaBlue - Gamma for blue channel coefficient

adjustGamma

public void adjustGamma(float gamma)

Gamma-correction of an image.

Overrides:

adjustGamma in class RasterCachedImage

Parameters:

gamma - Gamma for red, green and blue channels coefficient

binarizeFixed

public void binarizeFixed(byte threshold)

Binarization of an image with predefined threshold

Overrides:

binarizeFixed in class RasterCachedImage

Parameters:

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

binarizeBradley

public void binarizeBradley(double brightnessDifference,
                            int windowSize)

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

Overrides:

binarizeBradley in class RasterCachedImage

Parameters:

brightnessDifference - The brightness difference between pixel and the average of an s x s window of pixels centered around this pixel.

windowSize - The size of s x s window of pixels centered around this pixel

binarizeBradley

public void binarizeBradley(double brightnessDifference)

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

Overrides:

binarizeBradley in class RasterCachedImage

Parameters:

brightnessDifference - The brightness difference between pixel and the average of an s x s window of pixels centered around this pixel.

binarizeOtsu

public void binarizeOtsu()

Binarization of an image with Otsu thresholding

Overrides:

binarizeOtsu in class RasterCachedImage

crop

public void crop(Rectangle rectangle)

Cropping the image.

Overrides:

crop in class RasterCachedImage

Parameters:

rectangle - The rectangle.

crop

public void crop(int leftShift,
                 int rightShift,
                 int topShift,
                 int bottomShift)

Crop image with shifts.

Overrides:

crop in class RasterImage

Parameters:

leftShift - The left shift.

rightShift - The right shift.

topShift - The top shift.

bottomShift - The bottom shift.

Throws:

com.aspose.ms.System.ArgumentException - Rectangle incorrect. - rectangle or Rectangle must be contained in the image bounds. - rectangle

ImageException - Can't crop image. Frame index: " + frameIndex or Can't crop image.

dither

public void dither(int ditheringMethod,
                   int bitsCount,
                   IColorPalette customPalette)

Performs dithering on the current image.

Overrides:

dither in class RasterCachedImage

Parameters:

ditheringMethod - The dithering method.

bitsCount - The final bits count for dithering.

customPalette - The custom palette for dithering.

grayscale

public void grayscale()

Transformation of an image to its grayscale representation

Overrides:

grayscale in class RasterCachedImage

rotate

public void rotate(float angle,
                   boolean resizeProportionally,
                   Color backgroundColor)

RasterCahcedMultipageImage.Rotate image around the center.

Overrides:

rotate in class RasterCachedImage

Parameters:

angle - The rotate angle in degrees. Positive values will rotate clockwise.

resizeProportionally - 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 image contents are rotated.

backgroundColor - Color of the background.

rotateFlip

public void rotateFlip(int rotateFlipType)

Rotates, flips, or rotates and flips all pages.

Overrides:

rotateFlip in class RasterCachedImage

Parameters:

rotateFlipType - The rotate flip type.

See Also:

RotateFlipType

rotateFlipAll

@Deprecated
public void rotateFlipAll(int rotateFlip)

Deprecated. Please use rotateFlip instead of this method.

Rotates the flip all.

Parameters:

rotateFlip - The rotate flip.

resize

public void resize(int newWidth,
                   int newHeight,
                   int resizeType)

Resizes the image.

Overrides:

resize in class RasterCachedImage

Parameters:

newWidth - The new width.

newHeight - The new height.

resizeType - The resize type.

resize

public void resize(int newWidth,
                   int newHeight,
                   ImageResizeSettings settings)

Resizes the image.

Overrides:

resize in class RasterCachedImage

Parameters:

newWidth - The new width.

newHeight - The new height.

settings - The resize settings.

resizeWidthProportionally

public void resizeWidthProportionally(int newWidth,
                                      int resizeType)

Resizes the width proportionally.

Overrides:

resizeWidthProportionally in class Image

Parameters:

newWidth - The new width.

resizeType - Type of the resize.

resizeHeightProportionally

public void resizeHeightProportionally(int newHeight,
                                       int resizeType)

Resizes the width proportionally.

Overrides:

resizeHeightProportionally in class Image

Parameters:

newHeight - The new height.

resizeType - Type of the resize.

replaceColor

public void replaceColor(int oldColorArgb,
                         byte oldColorDiff,
                         int newColorArgb)

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

Overrides:

replaceColor in class RasterImage

Parameters:

oldColorArgb - Old color ARGB value to be replaced.

oldColorDiff - Allowed difference in old color to be able to widen replaced color tone.

newColorArgb - New color ARGB value to replace old color with.

replaceNonTransparentColors

public void replaceNonTransparentColors(int newColorArgb)

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.

Overrides:

replaceNonTransparentColors in class RasterImage

Parameters:

newColorArgb - New color ARGB value to replace non transparent colors with.

filter

public void filter(Rectangle rectangle,
                   FilterOptionsBase options)

Filters the specified rectangle.

Overrides:

filter in class RasterImage

Parameters:

rectangle - The rectangle.

options - The options.

normalizeAngle

public void normalizeAngle(boolean resizeProportionally,
                           Color backgroundColor)

Normalizes the angle. This method is applicable to scanned text documents to get rid of the skewed scan. This method uses RasterImage.getSkewAngle() and RasterImage.rotate(float, boolean, Color) methods.

Overrides:

normalizeAngle in class RasterImage

Parameters:

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

backgroundColor - Color of the background.

cacheData

public void cacheData()

Caches the data private.

Overrides:

cacheData in class RasterCachedImage