CAP_SEGMENTED

Featured Clients

Sectors: FinanceInformation TechnoloyGovernmentHealthcareIndustriesEducation(show all)

TWAIN Capability: CAP_SEGMENTED

CAP_SEGMENTED

Description

Describes the segmentation setting for captured images. Image segmentation occurs when either the device, the Source or the Application breaks up an image into a stream of image components (text, pictures, graphics) that must be assembled by the application to reconstruct the original document. Applications must use the DAT_EXTIMAGEINFO TWEI_SEGMENTNUMBER field to identify pieces of an image that are associated with each other through segmentation.

Manual segmentation is an advanced way of setting the Source to transfer image components with different parameters from the same page. Not all Sources support this feature.

Application

Applications should be able to GET SET whether segmentation will be applied to captured images.

If the Application sets Manual segmentation, it can specify different settings for every frame in ICAP_FRAMES. In this mode ICAP_FRAMES states before ICAP_COLORMANAGMENTENABLED in capability ordering. The Application can set the current frame by setting ICAP_FRAMES using the TW_ENUMERATION container and changing CurrentIndex only. The number of Frames and their parameters must be kept unchanged during this process, otherwise a Source will set all capabilities the same for all frames.

A Source may not support separate settings for all supported capabilities for different frames. Get the list of these capabilities from CAP_SUPPORTEDCAPSSEGMENTUNIQUE. Applications must set all common capabilities before it sets the Manual Segmentation mode, and then set only capabilities which are different for different frames.

Source

Values

If the Source is in Manual segmentation, and the Application changed the number of frames and their parameters, then the Source will make all capabilities the same for all frames using values for the current frame (prior this operation). In this mode the Source must ignore the capability order for ICAP_FRAMES. It may allow different settings for capabilities which are placed below ICAP_MINIMUMWIDTH in the capabilities order. The Source must report these capabilities in CAP_SUPPORTEDCAPSSEGMENTUNIQUE.

Type: TW_UINT

Value after MSG_OPENDS: (may be remembered from a previous session)

After MSG_RESET/MSG_RESETALL: TWSG_NONE

Allowed Values: TWSG_AUTO TWSG_NONE TWSG_MANUAL

Containers

MSG_GET TW_ONEVALUE TW_ENUMERATION

MSG_GETCURRENT TW_ONEVALUE

MSG_GETDEFAULT TW_ONEVALUE

MSG_SET TW_ONEVALUE

MSG_SETCONSTRAINT TW_ONEVALUE

TW_ENUMERATION

MSG_RESET TW_ONEVALUE

MSG_QUERYSUPPORT TW_ONEVALUE

Required By

None

TWAIN Version Introduced

Version 1.91

Related

ICAP_FRAMES ICAP_MAXFRAMES CAP_SUPPORTEDCAPSSEGMENTUNIQUE

TWAIN Notice

Where would you like to scan from? Scan in Web Apps Scan in Java Scan in .NET