Class RescaleOp
- All Implemented Interfaces:
-
BufferedImageOp
,RasterOp
public class RescaleOp extends Object implements BufferedImageOp, RasterOp
The pseudo code for the rescaling operation is as follows:
for each pixel from Source object { for each band/component of the pixel { dstElement = (srcElement*scaleFactor) + offset } }
For Rasters, rescaling operates on bands. The number of sets of scaling constants may be one, in which case the same constants are applied to all bands, or it must equal the number of Source Raster bands.
For BufferedImages, rescaling operates on color and alpha components. The number of sets of scaling constants may be one, in which case the same constants are applied to all color (but not alpha) components. Otherwise, the number of sets of scaling constants may equal the number of Source color components, in which case no rescaling of the alpha component (if present) is performed. If neither of these cases apply, the number of sets of scaling constants must equal the number of Source color components plus alpha components, in which case all color and alpha components are rescaled.
BufferedImage sources with premultiplied alpha data are treated in the same manner as non-premultiplied images for purposes of rescaling. That is, the rescaling is done per band on the raw data of the BufferedImage source without regard to whether the data is premultiplied. If a color conversion is required to the destination ColorModel, the premultiplied state of both source and destination will be taken into account for this step.
Images with an IndexColorModel cannot be rescaled.
If a RenderingHints object is specified in the constructor, the color rendering hint and the dithering hint may be used when color conversion is required.
Note that in-place operation is allowed (i.e. the source and destination can be the same object).
Constructor Summary
Constructor | Description |
---|---|
RescaleOp |
Constructs a new RescaleOp with the desired scale factors and offsets. |
RescaleOp |
Constructs a new RescaleOp with the desired scale factor and offset. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
BufferedImage |
createCompatibleDestImage |
Creates a zeroed destination image with the correct size and number of bands. |
WritableRaster |
createCompatibleDestRaster |
Creates a zeroed-destination Raster with the correct size and number of bands, given this source. |
final BufferedImage |
filter |
Rescales the source BufferedImage. |
final WritableRaster |
filter |
Rescales the pixel data in the source Raster. |
final Rectangle2D |
getBounds2D |
Returns the bounding box of the rescaled destination image. |
final Rectangle2D |
getBounds2D |
Returns the bounding box of the rescaled destination Raster. |
final int |
getNumFactors() |
Returns the number of scaling factors and offsets used in this RescaleOp. |
final float[] |
getOffsets |
Returns the offsets in the given array. |
final Point2D |
getPoint2D |
Returns the location of the destination point given a point in the source. |
final RenderingHints |
getRenderingHints() |
Returns the rendering hints for this op. |
final float[] |
getScaleFactors |
Returns the scale factors in the given array. |
Constructor Details
RescaleOp
public RescaleOp(float[] scaleFactors, float[] offsets, RenderingHints hints)
- Parameters:
-
scaleFactors
- the specified scale factors -
offsets
- the specified offsets -
hints
- the specifiedRenderingHints
, ornull
RescaleOp
public RescaleOp(float scaleFactor, float offset, RenderingHints hints)
- Parameters:
-
scaleFactor
- the specified scale factor -
offset
- the specified offset -
hints
- the specifiedRenderingHints
, ornull
Method Details
getScaleFactors
public final float[] getScaleFactors(float[] scaleFactors)
- Parameters:
-
scaleFactors
- the array to contain the scale factors of thisRescaleOp
- Returns:
- the scale factors of this
RescaleOp
.
getOffsets
public final float[] getOffsets(float[] offsets)
- Parameters:
-
offsets
- the array to contain the offsets of thisRescaleOp
- Returns:
- the offsets of this
RescaleOp
.
getNumFactors
public final int getNumFactors()
- Returns:
- the number of scaling factors and offsets of this
RescaleOp
.
filter
public final BufferedImage filter(BufferedImage src, BufferedImage dst)
- Specified by:
-
filter
in interfaceBufferedImageOp
- Parameters:
-
src
- theBufferedImage
to be filtered -
dst
- the destination for the filtering operation ornull
- Returns:
- the filtered
BufferedImage
. - Throws:
-
IllegalArgumentException
- if theColorModel
ofsrc
is anIndexColorModel
, or if the number of scaling factors and offsets in thisRescaleOp
do not meet the requirements stated in the class comments, or if the source and destination images differ in size.
filter
public final WritableRaster filter(Raster src, WritableRaster dst)
- Specified by:
-
filter
in interfaceRasterOp
- Parameters:
-
src
- theRaster
to be filtered -
dst
- the destination for the filtering operation ornull
- Returns:
- the filtered
WritableRaster
. - Throws:
-
IllegalArgumentException
- ifsrc
anddst
do not have the same number of bands, or if the number of scaling factors and offsets in thisRescaleOp
do not meet the requirements stated in the class comments, or if the source and destination rasters differ in size.
getBounds2D
public final Rectangle2D getBounds2D(BufferedImage src)
- Specified by:
-
getBounds2D
in interfaceBufferedImageOp
- Parameters:
-
src
- TheBufferedImage
to be filtered - Returns:
- The
Rectangle2D
representing the destination image's bounding box.
getBounds2D
public final Rectangle2D getBounds2D(Raster src)
- Specified by:
-
getBounds2D
in interfaceRasterOp
- Parameters:
-
src
- the rescaled destinationRaster
- Returns:
- the bounds of the specified
Raster
.
createCompatibleDestImage
public BufferedImage createCompatibleDestImage(BufferedImage src, ColorModel destCM)
- Specified by:
-
createCompatibleDestImage
in interfaceBufferedImageOp
- Parameters:
-
src
- Source image for the filter operation. -
destCM
- ColorModel of the destination. If null, the ColorModel of the source will be used. - Returns:
- the zeroed-destination image.
createCompatibleDestRaster
public WritableRaster createCompatibleDestRaster(Raster src)
Raster
with the correct size and number of bands, given this source.- Specified by:
-
createCompatibleDestRaster
in interfaceRasterOp
- Parameters:
-
src
- the sourceRaster
- Returns:
- the zeroed-destination
Raster
.
getPoint2D
public final Point2D getPoint2D(Point2D srcPt, Point2D dstPt)
- Specified by:
-
getPoint2D
in interfaceBufferedImageOp
- Specified by:
-
getPoint2D
in interfaceRasterOp
- Parameters:
-
srcPt
- a point in the source image -
dstPt
- the destination point ornull
- Returns:
- the location of the destination point.
getRenderingHints
public final RenderingHints getRenderingHints()
- Specified by:
-
getRenderingHints
in interfaceBufferedImageOp
- Specified by:
-
getRenderingHints
in interfaceRasterOp
- Returns:
- the rendering hints of this
RescaleOp
.
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/java/awt/image/RescaleOp.html