VintaSoft Imaging .NET SDK 12.4: Documentation for .NET developer
Vintasoft.Imaging.ImageProcessing Namespace / OverlayMaskedCommand Class
Members Object Syntax Example Hierarchy Requirements SeeAlso
In This Topic
    OverlayMaskedCommand Class
    In This Topic
    Overlays image on a top of the another image using 8-bit image mask.
    Object Model
    VintasoftImage VintasoftImage RegionOfInterest ProcessingCommandResults OverlayMaskedCommand
    Syntax
    'Declaration
    
    Public Class OverlayMaskedCommand
       Inherits ProcessingCommandWithRegion
    
    
    public class OverlayMaskedCommand : ProcessingCommandWithRegion
    
    
    public __gc class OverlayMaskedCommand : public ProcessingCommandWithRegion*
    
    
    public ref class OverlayMaskedCommand : public ProcessingCommandWithRegion^
    
    
    Example

    This C#/VB.NET code shows how to load image from disk, overlay it by another image and save the result to a new image file.

    
    Class OverlayMaskedCommandExample
        Public Sub ProcessImage()
            ' [ do not forget to set your image file path here! ]
            ' create an image collection
            Using images As New Vintasoft.Imaging.ImageCollection()
                ' add image to the image collection
                images.Add("Flower.jpg")
                Try
                    Using overlayImage As New Vintasoft.Imaging.VintasoftImage("Background.jpg")
                        Using maskImage As New Vintasoft.Imaging.VintasoftImage("MaskImage.png")
                            ' create the image processing command
                            Dim command As New Vintasoft.Imaging.ImageProcessing.OverlayMaskedCommand()
                            command.OverlayImage = overlayImage
                            command.MaskImage = maskImage
    
                            ' subscribe to progress event of image processing command
                            AddHandler command.Progress, New System.EventHandler(Of Vintasoft.Imaging.ImageProcessing.ImageProcessingProgressEventArgs)(AddressOf command_Progress)
    
                            Try
                                ' for each image in image collection
                                For Each image As Vintasoft.Imaging.VintasoftImage In images
                                    ' apply the image processing command to the image
                                    command.ExecuteInPlace(image)
                                Next
                            Catch ex As Vintasoft.Imaging.ImageProcessing.ImageProcessingException
                                ' show error message
                                System.Windows.Forms.MessageBox.Show(ex.Message)
                                Return
                            End Try
                        End Using
                    End Using
    
                    ' save the processed image collection to a new TIFF file
                    images.SaveSync("processed-image.tif")
                Finally
                    images.ClearAndDisposeItems()
                End Try
            End Using
        End Sub
    
        Private Sub command_Progress(sender As Object, e As Vintasoft.Imaging.ImageProcessing.ImageProcessingProgressEventArgs)
            ' update progress info using e.Progress property
            ' ...
    
            ' cancel execution of command using e.Cancel property if necessary
            ' ...
        End Sub
    End Class
    
    
    
    class OverlayMaskedCommandExample
    {
        public void ProcessImage()
        {
            // [ do not forget to set your image file path here! ]
            // create an image collection
            using (Vintasoft.Imaging.ImageCollection images = new Vintasoft.Imaging.ImageCollection())
            {
                // add image to the image collection
                images.Add("Flower.jpg");
                try
                {
                    using (Vintasoft.Imaging.VintasoftImage overlayImage = new Vintasoft.Imaging.VintasoftImage("Background.jpg"))
                    using (Vintasoft.Imaging.VintasoftImage maskImage = new Vintasoft.Imaging.VintasoftImage("MaskImage.png"))
                    {
                        // create the image processing command
                        Vintasoft.Imaging.ImageProcessing.OverlayMaskedCommand command =
                            new Vintasoft.Imaging.ImageProcessing.OverlayMaskedCommand();
                        command.OverlayImage = overlayImage;
                        command.MaskImage = maskImage;
    
                        // subscribe to progress event of image processing command
                        command.Progress +=
                            new System.EventHandler<Vintasoft.Imaging.ImageProcessing.ImageProcessingProgressEventArgs>(command_Progress);
    
                        try
                        {
                            // for each image in image collection
                            foreach (Vintasoft.Imaging.VintasoftImage image in images)
                            {
                                // apply the image processing command to the image
                                command.ExecuteInPlace(image);
                            }
                        }
                        catch (Vintasoft.Imaging.ImageProcessing.ImageProcessingException ex)
                        {
                            // show error message
                            System.Windows.Forms.MessageBox.Show(ex.Message);
                            return;
                        }
                    }
    
                    // save the processed image collection to a new TIFF file
                    images.SaveSync("processed-image.tif");
                }
                finally
                {
                    images.ClearAndDisposeItems();
                }
            }
        }
    
        void command_Progress(object sender, Vintasoft.Imaging.ImageProcessing.ImageProcessingProgressEventArgs e)
        {
            // update progress info using e.Progress property
            // ...
    
            // cancel execution of command using e.Cancel property if necessary
            // ...
        }
    }
    
    

    Inheritance Hierarchy

    System.Object
       Vintasoft.Imaging.ImageProcessing.ProcessingCommandBase
          Vintasoft.Imaging.ImageProcessing.ProcessingCommandWithRegion
             Vintasoft.Imaging.ImageProcessing.OverlayMaskedCommand

    Requirements

    Target Platforms: .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

    See Also