RemoveGarbage Method of the ImageDocument Object

RemoveGarbage method of the ImageDocument Object in the ABBYY FineReader Engine API — Removes garbage (excess dots smaller than a given size) from the image; for color images, garbage is detected on the black-and-white plane and removed from all planes.

This method removes garbage (excess dots that are smaller than a certain size) from the image. The image can be color as well as black-and-white. In case of a color image the garbage will be detected on the black-and-white image plane and afterwards removed from all planes.

Syntax

C++

HRESULT RemoveGarbage(
  IRegion* Region,
  int      GarbageSize
);

C#

void RemoveGarbage(
  IRegion Region,
  int    GarbageSize
);

Visual Basic .NET

Sub RemoveGarbage( _
  Region As IRegion, _
  GarbageSize As Integer _
)

Parameters

Region

[in] This parameter of the Region type specifies the set of rectangles to remove garbage from. The coordinates of rectangles are related to the deskewed image. This parameter may be 0. In this case, the garbage is removed from the whole image.

GarbageSize

[in] This variable specifies the maximum area of black dots that are to be considered garbage (in pixels). The value of -1 for this input parameter tells ABBYY FineReader Engine to automatically calculate the size of garbage.

You cannot call this method with both parameters set to default. If you would like to remove garbage from the whole image, you need to set garbage size; if you would like garbage size to be calculated automatically, you need to specify a region on the image.

Return values

This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

See also

ImageDocument