PixelsData (OMERO API)

java.lang.Object
- omero.gateway.model.DataObject
- - omero.gateway.model.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

Author:

Jean-Marie Burel j.burel@dundee.ac.uk,
Andrea Falconi a.falconi@dundee.ac.uk

Field Summary

Fields
Modifier and Type	Field and Description
`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 `PixelsI.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

Constructors
Constructor and Description

PixelsData()
Creates a new instance.

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

Constructors
Constructor and Description
`PixelsData()` Creates a new instance.
`PixelsData(omero.model.Pixels pixels)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ImageData`	`getImage()` Returns the image linked to this pixels' set.
`double`	`getPixelSizeX()` Deprecated. Replaced by `getPixelSizeX(UnitsLength)`
`omero.model.Length`	`getPixelSizeX(omero.model.enums.UnitsLength unit)` Returns the dimension of a pixel along the X-axis.
`double`	`getPixelSizeY()` Deprecated. Replaced by `getPixelSizeY(UnitsLength)`
`omero.model.Length`	`getPixelSizeY(omero.model.enums.UnitsLength unit)` Returns the dimension of a pixel along the Y-axis.
`double`	`getPixelSizeZ()` Deprecated. Replaced by `getPixelSizeZ(UnitsLength)`
`omero.model.Length`	`getPixelSizeZ(omero.model.enums.UnitsLength unit)` Returns the dimension of a pixel along the Z-axis
`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)` Deprecated. Replaced by `setPixelSizeX(Length)`
`void`	`setPixelSizeX(omero.model.Length pixelSizeX)` Sets the dimension of a pixel along the X-axis
`void`	`setPixelSizeY(double pixelSizeY)` Deprecated. Replaced by `setPixelSizeY(Length)`
`void`	`setPixelSizeY(omero.model.Length pixelSizeY)` Sets the dimension of a pixel along the Y-axis.
`void`	`setPixelSizeZ(double pixelSizeZ)` Deprecated. Replaced by `setPixelSizeZ(Length)`
`void`	`setPixelSizeZ(omero.model.Length pixelSizeZ)` Sets the dimension of a pixel along the Z-axis
`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 omero.gateway.model.DataObject
asAnnotation, asChannel, asDataset, asExperimenter, asFolder, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, canAnnotate, canDelete, canEdit, canLink, getCreated, getDetails, getGroupId, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, 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 PixelsI.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 float 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
```
@Deprecated
public void setPixelSizeX(double pixelSizeX)
```
    Deprecated. Replaced by setPixelSizeX(Length)
    
    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.
  - setPixelSizeX
```
public void setPixelSizeX(omero.model.Length pixelSizeX)
```
    Sets the dimension of a pixel along the X-axis
    
    Parameters:
    
    pixelSizeX - The dimension of a pixel along the X-axis.
  - getPixelSizeX
```
@Deprecated
public double getPixelSizeX()
```
    Deprecated. Replaced by getPixelSizeX(UnitsLength)
    
    Returns the dimension of a pixel along the X-axis, dimension is in microns.
    
    Returns:
    
    See above.
  - getPixelSizeX
```
public omero.model.Length getPixelSizeX(omero.model.enums.UnitsLength unit)
                                 throws BigResult
```
    Returns the dimension of a pixel along the X-axis.
    
    Parameters:
    
    unit - The unit (may be null, in which case no conversion will be performed)
    
    Returns:
    
    See above.
    
    Throws:
    
    BigResult - If an arithmetic under-/overflow occurred
  - setPixelSizeY
```
@Deprecated
public void setPixelSizeY(double pixelSizeY)
```
    Deprecated. Replaced by setPixelSizeY(Length)
    
    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.
  - setPixelSizeY
```
public void setPixelSizeY(omero.model.Length pixelSizeY)
```
    Sets the dimension of a pixel along the Y-axis.
    
    Parameters:
    
    pixelSizeY - The dimension of a pixel along the Y-axis.
  - getPixelSizeY
```
@Deprecated
public double getPixelSizeY()
```
    Deprecated. Replaced by getPixelSizeY(UnitsLength)
    
    Returns the dimension of a pixel along the Y-axis.
    
    Returns:
    
    See above.
  - getPixelSizeY
```
public omero.model.Length getPixelSizeY(omero.model.enums.UnitsLength unit)
                                 throws BigResult
```
    Returns the dimension of a pixel along the Y-axis.
    
    Parameters:
    
    unit - The unit (may be null, in which case no conversion will be performed)
    
    Returns:
    
    See above.
    
    Throws:
    
    BigResult - If an arithmetic under-/overflow occurred
  - setPixelSizeZ
```
@Deprecated
public void setPixelSizeZ(double pixelSizeZ)
```
    Deprecated. Replaced by setPixelSizeZ(Length)
    
    Sets the dimension of a pixel along the Z-axis.
    
    Parameters:
    
    pixelSizeZ - The dimension of a pixel along the Z-axis.
  - setPixelSizeZ
```
public void setPixelSizeZ(omero.model.Length pixelSizeZ)
```
    Sets the dimension of a pixel along the Z-axis
    
    Parameters:
    
    pixelSizeZ - The dimension of a pixel along the Z-axis.
  - getPixelSizeZ
```
@Deprecated
public double getPixelSizeZ()
```
    Deprecated. Replaced by getPixelSizeZ(UnitsLength)
    
    Returns the dimension of a pixel along the Z-axis.
    
    Returns:
    
    See above.
  - getPixelSizeZ
```
public omero.model.Length getPixelSizeZ(omero.model.enums.UnitsLength unit)
                                 throws BigResult
```
    Returns the dimension of a pixel along the Z-axis
    
    Parameters:
    
    unit - The unit (may be null, in which case no conversion will be performed)
    
    Returns:
    
    See above.
    
    Throws:
    
    BigResult - If an arithmetic under-/overflow occurred
  - 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.

Class PixelsData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class omero.gateway.model.DataObject

Methods inherited from class java.lang.Object

Field Detail

IMAGE

INT8_TYPE

INT16_TYPE

INT32_TYPE

UINT8_TYPE

UINT16_TYPE

UINT32_TYPE

FLOAT_TYPE

DOUBLE_TYPE

COMPLEX_TYPE

DOUBLE_COMPLEX_TYPE

Constructor Detail

PixelsData

PixelsData

Method Detail

setSizeX

getSizeX

setSizeY

getSizeY

setSizeZ

getSizeZ

setSizeC

getSizeC

setSizeT

getSizeT

setPixelSizeX

setPixelSizeX

getPixelSizeX

getPixelSizeX

setPixelSizeY

setPixelSizeY

getPixelSizeY

getPixelSizeY

setPixelSizeZ

setPixelSizeZ

getPixelSizeZ

getPixelSizeZ

getPixelType

getImage

setImage