Hand Held Products 5080, User Manual

Page: 43 / 64

5X80 Series Software Development Kit (SDK) User’s Guide 4 - 7
Image Acquisition structure:
typedef struct _tagHHP_IMAGE_ACQUISITION
{
DWORD dwStructSize; Size of structure in bytes.
DWORD dwMask; Mask of active items.
Config items
DWORD dwWhiteValue; Target “white pixel” value.
DWORD dwWhiteWindow; Acceptable delta from white value.
DWORD dwMaxNumExposures; Max frame capture tries for white value.
HHP_DUTY_CYCLE illuminatCycle; Illumination duty cycle (never on, on during imaging).
HHP_DUTY_CYCLE aimerCycle; Aimer duty cycle (never on, on during imaging).
HHP_GAIN fixedGain; If manual capture mode, gain value for capture.
DWORD dwFixedExposure; If manual capture mode, exposure time for capture.
HHP_FRAME_RATE frameRate; If manual capture mode, frame rate for capture.
HHP_AUTOEXPOSURE captureMode; Autoexposure (AGC) Capture mode: barcode, photo or manual.
Capture time only, not real config items:
BOOL bWaitForTrigger; Wait for hardware or software trigger before capturing image.
BOOL bPreviewImage; Capture a preview image. These are subsample 3, full window,
JPEG transfer images.
} HHP_IMAGE_ACQUISITION, *PHHP_IMAGE_ACQUISITION;
Image Transfer bit masks:
#define BITS_PER_PIXEL_MASK 0x00001 Number of bits per pixel transferred (1 or 8).
#define SUBSAMPLE_VALUE 0x00002 Subsample value (1-10).
#define SUBSAMPLE_VALUE_MASK 0x00002 Subsample value (1-10).
#define BOUNDING_RECTANGLE_MASK 0x00004 Rectangular region within image to send.
#define COMPRESSION_MODE_MASK 0x00008 No Compression, Lossless or Lossy.
#define HISTOGRAM_STRETCH_MASK 0x00010 Range -> 0 - 255.
#define COMPRESSION_FACTOR_MASK 0x00020 If lossy compression, image quality percent.
#define EDGE_ENHANCEMENT_MASK 0x00100 Edge sharpening filter.
#define GAMMA_CORRECTION_MASK 0x00200 Gamma correction.
#define TEXT_ENHANCEMENT_MASK 0x00400 Text sharpening filter.
#define INFINITY_FILTER_MASK 0x00800 Sharpening for image beyond normal focus.
#define FLIP_IMAGE_MASK 0x01000 Rotate the image 180 degrees.
#define NOISE_FILTER_MASK 0x02000 Smoothing (fly spec) filter.
#define TRANSFER_UPDATE_HWND 0x00040 Transfer progress message window.
#define TRANSFER_UPDATE_DWORD 0x00080 Pointer to DWORD for percent of transfer complete.
#define TRANSFER_MASK_ALL 0x03fff Mask to select all configuration items in structure.
#define TRANSFER_MASK_ALL_NO_NOTIFY 0x03f3f Mask to select all structure members.
Image Transfer structure:
typedef struct _tagHHP_IMAGE_TRANSFER
{
DWORD dwStructSize; Size of structure in bytes.
DWORD dwMask; Mask of active items.
Config items:
DWORD dwBitsPerPixel; Bits per pixel for transferred image (1 or 8 bits only).
DWORD dwSubSample; Subsample value. This means take every dwSubSample pixels
of every dwSubSample row. The default is 1.
RECT boundingRect; Rectangle describing a window within the image. All pixels out-
side this rectangle are omitted from the transferred image.
BOOL bHistogramStretch; Scaled frequency of total image pixels.
Compression_t compressionMode; How image is compressed on transfer. Compression reduces
the amount of data to transfer but can reduce image quality
(Lossy compression) and does take a finite length of time.