Package ch.systemsx.cisd.openbis.plugin.screening.shared.api.v1.dto

Class ExperimentImageMetadata

java.lang.Object

ch.systemsx.cisd.openbis.plugin.screening.shared.api.v1.dto.ExperimentImageMetadata

All Implemented Interfaces:

java.io.Serializable

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

Contains summary meta data for images within an experiment.

Most of the class member fields are optional and will have data populated only if it is valid for all entities within the experiment. For example, the field originalImageSize will not be NULL only if all the images in the experiment have the same size.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExperimentImageMetadata(ExperimentIdentifier identifier, Geometry plateGeometry, Geometry tileGeometry, java.util.List<ImageChannel> channels, ImageSize originalImageSize, java.util.List<ImageSize> thumbnailImageSizes)

Method Summary

Modifier and Type	Method	Description
java.util.List<ImageChannel>	getChannels()	Return all channels of images contained in the experiment.
ExperimentIdentifier	getIdentifier()	Return the experiment identifier.
ImageSize	getOriginalImageSize()	Returns the image size if all images in the experiment have the same size.
Geometry	getPlateGeometry()	Returns the plate geometry if all plates in the experiment have the same geometry.
java.util.List<ImageSize>	getThumbnailImageSizes()	Returns a sorted list of image sizes where for all experiment's images thumbnail images of these sizes exist.
Geometry	getTileGeometry()	Returns the tiles geometry if all tiles in the experiment have the same geometry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExperimentImageMetadata

public ExperimentImageMetadata(ExperimentIdentifier identifier,
                               Geometry plateGeometry,
                               Geometry tileGeometry,
                               java.util.List<ImageChannel> channels,
                               ImageSize originalImageSize,
                               java.util.List<ImageSize> thumbnailImageSizes)

Method Detail

getIdentifier

public ExperimentIdentifier getIdentifier()

Return the experiment identifier.

getChannels

public java.util.List<ImageChannel> getChannels()

Return all channels of images contained in the experiment.

getPlateGeometry

public Geometry getPlateGeometry()

Returns the plate geometry if all plates in the experiment have the same geometry. Returns NULL if two or more of the experiment's plates have different geometries.

getTileGeometry

public Geometry getTileGeometry()

Returns the tiles geometry if all tiles in the experiment have the same geometry. Returns NULL if two or more of the experiment's tiles have different geometries.

getOriginalImageSize

public ImageSize getOriginalImageSize()

Returns the image size if all images in the experiment have the same size. Returns NULL if two or more of the experiment's images have different sizes.

getThumbnailImageSizes

public java.util.List<ImageSize> getThumbnailImageSizes()

Returns a sorted list of image sizes where for all experiment's images thumbnail images of these sizes exist.

Returns:

an empty list if no common thumbnail image size exists.