MultiPixelPackedSampleModel class represents
one-banded images and can pack multiple one-sample
pixels into one data element. Pixels are not allowed to span data elements.
The data type can be DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT,
or DataBuffer.TYPE_INT. Each pixel must be a power of 2 number of bits
and a power of 2 number of pixels must fit exactly in one data element.
Pixel bit stride is equal to the number of bits per pixel. Scanline
stride is in data elements and the last several data elements might be
padded with unused pixels. Data bit offset is the offset in bits from
the beginning of the DataBuffer
to the first pixel and must be
a multiple of pixel bit stride.
The following code illustrates extracting the bits for pixel
x, y from DataBuffer data
and storing the pixel data in data elements of type
dataType:
int dataElementSize = DataBuffer.getDataTypeSize(dataType);
int bitnum = dataBitOffset + x*pixelBitStride;
int element = data.getElem(y*scanlineStride + bitnum/dataElementSize);
int shift = dataElementSize - (bitnum & (dataElementSize-1))
- pixelBitStride;
int pixel = (element >> shift) & ((1 << pixelBitStride) - 1);
MultiPixelPackedSampleModel with the
specified data type, width, height and number of bits per pixel.MultiPixelPackedSampleModel with
specified data type, width, height, number of bits per pixel,
scanline stride and data bit offset.MultiPixelPackedSampleModel with the
specified width and height. The new
MultiPixelPackedSampleModel has the
same storage data type and number of bits per pixel as this
MultiPixelPackedSampleModel.DataBuffer that corresponds to this
MultiPixelPackedSampleModel. The
DataBuffer object's data type and size
is consistent with this MultiPixelPackedSampleModel.
The DataBuffer has a single bank.MultiPixelPackedSampleModel with a
subset of the bands of this
MultiPixelPackedSampleModel. Since a
MultiPixelPackedSampleModel only has one band, the
bands argument must have a length of one and indicate the zeroth
band.xth pixel of a scanline.
This offset is the same for all scanlines.
The following code illustrates transferring data for a rectangular
region of pixels from
DataBuffer db1, whose storage layout is described by
SampleModel sm1, to DataBuffer db2, whose
storage layout is described by SampleModel sm2.
The transfer will generally be more efficient than using
getPixels/setPixels.
SampleModel sm1, sm2;
DataBuffer db1, db2;
sm2.setDataElements(x, y, w, h, sm1.getDataElements(x, y, w,
h, null, db1), db2);
Using getDataElements/setDataElements to transfer between two
DataBuffer/SampleModel pairs is legitimate if the SampleModels have
the same number of bands, corresponding bands have the same number of
bits per sample, and the TransferTypes are the same.
If obj is non-null, it should be a primitive array of type TransferType. Otherwise, a ClassCastException is thrown. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds, or if obj is non-null and is not large enough to hold the pixel data.
MultiPixelPackedSampleModel,
the array has one element, and the type is the smallest of
DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, or DataBuffer.TYPE_INT
that can hold a single pixel. Generally, obj
should be passed in as null, so that the
Object is created automatically and is the
correct primitive data type.
The following code illustrates transferring data for one pixel from
DataBuffer db1, whose storage layout is
described by MultiPixelPackedSampleModel
mppsm1, to DataBuffer db2,
whose storage layout is described by
MultiPixelPackedSampleModel mppsm2.
The transfer is generally more efficient than using
getPixel or setPixel.
MultiPixelPackedSampleModel mppsm1, mppsm2;
DataBufferInt db1, db2;
mppsm2.setDataElements(x, y, mppsm1.getDataElements(x, y, null,
db1), db2);
Using getDataElements or setDataElements
to transfer between two DataBuffer/SampleModel pairs
is legitimate if the SampleModels have the same number
of bands, corresponding bands have the same number of
bits per sample, and the TransferTypes are the same.
If obj is not null, it should be a
primitive array of type TransferType. Otherwise, a
ClassCastException is thrown. An
ArrayIndexOutOfBoundsException is thrown if the
coordinates are not in bounds, or if obj is not
null and is not large enough to hold the pixel data.
MultiPixelPackedSampleModel, this is
one.int array.
ArrayIndexOutOfBoundsException is thrown if the
coordinates are not in bounds.int the sample in a specified band for the
pixel located at (x, y). An
ArrayIndexOutOfBoundsException is thrown if the
coordinates are not in bounds.getDataElements and setDataElements
methods. The TransferType might or might not be the same as the
storage DataType. The TransferType is one of
DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT,
or DataBuffer.TYPE_INT.wait methods.
The awakened thread will not be able to proceed until the current thread relinquishes the lock on this object. The awakened thread will compete in the usual manner with any other threads that might be actively competing to synchronize on this object; for example, the awakened thread enjoys no reliable privilege or disadvantage in being the next thread to lock this object.
This method should only be called by a thread that is the owner of this object's monitor. A thread becomes the owner of the object's monitor in one of three ways:
synchronized statement
that synchronizes on the object.
Class, by executing a
synchronized static method of that class.
Only one thread at a time can own an object's monitor.
wait methods.
The awakened threads will not be able to proceed until the current thread relinquishes the lock on this object. The awakened threads will compete in the usual manner with any other threads that might be actively competing to synchronize on this object; for example, the awakened threads enjoy no reliable privilege or disadvantage in being the next thread to lock this object.
This method should only be called by a thread that is the owner
of this object's monitor. See the notify method for a
description of the ways in which a thread can become the owner of
a monitor.
The following code illustrates transferring data for a rectangular
region of pixels from
DataBuffer db1, whose storage layout is described by
SampleModel sm1, to DataBuffer db2, whose
storage layout is described by SampleModel sm2.
The transfer will generally be more efficient than using
getPixels/setPixels.
SampleModel sm1, sm2;
DataBuffer db1, db2;
sm2.setDataElements(x, y, w, h, sm1.getDataElements(x, y, w, h,
null, db1), db2);
Using getDataElements/setDataElements to transfer between two
DataBuffer/SampleModel pairs is legitimate if the SampleModels have
the same number of bands, corresponding bands have the same number of
bits per sample, and the TransferTypes are the same.
obj must be a primitive array of type TransferType. Otherwise, a ClassCastException is thrown. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds, or if obj is not large enough to hold the pixel data.
DataBuffer from a primitive array of type
TransferType. For a MultiPixelPackedSampleModel,
only the first element of the array holds valid data,
and the type must be the smallest of
DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, or DataBuffer.TYPE_INT
that can hold a single pixel.
The following code illustrates transferring data for one pixel from
DataBuffer db1, whose storage layout is
described by MultiPixelPackedSampleModel
mppsm1, to DataBuffer db2,
whose storage layout is described by
MultiPixelPackedSampleModel mppsm2.
The transfer is generally more efficient than using
getPixel or setPixel.
MultiPixelPackedSampleModel mppsm1, mppsm2;
DataBufferInt db1, db2;
mppsm2.setDataElements(x, y, mppsm1.getDataElements(x, y, null,
db1), db2);
Using getDataElements or setDataElements to
transfer between two DataBuffer/SampleModel pairs is
legitimate if the SampleModel objects have
the same number of bands, corresponding bands have the same number of
bits per sample, and the TransferTypes are the same.
obj must be a primitive array of type TransferType.
Otherwise, a ClassCastException is thrown. An
ArrayIndexOutOfBoundsException is thrown if the
coordinates are not in bounds, or if obj is not large
enough to hold the pixel data.
DataBuffer using an
int array for input.
ArrayIndexOutOfBoundsException is thrown if
the coordinates are not in bounds.DataBuffer using an
int for input.
An ArrayIndexOutOfBoundsException is thrown if the
coordinates are not in bounds.toString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
The current thread must own this object's monitor. The thread
releases ownership of this monitor and waits until another thread
notifies threads waiting on this object's monitor to wake up
either through a call to the notify method or the
notifyAll method. The thread then waits until it can
re-obtain ownership of the monitor and resumes execution.
As in the one argument version, interrupts and spurious wakeups are possible, and this method should always be used in a loop:
synchronized (obj) {
while (<condition does not hold>)
obj.wait();
... // Perform action appropriate to condition
}
This method should only be called by a thread that is the owner
of this object's monitor. See the notify method for a
description of the ways in which a thread can become the owner of
a monitor.The current thread must own this object's monitor.
This method causes the current thread (call it T) to place itself in the wait set for this object and then to relinquish any and all synchronization claims on this object. Thread T becomes disabled for thread scheduling purposes and lies dormant until one of four things happens:
A thread can also wake up without being notified, interrupted, or timing out, a so-called spurious wakeup. While this will rarely occur in practice, applications must guard against it by testing for the condition that should have caused the thread to be awakened, and continuing to wait if the condition is not satisfied. In other words, waits should always occur in loops, like this one:
synchronized (obj) {
while (<condition does not hold>)
obj.wait(timeout);
... // Perform action appropriate to condition
}
(For more information on this topic, see Section 3.2.3 in Doug Lea's
"Concurrent Programming in Java (Second Edition)" (Addison-Wesley,
2000), or Item 50 in Joshua Bloch's "Effective Java Programming
Language Guide" (Addison-Wesley, 2001).
If the current thread is interrupted by another thread while it is waiting, then an InterruptedException is thrown. This exception is not thrown until the lock status of this object has been restored as described above.
Note that the wait method, as it places the current thread into the wait set for this object, unlocks only this object; any other objects on which the current thread may be synchronized remain locked while the thread waits.
This method should only be called by a thread that is the owner
of this object's monitor. See the notify method for a
description of the ways in which a thread can become the owner of
a monitor.
This method is similar to the wait method of one
argument, but it allows finer control over the amount of time to
wait for a notification before giving up. The amount of real time,
measured in nanoseconds, is given by:
1000000*timeout+nanos
In all other respects, this method does the same thing as the method of one argument. In particular, wait(0, 0) means the same thing as wait(0).
The current thread must own this object's monitor. The thread releases ownership of this monitor and waits until either of the following two conditions has occurred:
notify method
or the notifyAll method.
timeout
milliseconds plus nanos nanoseconds arguments, has
elapsed.
The thread then waits until it can re-obtain ownership of the monitor and resumes execution.
As in the one argument version, interrupts and spurious wakeups are possible, and this method should always be used in a loop:
synchronized (obj) {
while (<condition does not hold>)
obj.wait(timeout, nanos);
... // Perform action appropriate to condition
}
This method should only be called by a thread that is the owner
of this object's monitor. See the notify method for a
description of the ways in which a thread can become the owner of
a monitor.