GoWebScanCalNode.h

Go to the documentation of this file.

/**
* @file    GoWebScanCalNode.h
* @brief   Declares a GoWebScanCalNode object.
*
* @internal
* Copyright (C) 2017-2026 by LMI Technologies Inc.
* Licensed under the MIT License.
* Redistributed files must retain the above copyright notice.
*/

#ifndef GO_WEB_SCAN_CAL_NODE_H
#define GO_WEB_SCAN_CAL_NODE_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>

/**
* @class   GoWebScanCalNode
* @extends kObject
* @ingroup GoWebScanSdk-Calibration
* @brief   Represents a container for node-level system calibration data. Refer to GoWebScanCal
*          for a description of system calibration.
* @see     GoWebScanCal    
*/
typedef kObject GoWebScanCalNode;

// Forward declaration
typedef kObject GoWebScanCal; 

/**
 * Constructs a GoWebScanCalNode object.
 * 
 * @public              @memberof GoWebScanCalNode
 * @param   node        Receives the constructed GoWebScanCalNode object.
 * @param   cal         System calibration object that the node is part of.
 * @param   allocator   Memory allocator (or kNULL for default).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalNode_Construct(GoWebScanCalNode* node, GoWebScanCal cal, kAlloc allocator);

/**
 * Gets the system plane the node is located in.
 * 
 * @public          @memberof GoWebScanCalNode
 * @param   node    GoWebScanCalNode object.
 * @return          System plane.
 */
GoWebScanFx(GoWebScanSystemPlane) GoWebScanCalNode_Plane(GoWebScanCalNode node); 

/**
* Gets the column the node is located in. 
* 
* @public          @memberof GoWebScanCalNode
* @param   node    GoWebScanCalNode object.
* @return          Column index of node.
* @see             GoWebScanConfigNode_Column                
*/
GoWebScanFx(k32s) GoWebScanCalNode_Column(GoWebScanCalNode node); 

/**
* Gets the sensor ID of the node. For systems with vision sensors, this will be the ID
* of the connected profile sensor.
* 
* @public          @memberof GoWebScanCalNode
* @param   node    GoWebScanCalNode object.
* @return          Device ID of node.
*/
GoWebScanFx(k32s) GoWebScanCalNode_DeviceId(GoWebScanCalNode node); 

/**
* Gets the bank ID of the node. This is the index with respect to the sensor.
* 
* @public          @memberof GoWebScanCalNode
* @param   node    GoWebScanCalNode object.
* @return          Bank ID of node.
*/
GoWebScanFx(k32s) GoWebScanCalNode_BankId(GoWebScanCalNode node); 

/**
 * Sets the X offset of the node in mils. This is only used when detection of locators is
 * enabled during vision calibration, otherwise the offset is 0.
 * 
 * @public          @memberof GoWebScanCalNode
 * @param   node    GoWebScanCalNode object.
 * @param   xOffset X offset (mils).
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalNode_SetXOffset(GoWebScanCalNode node, k32s xOffset); 

/**
* Gets the X offset of the node in mils. This is only used when detection of locators is
* enabled during vision calibration, otherwise the offset is 0.
* 
* @public          @memberof GoWebScanCalNode
* @param   node    GoWebScanCalNode object.
* @return          X offset (mils).
*/
GoWebScanFx(k32s) GoWebScanCalNode_XOffset(GoWebScanCalNode node); 

/**
 * Gets the array of profile Y offsets, which represents alignment offsets in Y per spot.
 * 
 * @public          @memberof GoWebScanCalNode
 * @param   node    GoWebScanCalNode object.
 * @return          Array of profile Y offsets. Type k32s.
 */
GoWebScanFx(kArray1) GoWebScanCalNode_ProfileYOffsets(GoWebScanCalNode node); 

/**
 * Gets the array of profile Z offsets, which represents alignment offsets in Z per spot.
 * 
 * @public          @memberof GoWebScanCalNode
 * @param   node    GoWebScanCalNode object.
 * @return          Array of profile Z offsets. Type k16s.
 */
GoWebScanFx(kArray1) GoWebScanCalNode_ProfileZOffsets(GoWebScanCalNode node); 

/**
 * Gets the array of vision Y offsets, which represents alignment offsets in Y per column of 
 * the vision image.
 * 
 * @public          @memberof GoWebScanCalNode
 * @param   node    GoWebScanCalNode object.
 * @return          Array of vision Y offsets. Type k32s.
 */
GoWebScanFx(kArray1) GoWebScanCalNode_VisionYOffsets(GoWebScanCalNode node); 

/**
 * Gets the array of vision red gains, which represent correction gains to produce a balanced 
 * white image. Gains are for each pixel of the vision image.
 * 
 * @public          @memberof GoWebScanCalNode
 * @param   node    GoWebScanCalNode object.
 * @return          Array of vision red gains. Type k64f.
 */
GoWebScanFx(kArray2) GoWebScanCalNode_VisionRGains(GoWebScanCalNode node); 

/**
 * Gets the array of vision green gains, which represent correction gains to produce a balanced 
 * white image. Gains are for each pixel of the vision image.
 * 
 * @public          @memberof GoWebScanCalNode
 * @param   node    GoWebScanCalNode object.
 * @return          Array of vision green gains. Type k64f.
 */
GoWebScanFx(kArray2) GoWebScanCalNode_VisionGGains(GoWebScanCalNode node); 

/**
 * Gets the array of vision blue gains, which represent correction gains to produce a balanced 
 * white image. Gains are for each pixel of the vision image.
 * 
 * @public          @memberof GoWebScanCalNode
 * @param   node    GoWebScanCalNode object.
 * @return          Array of vision blue gains. Type k64f.
 */
GoWebScanFx(kArray2) GoWebScanCalNode_VisionBGains(GoWebScanCalNode node); 

/**
 * Sets the array of profile Y offsets, which represents alignment offsets in Y per spot.
 *
 * @public          @memberof GoWebScanCalNode
 * @param   node    GoWebScanCalNode object.
 * @param   offsets Array of profile Y offsets. Type k32s.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalNode_SetProfileYOffsets(GoWebScanCalNode node, kArray1 offsets);

/**
 * Sets the array of profile Z offsets, which represents alignment offsets in Z per spot.
 *
 * @public          @memberof GoWebScanCalNode
 * @param   node    GoWebScanCalNode object.
 * @param   offsets Array of profile Z offsets. Type k16s.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalNode_SetProfileZOffsets(GoWebScanCalNode node, kArray1 offsets);

/**
 * Sets the array of vision Y offsets, which represents alignment offsets in Y per column of
 * the vision image.
 *
 * @public          @memberof GoWebScanCalNode
 * @param   node    GoWebScanCalNode object.
 * @param   offsets Array of vision Y offsets. Type k32s.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalNode_SetVisionYOffsets(GoWebScanCalNode node, kArray1 offsets);

/**
 * Update the array of vision red gains, which represent correction gains to produce a balanced
 * white image. Gains are for each pixel of the vision image. The gains are compressed to 8 bit 
 * values on a logarithmic scale, and therefore may not match the input values directly.
 *
 * @public          @memberof GoWebScanCalNode
 * @param   node    GoWebScanCalNode object.
 * @param   gains   Array of vision red gains. Type k64f.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalNode_UpdateVisionRGains(GoWebScanCalNode node, kArray2 gains);

/**
 * Update the array of vision green gains, which represent correction gains to produce a balanced
 * white image. Gains are for each pixel of the vision image. The gains are compressed to 8 bit 
 * values on a logarithmic scale, and therefore may not match the input values directly.
 *
 * @public          @memberof GoWebScanCalNode
 * @param   node    GoWebScanCalNode object.
 * @param   gains   Array of vision green gains. Type k64f.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalNode_UpdateVisionGGains(GoWebScanCalNode node, kArray2 gains);

/**
 * Update the array of vision blue gains, which represent correction gains to produce a balanced
 * white image. Gains are for each pixel of the vision image. The gains are compressed to 8 bit 
 * values on a logarithmic scale, and therefore may not match the input values directly.
 *
 * @public          @memberof GoWebScanCalNode
 * @param   node    GoWebScanCalNode object.
 * @param   gains   Array of vision blue gains. Type k64f.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalNode_UpdateVisionBGains(GoWebScanCalNode node, kArray2 gains);

/**
 * Gets the color filter array type of the node (for vision only).
 * 
 * @public          @memberof GoWebScanCalNode
 * @param   node    GoWebScanCalNode object.
 * @return          Color filter array type.
 */
GoWebScanFx(kCfa) GoWebScanCalNode_Cfa(GoWebScanCalNode node);

/**
 * Sets the color filter array type of the node (for vision only).
 * 
 * @public          @memberof GoWebScanCalNode
 * @param   node    GoWebScanCalNode object.
 * @param   cfa     Color filter array type.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalNode_SetCfa(GoWebScanCalNode node, kCfa cfa);

#include <GoWebScanSdk/GoWebScanCalNode.x.h>

#endif