Formula: Add imageValue(image)

Author: kasemir

core/formula/src/main/java/org/csstudio/apputil/formula/areadetector/ImageValueFunction.java

@@ -0,0 +1,65 @@
+/*******************************************************************************
+ * Copyright (c) 2022 Oak Ridge National Laboratory.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ ******************************************************************************/
+package org.csstudio.apputil.formula.areadetector;
+
+import java.util.Arrays;
+import java.util.List;
+
+import org.csstudio.apputil.formula.spi.FormulaFunction;
+import org.epics.vtype.Display;
+import org.epics.vtype.VImage;
+import org.epics.vtype.VNumberArray;
+import org.epics.vtype.VType;
+
+/** A formula function for fetching VImage array data
+ *  @author Kay Kasemir
+ */
+public class ImageValueFunction implements FormulaFunction
+{
+    @Override
+    public String getCategory()
+    {
+        return "areaDetector";
+    }
+
+    @Override
+    public String getName()
+    {
+        return "imageValue";
+    }
+
+    @Override
+    public String getDescription()
+    {
+        return "Fetch array data of image";
+    }
+
+    @Override
+    public List<String> getArguments()
+    {
+        return List.of("image");
+    }
+
+    /** Fetch info from image
+     *  @param image Image
+     *  @return VType to return from function
+     */
+    protected VType getImageData(final VImage image)
+    {
+        return VNumberArray.of(image.getData(), image.getAlarm(), image.getTime(), Display.none());
+    }
+
+    @Override
+    public VType compute(final VType... args) throws Exception
+    {
+        if (args.length != 1 || ! (args[0] instanceof VImage))
+            throw new Exception("Function " + getName() +
+                    " takes VImage but received " + Arrays.toString(args));
+        return getImageData((VImage) args[0]);
+    }
+}

core/formula/src/main/java/org/csstudio/apputil/formula/areadetector/ImageWidthFunction.java

@@ -7,10 +7,6 @@
  ******************************************************************************/
 package org.csstudio.apputil.formula.areadetector;
 
-import java.util.Arrays;
-import java.util.List;
-
-import org.csstudio.apputil.formula.spi.FormulaFunction;
 import org.epics.vtype.Display;
 import org.epics.vtype.VImage;
 import org.epics.vtype.VInt;
@@ -19,14 +15,8 @@
 /** A formula function for fetching width of VImage
  *  @author Kay Kasemir
  */
-public class ImageWidthFunction implements FormulaFunction
+public class ImageWidthFunction extends ImageValueFunction
 {
-    @Override
-    public String getCategory()
-    {
-        return "areaDetector";
-    }
-
     @Override
     public String getName()
     {
@@ -39,12 +29,6 @@ public String getDescription()
         return "Fetch width of image";
     }
 
-    @Override
-    public List<String> getArguments()
-    {
-        return List.of("image");
-    }
-
     /** Fetch info (width, height, ...) from image
      *
      *  Subclass can override
@@ -58,13 +42,8 @@ protected int getImageInfo(final VImage image)
     }
 
     @Override
-    public VType compute(final VType... args) throws Exception
+    protected VType getImageData(final VImage image)
     {
-        if (args.length != 1 || ! (args[0] instanceof VImage))
-            throw new Exception("Function " + getName() +
-                    " takes VImage but received " + Arrays.toString(args));
-
-        final VImage image = (VImage) args[0];
         return VInt.of(getImageInfo(image), image.getAlarm(), image.getTime(), Display.none());
     }
 }

core/formula/src/main/resources/META-INF/services/org.csstudio.apputil.formula.spi.FormulaFunction

@@ -27,11 +27,12 @@ org.csstudio.apputil.formula.math.Pow
 # Other functions
 org.csstudio.apputil.formula.demo.Factorial
 org.csstudio.apputil.formula.areadetector.ADDataTypeMappingFunction
-org.csstudio.apputil.formula.areadetector.ImageWidthFunction
 org.csstudio.apputil.formula.areadetector.ImageHeightFunction
+org.csstudio.apputil.formula.areadetector.ImageValueFunction
+org.csstudio.apputil.formula.areadetector.ImageWidthFunction
 org.csstudio.apputil.formula.areadetector.ImageXOffsetFunction
-org.csstudio.apputil.formula.areadetector.ImageYOffsetFunction
 org.csstudio.apputil.formula.areadetector.ImageXReversedFunction
+org.csstudio.apputil.formula.areadetector.ImageYOffsetFunction
 org.csstudio.apputil.formula.areadetector.ImageYReversedFunction
 
 # String