omero::api::PyramidService
Overview
[ "ami", "amd" ]
interface PyramidService extends StatefulServiceInterface
Derived Classes and Interfaces
- RawPixelsStore
- RenderingEngine
Operation Index
- requiresPixelsPyramid
-
Whether or not this raw pixels store requires a backing
pixels pyramid to provide sub-resolutions of the data.
- getResolutionLevels
-
Retrieves the number of resolution levels that the backing
pixels pyramid contains.
- getResolutionDescriptions
-
Retrieves a more complete definition of the resolution
level in question.
- getResolutionLevel
-
Retrieves the active resolution level.
- setResolutionLevel
-
Sets the active resolution level.
- getTileSize
-
Retrieves the tile size for the pixel store.
Operations
bool requiresPixelsPyramid() throws ServerError
Whether or not this raw pixels store requires a backing
pixels pyramid to provide sub-resolutions of the data.
Return Value
true if the pixels store requires a
pixels pyramid and false otherwise.
int getResolutionLevels() throws ServerError
Retrieves the number of resolution levels that the backing
pixels pyramid contains.
Return Value
The number of resolution levels. This value does not
necessarily indicate either the presence or absence of a
pixels pyramid.
Retrieves a more complete definition of the resolution
level in question. The size of this array will be of
length {@code getResolutionLevels}.
int getResolutionLevel() throws ServerError
Retrieves the active resolution level.
Return Value
The active resolution level.
void setResolutionLevel(int resolutionLevel) throws ServerError
Sets the active resolution level.
Parameters
- resolutionLevel
-
The resolution level to be used by
the pixel buffer.
::Ice::IntSeq getTileSize() throws ServerError
Retrieves the tile size for the pixel store.
Return Value
An array of length = 2 where the first
value of the array is the tile width and the second value is
the tile height.
