GrabWindow

Method to define the grabbing window area

Parameter Info

Class Category Level Type Access
Channel Grabber Timing ADJUST Enumerated Set and Get
Num ID String Identifier C, C++ identifier
683 << 14 GrabWindow MC_GrabWindow

Parameter Description

This enumerated parameter selects the method defining the grabbing window area within the camera active area.

For area-scan cameras, the grabbing window area is inferred from the camera active rectangular window.

For line-scan cameras, the width of the grabbing window area is inferred from the camera active linear window.

Parameter Usage

By default, the grabbing window is the largest area achievable by the camera sensor.

Alternatively, using the MAN setting, the grabbing window can be reduced to a single rectangular area located anywhere in the camera active area.

Parameter Values

Enumeration: NOBLACK, MAN

Table 1. NOBLACK
MC_GrabWindow_NOBLACK

Applicable product(s): 1155 Picolo.

Description for

For digital area-scan cameras, the grabbing window area matches exactly the Camera Active Area:
  • Grabbing window width is defined by Hactive_Px.
  • Grabbing window height is defined by Vactive_Ln.
  • Grabbing window X-position offset is 0.
  • Grabbing window Y-position offset is 0.
For digital line-scan cameras, the grabbing window width matches exactly the Camera Active Area:
  • Grabbing window width is defined by Hactive_Px.
  • Grabbing window X-position offset = 0.

Default value.

Table 2. MAN
MC_GrabWindow_MAN

Description

For area-scan cameras, the grabbing window area and location are defined by separate parameters:
  • Grabbing window width is defined by WindowX_Px.
  • Grabbing window height is defined by WindowY_Ln.
  • Grabbing window X-position offset is defined by OffsetX_Px.
  • Grabbing window Y-position offset is defined by OffsetY_Ln.
For digital line-scan cameras, the grabbing window width and position are defined by separate parameters:
  • Grabbing window width is defined by WindowX_Px.
  • Grabbing window X-position offset is defined by OffsetX_Px.
Applicability condition(s):
  • Condition: Line-scan or TDI line-scan cameras
  • Condition: Area-scan cameras having a single region along the Y direction. For instance, the value is not applicable to cameras having a TapGeometry value suffixed _2YE.