HasRegion Property

Summary

Determines whether this RasterImage has a region.

Syntax

Objective-C

C++/CLI

Java

Python

public bool HasRegion { get; }

@property (nonatomic, assign, readonly) BOOL hasRegion

public boolean hasRegion();

public: 
property bool HasRegion { 
   bool get(); 
}

HasRegion # get  (RasterImage)

Property Value

true if this RasterImage has a region; false, otherwise.

Remarks

When an image has a region, the LEADTOOLS methods that modify the pixel values (for example PosterizeCommand) act on the region, rather than the whole image. In addition, the LEADTOOLS methods that flip, reverse, rotate, shear, or resize an image also transform the region to match the image. For example, if you were to shear the image that had a rectangular region, the region would become a parallelogram.

To remove an image region, use MakeRegionEmpty.

For more information, refer to Working with the Existing Region.

Example

Java

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 Leadtools.Svg; 
 
 
public void RegionExample() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); 
   string destFileName1 = Path.Combine(LEAD_VARS.ImagesDir, "Image1_InvertRegion.bmp"); 
   string destFileName2 = Path.Combine(LEAD_VARS.ImagesDir, "Image1_InvertNoRegion.bmp"); 
 
   // Load the image 
   RasterImage image = codecs.Load(srcFileName); 
 
   // The image should have no region 
   Console.WriteLine("After loading, HasRegion = {0}", image.HasRegion); 
   Assert.IsTrue(!image.HasRegion); 
 
   // Add a region to the image 
   LeadRect rc = new LeadRect(0, 0, image.Width / 4, image.Height / 4); 
   image.AddEllipseToRegion(null, rc, RasterRegionCombineMode.Set); 
 
   // The image should have a region now 
   Console.WriteLine("After AddEllipseToRegion, HasRegion = {0}", image.HasRegion); 
   Assert.IsTrue(image.HasRegion); 
 
   // Invert this image and save it to a file 
   InvertCommand command = new InvertCommand(); 
   command.Run(image); 
   codecs.Save(image, destFileName1, RasterImageFormat.Bmp, 24); 
 
   // Get rid of the region 
   image.MakeRegionEmpty(); 
 
   // The image should not have a region now 
   Console.WriteLine("After MakeRegionEmpty, HasRegion = {0}", image.HasRegion); 
   Assert.IsTrue(!image.HasRegion); 
 
   // Invert again and save it 
   command.Run(image); 
   codecs.Save(image, destFileName2, RasterImageFormat.Bmp, 24); 
 
   image.Dispose(); 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.FileInputStream; 
import java.io.IOException; 
import java.io.InputStream; 
import java.util.ArrayList; 
import java.util.List; 
 
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.core.*; 
import leadtools.svg.*; 
import leadtools.imageprocessing.CloneCommand; 
import leadtools.imageprocessing.FillCommand; 
import leadtools.imageprocessing.FlipCommand; 
import leadtools.imageprocessing.GrayscaleCommand; 
import leadtools.imageprocessing.color.InvertCommand; 
import leadtools.imageprocessing.color.PosterizeCommand; 
 
 
public void regionExample() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   RasterCodecs codecs = new RasterCodecs(); 
   String srcFileName = combine(LEAD_VARS_IMAGES_DIR, "Image1.cmp"); 
   String destFileName1 = combine(LEAD_VARS_IMAGES_DIR, "Image1_InvertRegion.bmp"); 
   String destFileName2 = combine(LEAD_VARS_IMAGES_DIR, "Image1_InvertNoRegion.bmp"); 
 
   // Load the image 
   RasterImage image = codecs.load(srcFileName); 
 
   // The image should have no region 
   System.out.printf("After loading, HasRegion = %s%n", image.hasRegion()); 
   assertTrue(!image.hasRegion()); 
 
   // Add a region to the image 
   LeadRect rc = new LeadRect(0, 0, image.getWidth() / 4, image.getHeight() / 4); 
   image.addEllipseToRegion(null, rc, RasterRegionCombineMode.SET); 
 
   // The image should have a region now 
   System.out.printf("After AddEllipseToRegion, HasRegion = %s%n", image.hasRegion()); 
   assertTrue(image.hasRegion()); 
 
   // Invert this image and save it to a file 
   InvertCommand command = new InvertCommand(); 
   command.run(image); 
   codecs.save(image, destFileName1, RasterImageFormat.BMP, 24); 
 
   assertTrue("file unsuccessfully saved to " + destFileName1, (new File(destFileName1)).exists()); 
   System.out.printf("File saved successfully to %s%n", destFileName1); 
 
   // Get rid of the region 
   image.makeRegionEmpty(); 
 
   // The image should not have a region now 
   System.out.printf("After MakeRegionEmpty, HasRegion = %s%n", image.hasRegion()); 
   assertTrue(!image.hasRegion()); 
 
   // Invert again and save it 
   command.run(image); 
   codecs.save(image, destFileName2, RasterImageFormat.BMP, 24); 
 
   assertTrue("file unsuccessfully saved to " + destFileName2, (new File(destFileName2)).exists()); 
   System.out.printf("File saved successfully to %s%n", destFileName2); 
 
   // Clean up 
   image.dispose(); 
   codecs.dispose(); 
}

Requirements

Target Platforms

Reference

RasterImage Class

RasterImage Members

Download our FREE evaluation

Help Version 23.0.2024.5.22