Basler_UniversalChunkDataParams::CUniversalChunkDataParams_Params#
#include <pylon/_BaslerUniversalChunkDataParams.h>
Inherits from Basler_UniversalChunkDataParams::CUniversalChunkDataParams_Params_v9_0_0
Inherited by Pylon::CBaslerUniversalGrabResultData
Public Attributes#
Name | |
---|---|
Pylon::IEnumParameterT< BslChunkAutoBrightnessStatusEnums > & | BslChunkAutoBrightnessStatus Indicates the status of the target brightness adjustments performed by the Exposure Auto and Gain Auto auto functions - Applies to: ace 2 GigE, ace 2 USB, dart 2 USB and dart USB. |
Pylon::IEnumParameterT< BslChunkTimestampSelectorEnums > & | BslChunkTimestampSelector Sets which information should be included in the Chunk Timestamp Value chunk - Applies to: ace 2 GigE, ace 2 USB, dart 2 USB and dart USB. |
Pylon::IIntegerEx & | BslChunkTimestampValue Value of the timestamp when the image was acquired - Applies to: ace 2 GigE, ace 2 USB, dart 2 USB and dart USB. |
Pylon::IFloatEx & | ChunkBslLineRatio Returns the exposure ratio of the selected output line - Applies to: Stereo ace. |
Pylon::IFloatEx & | ChunkBslMaxDepth Maximum depth that was used - Applies to: Stereo ace. |
Pylon::IFloatEx & | ChunkBslMinDepth Minimum depth that was used - Applies to: Stereo ace. |
Pylon::IFloatEx & | ChunkBslNoise Returns the noise of the image - Applies to: Stereo ace. |
Pylon::IBooleanEx & | ChunkBslReducedDepthRange Signals if the depth range had to be reduced due to memory limits - Applies to: Stereo ace. |
Pylon::IEnumParameterT< ChunkComponentIDEnums > & | ChunkComponentID Returns the component of the payload image - Applies to: Stereo ace. |
Pylon::IIntegerEx & | ChunkComponentIDValue Returns a unique Identifier value that corresponds to the selected chunk component - Applies to: Stereo ace. |
Pylon::IEnumParameterT< ChunkComponentSelectorEnums > & | ChunkComponentSelector Selects the Component from which to retreive data from - Applies to: Stereo ace. |
Pylon::IIntegerEx & | ChunkComponents Returns the bitmask of components contained in this block - Applies to: Stereo ace. |
Pylon::IEnumParameterT< ChunkCounterSelectorEnums > & | ChunkCounterSelector Sets which counter to retrieve chunk data from - Applies to: ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB. |
Pylon::IIntegerEx & | ChunkCounterValue Value of the selected chunk counter - Applies to: ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB. |
Pylon::IIntegerEx & | ChunkDecimationHorizontal Horizontal sub-sampling of the image - Applies to: Stereo ace. |
Pylon::IIntegerEx & | ChunkDecimationVertical Vertical sub-sampling of the image - Applies to: Stereo ace. |
Pylon::IIntegerEx & | ChunkDynamicRangeMax Maximum possible pixel value in the acquired image - Applies to: GigE and ace 2 GigE. |
Pylon::IIntegerEx & | ChunkDynamicRangeMin Minimum possible pixel value in the acquired image - Applies to: GigE and ace 2 GigE. |
Pylon::IFloatEx & | ChunkExposureTime Exposure time used to acquire the image - Applies to: GigE, Stereo ace, ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB. |
Pylon::IEnumParameterT< ChunkExposureTimeSelectorEnums > & | ChunkExposureTimeSelector Sets which exposure time to retrieve chunk data from - Applies to: ace 2 GigE, ace 2 USB and dart USB. |
Pylon::IIntegerEx & | ChunkFrameID Unique identifier of the current frame - Applies to: Stereo ace, ace 2 GigE, ace 2 USB, dart 2 USB and dart USB. |
Pylon::IIntegerEx & | ChunkFrameTriggerCounter Value of the Frame Trigger counter when the image was acquired - Applies to: GigE. |
Pylon::IIntegerEx & | ChunkFrameTriggerIgnoredCounter Value of the Frame Trigger Ignored counter when the image was acquired - Applies to: GigE. |
Pylon::IIntegerEx & | ChunkFramecounter Value of the Frame counter when the image was acquired - Applies to: GigE. |
Pylon::IIntegerEx & | ChunkFramesPerTriggerCounter Value of the Frames per Trigger counter when the image was acquired - Applies to: GigE. |
Pylon::IFloatEx & | ChunkGain Gain used during image acquisition - Applies to: Stereo ace, ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB. |
Pylon::IIntegerEx & | ChunkGainAll Gain All value of the acquired image - Applies to: GigE. |
Pylon::IEnumParameterT< ChunkGainSelectorEnums > & | ChunkGainSelector Sets which gain channel to retrieve chunk data from - Applies to: ace 2 GigE, ace 2 USB, ace USB and dart USB. |
Pylon::IIntegerEx & | ChunkHeight AOI height of the acquired image - Applies to: GigE, Stereo ace and ace 2 GigE. |
Pylon::IIntegerEx & | ChunkInputStatusAtLineTriggerBitsPerLine Number of bits per line used for the Input Status At Line Trigger parameter - Applies to: GigE. |
Pylon::IIntegerEx & | ChunkInputStatusAtLineTriggerIndex Index number used for the Input Status At Line Trigger parameter - Applies to: GigE. |
Pylon::IIntegerEx & | ChunkInputStatusAtLineTriggerValue Value indicating the status of the camera's input lines when a specific line was acquired - Applies to: GigE. |
Pylon::IEnumParameterT< ChunkLineSelectorEnums > & | ChunkLineSelector Selects the output for which to read the LineSource - Applies to: Stereo ace. |
Pylon::IEnumParameterT< ChunkLineSourceEnums > & | ChunkLineSource Line source for selected line - Applies to: Stereo ace. |
Pylon::IBooleanEx & | ChunkLineStatus Returns the current status of the selected input or output Line - Applies to: Stereo ace. |
Pylon::IIntegerEx & | ChunkLineStatusAll Bit field that indicates the status of all of the camera's input and output lines when the image was acquired - Applies to: GigE, Stereo ace, ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB. |
Pylon::IIntegerEx & | ChunkLineTriggerCounter Value of the Line Trigger counter when the image was acquired - Applies to: GigE. |
Pylon::IIntegerEx & | ChunkLineTriggerEndToEndCounter Value of the Line Trigger End to End counter when the image was acquired - Applies to: GigE. |
Pylon::IIntegerEx & | ChunkLineTriggerIgnoredCounter Value of the Line Trigger Ignored counter when the image was acquired - Applies to: GigE. |
Pylon::IIntegerEx & | ChunkOffsetX X offset of the AOI of the acquired image - Applies to: GigE, Stereo ace and ace 2 GigE. |
Pylon::IIntegerEx & | ChunkOffsetY Y offset of the AOI of the acquired image - Applies to: GigE, Stereo ace and ace 2 GigE. |
Pylon::IIntegerEx & | ChunkPartIndex Returns index of the image part in this block depending on selected component - Applies to: Stereo ace. |
Pylon::IIntegerEx & | ChunkPayloadCRC16 CRC checksum of the acquired image - Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB. |
Pylon::IIntegerEx & | ChunkPixelDynamicRangeMax Maximum possible pixel value in the acquired image - Applies to: ace 2 GigE. |
Pylon::IIntegerEx & | ChunkPixelDynamicRangeMin Minimum possible pixel value in the acquired image - Applies to: ace 2 GigE. |
Pylon::IEnumParameterT< ChunkPixelFormatEnums > & | ChunkPixelFormat Indicates the pixel format of the acquired image - Applies to: GigE, Stereo ace and ace 2 GigE. |
Pylon::IFloatEx & | ChunkScan3dBaseline Baseline of the stereo cameras - Applies to: Stereo ace. |
Pylon::IFloatEx & | ChunkScan3dCoordinateOffset Returns the offset when transforming a pixel from relative coordinates to world coordinates - Applies to: Stereo ace. |
Pylon::IFloatEx & | ChunkScan3dCoordinateScale Returns the scale factor when transforming a pixel from relative coordinates to world coordinates - Applies to: Stereo ace. |
Pylon::IEnumParameterT< ChunkScan3dCoordinateSelectorEnums > & | ChunkScan3dCoordinateSelector Selects which Coordinate to retrieve data from - Applies to: Stereo ace. |
Pylon::IEnumParameterT< ChunkScan3dDistanceUnitEnums > & | ChunkScan3dDistanceUnit Returns the Distance Unit of the payload image - Applies to: Stereo ace. |
Pylon::IFloatEx & | ChunkScan3dFocalLength Focal length - Applies to: Stereo ace. |
Pylon::IBooleanEx & | ChunkScan3dInvalidDataFlag Returns if a specific non-valid data flag is used in the payload image - Applies to: Stereo ace. |
Pylon::IFloatEx & | ChunkScan3dInvalidDataValue Returns the value which identifies a non-valid pixel - Applies to: Stereo ace. |
Pylon::IEnumParameterT< ChunkScan3dOutputModeEnums > & | ChunkScan3dOutputMode Returns the Calibrated Mode of the payload image - Applies to: Stereo ace. |
Pylon::IFloatEx & | ChunkScan3dPrincipalPointU Horizontal position of the principal point - Applies to: Stereo ace. |
Pylon::IFloatEx & | ChunkScan3dPrincipalPointV Vertical position of the principal point - Applies to: Stereo ace. |
Pylon::IIntegerEx & | ChunkSequenceSetIndex Sequence set index number related to the acquired image - Applies to: GigE. |
Pylon::IIntegerEx & | ChunkSequencerSetActive Index of the active sequencer set - Applies to: ace 2 GigE, ace 2 USB and ace USB. |
Pylon::IIntegerEx & | ChunkShaftEncoderCounter Value of the Shaft Encoder counter when the image was acquired - Applies to: GigE. |
Pylon::IIntegerEx & | ChunkStride Number of bytes of data between the beginning of one line in the acquired image and the beginning of the next line in the acquired image - Applies to: GigE and ace 2 GigE. |
Pylon::IIntegerEx & | ChunkTimestamp Value of the timestamp when the image was acquired - Applies to: GigE, Stereo ace and ace USB. |
Pylon::IIntegerEx & | ChunkTriggerinputcounter Value of the Trigger Input counter when the image was acquired - Applies to: GigE. |
Pylon::IIntegerEx & | ChunkVirtLineStatusAll Status of all of the camera's virtual input and output lines when the image was acquired - Applies to: GigE. |
Pylon::IIntegerEx & | ChunkWidth Width of the AOI of the acquired image - Applies to: GigE, Stereo ace and ace 2 GigE. |
Detailed Description#
A parameter class containing all parameters as members that are available for chunk data of Basler camera devices.
The parameter class is used by the CBaslerUniversalGrabResultPtr
class. More information can be found in the code of the [Grab_ChunkImage] sample.
Public Attributes Documentation#
variable BslChunkAutoBrightnessStatus#
Indicates the status of the target brightness adjustments performed by the Exposure Auto and Gain Auto auto functions - Applies to: ace 2 GigE, ace 2 USB, dart 2 USB and dart USB.
Visibility: Expert
variable BslChunkTimestampSelector#
Sets which information should be included in the Chunk Timestamp Value chunk - Applies to: ace 2 GigE, ace 2 USB, dart 2 USB and dart USB.
Visibility: Expert
Selecting Parameters: BslChunkTimestampValue
variable BslChunkTimestampValue#
Value of the timestamp when the image was acquired - Applies to: ace 2 GigE, ace 2 USB, dart 2 USB and dart USB.
Visibility: Expert
Selected by: BslChunkTimestampSelector
variable ChunkBslLineRatio#
Returns the exposure ratio of the selected output line - Applies to: Stereo ace.
Visibility: Expert
Selected by: ChunkLineSelector
variable ChunkBslMaxDepth#
Maximum depth that was used - Applies to: Stereo ace.
Visibility: Expert
variable ChunkBslMinDepth#
Minimum depth that was used - Applies to: Stereo ace.
Minimum depth that was used. This can be higher than anticipated due to camera or memory requirements.
Visibility: Expert
variable ChunkBslNoise#
Returns the noise of the image - Applies to: Stereo ace.
Visibility: Expert
variable ChunkBslReducedDepthRange#
Signals if the depth range had to be reduced due to memory limits - Applies to: Stereo ace.
Visibility: Expert
variable ChunkComponentID#
Returns the component of the payload image - Applies to: Stereo ace.
Returns the component of the payload image. This can be used to identify the image component of a generic part in a multi-part transfer.
Visibility: Expert
Selected by: ChunkComponentSelector
variable ChunkComponentIDValue#
Returns a unique Identifier value that corresponds to the selected chunk component - Applies to: Stereo ace.
Visibility: Expert
Selected by: ChunkComponentSelector
variable ChunkComponentSelector#
Selects the Component from which to retreive data from - Applies to: Stereo ace.
Visibility: Expert
Selecting Parameters: ChunkComponentID, ChunkComponentIDValue, ChunkDecimationHorizontal, ChunkDecimationVertical, ChunkHeight, ChunkOffsetX, ChunkOffsetY, ChunkPartIndex, ChunkPixelFormat, ChunkScan3dFocalLength, ChunkScan3dPrincipalPointU, ChunkScan3dPrincipalPointV and ChunkWidth
variable ChunkComponents#
Returns the bitmask of components contained in this block - Applies to: Stereo ace.
Visibility: Expert
variable ChunkCounterSelector#
Sets which counter to retrieve chunk data from - Applies to: ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB.
Visibility: Expert
Selecting Parameters: ChunkCounterValue
variable ChunkCounterValue#
Value of the selected chunk counter - Applies to: ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB.
Visibility: Beginner
Selected by: ChunkCounterSelector
variable ChunkDecimationHorizontal#
Horizontal sub-sampling of the image - Applies to: Stereo ace.
Visibility: Expert
Selected by: ChunkComponentSelector
variable ChunkDecimationVertical#
Vertical sub-sampling of the image - Applies to: Stereo ace.
Visibility: Expert
Selected by: ChunkComponentSelector
variable ChunkDynamicRangeMax#
Maximum possible pixel value in the acquired image - Applies to: GigE and ace 2 GigE.
Visibility: Beginner
variable ChunkDynamicRangeMin#
Minimum possible pixel value in the acquired image - Applies to: GigE and ace 2 GigE.
Visibility: Beginner
variable ChunkExposureTime#
Exposure time used to acquire the image - Applies to: GigE, Stereo ace, ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB.
Visibility: Beginner
Selected by: ChunkExposureTimeSelector
variable ChunkExposureTimeSelector#
Sets which exposure time to retrieve chunk data from - Applies to: ace 2 GigE, ace 2 USB and dart USB.
Visibility: Expert
Selecting Parameters: ChunkExposureTime
variable ChunkFrameID#
Unique identifier of the current frame - Applies to: Stereo ace, ace 2 GigE, ace 2 USB, dart 2 USB and dart USB.
Unique identifier of the current frame. The frame ID starts at 0 and keeps incrementing by 1 for each exposed image until the camera is powered off. The maximum value is 2^48.
Visibility: Expert
variable ChunkFrameTriggerCounter#
Value of the Frame Trigger counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
variable ChunkFrameTriggerIgnoredCounter#
Value of the Frame Trigger Ignored counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
variable ChunkFramecounter#
Value of the Frame counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
variable ChunkFramesPerTriggerCounter#
Value of the Frames per Trigger counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
variable ChunkGain#
Gain used during image acquisition - Applies to: Stereo ace, ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB.
Visibility: Beginner
Selected by: ChunkGainSelector
variable ChunkGainAll#
Gain All value of the acquired image - Applies to: GigE.
Visibility: Beginner
variable ChunkGainSelector#
Sets which gain channel to retrieve chunk data from - Applies to: ace 2 GigE, ace 2 USB, ace USB and dart USB.
Visibility: Expert
Selecting Parameters: ChunkGain
variable ChunkHeight#
AOI height of the acquired image - Applies to: GigE, Stereo ace and ace 2 GigE.
Visibility: Beginner
Selected by: ChunkComponentSelector
variable ChunkInputStatusAtLineTriggerBitsPerLine#
Number of bits per line used for the Input Status At Line Trigger parameter - Applies to: GigE.
Visibility: Beginner
variable ChunkInputStatusAtLineTriggerIndex#
Index number used for the Input Status At Line Trigger parameter - Applies to: GigE.
Index number used for the Input Status At Line Trigger parameter. The index number can be used to get the state of the camera's input lines when a specific line was acquired. For example, if you want to know the state of the camera's input lines when line 30 was acquired, set the index to 30, then retrieve the value of Status Index parameter.
Visibility: Beginner
variable ChunkInputStatusAtLineTriggerValue#
Value indicating the status of the camera's input lines when a specific line was acquired - Applies to: GigE.
Value indicating the status of the camera's input lines when a specific line was acquired. The information is stored in a 4-bit value (bit 0 = input line 1 state, bit 1 = input line 2 state etc.). For more information, see the Status Index parameter documentation.
Visibility: Beginner
variable ChunkLineSelector#
Selects the output for which to read the LineSource - Applies to: Stereo ace.
Visibility: Expert
Selecting Parameters: ChunkBslLineRatio, ChunkLineSource and ChunkLineStatus
variable ChunkLineSource#
Line source for selected line - Applies to: Stereo ace.
Visibility: Expert
Selected by: ChunkLineSelector
variable ChunkLineStatus#
Returns the current status of the selected input or output Line - Applies to: Stereo ace.
Visibility: Expert
Selected by: ChunkLineSelector
variable ChunkLineStatusAll#
Bit field that indicates the status of all of the camera's input and output lines when the image was acquired - Applies to: GigE, Stereo ace, ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB.
Visibility: Beginner
variable ChunkLineTriggerCounter#
Value of the Line Trigger counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
variable ChunkLineTriggerEndToEndCounter#
Value of the Line Trigger End to End counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
variable ChunkLineTriggerIgnoredCounter#
Value of the Line Trigger Ignored counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
variable ChunkOffsetX#
X offset of the AOI of the acquired image - Applies to: GigE, Stereo ace and ace 2 GigE.
Visibility: Beginner
Selected by: ChunkComponentSelector
variable ChunkOffsetY#
Y offset of the AOI of the acquired image - Applies to: GigE, Stereo ace and ace 2 GigE.
Visibility: Beginner
Selected by: ChunkComponentSelector
variable ChunkPartIndex#
Returns index of the image part in this block depending on selected component - Applies to: Stereo ace.
Visibility: Expert
Selected by: ChunkComponentSelector
variable ChunkPayloadCRC16#
CRC checksum of the acquired image - Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB.
CRC checksum of the acquired image. The checksum is calculated using all of the image data and all of the appended chunks except for the checksum itself.
Visibility: Beginner
variable ChunkPixelDynamicRangeMax#
Maximum possible pixel value in the acquired image - Applies to: ace 2 GigE.
Visibility: Expert
variable ChunkPixelDynamicRangeMin#
Minimum possible pixel value in the acquired image - Applies to: ace 2 GigE.
Visibility: Expert
variable ChunkPixelFormat#
Indicates the pixel format of the acquired image - Applies to: GigE, Stereo ace and ace 2 GigE.
Visibility: Beginner
Selected by: ChunkComponentSelector
variable ChunkScan3dBaseline#
Baseline of the stereo cameras - Applies to: Stereo ace.
Baseline of the stereo cameras in m.
Visibility: Expert
variable ChunkScan3dCoordinateOffset#
Returns the offset when transforming a pixel from relative coordinates to world coordinates - Applies to: Stereo ace.
Visibility: Expert
Selected by: ChunkScan3dCoordinateSelector
variable ChunkScan3dCoordinateScale#
Returns the scale factor when transforming a pixel from relative coordinates to world coordinates - Applies to: Stereo ace.
Visibility: Expert
Selected by: ChunkScan3dCoordinateSelector
variable ChunkScan3dCoordinateSelector#
Selects which Coordinate to retrieve data from - Applies to: Stereo ace.
Visibility: Expert
Selecting Parameters: ChunkScan3dCoordinateOffset, ChunkScan3dCoordinateScale, ChunkScan3dInvalidDataFlag and ChunkScan3dInvalidDataValue
variable ChunkScan3dDistanceUnit#
Returns the Distance Unit of the payload image - Applies to: Stereo ace.
Visibility: Expert
variable ChunkScan3dFocalLength#
Focal length - Applies to: Stereo ace.
Focal length of the camera in pixels.
Visibility: Expert
Selected by: ChunkComponentSelector
variable ChunkScan3dInvalidDataFlag#
Returns if a specific non-valid data flag is used in the payload image - Applies to: Stereo ace.
Visibility: Expert
Selected by: ChunkScan3dCoordinateSelector
variable ChunkScan3dInvalidDataValue#
Returns the value which identifies a non-valid pixel - Applies to: Stereo ace.
Visibility: Expert
Selected by: ChunkScan3dCoordinateSelector
variable ChunkScan3dOutputMode#
Returns the Calibrated Mode of the payload image - Applies to: Stereo ace.
Visibility: Expert
variable ChunkScan3dPrincipalPointU#
Horizontal position of the principal point - Applies to: Stereo ace.
Visibility: Expert
Selected by: ChunkComponentSelector
variable ChunkScan3dPrincipalPointV#
Vertical position of the principal point - Applies to: Stereo ace.
Visibility: Expert
Selected by: ChunkComponentSelector
variable ChunkSequenceSetIndex#
Sequence set index number related to the acquired image - Applies to: GigE.
Visibility: Beginner
variable ChunkSequencerSetActive#
Index of the active sequencer set - Applies to: ace 2 GigE, ace 2 USB and ace USB.
Visibility: Beginner
variable ChunkShaftEncoderCounter#
Value of the Shaft Encoder counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
variable ChunkStride#
Number of bytes of data between the beginning of one line in the acquired image and the beginning of the next line in the acquired image - Applies to: GigE and ace 2 GigE.
Visibility: Beginner
variable ChunkTimestamp#
Value of the timestamp when the image was acquired - Applies to: GigE, Stereo ace and ace USB.
Visibility: Beginner
variable ChunkTriggerinputcounter#
Value of the Trigger Input counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
variable ChunkVirtLineStatusAll#
Status of all of the camera's virtual input and output lines when the image was acquired - Applies to: GigE.
Visibility: Beginner
variable ChunkWidth#
Width of the AOI of the acquired image - Applies to: GigE, Stereo ace and ace 2 GigE.
Visibility: Beginner
Selected by: ChunkComponentSelector