VintaSoft Imaging .NET SDK 15.1: Documentation for .NET developer
Vintasoft.Imaging.ImageProcessing.Info Namespace / GetHistogramCommand Class
Members Object Syntax Example Hierarchy Requirements SeeAlso
In This Topic
GetHistogramCommand Class
In This Topic
Gets an information about the histogram of the image.
Object Model
RegionOfInterest ProcessingCommandResults GetHistogramCommand
Syntax
Example

This C#/VB.NET code shows how to load an image from disk and calculate histogram of the image.


Class GetHistogramCommandExample
    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("Deskew.tif")
            Try
                ' create the image processing command
                Dim command As New Vintasoft.Imaging.ImageProcessing.Info.GetHistogramCommand()
                command.HistogramType = Vintasoft.Imaging.ImageProcessing.HistogramType.Luminosity

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

                        Dim luminosityHistogram As Integer() = command.LuminosityHistogram
                        Dim luminosityHistogramString As String = String.Empty

                        For i As Integer = 0 To luminosityHistogram.Length - 2
                            luminosityHistogramString += String.Format("{0} ", luminosityHistogram(i))
                        Next
                        luminosityHistogramString += String.Format("{0}", luminosityHistogram(luminosityHistogram.Length - 1))

                        System.Windows.Forms.MessageBox.Show(String.Format("Luminosity histogram: {0}.", luminosityHistogramString))
                    Next
                Catch ex As Vintasoft.Imaging.ImageProcessing.ImageProcessingException
                    ' show error message
                    System.Windows.Forms.MessageBox.Show(ex.Message)
                    Return
                End Try
            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 GetHistogramCommandExample
{
    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("Deskew.tif");
            try
            {
                // create the image processing command
                Vintasoft.Imaging.ImageProcessing.Info.GetHistogramCommand command =
                    new Vintasoft.Imaging.ImageProcessing.Info.GetHistogramCommand();
                command.HistogramType = Vintasoft.Imaging.ImageProcessing.HistogramType.Luminosity;

                // 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);

                        int[] luminosityHistogram = command.LuminosityHistogram;
                        string luminosityHistogramString = string.Empty;

                        for (int i = 0; i < luminosityHistogram.Length - 1; i++)
                            luminosityHistogramString += string.Format("{0} ", luminosityHistogram[i]);
                        luminosityHistogramString += string.Format("{0}", luminosityHistogram[luminosityHistogram.Length - 1]);

                        System.Windows.Forms.MessageBox.Show(string.Format("Luminosity histogram: {0}.", luminosityHistogramString));
                    }
                }
                catch (Vintasoft.Imaging.ImageProcessing.ImageProcessingException ex)
                {
                    // show error message
                    System.Windows.Forms.MessageBox.Show(ex.Message);
                    return;
                }
            }
            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.Info.GetHistogramCommand

Requirements

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

See Also