pojos
Class PixelsData

java.lang.Object
  extended by pojos.DataObject
      extended by pojos.PixelsData

public class PixelsData
extends DataObject

The data that makes up an OME Pixels object along with a back pointer to the Image that owns this Pixels. A Pixels object represents a 5D raw data array that stores the Image pixels.

Since:
OME2.2
Version:
2.2 (Internal version: $Revision$ $Date: 2005/05/09 19:50:41 $)
Author:
Jean-Marie Burel      j.burel@dundee.ac.uk,
Andrea Falconi      a.falconi@dundee.ac.uk

Field Summary
static String COMPLEX_TYPE
          Identifies the type used to store pixel values.
static String DOUBLE_COMPLEX_TYPE
          Identifies the type used to store pixel values.
static String DOUBLE_TYPE
          Identifies the type used to store pixel values.
static String FLOAT_TYPE
          Identifies the type used to store pixel values.
static String IMAGE
          Identifies the Pixels#IMAGE field.
static String INT16_TYPE
          Identifies the type used to store pixel values.
static String INT32_TYPE
          Identifies the type used to store pixel values.
static String INT8_TYPE
          Identifies the type used to store pixel values.
static String UINT16_TYPE
          Identifies the type used to store pixel values.
static String UINT32_TYPE
          Identifies the type used to store pixel values.
static String UINT8_TYPE
          Identifies the type used to store pixel values.
 
Constructor Summary
PixelsData()
          Creates a new instance.
PixelsData(omero.model.Pixels pixels)
          Creates a new instance.
 
Method Summary
 ImageData getImage()
          Returns the image linked to this pixels' set.
 double getPixelSizeX()
          Returns the dimension of a pixel along the X-axis, dimension is in microns.
 double getPixelSizeY()
          Returns the dimension of a pixel along the Y-axis, dimension is in microns.
 double getPixelSizeZ()
          Returns the dimension of a pixel along the Z-axis, dimension is in microns.
 String getPixelType()
          Returns the pixels type.
 int getSizeC()
          Returns the number of channels.
 int getSizeT()
          Returns the number of time-points.
 int getSizeX()
          Returns the number of pixels along the X-axis.
 int getSizeY()
          Returns the number of pixels along the Y-axis.
 int getSizeZ()
          Returns the number of pixels along the Z-axis.
 void setImage(ImageData image)
          Sets the image linked to this pixels' set.
 void setPixelSizeX(double pixelSizeX)
          Sets the dimension of a pixel along the X-axis, dimension is in microns.
 void setPixelSizeY(double pixelSizeY)
          Sets the dimension of a pixel along the Y-axis, dimension is in microns.
 void setPixelSizeZ(double pixelSizeZ)
          Sets the dimension of a pixel along the Z-axis, dimension is in microns.
 void setSizeC(int sizeC)
          Sets the number of channels.
 void setSizeT(int sizeT)
          Sets the number of time-points.
 void setSizeX(int sizeX)
          Sets the number of pixels along the X-axis.
 void setSizeY(int sizeY)
          Sets the number of pixels along the Y-axis.
 void setSizeZ(int sizeZ)
          Sets the number of pixels along the Z-axis.
 
Methods inherited from class pojos.DataObject
asAnnotation, asChannel, asDataset, asExperimenter, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, getCreated, getDetails, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, setDirty, setId, setValue, setVersion, timeOfEvent, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

IMAGE

public static final String IMAGE
Identifies the Pixels#IMAGE field.

See Also:
Constant Field Values

INT8_TYPE

public static final String INT8_TYPE
Identifies the type used to store pixel values. Maps onto the OME int8 string identifier.

See Also:
Constant Field Values

INT16_TYPE

public static final String INT16_TYPE
Identifies the type used to store pixel values. Maps onto the OME int16 string identifier.

See Also:
Constant Field Values

INT32_TYPE

public static final String INT32_TYPE
Identifies the type used to store pixel values. Maps onto the OME "int32 string identifier.

See Also:
Constant Field Values

UINT8_TYPE

public static final String UINT8_TYPE
Identifies the type used to store pixel values. Maps onto the OME uint8 string identifier.

See Also:
Constant Field Values

UINT16_TYPE

public static final String UINT16_TYPE
Identifies the type used to store pixel values. Maps onto the OME uint16 string identifier.

See Also:
Constant Field Values

UINT32_TYPE

public static final String UINT32_TYPE
Identifies the type used to store pixel values. Maps onto the OME uint32 string identifier.

See Also:
Constant Field Values

FLOAT_TYPE

public static final String FLOAT_TYPE
Identifies the type used to store pixel values. Maps onto the OME double string identifier.

See Also:
Constant Field Values

DOUBLE_TYPE

public static final String DOUBLE_TYPE
Identifies the type used to store pixel values. Maps onto the OME double string identifier.

See Also:
Constant Field Values

COMPLEX_TYPE

public static final String COMPLEX_TYPE
Identifies the type used to store pixel values. Maps onto the OME complex string identifier.

See Also:
Constant Field Values

DOUBLE_COMPLEX_TYPE

public static final String DOUBLE_COMPLEX_TYPE
Identifies the type used to store pixel values. Maps onto the OME double-complex string identifier.

See Also:
Constant Field Values
Constructor Detail

PixelsData

public PixelsData()
Creates a new instance.


PixelsData

public PixelsData(omero.model.Pixels pixels)
Creates a new instance.

Parameters:
pixels - Back pointer to the Pixels model object. Mustn't be null.
Throws:
IllegalArgumentException - If the object is null.
Method Detail

setSizeX

public void setSizeX(int sizeX)
Sets the number of pixels along the X-axis.

Parameters:
sizeX - The number of pixels along the X-axis.

getSizeX

public int getSizeX()
Returns the number of pixels along the X-axis.

Returns:
See above.

setSizeY

public void setSizeY(int sizeY)
Sets the number of pixels along the Y-axis.

Parameters:
sizeY - The number of pixels along the Y-axis.

getSizeY

public int getSizeY()
Returns the number of pixels along the Y-axis.

Returns:
See above.

setSizeZ

public void setSizeZ(int sizeZ)
Sets the number of pixels along the Z-axis.

Parameters:
sizeZ - The number of pixels along the Z-axis.

getSizeZ

public int getSizeZ()
Returns the number of pixels along the Z-axis.

Returns:
See above.

setSizeC

public void setSizeC(int sizeC)
Sets the number of channels.

Parameters:
sizeC - The number of channels.

getSizeC

public int getSizeC()
Returns the number of channels.

Returns:
See above.

setSizeT

public void setSizeT(int sizeT)
Sets the number of time-points.

Parameters:
sizeT - The number of time-points.

getSizeT

public int getSizeT()
Returns the number of time-points.

Returns:
See above.

setPixelSizeX

public void setPixelSizeX(double pixelSizeX)
Sets the dimension of a pixel along the X-axis, dimension is in microns.

Parameters:
pixelSizeX - The dimension of a pixel along the X-axis.

getPixelSizeX

public double getPixelSizeX()
Returns the dimension of a pixel along the X-axis, dimension is in microns.

Returns:
See above.

setPixelSizeY

public void setPixelSizeY(double pixelSizeY)
Sets the dimension of a pixel along the Y-axis, dimension is in microns.

Parameters:
pixelSizeY - The dimension of a pixel along the Y-axis.

getPixelSizeY

public double getPixelSizeY()
Returns the dimension of a pixel along the Y-axis, dimension is in microns.

Returns:
See above.

setPixelSizeZ

public void setPixelSizeZ(double pixelSizeZ)
Sets the dimension of a pixel along the Z-axis, dimension is in microns.

Parameters:
pixelSizeZ - The dimension of a pixel along the Z-axis.

getPixelSizeZ

public double getPixelSizeZ()
Returns the dimension of a pixel along the Z-axis, dimension is in microns.

Returns:
See above.

getPixelType

public String getPixelType()
Returns the pixels type.

Returns:
See above.

getImage

public ImageData getImage()
Returns the image linked to this pixels' set.

Returns:
See above.

setImage

public void setImage(ImageData image)
Sets the image linked to this pixels' set.

Parameters:
image - The linked image.


OmeroJava Api

Version: 4.3.3-00d1137e-b2894

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