Java Doc for RectIter.java in  » 6.0-JDK-Modules » Java-Advanced-Imaging » javax » media » jai » iterator » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » Java Advanced Imaging » javax.media.jai.iterator 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.media.jai.iterator.RectIter

All known Subclasses:   com.sun.media.jai.iterator.RectIterFallback,
RectIter
public interface RectIter (Code)
An iterator for traversing a read-only image in top-to-bottom, left-to-right order. This will generally be the fastest style of iterator, since it does not need to perform bounds checks against the top or left edges of tiles.

The iterator is initialized with a particular rectangle as its bounds, which it is illegal to exceed. This initialization takes place in a factory method and is not a part of the iterator interface itself. Once initialized, the iterator may be reset to its initial state by means of the startLine(), startPixels(), and startBands() methods. Its position may be advanced using the nextLine(), jumpLines(), nextPixel(), jumpPixels(), and nextBand() methods.

The iterator's position may be tested against the bounding rectangle by means of the finishedLines(), finishedPixels(), and finishedBands() methods, as well as the hybrid methods nextLineDone(), nextPixelDone(), and nextBandDone().

The getSample(), getSampleFloat(), and getSampleDouble() methods are provided to allow read-only access to the source data. The various source bands may also be accessed in random fashion using the variants that accept a band index. The getPixel() methods allow retrieval of all bands simultaneously.

An instance of RectIter may be obtained by means of the RectIterFactory.create() method, which returns an opaque object implementing this interface.
See Also:   WritableRectIter
See Also:   RectIterFactory





Method Summary
 booleanfinishedBands()
     Returns true if the max band in the image has been exceeded.
 booleanfinishedLines()
     Returns true if the bottom row of the bounding rectangle has been passed.
 booleanfinishedPixels()
     Returns true if the right edge of the bounding rectangle has been passed.
 int[]getPixel(int[] iArray)
     Returns the samples of the current pixel from the image in an array of int.
Parameters:
  iArray - An optionally preallocated int array.
 float[]getPixel(float[] fArray)
     Returns the samples of the current pixel from the image in an array of float.
Parameters:
  fArray - An optionally preallocated float array.
 double[]getPixel(double[] dArray)
     Returns the samples of the current pixel from the image in an array of double.
Parameters:
  dArray - An optionally preallocated double array.
 intgetSample()
     Returns the current sample as an integer.
 intgetSample(int b)
     Returns the specified sample of the current pixel as an integer.
 doublegetSampleDouble()
     Returns the current sample as a double.
 doublegetSampleDouble(int b)
     Returns the specified sample of the current pixel as a double.
 floatgetSampleFloat()
     Returns the current sample as a float.
 floatgetSampleFloat(int b)
     Returns the specified sample of the current pixel as a float.
 voidjumpLines(int num)
     Jumps downward num lines from the current position.
 voidjumpPixels(int num)
     Jumps rightward num pixels from the current position.
 voidnextBand()
     Sets the iterator to the next band in the image.
 booleannextBandDone()
     Sets the iterator to the next band in the image, and returns true if the max band has been exceeded.
 voidnextLine()
     Sets the iterator to the next line of the image.
 booleannextLineDone()
     Sets the iterator to the next line in the image, and returns true if the bottom row of the bounding rectangle has been passed.
 voidnextPixel()
     Sets the iterator to the next pixel in image (that is, move rightward).
 booleannextPixelDone()
     Sets the iterator to the next pixel in the image (that is, move rightward).
 voidstartBands()
     Sets the iterator to the first band of the image.
 voidstartLines()
     Sets the iterator to the first line of its bounding rectangle.
 voidstartPixels()
     Sets the iterator to the leftmost pixel of its bounding rectangle.



Method Detail
finishedBands
boolean finishedBands()(Code)
Returns true if the max band in the image has been exceeded.



finishedLines
boolean finishedLines()(Code)
Returns true if the bottom row of the bounding rectangle has been passed.



finishedPixels
boolean finishedPixels()(Code)
Returns true if the right edge of the bounding rectangle has been passed.



getPixel
int[] getPixel(int[] iArray)(Code)
Returns the samples of the current pixel from the image in an array of int.
Parameters:
  iArray - An optionally preallocated int array. the contents of the pixel as an int array.



getPixel
float[] getPixel(float[] fArray)(Code)
Returns the samples of the current pixel from the image in an array of float.
Parameters:
  fArray - An optionally preallocated float array. the contents of the pixel as a float array.



getPixel
double[] getPixel(double[] dArray)(Code)
Returns the samples of the current pixel from the image in an array of double.
Parameters:
  dArray - An optionally preallocated double array. the contents of the pixel as a double array.



getSample
int getSample()(Code)
Returns the current sample as an integer.



getSample
int getSample(int b)(Code)
Returns the specified sample of the current pixel as an integer.
Parameters:
  b - the band index of the desired sample.



getSampleDouble
double getSampleDouble()(Code)
Returns the current sample as a double.



getSampleDouble
double getSampleDouble(int b)(Code)
Returns the specified sample of the current pixel as a double.
Parameters:
  b - the band index of the desired sample.



getSampleFloat
float getSampleFloat()(Code)
Returns the current sample as a float.



getSampleFloat
float getSampleFloat(int b)(Code)
Returns the specified sample of the current pixel as a float.
Parameters:
  b - the band index of the desired sample.



jumpLines
void jumpLines(int num)(Code)
Jumps downward num lines from the current position. Num may be negative. The pixel and band offsets are unchanged. If the position after the jump is outside of the iterator's bounding box, an IndexOutOfBoundsException will be thrown and the position will be unchanged.
throws:
  IndexOutOfBoundsException - if the position goes outsideof the iterator's bounding box.



jumpPixels
void jumpPixels(int num)(Code)
Jumps rightward num pixels from the current position. Num may be negative. The line and band offsets are unchanged. If the position after the jump is outside of the iterator's bounding box, an IndexOutOfBoundsException will be thrown and the position will be unchanged.
throws:
  IndexOutOfBoundsException - if the position goes outsideof the iterator's bounding box.



nextBand
void nextBand()(Code)
Sets the iterator to the next band in the image. The pixel column and line are unchanged.



nextBandDone
boolean nextBandDone()(Code)
Sets the iterator to the next band in the image, and returns true if the max band has been exceeded. The pixel column and line are unchanged.



nextLine
void nextLine()(Code)
Sets the iterator to the next line of the image. The pixel and band offsets are unchanged. If the iterator passes the bottom line of the rectangles, calls to get() methods are not valid.



nextLineDone
boolean nextLineDone()(Code)
Sets the iterator to the next line in the image, and returns true if the bottom row of the bounding rectangle has been passed.



nextPixel
void nextPixel()(Code)
Sets the iterator to the next pixel in image (that is, move rightward). The line and band offsets are unchanged.

This method may be used in conjunction with the method finishedPixels. Or the method nextPixelDone, which sets the iterator to the next pixel and checks the bound, may be used instead of this method.




nextPixelDone
boolean nextPixelDone()(Code)
Sets the iterator to the next pixel in the image (that is, move rightward). Returns true if the right edge of the bounding rectangle has been passed. The line and band offsets are unchanged.



startBands
void startBands()(Code)
Sets the iterator to the first band of the image. The pixel column and line are unchanged.



startLines
void startLines()(Code)
Sets the iterator to the first line of its bounding rectangle. The pixel and band offsets are unchanged.



startPixels
void startPixels()(Code)
Sets the iterator to the leftmost pixel of its bounding rectangle. The line and band offsets are unchanged.



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.