GoWebScanUtilities.h

Go to the documentation of this file.

/**
* @file    GoWebScanUtilities.h
* @brief   Defines GoWebScan utility functions.
*
* @internal
* Copyright (C) 2017-2021 by LMI Technologies Inc.
* Licensed under the MIT License.
* Redistributed files must retain the above copyright notice.
*/

#ifndef GO_WEB_SCAN_UTILITIES_H
#define GO_WEB_SCAN_UTILITIES_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>
#include <kApi/Data/kArray1.h>
#include <kApi/Data/kArray2.h>
#include <kApi/Data/kArray3.h>
#include <kApi/Data/kImage.h>
#include <kApi/Data/kMath.h>
#include <math.h>

#define NM_TO_MM(VALUE)                         (((k64f)(VALUE))/1000000.0)                 ///< Converts nanometers to millimeters
#define UM_TO_MM(VALUE)                         (((k64f)(VALUE))/1000.0)                    ///< Converts micrometers to millimeters
#define MM_TO_MILS(VALUE)                       ((VALUE)*39.3701)                           ///< Converts millimeters to mils

/**
* Applies an obstruction to raw sensor profile data. The obstruction defines a mask covering a
* specified ROI in Z and X. Masked points are set to null.
*
* @public                   @memberof GoWebScanSdk
* @param  inPoints          Pointer to input profile points. 
* @param  outPoints         Pointer to masked output profile points. Can reuse the input buffer.
* @param  count             Count of profile points.
* @param  obstructions      Pointer to start of obstruction buffer.
* @param  obstructionCount  Count of obstructions in buffer.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanUtils_ApplyProfileMask(const kPoint16s* inPoints, kPoint16s* outPoints, kSize count, const GoWebScanObstruction* obstructions, kSize obstructionCount);

/**
* Reorients profile data to align with system coordinates in standard orienation. In standard
* orientation, the sensor X-axis is aligned to the system X-axis, and the sensor z-axis is 
* opposite the system z-axis. X data is converted to system coordinates.
*
* @public                   @memberof GoWebScanSdk
* @param  inPoints          Pointer to input profile points. 
* @param  outPoints         Pointer to reoriented profile points.
* @param  count             Count of profile points.
* @param  xInCenter         X-center of sensor in system coordinates.
* @param  xOrientation      X-orientation of sensor. 
* @param  zOrientation      Z-orientation of sensor.
* @return                   Operation status.
* @see                      GoWebScanSettings_XOrientation, GoWebScanSettings_ZOrientation
*/
GoWebScanFx(kStatus) GoWebScanUtils_ApplyProfileOrientation(const kPoint16s* inPoints, kPoint16s* outPoints, kSSize count, k32s xInCenter, k32s xOrientation, k32s zOrientation);

/**
* Applies an offset in Z to each input profile point. These offsets typically represent a system 
* calibration to align all sensors to a common plane.
*
* @public                   @memberof GoWebScanSdk
* @param  inPoints          Pointer to input profile points.  Can reuse the input buffer.
* @param  zOffsets          Pointer to Z offset buffer.
* @param  outPoints         Pointer to reoriented profile points.
* @param  count             Count of profile points.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanUtils_ApplyProfileZOffset(const kPoint16s* inPoints, const k16s* zOffsets, kPoint16s* outPoints, kSSize count);

/**
* Modifies profile spots that fall on the side edge of a board (edge along Y-axis) and report a 
* different range than  their neighbour. Side edge spots are modified to report the range of the 
* adjacent spot that is on the board, giving the board edge a 90 degree angle and more accurate 
* length instead of a curved edge.
*
* @public                       @memberof GoWebScanSdk
* @param  inPoints              Pointer to input profile points. 
* @param  outPoints             Pointer to output profile points.
* @param  count                 Count of profile points.
* @param  extrapolationWindow   Amount along X-axis to extend board.
* @return                       Operation status.
*/
GoWebScanFx(kStatus) GoWebScanUtils_ExtendSideProfile(const kPoint16s* inPoints, kPoint16s* outPoints, kSSize count, kSSize extrapolationWindow);

/**
* Resamples profile data in the X-axis.
*
* @public                       @memberof GoWebScanSdk
* @param  style                 Type of interpolation to apply during resampling.
* @param  inPoints              Pointer to input profile points. 
* @param  pointCount            Count of input profile points.
* @param  outPoints             Pointer to output resampled Z profiles.
* @param  profileCount          Count of output profiles.
* @param  xStart                Start location, in mils, of resampling. In system coordinates.
* @param  xRes                  Desired resolution, in mils/pixel, of resampled data.
* @param  interpolationWindow   Maximum input data X-gap, in mils, to be filled in with resampled data.
* @param  extrapolationWindow   Distance, in mils, to extend resampling window around pairs of input points.
* @return                       Operation status.
*/
GoWebScanFx(kStatus) GoWebScanUtils_ResampleProfileX(GoWebScanInterpolation style, const kPoint16s* inPoints, kSSize pointCount, k16s* outProfile, kSSize profileCount, k32s xStart, k32s xRes, k32s interpolationWindow, k32s extrapolationWindow);

/**
* Fills gaps in input Z data. Null input Z values are filled leftmost valid point. Initial null regions 
* are filled with rightmost valid Z value.
*
* @public                       @memberof GoWebScanSdk
* @param  inProfile             Pointer to input profiles. 
* @param  outProfile            Pointer to output profiles. Can reuse the input buffer.
* @param  count                 Count of profile values.
* @param  defaultZValue         Value to fill gaps if no valid values are found.
* @return                       Operation status.
*/
GoWebScanFx(kStatus) GoWebScanUtils_FillResampledProfile(const k16s* inProfile, k16s* outProfile, kSSize count, k16s defaultZValue);

/**
* Reorients vision data to align with system coordinates in standard orienation. In standard
* orientation, the sensor X-axis is aligned to the system X-axis, and the sensor Y-axis is 
* opposite the system Y-axis.
*
* @public                   @memberof GoWebScanSdk
* @param  in                Input vision image. Type k8u (raw Bayer image).
* @param  out               Reoriented output vision image. Type k8u (raw Bayer image).
* @param  xOrientation      X-orientation of sensor.
* @param  yOrientation      Y-orientation of sensor.
* @return                   Operation status.
* @see                      GoWebScanSettings_XOrientation, GoWebScanSettings_YOrientation
*/
GoWebScanFx(kStatus) GoWebScanUtils_ApplyVisionOrientation(kImage in, kImage out, k32s xOrientation, k32s yOrientation);

/**
 * Applies color gains to input raw Bayer image. Gains are typically determined during
 * system calibration.
 * 
 * @public              @memberof GoWebScanSdk
 * @param   in          Input vision image. Type k8u (raw Bayer image).
 * @param   out         Output vision image. Type k8u (raw Bayer image).
 * @param   gains       Array of gains for all 4 channels for the image. Height of array is same
 *                      as input image, width is 4*input width. Type k16u.
 * @param   gainShift   Bit shift of gains.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_ApplyVisionGains(kImage in, kImage out, kArray2 gains, k32s gainShift);

/**
 * Reorients tracheid data to align with system coordinates in standard orienation. In standard
 * orientation, the sensor X-axis is aligned to the system X-axis, and the sensor z-axis is 
 * opposite the system z-axis. X data is converted to system coordinates.
 * 
 * @public                  @memberof GoWebScanSdk
 * @param   inPoints        Pointer to input tracheid points. 
 * @param   outPoints       Pointer to output tracheid points. 
 * @param   count           Number of points.
 * @param   xInCenter       X-center of sensor in system coordinates.
 * @param   xOrientation    X-orientation of sensor.
 * @return                  Operation status.
 * @see                     GoWebScanSettings_XOrientation
 */
GoWebScanFx(kStatus) GoWebScanUtils_ApplyTracheidOrientation(const GoWebScanTracheidPoint* inPoints, GoWebScanTracheidPoint* outPoints, kSSize count, k32s xInCenter, k32s xOrientation);

/**
 * Resamples tracheid data in the X-axis.
 * 
 * @public                      @memberof GoWebScanSdk
 * @param   inPoints            Pointer to input tracheid points.
 * @param   pointCount          Number of input points.
 * @param   outValues           Pointer to output resampled tracheid values.
 * @param   valueCount          Number of output values.
 * @param   xStart              Start location, in mils, of resampling. In system coordinates.
 * @param   xRes                Desired resolution, in mils/pixel, of resampled data.
 * @param   interpolationWindow Maximum input data X-gap, in mils, to be filled in with resampled
 *                              data.
 * @param   extrapolationWindow Distance, in mils, to extend resampling window around pairs of
 *                              input points.
 * @return                      Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_ResampleTracheidX(const GoWebScanTracheidPoint* inPoints, kSSize pointCount, GoWebScanTracheidValue* outValues, kSSize valueCount, k32s xStart, k32s xRes, k32s interpolationWindow, k32s extrapolationWindow);

/**
 * Replaces all values in a profile system tile with nulls.
 * 
 * @public              @memberof GoWebScanSdk
 * @param   systemData  Profile system tile. Type k16s.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_ClearProfileSystemTile(kArray2 systemData);

/**
 * Replaces all values in a vision system tile with zeroes.
 * 
 * @public              @memberof GoWebScanSdk
 * @param   systemData  Vision system tile. Type kRgb.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_ClearVisionSystemTile(kArray2 systemData);

/**
 * Replaces all values in a tracheid system tile with nulls.
 * 
 * @public              @memberof GoWebScanSdk
 * @param   systemData  Tracheid system tile. Type GoWebScanTracheidValue.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_ClearTracheidSystemTile(kArray3 systemData);

/**
 * Copies a profile tile from an individual sensor into a system tile at a specified column.
 * 
 * @public              @memberof GoWebScanSdk
 * @param   systemData  Profile system tile. Type k16s.
 * @param   childData   Profile sensor tile. Type k16s.
 * @param   x0          Column index within system tile to copy child data into.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_CopyProfileChildTile(kArray2 systemData, kArray2 childData, kSSize x0);

/**
 * Copies a vision tile from an individual sensor into a system tile at a specified column.
 * 
 * @public              @memberof GoWebScanSdk
 * @param   systemData  Vision system tile. Type kRgb.
 * @param   childData   Vision sensor tile. Type kRgb.
 * @param   x0          Column index within system tile to copy child data into.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_CopyVisionChildTile(kArray2 systemData, kArray2 childData, kSSize x0);

/**
 * Copies a tracheid tile from an individual sensor into a system tile at a specified column.
 * 
 * @public              @memberof GoWebScanSdk
 * @param   systemData  Tracheid system tile. Type GoWebScanTracheidValue.
 * @param   childData   Tracheid sensor tile. Type GoWebScanTracheidValue.
 * @param   x0          Column index within system tile to copy child data into.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_CopyTracheidChildTile(kArray3 systemData, kArray3 childData, kSSize x0);

/**
 * Copies two sensors' profile tiles into the system tile and blends the overlap in X. Data is
 * blended by a weighted average.
 * 
 * @public              @memberof GoWebScanSdk
 * @param   systemData  Profile system tile. Type k16s.
 * @param   childData0  First profile sensor tile. Type k16s.
 * @param   childData1  Second profile sensor tile. Type k16s.
 * @param   x0          Column index within system tile to copy first profile sensor tile into.
 * @param   x1          Column index within system tile to copy second profile sensor tile into.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_BlendProfileChildOverlap(kArray2 systemData, kArray2 childData0, kArray2 childData1, kSSize x0, kSSize x1);

/**
 * Copies two sensors' vision tiles into the system tile and blends the overlap in X. Data is
 * blended by a weighted average.
 * 
 * @public              @memberof GoWebScanSdk
 * @param   systemData  Vision system tile. Type kRgb.
 * @param   childData0  First vision sensor tile. Type kRgb.
 * @param   childData1  Second vision sensor tile. Type kRgb.
 * @param   x0          Column index within system tile to copy first vision sensor tile into.
 * @param   x1          Column index within system tile to copy second vision sensor tile into.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_BlendVisionChildOverlap(kArray2 systemData, kArray2 childData0, kArray2 childData1, kSSize x0, kSSize x1);

/**
* Copies two sensors' tracheid tiles into the system tile and blends the overlap in X. Data is
* blended by a weighted average.
* 
* @public              @memberof GoWebScanSdk
* @param   systemData  Tracheid system tile. Type GoWebScanTracheidValue.
* @param   childData0  First tracheid sensor tile. Type GoWebScanTracheidValue.
* @param   childData1  Second tracheid sensor tile. Type GoWebScanTracheidValue.
* @param   x0          Column index within system tile to copy first tracheid sensor tile into.
* @param   x1          Column index within system tile to copy second tracheid sensor tile into.
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanUtils_BlendTracheidChildOverlap(kArray3 systemData, kArray3 childData0, kArray3 childData1, kSSize x0, kSSize x1);

/**
 * Copies two sensors' profile tiles into the system tile and fills the gap in X. Data is filled
 * with interpolated data.
 * 
 * @public                  @memberof GoWebScanSdk
 * @param   systemData      Profile system tile. Type k16s.
 * @param   childData0      First profile sensor tile. Type k16s.
 * @param   childData1      Second profile sensor tile. Type k16s.
 * @param   x0              Column index within system tile to copy first profile sensor tile
 *                          into.
 * @param   x1              Column index within system tile to copy second profile sensor tile
 *                          into.
 * @param   gapSearchWindow Gaps are processed by searching for the last valid left element and
 *                          first valid right element within the gap search window.
 * @param   interpolation   Type of interpolation to use to fill gap.
 * @return                  Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_FillProfileChildGap(kArray2 systemData, kArray2 childData0, kArray2 childData1, kSSize x0, kSSize x1, k32s gapSearchWindow, GoWebScanInterpolation interpolation);

/**
* Copies two sensors' vision tiles into the system tile and fills the gap in X. Data is filled
* with the nearest neighbour's value.
* 
* @public                  @memberof GoWebScanSdk
* @param   systemData      Vision system tile. Type kRgb.
* @param   childData0      First vision sensor tile. Type kRgb.
* @param   childData1      Second vision sensor tile. Type kRgb.
* @param   x0              Column index within system tile to copy first vision sensor tile
*                          into.
* @param   x1              Column index within system tile to copy second vision sensor tile
*                          into.
* @param   gapSearchWindow Gaps are processed by searching for the last valid left element and
*                          first valid right element within the gap search window.
* @return                  Operation status.
*/
GoWebScanFx(kStatus) GoWebScanUtils_FillVisionChildGap(kArray2 systemData, kArray2 childData0, kArray2 childData1, kSSize x0, kSSize x1, k32s gapSearchWindow);

/**
* Copies two sensors' tracheid tiles into the system tile and fills the gap in X. Data is filled
* with the nearest neighbour's value.
* 
* @public                  @memberof GoWebScanSdk
* @param   systemData      Tracheid system tile. Type GoWebScanTracheidValue.
* @param   childData0      First tracheid sensor tile. Type GoWebScanTracheidValue.
* @param   childData1      Second tracheid sensor tile. Type GoWebScanTracheidValue.
* @param   x0              Column index within system tile to copy first tracheid sensor tile
*                          into.
* @param   x1              Column index within system tile to copy second tracheid sensor tile
*                          into.
* @param   gapSearchWindow Gaps are processed by searching for the last valid left element and
*                          first valid right element within the gap search window.
* @return                  Operation status.
*/
GoWebScanFx(kStatus) GoWebScanUtils_FillTracheidChildGap(kArray3 systemData, kArray3 childData0, kArray3 childData1, kSSize x0, kSSize x1, k32s gapSearchWindow);

/**
 * Determines presence information from input profiles and adds to existing presence
 * information. Presence is defined as true when a profile is non-null, false otherwise.
 * 
 * @public                  @memberof GoWebScanSdk
 * @param   presenceData    Pointer to input profile buffer.
 * @param   presenceTest    Pointer to output presence buffer. Can contain existing presence
 *                          information, otherwise all values should be set to 0.
 * @param   count           Number of profiles.
 * @return                  Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_AddPresenceData(const k16s* presenceData, kBool* presenceTest, kSSize count);

/**
 * Determines if an object is detected in a row of input presence data. An object is defined as
 * having a true presence count greater than the trigger threshold. The true presence values can
 * either be located anywhere in the row (global detection style) or must be contiguous (local
 * detection style).
 * 
 * @public                      @memberof GoWebScanSdk
 * @param   presenceTest        Pointer to input presence buffer.
 * @param   count               Number of presence values.
 * @param   detectionStyle      The board detection style.
 * @param   triggerThreshold    Minimum number of true presence data to trigger if an object is
 *                              detected.
 * @param   isDetected          Receives a boolean representing if an object was found in the
 *                              data.
 * @return                      Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_DetectObject(const kBool* presenceTest, kSSize count, GoWebScanDetectionStyle detectionStyle, k32s triggerThreshold, kBool* isDetected);

/**
 * Extracts a requested section from a profile system tile (representing merged and resampled
 * data from an entire plane of the system). The section is represented by a start column
 * (ceil(system x0 / xRes)). The output section array should be initialized to be the section
 * width (ceil((x1 - x0) / xRes)) and have a height matching the input profile system tile.
 * 
 * @public              @memberof GoWebScanSdk
 * @param   tile        Input profile system tile's data array. Type k16s.
 * @param   section     Output data array representing requested section. Array should be
 *                      constructed and initialized to the expected section width (width of
 *                      section in mils divided by X resolution) and expected section height
 *                      (same height as the profile system tile). Type k16s.
 * @param   tileX0      The profile system tile's start column. Can be determined from
 *                      GoWebScanConfig_XStartPix.
 * @param   sectionX0   The section's start column. Can be determined by the section x0 in
 *                      GoWebScanSettings divided by the X resolution.
 * @param   nullValue   Null value to fill data with if the section falls outside the system
 *                      tile's X field of view.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_ProfileTileToSection(kArray2 tile, kArray2 section, kSSize tileX0, kSSize sectionX0, k16s nullValue);

/**
* Extracts a requested section from a vision system tile (representing merged and resampled
* data from an entire plane of the system). The section is represented by a start column
* (ceil(system x0 / xRes)). The output section array should be initialized to be the section
* width (ceil((x1 - x0) / xRes)) and have a height matching the input vision system tile.
* 
* @public              @memberof GoWebScanSdk
* @param   tile        Input vision system tile's data array. Type kRgb.
* @param   section     Output data array representing requested section. Array should be
*                      constructed and initialized to the expected section width (width of
*                      section in mils divided by X resolution) and expected section height
*                      (same height as the profile system tile). Type kRgb.
* @param   tileX0      The vision system tile's start column. Can be determined from
*                      GoWebScanConfig_XStartPix.
* @param   sectionX0   The section's start column. Can be determined by the section x0 in
*                      GoWebScanSettings divided by the X resolution.
* @param   nullValue   Null value to fill data with if the section falls outside the system
*                      tile's X field of view.
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanUtils_VisionTileToSection(kArray2 tile, kArray2 section, kSSize tileX0, kSSize sectionX0, kRgb nullValue);

/**
 * Extracts a requested section from a tracheid system tile (representing merged and resampled
 * data from an entire plane of the system). The section is represented by a start column
 * (ceil(system x0 / xRes)). The output section array should be initialized to be the section
 * width (ceil((x1 - x0) / xRes)) and have a height matching the input vision system tile.
 * 
 * @public                  @memberof GoWebScanSdk
 * @param   tile            Input tracheid system tile's data array. Type GoWebScanTracheidValue.
 * @param   angleSection    Output angle array representing requested section. Output arrays
 *                          should be constructed and initialized to the expected section width
 *                          (width of section in mils divided by X resolution) and expected
 *                          section height (same height as the profile system tile). Type k8u.
 * @param   scatterSection  Output scatter array representing requested section. Type k8u.
 * @param   areaSection     Output area array representing requested section. Type k8u.
 * @param   tileX0          The vision system tile's start column. Can be determined from
 *                          GoWebScanConfig_XStartPix.
 * @param   sectionX0       The section's start column. Can be determined by the section x0 in
 *                          GoWebScanSettings divided by the X resolution.
 * @return                  Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_TracheidTileToSection(kArray3 tile, kArray2 angleSection, kArray2 scatterSection, kArray2 areaSection, kSSize tileX0, kSSize sectionX0);

/**
 * Determines the new Bayer color filter array pattern if the input data undergoes an X and Y
 * orientation change.
 * 
 * @public                  @memberof GoWebScanSdk
 * @param   cfa             Original color filter array type.
 * @param   xOrientation    The sensor X-orientation.
 * @param   yOrientation    The sensor Y-orientation.
 * @return                  New color filter array type.
 * @see                     GoWebScanSettings_XOrientation, GoWebScanSettings_YOrientation
 */
GoWebScanFx(kCfa) GoWebScanUtils_ReorientCfa(kCfa cfa, k32s xOrientation, k32s yOrientation);

/* Calibration utilities */

/**
 * Returns Bayer cell indexes for each color channel based on color filter array type.
 * 
 * @public          @memberof GoWebScanSdk
 * @param   cfa     Color filter array type.
 * @param   red     Receives the red index.
 * @param   greenR  Receives the green-red index.
 * @param   greenB  Receives the green-blue index.
 * @param   blue    Receives the blue index.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_BayerCellToIndices(kCfa cfa, kSSize* red, kSSize* greenR, kSSize* greenB, kSSize* blue); 

/**
 * Maps an RGB pixel's channels to a Bayer cell given the color filter array type.
 * 
 * @public          @memberof GoWebScanSdk
 * @param   cfa     Color filter array type.
 * @param   pixel   Input RGB pixel.
 * @param   values  Pointer to output Bayer cell buffer.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_RgbToBayerCell(kCfa cfa, kRgb pixel, k32s* values);  

/**
 * Linearly scales values from an input array to an output array of a different width.
 * 
 * @public              @memberof GoWebScanSdk
 * @param   in          Input array of 32s values.
 * @param   out         Output array of 32s values. Function will handle reallocating the array to the
 *                      specified outWidth.
 * @param   outWidth    Width of the output array.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_SampleYValues(kArray1 in, kArray1 out, kSSize outWidth); 

/**
 * Linearly scales gain coefficients from an input array to an output array of a different
 * height and width.
 * 
 * @public              @memberof GoWebScanSdk
 * @param   in          Input array of gain coefficients. Type k64f.
 * @param   out         Output array of scaled gain coefficients. Function will handle
 *                      reallocating the array to the specified outWidth and outHeight. Type k64f.
 * @param   outWidth    Width of the output array.
 * @param   outHeight   Height of the output array.
 * @param   alloc       Memory allocator (or kNULL for default).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_SampleGainCoefficientsChannel(kArray2 in, kArray2 out, kSSize outWidth, kSSize outHeight, kAlloc alloc); 

/**
 * Merges individual color channel gains into a Bayer pattern gain array.
 * 
 * @public          @memberof GoWebScanSdk
 * @param   cfa     Color filter array type of the output Bayer gain array.
 * @param   red     Input array of red gains. Same width and height as other input gains. Type
 *                  k64f.
 * @param   green   Input array of green gains. Same width and height as other input gains. Type
 *                  k64f.
 * @param   blue    Input array of blue gains. Same width and height as other input gains. Type
 *                  k64f.
 * @param   merged  Output array of merged gains. Will be reallocated to 2x width and height of
 *                  input gains (due to Bayer pattern). Type k64f.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_MergeGainCoefficentChannels(kCfa cfa, kArray2 red, kArray2 green, kArray2 blue, kArray2 merged); 

/**
 * Converts floating point gains to 16-bit unsigned gains scaled by 1 &lt;&lt;
 * GO_WEB_SCAN_FLATFIELD_RES_BITS.
 * 
 * @public      @memberof GoWebScanSdk
 * @param   in  Input floating point gains. Type k64f.
 * @param   out Output scaled integer gains. Type k16u.
 * @return      Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_ScaleGainImage(kArray2 in, kArray2 out); 

/**
 * Calculates count of non-null points.
 * 
 * @public              @memberof GoWebScanSdk
 * @param   points      Pointer to start of points buffer.
 * @param   pointCount  Number of points.
 * @param   validCount  Receives the count of non-null points.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanUtils_CountValidPoints(const kPoint16s* points, kSize pointCount, kSize* validCount);

#include <GoWebScanSdk/GoWebScanUtilities.x.h>

#endif