Improve the documentation for the formula functions

Author: shroffk

core/formula/doc/index.rst

@@ -150,6 +150,7 @@ This includes the average, min, max, and element count
 
 **arrayMin(VNumberArray array)** - Returns a VDouble with the smallest value of the given array
 
+**arraySampleWithStride(VNumberArray array, VNumber stride, VNumber offset)** - Returns a VNumberArray where each element is defined as array\[x \* stride + offset\].
 
 String
 ------
@@ -206,4 +207,12 @@ i.e. [Int8, UInt8, Int16, UInt16, Int32, UInt32, Float32, Float64].
 
 **imageYOffset(VImage image)** - Fetch vertical offset of image.
 
-**imageYReversed(VImage image)** - Fetch vertical reversal of image.
+**imageYReversed(VImage image)** - Fetch vertical reversal of image.
+
+**imageDataHorizontalProfile(VNumberArray image, VNumber imageWidth, VNumber yPosition)** - Fetch the horizontal profile data for the given Image data at a specific y position.
+
+**imageDataVerticalProfile(VNumberArray image, VNumber imageWidth, VNumber xPosition)** - Fetch the vertical profile data for the given Image data at a specific x position.
+
+**imageHorizontalProfile(VImage image, VNumber yPosition)** - Fetch the horizontal profile of the given Image at a specific y position.
+
+**imageVerticalProfile(VImage image, VNumber xPosition)** - Fetch the vertical profile of the given Image at a specific x position.

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

@@ -1,6 +1,5 @@
 package org.csstudio.apputil.formula.areadetector;
 
-
 import java.util.Arrays;
 import java.util.List;
 

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

@@ -10,38 +10,43 @@
 import java.util.Arrays;
 import java.util.List;
 
-/** A formula function for fetching the horizontal profile from image data.
- *  @author Kunal Shroff
+/**
+ * A formula function for fetching the horizontal profile from image data.
+ * This function extracts the horizontal profile along a given y position.
+ *
+ * @author Kunal Shroff
  */
-public class ImageDataHorizontalProfileFunction implements FormulaFunction
-{
+public class ImageDataHorizontalProfileFunction implements FormulaFunction {
 
     @Override
-    public String getCategory()
-    {
+    public String getCategory() {
         return "areaDetector";
     }
 
     @Override
-    public String getName()
-    {
+    public String getName() {
         return "imageDataHorizontalProfile";
     }
 
     @Override
-    public String getDescription()
-    {
+    public String getDescription() {
         return "Fetch the horizontal profile data for the given Image data at a specific y position.";
     }
 
     @Override
-    public List<String> getArguments()
-    {
+    public List<String> getArguments() {
         return List.of("image", "image width", "y position");
     }
 
-    protected VType getHorizontalProfile(final VNumberArray imageData, final int imageWidth, final int yPosition)
-    {
+    /**
+     * Computes the horizontal profile of the given image data at the specified y position.
+     *
+     * @param imageData  The image data.
+     * @param imageWidth The width of the image.
+     * @param yPosition  The y position in the image data from which to extract the horizontal profile.
+     * @return A VNumberArray representing the extracted horizontal profile.
+     */
+    protected VType getHorizontalProfile(final VNumberArray imageData, final int imageWidth, final int yPosition) {
         int start = yPosition * imageWidth;
         int end = start + imageWidth;
         return VNumberArray.of(imageData.getData().subList(start, end),
@@ -50,9 +55,18 @@ protected VType getHorizontalProfile(final VNumberArray imageData, final int ima
                 Display.none());
     }
 
+    /**
+     * Computes the horizontal profile based on the provided arguments.
+     *
+     * @param args The arguments, where:
+     *             - args[0] must be a numeric array
+     *             - args[1] must be the image width
+     *             - args[2] must be the y position
+     * @return The computed horizontal profile as a VType.
+     * @throws Exception If invalid arguments are provided.
+     */
     @Override
-    public VType compute(final VType... args) throws Exception
-    {
+    public VType compute(final VType... args) throws Exception {
         if (args.length != 3) {
             throw new Exception("Function " + getName() +
                     " requires 3 arguments but received " + Arrays.toString(args));

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

@@ -50,8 +50,9 @@ public List<String> getArguments()
     /**
      * Computes the vertical profile of the given VImage at the specified x position.
      *
-     * @param imageData The imageData.
-     * @param xPosition The x position in the imageData from which to extract the vertical profile.
+     * @param imageData The image data.
+     * @param width     The width of the image.
+     * @param xPosition The x position in the image data from which to extract the vertical profile.
      * @return A VNumberArray representing the extracted vertical profile.
      */
     protected VType getVerticalProfile(final VNumberArray imageData, final int width, final int xPosition) {
@@ -83,8 +84,9 @@ public int size() {
      * Computes the vertical profile based on the provided arguments.
      *
      * @param args The arguments, where:
-     *             - args[0] must be a VImage
-     *             - args[1] must be the x position
+     *             - args[0] must be a numeric array representing the image data
+     *             - args[1] must be the image width
+     *             - args[2] must be the x position
      * @return The computed vertical profile as a VType.
      * @throws Exception If invalid arguments are provided.
      */

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

@@ -48,6 +48,15 @@ protected VType getHorizontalProfile(final VImage image, final int yPosition)
         return VNumberArray.of(image.getData().subList(start, end), Alarm.none(), image.getTime(), Display.none());
     }
 
+    /**
+     * Computes the horizontal profile based on the provided arguments.
+     *
+     * @param args The arguments, where:
+     *             - args[0] must be a VImage
+     *             - args[1] must be the y position
+     * @return The computed horizontal profile as a VType.
+     * @throws Exception If invalid arguments are provided.
+     */
     @Override
     public VType compute(final VType... args) throws Exception
     {

core/formula/src/main/java/org/csstudio/apputil/formula/array/ArraySampleWithStrideFunction.java

@@ -49,7 +49,7 @@ public String getDescription() {
 
     @Override
     public List<String> getArguments() {
-        return List.of("array", "stride", "offset(optional)");
+        return List.of("array", "stride", "offset");
     }