agi.foundation.graphics.imaging

(agi.foundation.graphics-2024r3.jar)

Class BandOrderFilter

java.lang.Object

agi.foundation.graphics.imaging.RasterFilter

agi.foundation.graphics.imaging.BandOrderFilter

All Implemented Interfaces:

IDisposable, AutoCloseable

public final class BandOrderFilter
extends RasterFilter
implements IDisposable

Reorders or swizzles the bands of the source raster to match the band order of the RasterFormat specified by the BandOrder property. When MaintainRasterFormat is true, the source raster's format is maintained after swizzling.

Constructor Summary

Constructors

Constructor and Description
BandOrderFilter() Initializes a new instance.
BandOrderFilter(RasterFormat bandOrder) Initializes a new instance with a RasterFormat indicating the desired order of the bands in the source raster.
BandOrderFilter(RasterFormat bandOrder, boolean maintainImageFormat) Initializes a new instance with a RasterFormat indicating the desired order of the bands in the source raster, and whether to maintain the source raster's format after swizzling.

Method Summary

Modifier and Type	Method and Description
protected void	dispose(boolean disposing)
protected void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
RasterFormat	getBandOrder() Gets the RasterFormat indicating the desired order of the bands in the source raster.
boolean	getMaintainRasterFormat() Gets a value indicating whether to maintain the source raster's format after the filter is applied.
void	setBandOrder(RasterFormat value) Sets the RasterFormat indicating the desired order of the bands in the source raster.
void	setMaintainRasterFormat(boolean value) Sets a value indicating whether to maintain the source raster's format after the filter is applied.

Methods inherited from class agi.foundation.graphics.imaging.RasterFilter

dispose

Methods inherited from class java.lang.Object

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

Methods inherited from interface agi.foundation.compatibility.IDisposable

close, dispose

Constructor Detail

BandOrderFilter

public BandOrderFilter()

Initializes a new instance.

BandOrderFilter

public BandOrderFilter(RasterFormat bandOrder)

Initializes a new instance with a RasterFormat indicating the desired order of the bands in the source raster.

Parameters:

bandOrder - The RasterFormat indicating the desired order of the bands in the source raster.

BandOrderFilter

public BandOrderFilter(RasterFormat bandOrder,
                       boolean maintainImageFormat)

Initializes a new instance with a RasterFormat indicating the desired order of the bands in the source raster, and whether to maintain the source raster's format after swizzling.

Parameters:

bandOrder - The RasterFormat indicating the desired order of the bands in the source raster.

maintainImageFormat - true to maintain the source raster's format after swizzling; otherwise, false.

Method Detail

finalize

protected void finalize()
                 throws Throwable

Description copied from class: java.lang.Object

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java™ virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Overrides:

finalize in class Object

Throws:

Throwable - the Exception raised by this method

See Also:

WeakReference, PhantomReference

dispose

protected void dispose(boolean disposing)

Overrides:

dispose in class RasterFilter

getBandOrder

public final RasterFormat getBandOrder()

Gets the RasterFormat indicating the desired order of the bands in the source raster.

setBandOrder

public final void setBandOrder(RasterFormat value)

Sets the RasterFormat indicating the desired order of the bands in the source raster.

getMaintainRasterFormat

public final boolean getMaintainRasterFormat()

Gets a value indicating whether to maintain the source raster's format after the filter is applied. When true, the source raster's format is maintained after swizzling.

setMaintainRasterFormat

public final void setMaintainRasterFormat(boolean value)

Sets a value indicating whether to maintain the source raster's format after the filter is applied. When true, the source raster's format is maintained after swizzling.