You are here: Helper Functions > ClipOmrRegion

ClipOmrRegion
for Image Scanner Implementation Only

This function is only available to Scan User Exits using image scanners.

Clip a region of the form defined in OMR space. The OMR coordinates are converted into pixel coordinates internally, so it is not necessary to know the location of the OMR coordinates on the form.

The clip is taken using the depth and compression method set by previous calls to SetClipDepth and SetClipCompressionMethod. The pbResult return buffer contains the compressed clip. It is the responsibility of the user exit program to turn this compressed data into a TIF or some other representation.

The pbResult buffer is allocated by the system and is guaranteed to be long enough to hold the result of the clip. However, data in this buffer will be destroyed by subsequent clipping operations or any clipping done by ScanTools.

To support easy full-page clipping, if iCellStart, iTmStart, iCellCount and iTmCount are all zero, the full page image will be clipped.

There is a limitation on 8 bit clips using either Group 3 or Group 4 compression methods: the X dimension of the clip can not be greater than 1000 pixels. If an attempt is made to take a clip greater than 1000 pixels the clip is compressed using PackBits RLE. This does not affect the compression method used on subsequent clips.

The return values piRowCount and piColCount give the size of the actual clip in pixels.

NOTE: We recommend using the Group 4 compression method because it yields the best compression in all cases.

The Group 3 compression method is not recommended because Group 4 gives better compression and Group 3 is not supported by all viewers. If you must use Group 3, compression option 2D encoding is required.

NOT VALID for: INIT, ACQUIRE, DOCDONE, CLEANUP

Format
Return Values

Related topic

User Exit Migration

 

 

See Help on Help for additional information on using this help file.

See Scantron Technical Support for additional information on technical support and training options.

See the ScanTools Suite System Requirements for further details on hardware and software requirements.

ScanTools is a suite of products; the specific information you want may appear in the help for a different module. If you don't find what you're looking for here, try one of the following:

 

Scantron Corporation

Customer Service (forms, products, and services):

1-800-SCANTRON (722-6876)

www.scantron.com

Technical Support:

1-800-445-3141

[email protected]

Copyright © 1998-2012 Scantron Corporation. All rights reserved. Use permitted only under license. www.scantron.com. No part of the Help or user guides may be reproduced in any form, or by any means, without express permission from Scantron Corporation.

LINKS TO THIRD PARTY SITES

This help system may contain links to third party websites ("Linked Sites"). The Linked Sites are not under the control of Scantron and Scantron is not responsible for the content of any Linked Site, including without limitation any link contained in a Linked Site or any changes or modifications to a Linked Site. Scantron is not responsible for web casting or any other form of transmission received from any Linked Site. Scantron provides Users with the ability to link the Assessment System to the Linked Sites as a convenience to you, and the inclusion of any link does not imply endorsement by Scantron of the Linked Site or any association with its operators.