Skip to content

Commit

Permalink
Update Javadoc in RawPixelsStore to remove references to romio component
Browse files Browse the repository at this point in the history
  • Loading branch information
melissalinkert committed Jul 5, 2018
1 parent e9c5af5 commit d364ccd
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions components/common/src/ome/api/RawPixelsStore.java
Original file line number Diff line number Diff line change
Expand Up @@ -130,13 +130,34 @@ public interface RawPixelsStore extends StatefulServiceInterface {

public Object getResolutionDescriptions();

/* @see ome.io.nio.PixelBuffer#getResolutionLevels() */
/**
* Retrieves the number of resolution levels that the backing
* pixels pyramid contains.
* @return The number of resolution levels. This value does not
* necessarily indicate either the presence or absence of a
* pixels pyramid.
**/
public int getResolutionLevels();

/* @see ome.io.nio.PixelBuffer#getResolutionLevel() */
/**
* Retrieves the active resolution level.
* @return The active resolution level. The level will be non-negative and less
* than {@link #getResolutionLevels()}. Resolution level 0 is the smallest
* resolution and resolution level <code>getResolutionLevels() - 1</code>
* is the largest resolution. This is the inverse of how Bio-Formats indexes
* resolutions.
*/
public int getResolutionLevel();

/* @see ome.io.nio.PixelBuffer#setResolutionLevel(int) */
/**
* Sets the active resolution level.
* @param resolutionLevel The resolution level to be used.
* The level should be non-negative and less than
* {@link #getResolutionLevels()}. * Resolution level 0 is the smallest
* resolution and resolution level <code>getResolutionLevels() - 1</code>
* is the largest resolution. This is the inverse of how Bio-Formats indexes
* resolutions.
*/
public void setResolutionLevel(int resolutionLevel);

public int[] getTileSize();
Expand Down

0 comments on commit d364ccd

Please sign in to comment.