RESOLVED - Issue #398 Image Compose Operator (GroupBy): allow one to specify the background value

#398

- fixed - background value to ignore can now be specified
- constructors are made private

Author: hornm

org.knime.knip.base/src/org/knime/knip/base/data/aggregation/ImgComposeOperator.java

@@ -75,7 +75,9 @@
 import org.knime.core.node.NotConfigurableException;
 import org.knime.core.node.defaultnodesettings.DialogComponent;
 import org.knime.core.node.defaultnodesettings.DialogComponentColumnNameSelection;
+import org.knime.core.node.defaultnodesettings.DialogComponentNumber;
 import org.knime.core.node.defaultnodesettings.DialogComponentStringSelection;
+import org.knime.core.node.defaultnodesettings.SettingsModelDouble;
 import org.knime.core.node.defaultnodesettings.SettingsModelString;
 import org.knime.knip.base.data.IntervalValue;
 import org.knime.knip.base.data.img.ImgPlusCell;
@@ -122,11 +124,17 @@ private static SettingsModelString createIntervalColumnModel() {
         return new SettingsModelString("interval_column", "");
     }
 
-    private DialogComponentStringSelection m_dcImgType;
+    private static SettingsModelDouble createBackgroundValueModel() {
+        return new SettingsModelDouble("background_value", 0.0);
+    }
 
     // dialog components
     private DialogComponent m_dcIntervalCol;
 
+    private DialogComponentStringSelection m_dcImgType;
+
+    private DialogComponentNumber m_dcBackgroundValue;
+
     // the default settings, i.e. if the respective globalsettings are not
     // set
     private String m_intervalCol = "";
@@ -150,11 +158,13 @@ private static SettingsModelString createIntervalColumnModel() {
 
     private T2 m_resultType = null;
 
+    // settings models
     private final SettingsModelString m_smImgType = createImgTypeModel();
 
-    // settings models
     private final SettingsModelString m_smIntervalCol = createIntervalColumnModel();
 
+    private final SettingsModelDouble m_smBackgroundValue = createBackgroundValueModel();
+
     public ImgComposeOperator() {
         super("compose_image_2", "Compose Image", "Compose Image");
     }
@@ -163,16 +173,16 @@ public ImgComposeOperator() {
      * @param label
      * @param globalSettings
      */
-    public ImgComposeOperator(final GlobalSettings globalSettings) {
-        this(globalSettings, null, null);
+    private ImgComposeOperator(final GlobalSettings globalSettings) {
+        this(globalSettings, null, null, 0);
     }
 
     /**
      * @param label
      * @param globalSettings
      */
     @SuppressWarnings("unchecked")
-    public ImgComposeOperator(final GlobalSettings globalSettings, final String colName, final String type) {
+    private ImgComposeOperator(final GlobalSettings globalSettings, final String colName, final String type, final double bgValue) {
         super("compose_image_2", "Compose Image", globalSettings);
 
         if (colName != null) {
@@ -181,10 +191,10 @@ public ImgComposeOperator(final GlobalSettings globalSettings, final String colN
         if (type != null) {
             m_smImgType.setStringValue(type);
         }
+        m_smBackgroundValue.setDoubleValue(bgValue);
 
         m_intervalCol = m_smIntervalCol.getStringValue();
         m_resultType = (T2)NativeTypes.getTypeInstance(NativeTypes.valueOf(m_smImgType.getStringValue()));
-
     }
 
     /*
@@ -201,7 +211,7 @@ private boolean addToImage(final ImgPlusValue<T1> val) {
         // Set segmented pixels to label
         final Cursor<T1> patchCursor = patch.localizingCursor();
         final T1 minVal = patch.firstElement().createVariable();
-        minVal.setReal(minVal.getMinValue());
+        minVal.setReal(m_smBackgroundValue.getDoubleValue());
         while (patchCursor.hasNext()) {
             patchCursor.fwd();
             if (patchCursor.get().compareTo(minVal) == 0) {
@@ -324,6 +334,8 @@ private void createDCs() {
                                                     NativeTypes.UNSIGNEDSHORTTYPE, NativeTypes.INTTYPE,
                                                     NativeTypes.UNSIGNEDINTTYPE, NativeTypes.LONGTYPE,
                                                     NativeTypes.FLOATTYPE, NativeTypes.DOUBLETYPE));
+
+            m_dcBackgroundValue = new DialogComponentNumber(createBackgroundValueModel(), "Background value", 1);
         }
     }
 
@@ -334,7 +346,7 @@ private void createDCs() {
     public AggregationOperator createInstance(final GlobalSettings globalSettings,
                                               final OperatorColumnSettings opColSettings) {
         return new ImgComposeOperator<T1, T2>(globalSettings, m_smIntervalCol.getStringValue(),
-                m_smImgType.getStringValue());
+                m_smImgType.getStringValue(), m_smBackgroundValue.getDoubleValue());
     }
 
     @Override
@@ -361,7 +373,11 @@ protected DataType getDataType(final DataType origType) {
      */
     @Override
     public String getDescription() {
-        return "Composes images from image patches.";
+        return "Composes images from image patches.\n"
+                + "Options:\n"
+                + "Interval: the size of the result image\n"
+                + "Result image type: the type of the result image\n"
+                + "Background value: this value will be ignored and not transferred to the result image.";
     }
 
     /**
@@ -401,6 +417,7 @@ public Component getSettingsPanel() {
         panel.setLayout(new BoxLayout(panel, BoxLayout.Y_AXIS));
         panel.add(m_dcIntervalCol.getComponentPanel());
         panel.add(m_dcImgType.getComponentPanel());
+        panel.add(m_dcBackgroundValue.getComponentPanel());
         return panel;
     }
 
@@ -418,6 +435,7 @@ public void loadSettingsFrom(final NodeSettingsRO settings, final DataTableSpec
         createDCs();
         m_dcIntervalCol.loadSettingsFrom(settings, new DataTableSpec[]{spec});
         m_dcImgType.loadSettingsFrom(settings, new DataTableSpec[]{spec});
+        m_dcBackgroundValue.loadSettingsFrom(settings, new DataTableSpec[]{spec});
     }
 
     /**
@@ -430,6 +448,13 @@ public void loadValidatedSettings(final NodeSettingsRO settings) throws InvalidS
             m_smIntervalCol.setStringValue("");
         }
         m_smImgType.loadSettingsFrom(settings);
+
+        try{
+            m_smBackgroundValue.loadSettingsFrom(settings);
+        }catch(InvalidSettingsException e) {
+            //backwards compatibility -
+            //use default value if settings not available
+        }
     }
 
     /**
@@ -461,12 +486,14 @@ public void saveSettingsTo(final NodeSettingsWO settings) {
             try {
                 m_dcIntervalCol.saveSettingsTo(settings);
                 m_dcImgType.saveSettingsTo(settings);
+                m_dcBackgroundValue.saveSettingsTo(settings);
             } catch (final InvalidSettingsException e) {
                 throw new RuntimeException(e.getMessage());
             }
         } else {
             m_smIntervalCol.saveSettingsTo(settings);
             m_smImgType.saveSettingsTo(settings);
+            m_smBackgroundValue.saveSettingsTo(settings);
         }
 
     }
@@ -478,5 +505,6 @@ public void saveSettingsTo(final NodeSettingsWO settings) {
     public void validateSettings(final NodeSettingsRO settings) throws InvalidSettingsException {
         m_smIntervalCol.validateSettings(settings);
         m_smImgType.validateSettings(settings);
+        m_smBackgroundValue.validateSettings(settings);
     }
 }