8 #ifndef K_FIRESYNC_CAMERA_STATE_H
9 #define K_FIRESYNC_CAMERA_STATE_H
896 #include <kFireSync/Client/kCameraState.x.h>
Abstract base class for camera algorithm parameters.
k64u kCameraState_LeadInNs(kCameraState state)
Reports the lead-in time for the camera state.
kCameraAlgorithm kCameraState_AlgorithmType(kCameraState state)
Gets current configuration type for a hardware-accelerated camera algorithm.
kSize kCameraState_KneeCount(kCameraState state)
Gets the number of knee points in the gamma curve (multi slope).
kStatus kCameraState_SetTop(kCameraState state, k32u top, kAdjust adjustment=kADJUST_NONE)
Sets the vertical origin of the camera region-of-interest (ROI).
k64u kCameraState_DelayNs(kCameraState state)
Gets the delay for the camera state, in nanoseconds.
k32u kCameraState_XSubsampling(kCameraState state)
Gets the column subsampling amount for the camera state.
k64u kCameraState_DurationNs(kCameraState state)
Reports the total time required to execute this camera state, in nanoseconds.
kStatus kCameraState_DelayNsInfo(kCameraState state, kInfo64u *info)
Reports constraint and validity information for the DelayNs setting, in nanoseconds.
Represents a camera state configuration.
kStatus kCameraState_SetKneeCap(kCameraState state, kSize index, k64f normalizedOutputCap)
Sets the knee point's normalized reset point as a fraction of the maximum output. ...
kStatus kCameraState_InvertX(kCameraState state, kBool invert)
Sets the horizontal orientation for the camera state.
k64f kCameraState_KneeCap(kCameraState state, kSize index)
Gets the knee point's normalized reset point as a fraction of the maximum output. ...
k64u kCameraState_TotalLeadInNs(kCameraState state)
Reports the total lead-in time for the camera state.
kStatus kCameraState_AutoBlackEnabledInfo(kCameraState state, kInfoBool *info)
Reports constraint and validity information for the AutoBlackEnabled setting.
kStatus kCameraState_SetDelayNs(kCameraState state, k64u delay, kAdjust adjustment=kADJUST_NONE)
Sets the delay for the camera state, in nanoseconds.
kStatus kCameraState_SetGain(kCameraState state, kCameraGain channel, k64f gain)
Sets the gain for the specified gain channel.
kStatus kCameraState_ExposureModeInfo(kCameraState state, kInfoBits *info)
Reports constraint and validity information for the ExposureMode setting.
kStatus kCameraState_LeftInfo(kCameraState state, kInfo32u *info)
Reports constraint and validity information for the Left setting.
kSize kCameraState_MaxBatchSize(kCameraState state)
Gets the maximum message batching size for the camera state.
kStatus kCameraState_WidthInfo(kCameraState state, kInfo32u *info)
Reports constraint and validity information for the Width setting.
kStatus kCameraState_XSubsamplingInfo(kCameraState state, kInfoBits *info)
Reports constraint and validity information for the XSubsampling setting.
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:544
kStatus kCameraState_SetXSubsamplingMode(kCameraState state, kCameraSubsampling mode)
Sets the column subsampling mode for the camera state.
kStatus kCameraState_SetExposureMode(kCameraState state, kCameraExposure mode)
Sets the exposure mode for the camera state.
k64f kCameraState_Gain(kCameraState state, kCameraGain channel)
Gets the gain for the specified gain channel.
Type of adjustment to perform to bring a setting into conformance with its constraints.
#define kADJUST_NONE
No adjustment.
Definition: kInfo.h:48
Represents camera configuration.
Represents camera subsampling modes.
kStatus kCameraState_KneeTimeInfo(kCameraState state, kSize index, kInfo64f *info)
Reports constraint and validity information for the KneeTime setting.
k32u kCameraState_Width(kCameraState state)
Gets the width of the camera region-of-interest (ROI).
kBool kCameraState_IsTransitionValid(kCameraState previous, kCameraState current)
Reports validity of state transitions.
kStatus kCameraState_ExposureNsInfo(kCameraState state, kInfo64u *info)
Reports constraint and validity information for the ExposureNs setting.
kCameraExposure kCameraState_ExposureMode(kCameraState state)
Gets the exposure mode for the camera state.
kCameraSubsampling kCameraState_YSubsamplingMode(kCameraState state)
Gets the row subsampling mode for the camera state.
kStatus kCameraState_SetMaxBatchSize(kCameraState state, kSize maxBatchSize)
Sets the maximum message batching size.
Represents constraint and validity information for a double setting.
Definition: kInfo.h:438
kStatus kCameraState_SetGapNs(kCameraState state, k64u gap, kAdjust adjustment=kADJUST_NONE)
Sets the gap for the camera state, in nanoseconds.
kStatus kCameraState_InvertY(kCameraState state, kBool invert)
Sets the vertical orientation for the camera state.
kStatus kCameraState_EnableAutoGap(kCameraState state, kBool enabled)
Enables automatic gap calculation for the camera state.
Represents constraint and validity information for a 32-bit signed integer setting.
Definition: kInfo.h:166
kStatus kCameraState_RamImageCountInfo(kCameraState state, kInfo32u *info)
Reports constraint and validity information for the RamImageCount setting.
Essential declarations related to FireSync nodes.
kStatus kCameraState_SetLeft(kCameraState state, k32u left, kAdjust adjustment=kADJUST_NONE)
Sets the horizontal origin of the camera region-of-interest (ROI).
kStatus kCameraState_GainInfo(kCameraState state, kCameraGain channel, kInfo64f *info)
Reports constraint and validity information for a Gain setting.
k32u kCameraState_Top(kCameraState state)
Gets the vertical origin of the camera region-of-interest (ROI).
kStatus kCameraState_KneeCapInfo(kCameraState state, kSize index, kInfo64f *info)
Reports constraint and validity information for the KneeCap setting.
kBool kCameraState_YInverted(kCameraState state)
Gets the vertical orientation for the camera state.
kStatus kCameraState_SetKneeCount(kCameraState state, kSize count)
Sets the number of knee points.
kStatus kCameraState_SetKneeTime(kCameraState state, kSize index, k64f normalizedExposureTime)
Sets the knee point's normalized exposure time as a fraction of the total exposure time...
kStatus kCameraState_MaxBatchSizeInfo(kCameraState state, kInfoSize *info)
Reports constraint and validity information for the MaxBatchSize setting.
Represents camera gain channels.
k64u kCameraState_TotalLeadOutNs(kCameraState state)
Reports the total lead-out time for the camera state.
kStatus kCameraState_SetHeight(kCameraState state, k32u height, kAdjust adjustment=kADJUST_NONE)
Sets the height of the camera region-of-interest (ROI).
kBool kCameraState_AutoGapEnabled(kCameraState state)
Reports whether automatic gap is enabled for the camera state.
k32u kCameraState_Height(kCameraState state)
Gets the height of the camera region-of-interest (ROI).
kStatus kCameraState_SetXSubsampling(kCameraState state, k32u xSubampling)
Sets the column subsampling amount for the camera state.
kStatus kCameraState_SetRamImageCount(kCameraState state, k32u count)
Sets the number of images that will be stored in FPGA RAM for this camera state (used for testing/sim...
Represents camera exposure mode.
kStatus kCameraState_EnableAutoBlack(kCameraState state, kBool enabled)
Enables automatic black-level adjustment for the camera state.
kStatus kCameraState_TopInfo(kCameraState state, kInfo32u *info)
Reports constraint and validity information for the Top setting.
kStatus kCameraState_SetBlack(kCameraState state, k32s black, kAdjust adjustment=kADJUST_NONE)
Set the black-level for the camera state (used when AutoBlack is disabled).
kStatus kCameraState_XInvertInfo(kCameraState state, kInfoBool *info)
Reports constraint and validity information for the XInverted setting.
kStatus kCameraState_SetYSubsampling(kCameraState state, k32u ySubampling)
Sets the row subsampling amount for the camera state.
k32u kCameraState_Left(kCameraState state)
Gets the horizontal origin of the camera region-of-interest (ROI).
kStatus kCameraState_BlackInfo(kCameraState state, kInfo32s *info)
Reports constraint and validity information for the Black setting.
k32s kCameraState_Black(kCameraState state)
Gets the black-level for the camera state (used when AutoBlack is disabled).
kStatus kCameraState_SetWidth(kCameraState state, k32u width, kAdjust adjustment=kADJUST_NONE)
Sets the width of the camera region-of-interest (ROI).
kStatus kCameraState_FrameSize(kCameraState state, kSize *frameSize)
Gets the frame size of the state.
kSize kCameraState_Id(kCameraState state)
Gets the id of the state.
kStatus kCameraState_YSubsamplingModeInfo(kCameraState state, kInfoBits *info)
Reports constraint and validity information for the YSubsamplingMode setting.
k32u kCameraState_YSubsampling(kCameraState state)
Gets the row subsampling amount for the camera state.
kStatus kCameraState_WriteRamImage(kCameraState state, kSize index, kImage image)
Writes an image into FPGA RAM (used for testing/simulation).
Represents constraint and validity information for a 64-bit unsigned integer setting.
Definition: kInfo.h:234
kCameraSubsampling kCameraState_XSubsamplingMode(kCameraState state)
Gets the column subsampling mode for the camera state.
k64u kCameraState_ExposureNs(kCameraState state)
Gets the exposure for the camera state, in nanoseconds.
kStatus kCameraState_YInvertInfo(kCameraState state, kInfoBool *info)
Reports constraint and validity information for the YInverted setting.
kStatus kCameraState_YSubsamplingInfo(kCameraState state, kInfoBits *info)
Reports constraint and validity information for the YSubsampling setting.
Represents camera hardware-accelerated algorithm types.
kBool kCameraState_XInverted(kCameraState state)
Gets the horizontal orientation for the camera state.
k64u kCameraState_LeadOutNs(kCameraState state)
Reports the lead-out time for the camera state.
kStatus kCameraState_XSubsamplingModeInfo(kCameraState state, kInfoBits *info)
Reports constraint and validity information for the XSubsamplingMode setting.
kCamera kCameraState_Camera(kCameraState state)
Gets the camera object associated with this state object.
Represents constraint and validity information for a 32-bit unsigned integer setting.
Definition: kInfo.h:98
k64u kCameraState_GapNs(kCameraState state)
Gets the gap for the camera state, in nanoseconds.
kStatus kCameraState_SetExposureNs(kCameraState state, k64u exposure, kAdjust adjustment=kADJUST_NONE)
Sets the exposure for the camera state, in nanoseconds.
Represents constraint and validity information for a kSize setting.
Definition: kInfo.h:370
kAlgInfo kCameraState_AlgorithmConfig(kCameraState state)
Gets configuration for a hardware-accelerated camera algorithm.
kStatus kCameraState_AutoGapEnabledInfo(kCameraState state, kInfoBool *info)
Reports constraint and validity information for the AutoGapEnabled setting.
k64u kCameraState_PreExposureNs(kCameraState state)
Estimates the time for which the camera might be sensitive to light prior to nominal exposure...
kStatus kCameraState_GapNsInfo(kCameraState state, kInfo64u *info)
Reports constraint and validity information for the GapNs setting.
kStatus kCameraState_HeightInfo(kCameraState state, kInfo32u *info)
Reports constraint and validity information for the Height setting.
k64f kCameraState_KneeTime(kCameraState state, kSize index)
Gets the knee point's normalized exposure time as a fraction of the total exposure time...
kStatus kCameraState_KneeCountInfo(kCameraState state, kInfoSize *info)
Reports constraint and validity information for the KneeCount setting.
k64u kCameraState_PostExposureNs(kCameraState state)
Estimates the time for which the camera might be sensitive to light after nominal exposure...
k32u kCameraState_RamImageCount(kCameraState state)
Gets the number of images stored in FPGA RAM for this camera state (used for testing/simulation).
kStatus kCameraState_SetYSubsamplingMode(kCameraState state, kCameraSubsampling mode)
Sets the row subsampling mode for the camera state.
Represents constraint and validity information for a boolean setting.
Definition: kInfo.h:493
kBool kCameraState_AutoBlackEnabled(kCameraState state)
Reports whether automatic black-level adjustment is enabled for the camera state. ...
