Package ch.systemsx.cisd.openbis.dss.etl.dto.api.impl

Class FeatureDefinition

  • All Implemented Interfaces:
    IFeatureDefinition, java.io.Serializable
    public class FeatureDefinition
extends java.lang.Object
implements IFeatureDefinition, java.io.Serializable
    Values of one feature for all wells + the way to build this structure.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      FeatureDefinition​(ch.systemsx.cisd.openbis.plugin.screening.shared.imaging.dataaccess.ImgFeatureDefDTO imgFeatureDefDTO)  
      FeatureDefinition​(ch.systemsx.cisd.openbis.plugin.screening.shared.imaging.dataaccess.ImgFeatureDefDTO imgFeatureDefDTO, ch.systemsx.cisd.openbis.dss.etl.featurevector.FeatureValuesMap currentFeatureVector)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addValue​(int wellRow, int wellColumn, java.lang.String value)  
      void addValue​(java.lang.String well, java.lang.String value)  
      void changeSeries​(java.lang.Double timeOrNull, java.lang.Double depthOrNull)
      Relevant only in cases where feature values for different timepoints and/or depth-scans are available.
      ch.systemsx.cisd.openbis.dss.etl.featurevector.CanonicalFeatureVector getCanonicalFeatureVector​(Geometry plateGeometry)  
      java.lang.String getFeatureLabel()  
      void setFeatureDescription​(java.lang.String description)
      Optional.
      void setFeatureLabel​(java.lang.String label)
      Optional.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • FeatureDefinition

        public FeatureDefinition​(ch.systemsx.cisd.openbis.plugin.screening.shared.imaging.dataaccess.ImgFeatureDefDTO imgFeatureDefDTO)

      • FeatureDefinition

        public FeatureDefinition​(ch.systemsx.cisd.openbis.plugin.screening.shared.imaging.dataaccess.ImgFeatureDefDTO imgFeatureDefDTO,
                         ch.systemsx.cisd.openbis.dss.etl.featurevector.FeatureValuesMap currentFeatureVector)

    • Method Detail

      • changeSeries

        public void changeSeries​(java.lang.Double timeOrNull,
                         java.lang.Double depthOrNull)
        Description copied from interface: IFeatureDefinition
        Relevant only in cases where feature values for different timepoints and/or depth-scans are available. In other cases one does not have to call this method at all.

        Sets the timepoint and/or the depth-scan values which will be used in all subsequent calls to IFeatureDefinition.addValue(java.lang.String, java.lang.String) until this method will be called again.

        Specified by:
        changeSeries in interface IFeatureDefinition

      • setFeatureLabel

        public void setFeatureLabel​(java.lang.String label)
        Optional. Sets the label of a feature.
        Specified by:
        setFeatureLabel in interface IFeatureDefinition

      • getFeatureLabel

        public java.lang.String getFeatureLabel()

      • setFeatureDescription

        public void setFeatureDescription​(java.lang.String description)
        Optional. Sets description of a feature.
        Specified by:
        setFeatureDescription in interface IFeatureDefinition

      • addValue

        public void addValue​(java.lang.String well,
                     java.lang.String value)
        Specified by:
        addValue in interface IFeatureDefinition
        Parameters:
        well - code of the well, e.g. A1
        value - value of the feature in the specified well

      • addValue

        public void addValue​(int wellRow,
                     int wellColumn,
                     java.lang.String value)
        Specified by:
        addValue in interface IFeatureDefinition
        Parameters:
        wellRow - row coordinate of the well, top-left well has (1,1) coordinates.
        wellColumn - column coordinate of the well, top-left well has (1,1) coordinates.
        value - value of the feature in the specified well

      • getCanonicalFeatureVector

        public ch.systemsx.cisd.openbis.dss.etl.featurevector.CanonicalFeatureVector getCanonicalFeatureVector​(Geometry plateGeometry)
        Returns:
        feature vector in a canonical form with all the values added so far.