←Select platform

Average Method

Summary

Changes the color of each pixel in an image to the average color of pixels in its neighborhood. This results in a blur effect.

Syntax

C#
VB
C++
[FaultContractAttribute(System.Type)] 
[OperationContractAttribute(Action="Average", 
   AsyncPattern=false, 
   IsOneWay=false, 
   IsInitiating=true, 
   IsTerminating=false)] 
public CommandResponse Average( 
   AverageRequest request 
) 
  
<FaultContractAttribute(DetailType=Leadtools.Services.Raster.FaultContracts.RasterFault,  
   Action="",  
   Name="",  
   Namespace="",  
   ProtectionLevel=ProtectionLevel.None,  
   HasProtectionLevel=False)> 
<OperationContractAttribute("Average")> 
Function Average( _ 
   ByVal request As Leadtools.Services.Imageprocessing.Datacontracts.AverageRequest _ 
) As Leadtools.Services.Imageprocessing.Datacontracts.CommandResponse 
[FaultContractAttribute(DetailType=Leadtools.Services.Raster.FaultContracts.RasterFault,  
   Action="",  
   Name="",  
   Namespace="",  
   ProtectionLevel=ProtectionLevel.None,  
   HasProtectionLevel=false)] 
[OperationContractAttribute("Average")] 
Leadtools.Services.Imageprocessing.Datacontracts.CommandResponse^ Average(  
   Leadtools.Services.Imageprocessing.Datacontracts.AverageRequest^ request 
)  

Parameters

request
A System.Runtime.Serialization.DataContractAttribute containing the data that will be used in this Average operation.

Return Value

A System.Runtime.Serialization.DataContractAttribute containing the modified image resulting from the Average operation.

Remarks
  • You control the amount of blur by specifying the size of the neighborhood that is used for averaging.
  • This operation supports 12 and 16-bit grayscale and 48 and 64-bit color images. Support for 12 and 16-bit grayscale and 48 and 64-bit color images is available only in the Document/Medical toolkits.
  • This operation does not support 32-bit grayscale images.

For more information, refer to Removing Noise.

Example

C#
VB
using Leadtools.Services; 
 
public void AverageExample() 
{ 
   FiltersProcessingServiceClient client = new FiltersProcessingServiceClient(); 
 
   RawBinaryData sourceBinaryData = new RawBinaryData(); 
   sourceBinaryData.Data = File.ReadAllBytes(Path.Combine(LEAD_VARS.ImagesDir, "image1.cmp")); 
 
   RasterConvertOptions convertOptions = new RasterConvertOptions(); 
 
   convertOptions.Source = sourceBinaryData; 
   convertOptions.Destination = null; 
   convertOptions.Format = RasterImageFormat.Bmp; 
   convertOptions.FirstPage = 1; 
   convertOptions.LastPage = 1; 
   convertOptions.BitsPerPixel = 24; 
   convertOptions.QualityFactor = 2; 
 
   AverageRequest request = new AverageRequest(); 
 
   request.ConvertOptions = convertOptions; 
   request.RegionData = null; 
   request.Dimension = 3; 
 
   CommandResponse response = client.Average(request); 
   if (response.Destination != null) 
   { 
      if (response.Destination is RawBinaryData) 
         File.WriteAllBytes(Path.Combine(LEAD_VARS.ImagesDir, "Average.bmp"), (response.Destination as RawBinaryData).Data); 
   } 
 
   client.Close(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
} 
Imports Leadtools.Services 
Imports Leadtools.Services.datacontracts._2009._01 
Imports Leadtools.Services.raster.datacontracts._2009._01 
Imports Leadtools.Services.ImageProcessing.datacontracts._2009._01 
 
Public Sub AverageExample() 
   Dim client As FiltersProcessingServiceClient = New FiltersProcessingServiceClient() 
 
   Dim sourceBinaryData As RawBinaryData = New RawBinaryData() 
   sourceBinaryData.Data = File.ReadAllBytes(Path.Combine(LEAD_VARS.ImagesDir, "image1.cmp")) 
 
   Dim convertOptions As RasterConvertOptions = New RasterConvertOptions() 
 
   convertOptions.Source = sourceBinaryData 
   convertOptions.Destination = Nothing 
   convertOptions.Format = RasterImageFormat.Bmp 
   convertOptions.FirstPage = 1 
   convertOptions.LastPage = 1 
   convertOptions.BitsPerPixel = 24 
   convertOptions.QualityFactor = 2 
 
   Dim request As AverageRequest = New AverageRequest() 
 
   request.ConvertOptions = convertOptions 
   request.RegionData = Nothing 
   request.Dimension = 3 
 
   Dim response As CommandResponse = client.Average(request) 
   If Not response.Destination Is Nothing Then 
      If TypeOf response.Destination Is RawBinaryData Then 
         File.WriteAllBytes(Path.Combine(LEAD_VARS.ImagesDir, "Average.bmp"), (TryCast(response.Destination, RawBinaryData)).Data) 
      End If 
   End If 
 
   client.Close() 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class 

Requirements

Target Platforms

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.