SubtractBackgroundCommand Constructor(Int32,SubtractBackgroundCommandType,Int32,SubtractBackgroundCommandFlags)

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public SubtractBackgroundCommand( 
   int rollingBall,
   SubtractBackgroundCommandType shrinkingSize,
   int brightnessFactor,
   SubtractBackgroundCommandFlags flags
)

'Declaration
 
Public Function New( _
   ByVal rollingBall As Integer, _
   ByVal shrinkingSize As SubtractBackgroundCommandType, _
   ByVal brightnessFactor As Integer, _
   ByVal flags As SubtractBackgroundCommandFlags _
)

'Usage
 
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)

public SubtractBackgroundCommand( 
   int rollingBall,
   SubtractBackgroundCommandType shrinkingSize,
   int brightnessFactor,
   SubtractBackgroundCommandFlags flags
)

function SubtractBackgroundCommand( 
   rollingBall ,
   shrinkingSize ,
   brightnessFactor ,
   flags 
)

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 accepts only 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.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

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

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";
}

function SubtractBackgroundConstructorExample()
{
   var codecs = new Leadtools.Codecs.RasterCodecs();
   codecs.throwExceptionsOnInvalidImages = true;

   // Load the image
   var srcFileName = "Assets\\Image1.cmp";
   var processedImage;
   return Tools.AppInstallFolder().getFileAsync(srcFileName).then(function (loadFile) {
      return codecs.loadAsync(Leadtools.LeadStreamFactory.create(loadFile));
   }).then(function (image) {
      // Prepare the command
      with (Leadtools.ImageProcessing.Core) {
         var command = new SubtractBackgroundCommand(50, SubtractBackgroundCommandType.dependOnRollingBallSize, 100, SubtractBackgroundCommandFlags.backgroundIsDarker);
         // Apply Subtract Background effect on the image.
         command.run(image);
      }
   });
}

[TestMethod]
public async Task SubtractBackgroundConstructorExample()
{
   // Load an image
   RasterCodecs codecs = new RasterCodecs();
   codecs.ThrowExceptionsOnInvalidImages = true;
   // Load the image
   string srcFileName = @"Assets\Image1.cmp";
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));

   // Prepare the command
   SubtractBackgroundCommand command = new SubtractBackgroundCommand(50, SubtractBackgroundCommandType.DependOnRollingBallSize, 100, SubtractBackgroundCommandFlags.BackgroundIsDarker);
   // Apply Subtract Background effect on the image.
   command.Run(image);

}

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();
}

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

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

SubtractBackgroundCommand Class
SubtractBackgroundCommand Members
Overload List