IImageDataSet (openbis_standard_technologies S346.0-r1619002377 API)

All Superinterfaces:

IDataSet, IDataSetImmutable, IDataSetUpdatable, IMetaprojectContent

All Known Implementing Classes:

ImageContainerDataSet
```
public interface IImageDataSet
extends IDataSet
```
Container image dataset which contains original and thumbnail physical datasets.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`establishSampleLinkForContainedDataSets()`	Deprecated. this method is for backwards compatibility only
`java.lang.String`	`figureGeometry()`	Utility method to find out the plate geometry by looking for which wells images are available.
`IDataSet`	`getOriginalDataset()`
`java.util.List<IDataSet>`	`getThumbnailDatasets()`
`void`	`setAnalysisProcedure(java.lang.String analysisProcedure)`	Sets analysis procedure.

Methods inherited from interface ch.systemsx.cisd.etlserver.registrator.api.v2.IDataSet
setDataSetKind, setDataSetType, setMeasuredData, setSpeedHint

Methods inherited from interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
getAllPropertyCodes, getChildrenDataSets, getContainedDataSetCodes, getContainerDataSet, getContainerDataSets, getDataSetCode, getDataSetKind, getDataSetType, getDataSetTypeWithPropertyTypes, getExperiment, getExternalCode, getExternalDataManagementSystem, getFileFormatType, getOrderInContainer, getParentDatasets, getPropertyValue, getSample, getSpeedHint, isContainedDataSet, isContainerDataSet, isLinkDataSet, isMeasuredData, isNoFileDataSet, isPostRegistered

Methods inherited from interface ch.systemsx.cisd.etlserver.registrator.api.v2.IDataSetUpdatable
setContainedDataSetCodes, setExperiment, setExternalCode, setExternalDataManagementSystem, setFileFormatType, setParentDatasets, setPropertyValue, setSample

Methods inherited from interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IMetaprojectContent
getEntityId

- Method Detail
  - getOriginalDataset
```
IDataSet getOriginalDataset()
```
  - getThumbnailDatasets
```
java.util.List<IDataSet> getThumbnailDatasets()
```
  - setAnalysisProcedure
```
void setAnalysisProcedure(java.lang.String analysisProcedure)
```
    Sets analysis procedure. Makes sense only for segmentation datasets.
  - establishSampleLinkForContainedDataSets
```
@Deprecated
void establishSampleLinkForContainedDataSets()
```
    Deprecated.
    this method is for backwards compatibility only
    
    If this method is called the contained data sets (original data set and thumbnails) will automatically linked to the sample specified by IDataSetUpdatable.setSample(ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable) . By default there will be no such links.
  - figureGeometry
```
java.lang.String figureGeometry()
```
    Utility method to find out the plate geometry by looking for which wells images are available.
    
    Returns:
    
    a constant which can be used as a vocabulary term value for $PLATE_GEOMETRY property of a plate/
    
    Throws:
    
    ch.systemsx.cisd.common.exceptions.UserFailureException - if all available geometries in openBIS are too small (there is a well outside).