ClearCommand Class

Summary

Sets all bits to 0 in the specified image, making it a black image.

Syntax

Objective-C

C++/CLI

Java

Python

public class ClearCommand : RasterCommand

@interface LTClearCommand : LTRasterCommand

public class ClearCommand extends RasterCommand

public ref class ClearCommand : public RasterCommand

class ClearCommand(RasterCommand):

Remarks

Sets all bits to 0, in the specified image. If the image has a palette, all pixels will be the color of the first palette entry.

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

Example

This example will clear an image before saving it back to disk.

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
 
 
public void ClearCommandExample() 
{ 
	RasterCodecs codecs = new RasterCodecs(); 
 
	string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); 
	string destFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1_clear.bmp"); 
 
	// Load the source image from disk 
	RasterImage image = codecs.Load(srcFileName); 
 
	// Clear the image 
	ClearCommand cmd = new ClearCommand(); 
	cmd.Run(image); 
 
	// Save the image to disk 
	codecs.Save( 
	   image, 
	   destFileName, 
	   RasterImageFormat.Bmp, 
	   24); 
 
	// Clean up 
	image.Dispose(); 
	codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.IOException; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.imageprocessing.*; 
 
 
public void clearCommandExample() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   RasterCodecs codecs = new RasterCodecs(); 
   String srcFileName = combine(LEAD_VARS_IMAGES_DIR, "rgsref.cmp"); 
   String destFileName = combine(LEAD_VARS_IMAGES_DIR, "rgsref_clear.bmp"); 
 
   // Load the source image from disk 
   RasterImage image = codecs.load(srcFileName); 
 
   // Clear the image 
   ClearCommand cmd = new ClearCommand(); 
   cmd.run(image); 
 
   // Save the image to disk 
   codecs.save(image, destFileName, RasterImageFormat.BMP, 24); 
   assertTrue("file unsuccessfully saved to " + destFileName, (new File(destFileName)).exists()); 
   System.out.printf("File saved successfully to %s%n", destFileName); 
 
   // Clean up 
   image.dispose(); 
   codecs.dispose(); 
}

Requirements

Target Platforms

Reference

ClearCommand Members

Leadtools.ImageProcessing Namespace

Download our FREE evaluation

Help Version 23.0.2024.5.22

Leadtools Assembly

Introduction

Getting Started

Namespaces

Leadtools Namespace

Leadtools.ImageProcessing Namespace

Assemblies