GetPixel Method

Summary

Returns the color of the specified pixel.

Syntax

Objective-C

C++

Java

public RasterColor GetPixel( 
   int row, 
   int column 
)

Public Function GetPixel( _ 
   ByVal row As Integer, _ 
   ByVal column As Integer _ 
) As RasterColor

- (LTRasterColor *)getPixelAtRow:(NSInteger)row  
                          column:(NSInteger)column

public RasterColor getPixel( 
  int row,  
  int column 
)

public: 
RasterColor GetPixel(  
   int row, 
   int column 
)

Parameters

row
The zero-based row number of the pixel.

column
The zero-based column number of the pixel.

Return Value

This method returns a RasterColor value which may represent an index into an image palette, a grayscale value (Medical Imaging only), or red, green, and blue color values. Alpha value for 32 and 64-bit images are also returned.

Remarks

The standard Windows values for RasterColor represent either red, green, and blue color values, or an index into the image palette. A RasterColor value with the RGB value of 0x00BBGGRR represents the blue, green, and red color values for the specified pixel, where 0xBB is the blue value, 0xGG is the green value and 0xRR is the red value. If 0x01000000 is set in the RGB value of RasterColor (0x010000ZZ), the lower 8 bits (0xZZ) represent an index into the image palette which holds the color value.

For 32 and 64-bit images, an alpha value is also available in the image. This method will return the alpha value in the returned RasterColor object A property. For 32-bit images, this will be the exact byte value of the alpha for the pixel. For 64-bit images, the alpha is 16-bit and since RasterColor.A is an 8-bit value, the returned alpha is normalized from its 16-bit value to 8-bit. For other bits/pixel values, the value returned from this method is identical to the value returned from GetPixelColor.

You can use the SetPixel method to assign the returned value to another pixel.

This method uses image coordinates to specify the pixel. Therefore, you must account for the view perspective of the image.

If you specify a pixel that is outside the image or outside the region (if the image has one), this method throws an exception.

This method supports signed/unsigned data images.

The GetPixel function can use the Extended Grayscale mask. For more information, refer to Grayscale Images

For more information, refer to Introduction to Image Processing With LEADTOOLS.

For more information refer to Accounting for View Perspective.

Example

This example uses will load an image as 32-bit, use GetPixel and SetPixel to set the alpha value for each pixel to 128 (half transparent) and save the result as PNG.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Core; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Dicom; 
using Leadtools.Drawing; 
using Leadtools.Controls; 
using LeadtoolsExamples.Common; 
using Leadtools.Svg; 
 
public void GetSetPixelExample() 
{ 
   string sourceFile = Path.Combine(ImagesPath.Path, "Sample1.cmp"); 
   string destFile = Path.Combine(ImagesPath.Path, "GetSetPixelExample.png"); 
 
   RasterCodecs codecs = new RasterCodecs(); 
 
   // Load the source image as 32-bit (with alpha) 
   RasterImage image = codecs.Load(sourceFile, 32, CodecsLoadByteOrder.Bgr, 1, 1); 
 
   // Loop through each pixel and set its alpha value to 128 (half transparent) 
   for (int row = 0; row < image.Height; row++) 
   { 
      for (int col = 0; col < image.Width; col++) 
      { 
         RasterColor color = image.GetPixel(row, col); 
         color.A = 128; 
         image.SetPixel(row, col, color); 
      } 
   } 
 
   // Save the image as PNG with these new alpha values 
   codecs.Save(image, destFile, RasterImageFormat.Png, 32); 
 
   // Clean up 
   image.Dispose(); 
   codecs.Dispose(); 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Core 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Controls 
Imports Leadtools.Dicom 
Imports Leadtools.Drawing 
Imports Leadtools.Svg 
 
Public Sub GetSetPixelExample() 
   Dim sourceFile As String = Path.Combine(LEAD_VARS.ImagesDir, "Sample1.cmp") 
   Dim destFile As String = Path.Combine(LEAD_VARS.ImagesDir, "GetSetPixelExample.png") 
 
   Dim codecs As New RasterCodecs() 
 
   ' Load the source image as 32-bit (with alpha) 
   Dim image As RasterImage = codecs.Load(sourceFile, 32, CodecsLoadByteOrder.Bgr, 1, 1) 
 
   ' Loop through each pixel and set its alpha value to 128 (half transparent) 
   For row As Integer = 0 To image.Height - 1 
      For col As Integer = 0 To image.Width - 1 
         Dim color As RasterColor = image.GetPixel(row, col) 
         color.A = 128 
         image.SetPixel(row, col, color) 
      Next 
   Next 
 
   ' Save the image as PNG with these new alpha values 
   codecs.Save(image, destFile, RasterImageFormat.Png, 32) 
 
   ' Clean up 
   image.Dispose() 
   codecs.Dispose() 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

Requirements

Target Platforms

Reference

RasterImage Class

RasterImage Members

SetPixel Method

Download our FREE evaluation

Help Version 20.0.2020.4.2