GoWebScanConfigNode.h

Go to the documentation of this file.

/**
* @file    GoWebScanConfigNode.h
* @brief   Declares a GoWebScanConfigNode 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_CONFIG_NODE_H
#define GO_WEB_SCAN_CONFIG_NODE_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>
#include <GoWebScanSdk/GoWebScanSettings.h>
#include <GoWebScanSdk/GoWebScanConfig.h>
#include <GoWebScanSdk/GoWebScanConfigSensor.h>
#include <GoWebScanSdk/GoWebScanCal.h>
#include <GoWebScanSdk/GoWebScanCalNode.h>
#include <GoWebScanSdk/GoWebScanConfigGroup.h>
#include <GoSdk/GoSdk.h>

/**
* @class   GoWebScanConfigNode
* @extends kObject
* @ingroup GoWebScanSdk-Config
* @brief   Represents a container for node-level parameters which are translated from user 
*          parameters set in GoWebScanSettings. This class maps the orientation of the node
*          to a standard orientation, performs the X-axis layout of node, and determines
*          node-specific algorithm parameters. This class is intended to be constructed from 
*          within a GoWebScanConfig object.
*          
*          GoWebScanConfig organizes the configuration at the system, group, sensor, and node
*          levels. Configuration of the groups within the system are represented by the
*          GoWebScanConfigGroup class, sensors by the GoWebScanConfigSensor class, and nodes
*          by the GoWebScanConfigNode class. GoWebScanConfig will construct and own these 
*          classes.
*/
typedef kObject GoWebScanConfigNode;

// Forward declarations
typedef kObject GoWebScanConfig;
typedef kObject GoWebScanConfigGroup;
typedef kObject GoWebScanConfigSensor;

/**
 * Constructs a GoWebScanConfigNode object.
 * 
 * @public  @memberof GoWebScanConfigNode
 * @param   node            Receives the constructed GoWebScanConfigNode object.
 * @param   bankId          Bank ID of node (index of node with respect to sensor).
 * @param   sensor          Configuration of parent sensor.
 * @param   settingsSensor  User settings for the sensor.
 * @param   calibration     System calibration. Set to kNULL if running system uncalibrated or if
 *                          running system calibration.
 * @param   sensorInfo      List of GoWebScanConfigSensorInfo structs representing information
 *                          from each sensor in the system.
 * @param   allocator       Memory allocator (or kNULL for default).
 * @return  Operation status.
 */
GoWebScanFx(kStatus) GoWebScanConfigNode_Construct(GoWebScanConfigNode* node, kSSize bankId, GoWebScanConfigSensor sensor,
    GoWebScanSettingsSensor settingsSensor, GoWebScanCal calibration, const GoWebScanConfigSensorInfo* sensorInfo, kAlloc allocator);

/**
* Gets the configuration of the sensor that the node is part of.
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          GoWebScanConfigSensor object representing sensor configuration.
*/
GoWebScanFx(GoWebScanConfigSensor) GoWebScanConfigNode_Parent(GoWebScanConfigNode node);

/**
* Gets the configuration of the group that the node is part of.
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          GoWebScanConfigGroup object representing group configuration.
*/
GoWebScanFx(GoWebScanConfigGroup) GoWebScanConfigNode_Group(GoWebScanConfigNode node);

/**
* Gets the configuration of the system that the node is part of.
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          GoWebScanConfig object representing system configuration.
*/
GoWebScanFx(GoWebScanConfig) GoWebScanConfigNode_Root(GoWebScanConfigNode node);

/**
 * Gets the serial number of the sensor the node is part of. In systems with vision sensors,
 * this is the profile sensor's ID.
 * 
 * @public          @memberof GoWebScanConfigNode
 * @param   node    GoWebScanConfigNode object.
 * @return          Profile sensor ID.
 */
GoWebScanFx(k32s) GoWebScanConfigNode_ProfileId(GoWebScanConfigNode node);

/**
* Gets the serial number of the vision sensor in a profile-vision sensor pair (for systems with
* vision). For systems without vision, this will return GO_WEB_SCAN_UNASSIGNED_SERIAL_NUMBER.
*
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          Vision sensor ID.
*/
GoWebScanFx(k32s) GoWebScanConfigNode_VisionId(GoWebScanConfigNode node);

/**
 * Gets the bank ID of the node (index of the node with respect to the sensor).
 * 
 * @public          @memberof GoWebScanConfigNode
 * @param   node    GoWebScanConfigNode object.
 * @return          Bank ID.
 */
GoWebScanFx(kSSize) GoWebScanConfigNode_BankId(GoWebScanConfigNode node);

/**
 * Gets the plane of the group that the node is part of.
 * 
 * @public          @memberof GoWebScanConfigNode
 * @param   node    GoWebScanConfigNode object.
 * @return          Plane of node.
 */
GoWebScanFx(GoWebScanSystemPlane) GoWebScanConfigNode_Plane(GoWebScanConfigNode node);

/**
 * Gets the column of the node. The columns increase left-to-right or right-to-left based on the
 * X orientation.
 * 
 * @public          @memberof GoWebScanConfigNode
 * @param   node    GoWebScanConfigNode object.
 * @return          Column of node.
 */
GoWebScanFx(kSSize) GoWebScanConfigNode_Column(GoWebScanConfigNode node);

/**
 * Gets the number of laser spots of the node.
 * 
 * @public          @memberof GoWebScanConfigNode
 * @param   node    GoWebScanConfigNode object.
 * @return          Number of laser spots.
 */
GoWebScanFx(kSSize) GoWebScanConfigNode_LaserDotCount(GoWebScanConfigNode node);

/**
* Gets the nominal X width of the node (mils).
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          X width of node (mils).
*/
GoWebScanFx(k32s) GoWebScanConfigNode_NominalFov(GoWebScanConfigNode node);

/**
* Gets the maximum Z value expected from profile sensors (depends on the
* sensor's active area) (mils).
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          Max Z (mils).
*/
GoWebScanFx(k32s) GoWebScanConfigNode_ProfileMaxZ(GoWebScanConfigNode node);

/**
* Gets the vision flatfield gain fractional bits preserved in integer calculations
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          Gain resolution bits.
*/
GoWebScanFx(k32s) GoWebScanConfigNode_VisionGainResBits(GoWebScanConfigNode node);

/**
 * Gets the expected width of vision data in pixels.
 * 
 * @public          @memberof GoWebScanConfigNode
 * @param   node    GoWebScanConfigNode object.
 * @return          Vision data width (pixels).
 */
GoWebScanFx(kSSize) GoWebScanConfigNode_VisionWidth(GoWebScanConfigNode node);

/**
* Gets the expected height of vision data in pixels.
* 
* @public           @memberof GoWebScanConfigNode
* @param   node     GoWebScanConfigNode object.
* @return           Vision data height (pixels).
*/
GoWebScanFx(kSSize) GoWebScanConfigNode_VisionHeight(GoWebScanConfigNode node);

/**
 * Gets the linear function representing the vision X resolution as a function of the Z range.
 * These coefficients are read from the sensor's GoGeoCal file.
 * 
 * @public          @memberof GoWebScanConfigNode
 * @param   node    GoWebScanConfigNode object.
 * @return          XRes(z) linear fit coefficients.
 */
GoWebScanFx(GoWebScanLinearFunction) GoWebScanConfigNode_VisionXResAsZ(GoWebScanConfigNode node);

/**
* Gets the linear function representing the vision Y resolution as a function of the Z range.
* These coefficients are read from the sensor's GoGeoCal file.
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          YRes(z) linear fit coefficients.
*/
GoWebScanFx(GoWebScanLinearFunction) GoWebScanConfigNode_VisionYResAsZ(GoWebScanConfigNode node);

/**
* Gets the linear function representing the vision Z offset as a function of the image row.
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          Z offset(angle) linear fit coefficients.
*/
GoWebScanFx(GoWebScanLinearFunction) GoWebScanConfigNode_VisionZOffAsR(GoWebScanConfigNode node);

/**
 * Gets the maximum Y-axis extent for vision data in mils. Calculates the extent using the
 * vision Y resolution, the expected maximum Z range for the profile-vision pair, and the
 * expected vision height.
 * 
 * @public          @memberof GoWebScanConfigNode
 * @param   node    GoWebScanConfigNode object.
 * @return          Maximum Y-axis extent (mils).
 */
GoWebScanFx(k32s) GoWebScanConfigNode_VisionMaxInputYExtent(GoWebScanConfigNode node);

/**
* Gets the minimum Y-axis extent for vision data in mils. Calculates the extent using the
* vision Y resolution, the expected minimum Z range for the profile-vision pair, and the
* expected vision height.
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          Minimum Y-axis extent (mils).
*/
GoWebScanFx(k32s) GoWebScanConfigNode_VisionMinInputYExtent(GoWebScanConfigNode node);

/**
 * Maps the RGB target intensities (for flatfield calibration) to a Bayer cell given the color
 * filter array type.
 * 
 * @public                  @memberof GoWebScanConfigNode
 * @param   node            GoWebScanConfigNode object.
 * @param   targets         Pointer to buffer representing Bayer cell.
 * @param   channelCount    Number of color channels in Bayer cell.
 * @param   cfa             Color filter array type of vision data.
 * @return                  Operation status.
 */
GoWebScanFx(kStatus) GoWebScanConfigNode_CalTargetVisionIntensity(GoWebScanConfigNode node, k32s* targets, kSize channelCount, kCfa cfa);

/**
 * Gets the width of vision gain images stored in calibration files.
 * 
 * @public          @memberof GoWebScanConfigNode
 * @param   node    GoWebScanConfigNode object.
 * @return          Width of gain images.
 */
GoWebScanFx(kSSize) GoWebScanConfigNode_VisionCalGainWidth(GoWebScanConfigNode node);

/**
* Gets the height of vision gain images stored in calibration files.
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          Height of gain images.
*/
GoWebScanFx(kSSize) GoWebScanConfigNode_VisionCalGainHeight(GoWebScanConfigNode node);

/**
* Gets the width of vision Y-offset array stored in calibration files.
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          Width of vision Y-offset array.
*/
GoWebScanFx(k32s) GoWebScanConfigNode_VisionCalYOffsetCount(GoWebScanConfigNode node);

/**
* Gets the X-orientation of the node. Normal (1) or opposite (0). Normal is defined as node
* X-axis aligned to the system X-axis in standard orientation (Refer to GoWebScanConfig for 
* a description of standard orientation).
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          Node X-orientation.
* @see             GoWebScanConfig    
*/
GoWebScanFx(k32s) GoWebScanConfigNode_XOrientation(GoWebScanConfigNode node);

/**
* Gets the Y-orientation of the node. Normal (1) or opposite (0). Normal is defined as node
* Y-axis opposite to the system Y-axis in standard orientation (Refer to GoWebScanConfig for 
* a description of standard orientation).
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          Node Y-orientation.
* @see             GoWebScanConfig  
*/
GoWebScanFx(k32s) GoWebScanConfigNode_YOrientation(GoWebScanConfigNode node);

/**
* Gets the Z-orientation of the node. Normal (1) or opposite (0). Normal is defined as node
* Z-axis opposite to the system Z-axis in standard orientation (Refer to GoWebScanConfig for 
* a description of standard orientation).
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          Node Z-orientation.
* @see             GoWebScanConfig  
*/
GoWebScanFx(k32s) GoWebScanConfigNode_ZOrientation(GoWebScanConfigNode node);

/**
* Gets the sensor calibration edge-orientation: Normal (1) or opposite (0).
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          Node calibration edge orientation.
*/
GoWebScanFx(k32s) GoWebScanConfigNode_EOrientation(GoWebScanConfigNode node);

/**
 * Gets the X-center of a data source in sensor coordinates (mils).
 * 
 * @public          @memberof GoWebScanConfigNode
 * @param   node    GoWebScanConfigNode object.
 * @param   source  Data source.
 * @return          X-center (mils).
 */
GoWebScanFx(k32s) GoWebScanConfigNode_OrientationXCenter(GoWebScanConfigNode node, GoWebScanDataSource source);

/**
* Gets the nominal X-center of the node in system coordinates (mils).
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          X-center (mils).
*/
GoWebScanFx(k32s) GoWebScanConfigNode_NominalXCenter(GoWebScanConfigNode node);

/**
* Gets the X-center of a data source in system coordinates (mils).
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @param   source  Data source.
* @return          X-center of data source (mils).
*/
GoWebScanFx(k32s) GoWebScanConfigNode_XCenter(GoWebScanConfigNode node, GoWebScanDataSource source);

/**
* Gets the X-axis start of resampled data in system coords for a data source (pixels).
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @param   source  Data source.
* @return          X-axis start of resampled data (pixels).
*/
GoWebScanFx(kSSize) GoWebScanConfigNode_XStartPix(GoWebScanConfigNode node, GoWebScanDataSource source);

/**
* Gets the X-axis end of resampled data in system coords for a data source (pixels).
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @param   source  Data source.
* @return          X-axis end of resampled data (pixels).
*/
GoWebScanFx(kSSize) GoWebScanConfigNode_XEndPix(GoWebScanConfigNode node, GoWebScanDataSource source);

/**
* Gets the X-axis count of resampled data in system coords for a data source.
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @param   source  Data source.
* @return          X-axis count of resampled data.
*/
GoWebScanFx(kSSize) GoWebScanConfigNode_XCountPix(GoWebScanConfigNode node, GoWebScanDataSource source);

/**
* Gets the approximate input data rate of a data source (bytes per second).
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @param   source  Data source.
* @return          Input data rate (bytes per second).
*/
GoWebScanFx(k64f) GoWebScanConfigNode_InputDataRate(GoWebScanConfigNode node, GoWebScanDataSource source);

/**
* Gets the approximate sampled data rate of a data source (bytes per travel-mils)
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @param   source  Data source.
* @return          Sampled data rate (bytes per travel-mils).
*/
GoWebScanFx(k64f) GoWebScanConfigNode_SampledDataRate(GoWebScanConfigNode node, GoWebScanDataSource source);

/**
* Gets the Y-offset from laser/tracheid plane to a data source's plane (mils).
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @param   source  Data source.
* @return          Y-offset (mils).
*/
GoWebScanFx(k64s) GoWebScanConfigNode_PlaneYOffset(GoWebScanConfigNode node, GoWebScanDataSource source);

/**
* Gets the minimum Y-interval for unique/retained data during calibration data collection (mils)
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @param   source  Data source.
* @return          Minimum Y-interval (mils).
*/
GoWebScanFx(k32s) GoWebScanConfigNode_MinYStep(GoWebScanConfigNode node, GoWebScanDataSource source);

/**
 * Gets the array of profile Z offsets calculated during system calibration. Offsets are per
 * laser spot.
 * 
 * @public          @memberof GoWebScanConfigNode
 * @param   node    GoWebScanConfigNode object.
 * @return          Z offsets. Type k16s. Size of GoWebScanConfigNode_LaserDotCount().
 */
GoWebScanFx(kArray1) GoWebScanConfigNode_ProfileZOffsets(GoWebScanConfigNode node);

/**
* Gets the array of profile Y offsets calculated during system calibration. Offsets are per
* laser spot.
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          Y offsets. Type k32s. Size of GoWebScanConfigNode_LaserDotCount().
*/
GoWebScanFx(kArray1) GoWebScanConfigNode_ProfileYOffsets(GoWebScanConfigNode node);

/**
 * Gets the array of vision Y offsets calculated during system calibration. Offsets are per
 * demosaiced vision column.
 * 
 * @public          @memberof GoWebScanConfigNode
 * @param   node    GoWebScanConfigNode object.
 * @return          Y offsets. Type k32s. Size of GoWebScanConfigNode_VisionWidth().
 */
GoWebScanFx(kArray1) GoWebScanConfigNode_VisionYOffsets(GoWebScanConfigNode node);

/**
 * Gets the array of vision Y offsets calculated during system calibration. Offsets are per raw
 * vision pixel.
 * 
 * @public          @memberof GoWebScanConfigNode
 * @param   node    GoWebScanConfigNode object.
 * @return          Vision gains. Type k16u. Size of GoWebScanConfigNode_VisionHeight() by
 *                  GoWebScanConfigNode_VisionWidth().
 */
GoWebScanFx(kArray2) GoWebScanConfigNode_VisionGains(GoWebScanConfigNode node);

/**
* Gets the array of tracheid Y offsets calculated during system calibration. Offsets are per
* laser spot.
* 
* @public          @memberof GoWebScanConfigNode
* @param   node    GoWebScanConfigNode object.
* @return          Y offsets. Type k32s. Size of GoWebScanConfigNode_LaserDotCount().
*/
GoWebScanFx(kArray1) GoWebScanConfigNode_TracheidYOffsets(GoWebScanConfigNode node);

/**
* Update the calibration.
*
* @public                  @memberof GoWebScanConfigNode
* @param   node            GoWebScanConfigNode object.
* @param   calibration     System calibration. Set to kNULL if running system uncalibrated or if running system calibration.
* @return                  Operation status.
*/
GoWebScanFx(kStatus) GoWebScanConfigNode_UpdateCalibration(GoWebScanConfigNode node, GoWebScanCal calibration);

#include <GoWebScanSdk/GoWebScanConfigNode.x.h>

#endif