java.lang.Object
- ch.systemsx.cisd.openbis.plugin.screening.shared.api.v1.dto.ImageDatasetMetadata

All Implemented Interfaces:: java.io.Serializable

@JsonObject("ImageDatasetMetadata")
public class ImageDatasetMetadata
extends java.lang.Object
implements java.io.Serializable

Metadata information about images in a specified dataset.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor	Description
`ImageDatasetMetadata(IImageDatasetIdentifier dataset, java.util.List<ImageChannel> channels, int tilesRows, int tilesCols, int width, int height, int thumbnailWidth, int thumbnailHeight)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`java.util.List<java.lang.String>`	`getChannelCodes()`	Returns channel codes.
`java.util.List<java.lang.String>`	`getChannelLabels()`	Deprecated. use `getChannels()` instead.
`java.util.List<java.lang.String>`	`getChannelNames()`	Deprecated. use `getChannels()` instead.
`java.util.List<ImageChannel>`	`getChannels()`	Returns the list of channels for this dataset.
`int`	`getHeight()`	Height of the images in this dataset.
`IImageDatasetIdentifier`	`getImageDataset()`	Identifier of this image dataset.
`int`	`getNumberOfChannels()`	Number of channels (wavelengths) in which images have been acquired for this dataset.
`int`	`getNumberOfTiles()`	Number of image tiles (or "fields") available for each well.
`int`	`getThumbnailHeight()`	The height of the thumbnail images, or 0 if no thumbnails are available for this data set.
`int`	`getThumbnailWidth()`	The width of the thumbnail images, or 0 if no thumbnails are available for this data set.
`int`	`getTilesCols()`	Number of columns of image tiles (or "fields") available for each well.
`int`	`getTilesRows()`	Number of rows of image tiles (or "fields") available for each well.
`int`	`getWidth()`	Width of the images in this dataset.
`boolean`	`hasThumbnails()`	`true`, if this data set has thumbnails, `false` otherwise.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ImageDatasetMetadata
```
public ImageDatasetMetadata(IImageDatasetIdentifier dataset,
                            java.util.List<ImageChannel> channels,
                            int tilesRows,
                            int tilesCols,
                            int width,
                            int height,
                            int thumbnailWidth,
                            int thumbnailHeight)
```
- Method Detail
  - getImageDataset
```
public IImageDatasetIdentifier getImageDataset()
```
    Identifier of this image dataset.
  - getNumberOfChannels
```
public int getNumberOfChannels()
```
    Number of channels (wavelengths) in which images have been acquired for this dataset.
  - getChannels
```
public java.util.List<ImageChannel> getChannels()
```
    Returns the list of channels for this dataset.
    
    Since:
    
    1.9
  - getChannelNames
```
@Deprecated
public java.util.List<java.lang.String> getChannelNames()
```
    Deprecated.
    use getChannels() instead.
    
    Names of channels in which images have been acquired for this dataset.
  - getChannelCodes
```
public java.util.List<java.lang.String> getChannelCodes()
```
    Returns channel codes.
    Note: If channel codes are unspecified channel names are returned. This will be the case if a serialized instance of a previous of this class will be deserialized.
  - getChannelLabels
```
@Deprecated
public java.util.List<java.lang.String> getChannelLabels()
```
    Deprecated.
    use getChannels() instead.
    
    Returns channel labels.
    Note: If channel labels are unspecified channel names are returned. This will be the case if a serialized instance of a previous of this class will be deserialized.
  - getTilesRows
```
public int getTilesRows()
```
    Number of rows of image tiles (or "fields") available for each well.
    Note: Will be 0 if the server does not support API version 1.6
    
    Since:
    
    1.6
  - getTilesCols
```
public int getTilesCols()
```
    Number of columns of image tiles (or "fields") available for each well.
    Note: Will be 0 if the server does not support API version 1.6
    
    Since:
    
    1.6
  - getNumberOfTiles
```
public int getNumberOfTiles()
```
    Number of image tiles (or "fields") available for each well.
  - getWidth
```
public int getWidth()
```
    Width of the images in this dataset.
  - getHeight
```
public int getHeight()
```
    Height of the images in this dataset.
  - getThumbnailWidth
```
public int getThumbnailWidth()
```
    The width of the thumbnail images, or 0 if no thumbnails are available for this data set.
    
    Since:
    
    1.6
  - getThumbnailHeight
```
public int getThumbnailHeight()
```
    The height of the thumbnail images, or 0 if no thumbnails are available for this data set.
    
    Since:
    
    1.6
  - hasThumbnails
```
public boolean hasThumbnails()
```
    true, if this data set has thumbnails, false otherwise.
    
    Since:
    
    1.6
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ImageDatasetMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImageDatasetMetadata

Method Detail

getImageDataset

getNumberOfChannels

getChannels

getChannelNames

getChannelCodes

getChannelLabels

getTilesRows

getTilesCols

getNumberOfTiles

getWidth

getHeight

getThumbnailWidth

getThumbnailHeight

hasThumbnails

toString