Label Property

Summary

Gets or sets a value that contains user defined text, which may be used to label or name this overlay.

Syntax

Objective-C

C++/CLI

Java

Python

public string Label { get; set; }

@property (nonatomic, copy, nullable) NSString *label

public String getLabel(); 
public void setLabel( 
   java.lang.String string 
);

public: 
property String^ Label { 
   String^ get(); 
   void set (    String^ ); 
}

Label # get and set (RasterOverlayAttributes)

Property Value

A String that contains user defined text, which may be used to label or name this overlay.

Remarks

For more information, refer to "Overlay Plane Module Attributes" in the DICOM standard and Overlay Overview.

Example

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 GetOverlayImageExample() 
{ 
	RasterCodecs codecs = new RasterCodecs(); 
	// load an image and set an overlay 
	RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "DICOM","image2.dcm"), 0, CodecsLoadByteOrder.BgrOrGray, 1, 1); 
	RasterImage imageOverlay1 = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "ulay1.bmp"), 1, CodecsLoadByteOrder.Rgb, 1, 1); 
	RasterImage imageOverlay2 = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "ulay1.bmp"), 1, CodecsLoadByteOrder.Rgb, 1, 1); 
	image.SetOverlayImage(0, imageOverlay1, RasterGetSetOverlayImageMode.Copy); 
	image.SetOverlayImage(1, imageOverlay2, RasterGetSetOverlayImageMode.Copy); 
 
	// update the attributes of one of the overlays 
	RasterOverlayAttributes attributes = image.GetOverlayAttributes(0, 
	   RasterGetSetOverlayAttributesFlags.Color | 
	   RasterGetSetOverlayAttributesFlags.Flags | 
	   RasterGetSetOverlayAttributesFlags.Origin | 
	   RasterGetSetOverlayAttributesFlags.BitIndex); 
 
	attributes.Color = new RasterColor(255, 255, 255); 
	attributes.AutoPaint = true; 
	attributes.AutoProcess = true; 
	attributes.Origin = new LeadPoint(5, 5); 
	attributes.BitPosition = image.BitsPerPixel - 1; 
 
	image.UpdateOverlayAttributes( 
	   0, 
	   attributes, 
	   RasterGetSetOverlayAttributesFlags.Color | 
	   RasterGetSetOverlayAttributesFlags.Flags | 
	   RasterGetSetOverlayAttributesFlags.Origin | 
	   RasterGetSetOverlayAttributesFlags.BitIndex); 
 
 
	int count = image.OverlayCount; 
	for (int i = 0; i < count; i++) 
	{ 
		using (RasterImage overlayTest = image.GetOverlayImage(i, RasterGetSetOverlayImageMode.NoCopy)) 
		{ 
			string fileName = string.Format(Path.Combine(LEAD_VARS.ImagesDir, "overlay{0}_copy.bmp"), i); 
			codecs.Save(overlayTest, fileName, RasterImageFormat.Bmp, 1); 
		} 
	} 
 
	image.Dispose(); 
	imageOverlay1.Dispose(); 
	imageOverlay2.Dispose(); 
	codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
}

Requirements

Target Platforms

Reference

RasterOverlayAttributes Class

RasterOverlayAttributes Members

Download our FREE evaluation

Help Version 22.0.2023.5.16

Leadtools Assembly

Introduction

Getting Started

Namespaces

Leadtools Namespace

Leadtools.ImageProcessing Namespace

Assemblies