java.lang.Object
- omero.gateway.model.DataObject
- - omero.gateway.model.ImageData

```
public class ImageData
extends DataObject
```
The data that makes up an OME Image along with links to its Pixels, enclosing Datasets, and the Experimenter that owns this Image.

Since:

OME2.2

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`ANNOTATIONS`	Identifies the `ImageI.ANNOTATIONLINKS` field.
`static java.lang.String`	`DATASET_LINKS`	Identifies the `ImageI.DATASETLINKS` field.
`static java.lang.String`	`DESCRIPTION`	Identifies the `ImageI.DESCRIPTION` field.
`static java.lang.String`	`NAME`	Identifies the `ImageI.NAME` field.
`static java.lang.String`	`PIXELS`	Identifies the `ImageI.PIXELS` field.

Constructor Summary

Constructors
Constructor Description

ImageData()
Creates a new instance.

ImageData(omero.model.Image image)
Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.sql.Timestamp`	`getAcquisitionDate()`	Returns the acquisition date.
`java.util.List<PixelsData>`	`getAllPixels()`	Returns all the sets of pixels related to this image.
`java.util.Set`	`getAnnotations()`	Returns the annotations
`java.util.Map<java.lang.Long,java.lang.Long>`	`getAnnotationsCounts()`	Returns the number of annotations linked to the object, key: id of the user, value: number of annotation.
`java.util.Set`	`getDatasets()`	Returns the datasets containing this image.
`PixelsData`	`getDefaultPixels()`	Returns the default set of pixels.
`java.lang.String`	`getDescription()`	Returns the description of the image.
`long`	`getFilesetId()`	Returns the ID of the fileset to which this image belongs.
`java.lang.String`	`getFormat()`	Returns the format of the image.
`int`	`getIndex()`	Returns the index of the image within the multi-images file.
`java.sql.Timestamp`	`getInserted()`	Returns the insertion time of the image.
`long`	`getInstrumentId()`	Returns the id of the instrument if any.
`java.lang.String`	`getName()`	Returns the name of the image.
`java.lang.String`	`getParentFilePath()`	Returns the path to the file hosting the image.
`java.lang.String`	`getPathToFile()`	Returns the path to the file.
`omero.model.OriginalFile`	`getReference()`	Returns the reference to the file to register.
`int`	`getSeries()`	Returns the series.
`boolean`	`isArchived()`	Returns `true` if the image has been archived, `false` otherwise.
`boolean`	`isFSImage()`	Returns `true` is the image has been imported the new import strategy known as FS import, `false` if imported using the previous import approach (data duplication).
`boolean`	`isLifetime()`	Returns `true` if the image is a lifetime image, `false` otherwise.
`void`	`setAllPixels(java.util.List<PixelsData> newValue)`	Sets the set of pixels related to this image.
`void`	`setAnnotations(java.util.Set newValue)`	Sets the image's annotations.
`void`	`setDatasets(java.util.Set newValue)`	Sets the datasets containing the image.
`void`	`setDefaultPixels(PixelsData defaultPixels)`	Sets the default set of pixels.
`void`	`setDescription(java.lang.String description)`	Sets the description of the image.
`void`	`setName(java.lang.String name)`	Sets the name of the image.
`void`	`setParentFilePath(java.lang.String path, int index)`	Sets the path to the file hosting the image.
`void`	`setPathToFile(java.lang.String path)`	Sets the path to the file.
`void`	`setReference(omero.model.OriginalFile reference)`	Sets the reference to the file to register.
`void`	`setRegisteredFile(omero.model.Image object)`	Sets the registered file.

Methods inherited from class omero.gateway.model.DataObject
asAnnotation, asChannel, asDataset, asExperimenter, asFolder, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlaneInfo, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, canAnnotate, canChgrp, canChown, 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
  - NAME
```
public static final java.lang.String NAME
```
    Identifies the ImageI.NAME field.
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
public static final java.lang.String DESCRIPTION
```
    Identifies the ImageI.DESCRIPTION field.
    
    See Also:
    
    Constant Field Values
  - PIXELS
```
public static final java.lang.String PIXELS
```
    Identifies the ImageI.PIXELS field.
    
    See Also:
    
    Constant Field Values
  - ANNOTATIONS
```
public static final java.lang.String ANNOTATIONS
```
    Identifies the ImageI.ANNOTATIONLINKS field.
    
    See Also:
    
    Constant Field Values
  - DATASET_LINKS
```
public static final java.lang.String DATASET_LINKS
```
    Identifies the ImageI.DATASETLINKS field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ImageData
```
public ImageData()
```
    Creates a new instance.
  - ImageData
```
public ImageData(omero.model.Image image)
```
    Creates a new instance.
    
    Parameters:
    
    image - Back pointer to the Image model object. Mustn't be null.
    
    Throws:
    
    java.lang.IllegalArgumentException - If the object is null.
- Method Detail
  - setPathToFile
```
public void setPathToFile(java.lang.String path)
```
    Sets the path to the file.
    
    Parameters:
    
    path - The value to set.
  - setReference
```
public void setReference(omero.model.OriginalFile reference)
```
    Sets the reference to the file to register.
    
    Parameters:
    
    reference - The value to set.
  - getReference
```
public omero.model.OriginalFile getReference()
```
    Returns the reference to the file to register.
    
    Returns:
    
    See above.
  - getPathToFile
```
public java.lang.String getPathToFile()
```
    Returns the path to the file.
    
    Returns:
    
    See above.
  - setParentFilePath
```
public void setParentFilePath(java.lang.String path,
                              int index)
```
    Sets the path to the file hosting the image. This should only be used to handle multi-images file e.g. some Leica files. Sets the index of the image within that file.
    
    Parameters:
    
    path - The path to set.
    
    index - The index to set.
  - getParentFilePath
```
public java.lang.String getParentFilePath()
```
    Returns the path to the file hosting the image. This should only be used to handle multi-images file e.g. some Leica files.
    
    Returns:
    
    See above.
  - getIndex
```
public int getIndex()
```
    Returns the index of the image within the multi-images file.
    
    Returns:
    
    See above.
  - getSeries
```
public int getSeries()
```
    Returns the series.
    
    Returns:
    
    See above.
  - getFormat
```
public java.lang.String getFormat()
```
    Returns the format of the image.
    
    Returns:
    
    See above.
  - setRegisteredFile
```
public void setRegisteredFile(omero.model.Image object)
```
    Sets the registered file.
    
    Parameters:
    
    object - The object to store.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of the image.
    
    Parameters:
    
    name - The name of the image. Mustn't be null.
    
    Throws:
    
    java.lang.IllegalArgumentException - If the name is null.
  - getName
```
public java.lang.String getName()
```
    Returns the name of the image.
    
    Returns:
    
    See above.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Sets the description of the image.
    
    Parameters:
    
    description - The description of the image.
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the description of the image.
    
    Returns:
    
    See above.
  - isArchived
```
public boolean isArchived()
```
    Returns true if the image has been archived, false otherwise.
    
    Returns:
    
    See above.
  - getAnnotationsCounts
```
public java.util.Map<java.lang.Long,java.lang.Long> getAnnotationsCounts()
```
    Returns the number of annotations linked to the object, key: id of the user, value: number of annotation. The map may be null if no annotation.
    
    Returns:
    
    See above.
  - getInserted
```
public java.sql.Timestamp getInserted()
```
    Returns the insertion time of the image.
    
    Returns:
    
    See above.
  - getAcquisitionDate
```
public java.sql.Timestamp getAcquisitionDate()
```
    Returns the acquisition date.
    
    Returns:
    
    See above.
  - getDefaultPixels
```
public PixelsData getDefaultPixels()
```
    Returns the default set of pixels.
    
    Returns:
    
    See above.
  - setDefaultPixels
```
public void setDefaultPixels(PixelsData defaultPixels)
```
    Sets the default set of pixels.
    
    Parameters:
    
    defaultPixels - The default set of pixels.
  - getAllPixels
```
public java.util.List<PixelsData> getAllPixels()
```
    Returns all the sets of pixels related to this image.
    
    Returns:
    
    See above.
  - setAllPixels
```
public void setAllPixels(java.util.List<PixelsData> newValue)
```
    Sets the set of pixels related to this image.
    
    Parameters:
    
    newValue - The set of pixels' set.
  - getDatasets
```
public java.util.Set getDatasets()
```
    Returns the datasets containing this image.
    
    Returns:
    
    See above.
  - setDatasets
```
public void setDatasets(java.util.Set newValue)
```
    Sets the datasets containing the image.
    
    Parameters:
    
    newValue - The set of datasets.
  - getAnnotations
```
public java.util.Set getAnnotations()
```
    Returns the annotations
    
    Returns:
    
    See above.
  - setAnnotations
```
public void setAnnotations(java.util.Set newValue)
```
    Sets the image's annotations.
    
    Parameters:
    
    newValue - The set of annotations.
  - isLifetime
```
public boolean isLifetime()
```
    Returns true if the image is a lifetime image, false otherwise.
    
    Returns:
    
    See above.
  - getInstrumentId
```
public long getInstrumentId()
```
    Returns the id of the instrument if any.
    
    Returns:
    
    See above.
  - isFSImage
```
public boolean isFSImage()
```
    Returns true is the image has been imported the new import strategy known as FS import, false if imported using the previous import approach (data duplication).
    
    Returns:
    
    See above.
  - getFilesetId
```
public long getFilesetId()
```
    Returns the ID of the fileset to which this image belongs. Similar to isFSImage(), for images imported pre-FS (data duplication) -1 will be returned. Else - the long value of the fileset ID.
    
    Returns:
    
    See above.

Constructor	Description
`ImageData()`	Creates a new instance.
`ImageData(omero.model.Image image)`	Creates a new instance.

Class ImageData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class omero.gateway.model.DataObject

Methods inherited from class java.lang.Object

Field Detail

NAME

DESCRIPTION

PIXELS

ANNOTATIONS

DATASET_LINKS

Constructor Detail

ImageData

ImageData

Method Detail

setPathToFile

setReference

getReference

getPathToFile

setParentFilePath

getParentFilePath

getIndex

getSeries

getFormat

setRegisteredFile

setName

getName

setDescription

getDescription

isArchived

getAnnotationsCounts

getInserted

getAcquisitionDate

getDefaultPixels

setDefaultPixels

getAllPixels

setAllPixels

getDatasets

setDatasets

getAnnotations

setAnnotations

isLifetime

getInstrumentId

isFSImage

getFilesetId