←Select platform

PredefinedSpatial Method

Summary

Imposes a predefined spatial filter on an image. This operation is available in the Document/Medical Toolkits.

Syntax

C++

[OperationContractAttribute(Action="PredefinedSpatial", 
   AsyncPattern=false, 
   IsOneWay=false, 
   IsInitiating=true, 
   IsTerminating=false)] 
[FaultContractAttribute(System.Type)] 
public CommandResponse PredefinedSpatial( 
   PredefinedSpatialRequest request 
)

  
<FaultContractAttribute(DetailType=Leadtools.Services.Raster.FaultContracts.RasterFault,  
   Action="",  
   Name="",  
   Namespace="",  
   ProtectionLevel=ProtectionLevel.None,  
   HasProtectionLevel=False)> 
<OperationContractAttribute("PredefinedSpatial")> 
Function PredefinedSpatial( _ 
   ByVal request As Leadtools.Services.Imageprocessing.Datacontracts.PredefinedSpatialRequest _ 
) As Leadtools.Services.Imageprocessing.Datacontracts.CommandResponse

[FaultContractAttribute(DetailType=Leadtools.Services.Raster.FaultContracts.RasterFault,  
   Action="",  
   Name="",  
   Namespace="",  
   ProtectionLevel=ProtectionLevel.None,  
   HasProtectionLevel=false)] 
[OperationContractAttribute("PredefinedSpatial")] 
Leadtools.Services.Imageprocessing.Datacontracts.CommandResponse^ PredefinedSpatial(  
   Leadtools.Services.Imageprocessing.Datacontracts.PredefinedSpatialRequest^ request 
)

Parameters

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

Return Value

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

Remarks

A spatial filter recomputes the brightness of each pixel in an image by using a weighted averaging technique that considers the surrounding pixels. Spatial filters are used for operations such as sharpening an image or detecting edges within the image.
The PredefinedSpatial operation works best with 24-bit, 16-bit, or grayscale images. If the image uses a color palette, this command matches the new brightness value of each pixel to the nearest color in the existing palette.
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.
It is beyond the scope of this documentation to explain how applying various weighting factors affects an image. If you specify your own filter, you should refer to a textbook on image processing. For example, Digital Image Processing: Principles and Applications, by Gregory A. Baxes.
This operation does not support 32-bit grayscale images.

For more information, refer to Detecting and Enhancing Edges and Lines. For more information, refer to List of Spatial Filters.

Example

using Leadtools.Services; 
 
public void PredefinedSpatialExample() 
{ 
   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; 
 
   PredefinedSpatialRequest request = new PredefinedSpatialRequest(); 
 
   request.ConvertOptions = convertOptions; 
   request.RegionData = null; 
   request.Predefined = SpatialFilterCommandPredefined.EmbossNorth; 
   CommandResponse response = client.PredefinedSpatial(request); 
 
   if (response.Destination != null) 
   { 
      if (response.Destination is RawBinaryData) 
         File.WriteAllBytes(Path.Combine(LEAD_VARS.ImagesDir, "PredefinedSpatial.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 PredefinedSpatialExample() 
   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 PredefinedSpatialRequest = New PredefinedSpatialRequest() 
 
   request.ConvertOptions = convertOptions 
   request.RegionData = Nothing 
   request.Predefined = SpatialFilterCommandPredefined.EmbossNorth 
   Dim response As CommandResponse = client.PredefinedSpatial(request) 
 
   If Not response.Destination Is Nothing Then 
      If TypeOf response.Destination Is RawBinaryData Then 
         File.WriteAllBytes(Path.Combine(LEAD_VARS.ImagesDir, "PredefinedSpatial.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

Reference

IFiltersProcessingService Interface

IFiltersProcessingService Members

Help Version 19.0.2017.10.27

Leadtools.Services.ImageProcessing.ServiceContracts Assembly

Introduction

Getting Started

Namespaces

Leadtools.Services.ImageProcessing.ServiceContracts Namespace

Assemblies