Package org.apache.sis.image
Class PixelIterator.Builder
Object
Builder
- Enclosing class:
- PixelIterator
Builds pixel iterators for specified region of interest, window size or iteration order.
 By default, the builder creates iterators for all pixels in the given raster or image,
 with unspecified iteration order. Users can invoke setter methods for specifying
 desired behavior for the iterators to create.
 
Example:
 
PixelIterator iterator = new PixelIterator.Builder().setRegionOfInterest(new Rectangle(10, 10, 5, 5).create(image);
- 
Constructor SummaryConstructorsConstructorDescriptionBuilder()Creates a new iterator builder with no region of interest, no window size and default iterator order.
- 
Method SummaryModifier and TypeMethodDescriptionCreates a read-only iterator for the given raster.create(RenderedImage data) Creates a read-only iterator for the given image.createWritable(Raster input, WritableRaster output) Creates an iterator which will read and write in two different rasters.createWritable(RenderedImage input, WritableRenderedImage output) Creates an iterator which will read and write in two different images.Creates a read/write iterator for the given raster.Creates a read/write iterator for the given image.setIteratorOrder(SequenceType order) Sets the desired iteration order.setRegionOfInterest(Rectangle subArea) Sets the region (in pixel coordinates) where to perform the iteration.setWindowSize(Dimension window) Sets the size of the window to use inPixelIterator.createWindow(TransferType)method.
- 
Constructor Details- 
Builderpublic Builder()Creates a new iterator builder with no region of interest, no window size and default iterator order.
 
- 
- 
Method Details- 
setRegionOfInterestSets the region (in pixel coordinates) where to perform the iteration. If this method is not invoked, then by default iterators will traverse all pixels in the image or raster. If a sub-area is specified, then the traversed area is the intersection ofsubAreawith the image or raster bounds.- Parameters:
- subArea- region to intersect, or- nullfor iterating over all image domain.
- Returns:
- thisfor method call chaining.
- Throws:
- IllegalArgumentException- if the given rectangle is empty.
 
- 
setWindowSizeSets the size of the window to use inPixelIterator.createWindow(TransferType)method. By default, iterators do not create windows.- Parameters:
- window- the window size, or- nullif no window will be created.
- Returns:
- thisfor method call chaining.
 
- 
setIteratorOrderSets the desired iteration order. Theorderargument can have the following values:
 Any otherSupported iteration order Value Iteration order nullMost efficient iteration order. SequenceType.LINEARFrom left to right, then from top to bottom. ordervalue will cause anIllegalArgumentExceptionto be thrown. More iteration orders may be supported in future Apache SIS versions.- Parameters:
- order- the desired iteration order, or- nullfor a default order.
- Returns:
- thisfor method call chaining.
 
- 
createCreates a read-only iterator for the given raster.- Parameters:
- data- the raster which contains the sample values on which to iterate.
- Returns:
- a new iterator traversing pixels in the given raster.
 
- 
createCreates a read-only iterator for the given image.- Parameters:
- data- the image which contains the sample values on which to iterate.
- Returns:
- a new iterator traversing pixels in the given image.
 
- 
createWritableCreates a read/write iterator for the given raster.- Parameters:
- data- the raster which contains the sample values on which to iterate.
- Returns:
- a new iterator traversing pixels in the given raster.
 
- 
createWritableCreates a read/write iterator for the given image.- Parameters:
- data- the image which contains the sample values on which to iterate.
- Returns:
- a new iterator traversing pixels in the given image.
 
- 
createWritableCreates an iterator which will read and write in two different rasters. The two rasters must use the same sample model and have the same bounds.- Parameters:
- input- the raster which contains the sample values to read.
- output- the raster where to write the sample values. Can be the same than- input.
- Returns:
- a new writable iterator.
 
- 
createWritableCreates an iterator which will read and write in two different images. The two images must use the same sample model and have the same bounds.- Parameters:
- input- the image which contains the sample values to read.
- output- the image where to write the sample values. Can be the same than- input.
- Returns:
- a new writable iterator.
 
 
-