LEADTOOLS Image Processing (Leadtools.ImageProcessing.Core assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
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 Leadtools.ImageProcessing.Core.SubtractBackgroundCommand class object with explicit parameters. Supported in Silverlight, Windows Phone 7

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 New 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 Leadtools.ImageProcessing.Core.SubtractBackgroundCommand on an image.

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

   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "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)

End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class
C#Copy Code
public void SubtractBackgroundConstructorExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

      RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "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);

   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}
SilverlightCSharpCopy Code
public void SubtractBackgroundConstructorExample(RasterImage image, Stream outStream)
{
   // Prepare the command
   SubtractBackgroundCommand command = new SubtractBackgroundCommand(50, SubtractBackgroundCommandType.DependOnRollingBallSize, 100, SubtractBackgroundCommandFlags.BackgroundIsDarker);
   // Apply Subtract Background effect on the image.
   command.Run(image);
   // Save result image
   RasterCodecs codecs = new RasterCodecs();
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24);
   image.Dispose();
}
SilverlightVBCopy Code
Public Sub SubtractBackgroundConstructorExample(ByVal image As RasterImage, ByVal outStream As Stream)
   ' Prepare the command
   Dim command As SubtractBackgroundCommand = New SubtractBackgroundCommand(50, SubtractBackgroundCommandType.DependOnRollingBallSize, 100, SubtractBackgroundCommandFlags.BackgroundIsDarker)
   ' Apply Subtract Background effect on the image.
   command.Run(image)
   ' Save result image
   Dim codecs As RasterCodecs = New RasterCodecs()
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24)
   image.Dispose()
End Sub

Requirements

Target Platforms: Silverlight 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also