ConvertToSource(RasterImage,ConvertToSourceOptions) Method

Converts a LEADTOOLS for .NET Leadtools.RasterImage object to WPF System.Windows.Media.ImageSource.

public static ImageSource ConvertToSource( 
   RasterImage image, 
   ConvertToSourceOptions options 
) 

  
Public Shared Function ConvertToSource( _ 
   ByVal image As RasterImage, _ 
   ByVal options As ConvertToSourceOptions _ 
) As ImageSource 

public: 
static ImageSource^ ConvertToSource(  
   RasterImage^ image, 
   ConvertToSourceOptions options 
)  

Parameters

Return Value

An System.Windows.Media.ImageSource object representing the converted image.

LEADTOOLS for .NET and Windows Presentation Foundation (WPF) support different pixel formats. These pixel formats may not be identical in some cases. The conversion process takes care of converting scanlines to a suitable format that best matches the source data.

The ConvertToSource method supports converting from any Leadtools.RasterImage regardless of the combination of the bits/pixel, compression, color order, grayscale properties of the source image. The ConvertToSource method will always returns a valid WPF System.Windows.Media.ImageSource by allocating temporary memory for the data and performing the necessary conversion on it.

In some cases, the Leadtools.RasterImage data is compatible with WPF and no conversion takes place. Converting a compatible Leadtools.RasterImage to WPF System.Windows.Media.ImageSource is faster and takes less resources than converting a non-compatible image. Please note that currently WPF does not allow direct access to the raw data pointers where the image data is stored. Therefore, there is always at least one copy operation regardless if the source data can be used directly by a WPF image (For example, through the use of the System.Windows.Media.Imaging.BitmapSource.Create method).

For a Leadtools.RasterImage to be compatible with WPF, it must have the following properties:

• The Leadtools.RasterImage must have conventional memory, not disk and nor tiled memory. ( RasterImage.IsConventionalMemory must be true and RasterImage.IsDiskMemory, RasterImage.IsTiled, RasterImage.IsGlobalMemory and RasterImage.IsMirrored must all be false)

• The Leadtools.RasterImage data must not be compressed (RasterImage.IsCompressed and RasterImage.IsSuperCompressed must both be false)

• The Leadtools.RasterImage data must not be signed (RasterImage.Signed must be false)

• The Leadtools.RasterImage must have compatible bits/pixel and color order values according the table below.

The following table lists the source Leadtools.RasterImage bits/pixel and source data properties and whether each combination is compatible with WPF.

Notes on gray scale images

Both LEADTOOLS and Windows Presentation Foundation support 16 bit grayscale image data. However LEADTOOLS supports extra features such as low/high bit values and color lookup tables. For a LEADTOOLS 16-bit grayscale Leadtools.RasterImage to be compatible with a WPF image with System.Windows.Media.PixelFormats.Gray16, the following conditions must be met:

• The value of RasterImage.UseLookupTable must be false

• The low/high bit values must not be used. Either, the values of RasterImage.LowBit and RasterImage.HighBit are set to the default values or the ConvertToSourceOptions.IgnoreLowHighBitsOnGrayImages flag must be passed to the ConvertToSource method

Notes on alpha channel

When converting images that support an alpha channel (32 or 64 bits/pixel images), the ConvertToSource method supports masking out the alpha channel bits to all 1's through or using the source image alpha channel bits through the use of the ConvertToSourceOptions.KeepAlphaValues flag. Masking out the alpha channel bits requires the source data image to be processed and as a result, the image will not be compatible with WPF.

For more information refer to RasterImage and WPF.

This example will use LEADTOOLS to load a Leadtools.RasterImage, convert to a WPF System.Windows.Media.ImageSource and set it in a System.Windows.Controls.Image control.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.Windows.Media; 
 
private void ConvertToSourceExample(System.Windows.Controls.Image imageControl) 
{ 
   string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); 
 
 
   using (RasterCodecs codecs = new RasterCodecs()) 
   { 
      // Load the image 
      using (RasterImage rasterImage = codecs.Load(srcFileName, 0, CodecsLoadByteOrder.Bgr, 1, 1)) 
      { 
         // Convert it to WPF/Silverlight ImageSource 
         System.Windows.Media.ImageSource source = RasterImageConverter.ConvertToSource(rasterImage, ConvertToSourceOptions.None); 
 
         // Set it in the Image control 
         imageControl.Source = source; 
      } 
   } 
 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
} 

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Windows.Media 
 
Private Sub ConvertToSourceExample(ByVal imageControl As System.Windows.Controls.Image) 
   Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp") 
 
 
   Using codecs As New RasterCodecs() 
      ' Load the image 
      Using rasterImage As RasterImage = codecs.Load(srcFileName, 0, CodecsLoadByteOrder.Bgr, 1, 1) 
         ' Convert it to WPF/Silverlight ImageSource 
         Dim source As System.Windows.Media.ImageSource = RasterImageConverter.ConvertToSource(rasterImage, ConvertToSourceOptions.None) 
 
         ' Set it in the Image control 
         imageControl.Source = source 
      End Using 
   End Using 
 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class 

c#[Silverlight C# Example] 
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.Windows.Media; 
 
private void ConvertToSourceExample(System.Windows.Controls.Image imageControl) 
{ 
   string srcFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Image1.cmp"; 
 
   RasterCodecs codecs = new RasterCodecs(); 
   // Load the image 
   using (RasterImage rasterImage = codecs.Load(srcFileName, 0, CodecsLoadByteOrder.Bgr, 1, 1)) 
   { 
      // Convert it to WPF/Silverlight ImageSource 
      System.Windows.Media.ImageSource source = RasterImageConverter.ConvertToSource(rasterImage, ConvertToSourceOptions.None); 
 
      // Set it in the Image control 
      imageControl.Source = source; 
   } 
} 
vb[Silverlight VB Example] 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.Windows.Media 
Imports Leadtools.ImageProcessing.Color 
 
Private Sub ConvertToSourceExample(ByVal imageControl As System.Windows.Controls.Image) 
   Dim srcFileName As String = LeadtoolsExamples.Common.ImagesPath.Path & "Image1.cmp" 
 
   Dim codecs As RasterCodecs = New RasterCodecs() 
   ' Load the image 
   Using rasterImage As RasterImage = codecs.Load(srcFileName, 0, CodecsLoadByteOrder.Bgr, 1, 1) 
      ' Convert it to WPF/Silverlight ImageSource 
      Dim source As System.Windows.Media.ImageSource = RasterImageConverter.ConvertToSource(rasterImage, ConvertToSourceOptions.None) 
 
      ' Set it in the Image control 
      imageControl.Source = source 
   End Using 
End Sub 

Target Platforms

Reference

RasterImageConverter Class

RasterImageConverter Members