ome.api
Interface RawPixelsStore

All Superinterfaces:
ServiceInterface, StatefulServiceInterface
All Known Implementing Classes:
RawPixelsBean

public interface RawPixelsStore
extends StatefulServiceInterface

Binary data provider. Initialized with the id of a Pixels instance, this interface can provide various slices, stacks, regions of the 5-dimensional (X-Y planes with multiple Z-sections and Channels over Time). The byte array returned by the getter methods and passed to the setter methods can and will be interpreted according to results of getByteWidth(), isFloat(), and isSigned().


Method Summary
 byte[] calculateMessageDigest()
           
 int getByteWidth()
           
 byte[] getCol(int x, int z, int c, int t)
           
 long getPixelsId()
          Returns the current Pixels set identifier.
 byte[] getPlane(int z, int c, int t)
           
 long getPlaneOffset(int z, int c, int t)
           
 byte[] getPlaneRegion(int z, int c, int t, int count, int offset)
           
 int getPlaneSize()
          delegates to PixelBuffer
 byte[] getRegion(int size, long offset)
           
 byte[] getRow(int y, int z, int c, int t)
           
 long getRowOffset(int y, int z, int c, int t)
           
 int getRowSize()
           
 byte[] getStack(int c, int t)
           
 long getStackOffset(int c, int t)
           
 int getStackSize()
           
 byte[] getTimepoint(int t)
           
 long getTimepointOffset(int t)
           
 int getTimepointSize()
           
 int getTotalSize()
           
 boolean isFloat()
           
 boolean isSigned()
           
 void prepare(Set<Long> pixelsIds)
          Prepares the stateful service with a cache of loaded Pixels objects.
 void setPixelsId(long pixelsId, boolean bypassOriginalFile)
          Initializes the stateful service for a given Pixels set.
 void setPlane(byte[] buffer, int z, int c, int t)
           
 void setRegion(int size, long offset, byte[] buffer)
           
 void setRow(byte[] buffer, int y, int z, int c, int t)
           
 void setStack(byte[] buffer, int z, int c, int t)
           
 void setTimepoint(byte[] buffer, int t)
           
 
Methods inherited from interface ome.api.StatefulServiceInterface
activate, close, getCurrentEventContext, passivate
 

Method Detail

setPixelsId

void setPixelsId(long pixelsId,
                 boolean bypassOriginalFile)
Initializes the stateful service for a given Pixels set.

Parameters:
pixelsId - Pixels set identifier.
bypassOriginalFile - Whether or not to bypass checking for an original file to back the pixel buffer used by this service. If requests are predominantly write-only or involve the population of a brand new pixel buffer using true here is a safe optimization otherwise false is expected.

getPixelsId

long getPixelsId()
Returns the current Pixels set identifier.

Returns:
See above.

prepare

void prepare(Set<Long> pixelsIds)
Prepares the stateful service with a cache of loaded Pixels objects. This method is designed to combat query overhead, where many sets of Pixels are to be read from or written to, by loading all the Pixels sets at once. Multiple calls will result in the existing cache being overwritten.

Parameters:
pixelsIds - Pixels IDs to cache.

getPlaneSize

int getPlaneSize()
delegates to PixelBuffer

Parameters:
pixelsId -
Returns:
See Also:
PixelBuffer.getPlaneSize()

getRowSize

int getRowSize()

getStackSize

int getStackSize()

getTimepointSize

int getTimepointSize()

getTotalSize

int getTotalSize()

getRowOffset

long getRowOffset(int y,
                  int z,
                  int c,
                  int t)

getPlaneOffset

long getPlaneOffset(int z,
                    int c,
                    int t)

getStackOffset

long getStackOffset(int c,
                    int t)

getTimepointOffset

long getTimepointOffset(int t)

getRegion

byte[] getRegion(int size,
                 long offset)

getRow

byte[] getRow(int y,
              int z,
              int c,
              int t)

getCol

byte[] getCol(int x,
              int z,
              int c,
              int t)

getPlaneRegion

byte[] getPlaneRegion(int z,
                      int c,
                      int t,
                      int count,
                      int offset)

getPlane

byte[] getPlane(int z,
                int c,
                int t)

getStack

byte[] getStack(int c,
                int t)

getTimepoint

byte[] getTimepoint(int t)

setRegion

void setRegion(int size,
               long offset,
               byte[] buffer)

setRow

void setRow(byte[] buffer,
            int y,
            int z,
            int c,
            int t)

setPlane

void setPlane(byte[] buffer,
              int z,
              int c,
              int t)

setStack

void setStack(byte[] buffer,
              int z,
              int c,
              int t)

setTimepoint

void setTimepoint(byte[] buffer,
                  int t)

getByteWidth

int getByteWidth()

isSigned

boolean isSigned()

isFloat

boolean isFloat()

calculateMessageDigest

byte[] calculateMessageDigest()


OmeroJava Api

Version: Beta-4.2.0-r7571-b29

Copyright © 2009 The University of Dundee. All Rights Reserved.