ome.services.blitz.gateway.services
Interface ImageService

All Known Implementing Classes:
ImageServiceImpl

public interface ImageService

Since:
OME3.0
Version:
3.0 (Internal version: $Revision: $Date: $)
Author:
Jean-Marie Burel      j.burel@dundee.ac.uk, Donald MacDonald      donald@lifesci.dundee.ac.uk

Method Summary
 Long copyImage(long imageId, int x, int y, int t, int z, List<Integer> channelList, String imageName)
          Copy the image and pixels from image.
 Long copyPixels(long pixelsID, int x, int y, int t, int z, List<Integer> channelList, String methodology)
          Copy the pixels set from pixels to a new set.
 Long copyPixels(long pixelsID, List<Integer> channelList, String methodology)
          Copy the pixels set from pixels to a new set.
 Long createImage(int sizeX, int sizeY, int sizeZ, int sizeT, List<Integer> channelList, omero.model.PixelsType pixelsType, String name, String description)
          Create a new image of specified X,Y, Z, T and channels plus pixelsType with name and description
 omero.model.Image getImage(long imageID)
          Get the image information for an image.
 omero.model.Pixels getPixels(long imageID)
          Get the pixels information for an image.
 byte[] getRawPlane(long pixelsId, int z, int c, int t)
          Get the raw plane from the server with id pixelsId, and channels, c, timepoint t, and z-section z.
 int[] getRenderedImage(long pixelsId, int z, int t)
          Render image as Buffered image.
 int[][][] getRenderedImageMatrix(long pixelsId, int z, int t)
          Render image as 3d matrix.
 byte[] getThumbnail(long pixelsId, omero.RInt sizeX, omero.RInt sizeY)
          Get the thumbnail of the image.
 Map<Long,byte[]> getThumbnailSet(omero.RInt sizeX, omero.RInt sizeY, List<Long> pixelsIds)
          Get a set of thumbnails.
 int[] renderAsPackedIntAsRGBA(long pixelsId, int z, int t)
          Render image as Buffered image.
 void setActive(Long pixelsId, int w, boolean active)
          Set the active channels in the pixels.
 void uploadPlane(long pixelsId, int z, int c, int t, byte[] data)
          Upload the plane to the server, on pixels id with channel and the time, + z section. the data is the client 2d data values.
 

Method Detail

createImage

Long createImage(int sizeX,
                 int sizeY,
                 int sizeZ,
                 int sizeT,
                 List<Integer> channelList,
                 omero.model.PixelsType pixelsType,
                 String name,
                 String description)
                 throws omero.ServerError
Create a new image of specified X,Y, Z, T and channels plus pixelsType with name and description

Parameters:
sizeX -
sizeY -
sizeZ -
sizeT -
channelList -
pixelsType -
name -
description -
Returns:
new image id.
Throws:
DSOutOfServiceException
DSAccessException
omero.ServerError

copyPixels

Long copyPixels(long pixelsID,
                int x,
                int y,
                int t,
                int z,
                List<Integer> channelList,
                String methodology)
                throws omero.ServerError
Copy the pixels set from pixels to a new set.

Parameters:
pixelsID - pixels id to copy.
x - width of plane.
y - height of plane.
t - num timepoints
z - num zsections.
channelList - the list of channels to copy.
methodology - what created the pixels.
Returns:
new id.
Throws:
DSOutOfServiceException
DSAccessException
omero.ServerError

copyPixels

Long copyPixels(long pixelsID,
                List<Integer> channelList,
                String methodology)
                throws omero.ServerError
Copy the pixels set from pixels to a new set.

Parameters:
pixelsID - pixels id to copy.
channelList - the list of channels to copy.
methodology - what created the pixels.
Returns:
new id.
Throws:
DSOutOfServiceException
DSAccessException
omero.ServerError

copyImage

Long copyImage(long imageId,
               int x,
               int y,
               int t,
               int z,
               List<Integer> channelList,
               String imageName)
               throws omero.ServerError
Copy the image and pixels from image.

Parameters:
imageId - image id to copy.
x - width of plane.
y - height of plane.
t - number of timepoints.
z - number of zsections.
channelList - the list of channels to copy.
imageName - The name of the image.
Returns:
new id.
Throws:
DSOutOfServiceException
DSAccessException
omero.ServerError

getRawPlane

byte[] getRawPlane(long pixelsId,
                   int z,
                   int c,
                   int t)
                   throws omero.ServerError
Get the raw plane from the server with id pixelsId, and channels, c, timepoint t, and z-section z. This is the plane as bytes, not converted to doubles.

Parameters:
pixelsId - see above.
c - see above.
t - see above.
z - see above.
Returns:
see above.
Throws:
DSOutOfServiceException
DSAccessException
omero.ServerError

getPixels

omero.model.Pixels getPixels(long imageID)
                             throws omero.ServerError
Get the pixels information for an image.

Parameters:
imageID - image id relating to the pixels.
Returns:
see above.
Throws:
DSOutOfServiceException
DSAccessException
omero.ServerError

getImage

omero.model.Image getImage(long imageID)
                           throws omero.ServerError
Get the image information for an image.

Parameters:
imageID - image id relating to the iamge.
Returns:
see above.
Throws:
DSOutOfServiceException
DSAccessException
omero.ServerError

getRenderedImage

int[] getRenderedImage(long pixelsId,
                       int z,
                       int t)
                       throws omero.ServerError
Render image as Buffered image.

Parameters:
pixelsId - pixels id of the plane to render
z - z section to render
t - timepoint to render
Returns:
packed int
Throws:
DSOutOfServiceException
DSAccessException
omero.ServerError

renderAsPackedIntAsRGBA

int[] renderAsPackedIntAsRGBA(long pixelsId,
                              int z,
                              int t)
                              throws omero.ServerError
Render image as Buffered image.

Parameters:
pixelsId - pixels id of the plane to render
z - z section to render
t - timepoint to render
Returns:
packed int
Throws:
DSOutOfServiceException
DSAccessException
omero.ServerError

getRenderedImageMatrix

int[][][] getRenderedImageMatrix(long pixelsId,
                                 int z,
                                 int t)
                                 throws omero.ServerError
Render image as 3d matrix.

Parameters:
pixelsId - pixels id of the plane to render
z - z section to render
t - timepoint to render
Returns:
packed int
Throws:
DSOutOfServiceException
DSAccessException
omero.ServerError

setActive

void setActive(Long pixelsId,
               int w,
               boolean active)
               throws omero.ServerError
Set the active channels in the pixels.

Parameters:
pixelsId - the pixels id.
w - the channel
active - set active?
Throws:
DSOutOfServiceException
DSAccessException
omero.ServerError

getThumbnail

byte[] getThumbnail(long pixelsId,
                    omero.RInt sizeX,
                    omero.RInt sizeY)
                    throws omero.ServerError
Get the thumbnail of the image.

Parameters:
pixelsId - for pixelsId
sizeX - size of thumbnail.
sizeY - size of thumbnail.
Returns:
see above.
Throws:
DSOutOfServiceException
DSAccessException
omero.ServerError

getThumbnailSet

Map<Long,byte[]> getThumbnailSet(omero.RInt sizeX,
                                 omero.RInt sizeY,
                                 List<Long> pixelsIds)
                                 throws omero.ServerError
Get a set of thumbnails.

Parameters:
sizeX - size of thumbnail.
sizeY - size of thumbnail.
pixelsIds - list of ids.
Returns:
see above.
Throws:
DSOutOfServiceException
DSAccessException
omero.ServerError

uploadPlane

void uploadPlane(long pixelsId,
                 int z,
                 int c,
                 int t,
                 byte[] data)
                 throws omero.ServerError
Upload the plane to the server, on pixels id with channel and the time, + z section. the data is the client 2d data values. This will be converted to the raw server bytes.

Parameters:
pixelsId - pixels id to upload to .
z - z section.
c - channel.
t - time point.
data - plane data.
Throws:
DSOutOfServiceException
DSAccessException
omero.ServerError


OmeroJava Api

Version: 4.3.4-dbcbce5a-b4

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