Leadtools.ImageProcessing.Core Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
SubtractBackgroundCommand Constructor(Int32,SubtractBackgroundCommandType,Int32,SubtractBackgroundCommandFlags)
See Also  Example
Leadtools.ImageProcessing.Core Namespace > SubtractBackgroundCommand Class > SubtractBackgroundCommand Constructor : SubtractBackgroundCommand Constructor(Int32,SubtractBackgroundCommandType,Int32,SubtractBackgroundCommandFlags)



rollingBall
The radius (in pixels) of the ball that will roll over the entire image to determine the background. Recommended value is 50. This parameter only accepts positive values.
shrinkingSize
Shrink size ratio used to minimize the image internally in order to increase the speed with little loss of accuracy.
brightnessFactor
Brightness factor for increasing or decreasing the brightness of the image. Valid values range from 0 - 400. If you pass 100 the brightness remains unchanged. Lower values darken the image while higher values lighten the image.
flags
Flags that indicate whether the background is darker than the foreground, and whether to show the objects without the background. You must select one from each group.
Initializes a new SubtractBackgroundCommand class object with explicit parameters.

Syntax

Visual Basic (Declaration) 
Public Function New( _
   ByVal rollingBall As Integer, _
   ByVal shrinkingSize As SubtractBackgroundCommandType, _
   ByVal brightnessFactor As Integer, _
   ByVal flags As SubtractBackgroundCommandFlags _
)
Visual Basic (Usage)Copy Code
Dim rollingBall As Integer
Dim shrinkingSize As SubtractBackgroundCommandType
Dim brightnessFactor As Integer
Dim flags As SubtractBackgroundCommandFlags
 
Dim instance As SubtractBackgroundCommand(rollingBall, shrinkingSize, brightnessFactor, flags)
C# 
public SubtractBackgroundCommand( 
   int rollingBall,
   SubtractBackgroundCommandType shrinkingSize,
   int brightnessFactor,
   SubtractBackgroundCommandFlags flags
)
C++/CLI 
public:
SubtractBackgroundCommand( 
   int rollingBall,
   SubtractBackgroundCommandType shrinkingSize,
   int brightnessFactor,
   SubtractBackgroundCommandFlags flags
)

Parameters

rollingBall
The radius (in pixels) of the ball that will roll over the entire image to determine the background. Recommended value is 50. This parameter only accepts positive values.
shrinkingSize
Shrink size ratio used to minimize the image internally in order to increase the speed with little loss of accuracy.
brightnessFactor
Brightness factor for increasing or decreasing the brightness of the image. Valid values range from 0 - 400. If you pass 100 the brightness remains unchanged. Lower values darken the image while higher values lighten the image.
flags
Flags that indicate whether the background is darker than the foreground, and whether to show the objects without the background. You must select one from each group.

Example

Run the SubtractBackgroundCommand on an image.

Visual BasicCopy Code
Public Sub SubtractBackgroundConstructorExample()
   RasterCodecs.Startup()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg")

   ' Prepare the command
   Dim command As SubtractBackgroundCommand = New SubtractBackgroundCommand(50, SubtractBackgroundCommandType.DependOnRollingBallSize, 100, SubtractBackgroundCommandFlags.BackgroundIsDarker)
   ' Apply Subtract Background effect on the image.
   command.Run(leadImage)

   RasterCodecs.Shutdown()
End Sub
C#Copy Code
public void SubtractBackgroundConstructorExample() 

   // Load an image 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg"); 
 
   // Prepare the command 
   SubtractBackgroundCommand command = new SubtractBackgroundCommand(50, SubtractBackgroundCommandType.DependOnRollingBallSize, 100, SubtractBackgroundCommandFlags.BackgroundIsDarker); 
   // Apply Subtract Background effect on the image. 
   command.Run(image); 
 
   RasterCodecs.Shutdown(); 
}

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also