HolePunchRemoveCommandFlags Enumeration

Summary

Values that determine the behavior of the hole punch removal process.

Syntax

C++/CLI

Java

Python

[FlagsAttribute()] 
public enum HolePunchRemoveCommandFlags

public final class HolePunchRemoveCommandFlags 
    extends java.lang.Enum<HolePunchRemoveCommandFlags>

[FlagsAttribute()] 
public enum class HolePunchRemoveCommandFlags

class HolePunchRemoveCommandFlags(Enum): 
   UseNormalDetection = 0 
   UseNormalDetection = 0 
   None, UseDpi = 1 
   None, SingleRegion = 2 
   None, LeadRegion = 4 
   None, CallBackRegion = 8 
   None, ImageUnchanged = 16 
   None, UseSize = 32 
   None, UseCount = 64 
   None, UseLocation = 128 
   None, UseAdvancedDetection = 65536

Members

Value	Member	Description
0x00000000	None	No flags.
0x00000000	UseNormalDetection	Use Normal Hole Punch Detection.
0x00000001	UseDpi	The unit of measure for all properties of the HolePunchRemoveCommand is thousandths of an inch. Use the image's DPI to convert to pixels. This allows the processing of many images with different DPI. If this flag is not set, the unit of measure for all properties of the HolePunchRemoveCommand is pixels.
0x00000002	SingleRegion	For each hole punch encountered by HolePunchRemoveCommand, if the Status is set to RemoveStatus.Remove, the removed hole punch is added to an internal single region. If it is set to RemoveStatus.NoRemove, the hole punch is not added to the single region. When HolePunchRemoveCommand returns, either ImageRegion or Region will reference a region that contains all the removed hole punches. If LeadRegion is also set, ImageRegion will be updated with a shallow copy of image that has a LEAD region that contains all the removed hole punches. If LeadRegion is not set, Region is updated with a LEADTOOLS RasterRegion that contains all the removed hole punches. When the region (either LEAD or Windows) is no longer needed, it must be disposed (either region allocated in ImageRegion or Region).
0x00000004	LeadRegion	When HolePunchRemoveCommand returns, ImageRegion is updated with a shallow copy of the Run method image that also contains a region with all the removed hole punches. This flag must be used in conjunction with SingleRegion. So set Flags to SingleRegion \| LeadRegion
0x00000008	CallBackRegion	The Region property receives a LEADTOOLS RasterRegion that contains the current hole punch to be removed. Setting this flag lets the user create his or her own composite of removed hole punches by combining the regions received, if Status is set to RemoveStatus.Remove. The regions can be combined using a logical OR operator. Combining all regions received when the Status is set to RemoveStatus.Remove results in a region identical to the region created when SingleRegion is set in Flags. For an example, refer to HolePunchRemoveCommand. When the region received by the Region property is no longer needed, it must be disposed of.
0x00000010	ImageUnchanged	The Run method image is unchanged. This is useful if you do not want to actually change the image data, but obtain information about any hole punches that are found.
0x00000020	UseSize	Use the MinimumHoleWidth, MinimumHoleHeight, MaximumHoleWidth, MaximumHoleHeight properties of the HolePunchRemoveCommand to indicate the size of the hole punches to remove If this flag is not set, default values for the four sizes will be used. If HolePunchRemoveCommandFlags.UseDpi is set, the defaults are calculated from the image DPI. Otherwise, the defaults are calculated from the image width and height.
0x00000040	UseCount	Use the MinimumHoleCount and MaximumHoleCount properties of the HolePunchRemoveCommand to indicate the number of hole punches to remove. If this flag is not set, default values for the two count values will be used. These default values are as follows: MinimumHoleCount = 3 and MaximumHoleCount = 3.
0x00000080	UseLocation	Use the Location property of the HolePunchRemoveCommand to indicate the location of the hole punches to remove. If this flag is not set, a default of HolePunchRemoveCommandLocation.Left will be used.
0x00010000	UseAdvancedDetection	Use Advanced Hole Punch Detection to return more accurate results.

Remarks

You can use a bitwise OR ( | ) to specify one or more flags.

Requirements

Target Platforms

Reference

Leadtools.ImageProcessing.Core Namespace

Download our FREE evaluation

Help Version 23.0.2024.3.3

Leadtools.ImageProcessing.Core Assembly

Introduction

Getting Started

Namespaces

Leadtools.ImageProcessing.Core Namespace

Assemblies