AutoFixImageResolutionOptions Structure

Summary

Provides the information needed to automatically convert the resolution of digital photos in LEADTOOLS toolkits.

Syntax

C++/CLI

Java

Python

public struct AutoFixImageResolutionOptions

public class AutoFixImageResolutionOptions

public: 
   value class AutoFixImageResolutionOptions sealed

class AutoFixImageResolutionOptions:

Remarks

Automatic resolution conversion is particularly useful in OCR or Document Writer operations.

Typically, a picture taken with a digital camera does not have good resolution information (DPI). (Images originating from scanners have good resolution information, but images from digital cameras do not.) This is because digital cameras usually set the resolution regardless of the width and height of the image captured. The resolution set is an arbitrary number, often 72 DPI.

An example will illustrate the consequences of using an arbitrary DPI. Suppose you take a 12 Megapixels (3000 x 4000) photo with a digital camera. Keeping the original resolution at 72 DPI, the image would be 41.6 x 55.5 inches. If you then convert this image to PDF without adjusting the resolution, it will generate a PDF file that is 41.6 x 55.5 inches. Loaded using a LEADTOOLS document viewer, the image will be loaded onto many pages (5x5 = 25 pages). Most people do not want or expect that. Therefore, it is preferable to adjust the resolution so the image fits inside a single page.

The following methods allow getting and setting the automatic resolution conversion options:

The settings in AutoFixImageResolutionOptions are used under the following conditions:

Directly if RasterImage.AutoFixResolution is called.
Indirectly when using RasterCodecs with any load method (RasterCodecs.Load, RasterCodecs.LoadAync, etc.) if the value of CodecsLoadOptions is true. The load methods use the settings in AutoFixImageResolutionOptions to determine whether the resolution in a file should be automatically updated to fit inside a rectangle of PageWidth x PageHeight in size.
Indirectly if a RasterCodecs.GetInformation (or an equivalent method that retrieves a CodecsImageInfo object for a file whose resolution should be automatically converted) is called. The XResolution and YResolution members will be set to the converted resolution. In addition, CodecsImageInfo will have the IsCorrectedResolution value set to true.

The fit calculation is a smart algorithm that measures the rectangle area, which means that if an image resolution needs to be updated, it will either be adjusted to fit inside a PageWidth x PageHeight rectangle, or in a PageHeight x PageWidth rectangle, whichever fits best.

The following examples assume the following conditions:

AutoFixImageResolutionOptions has been set
PageWidth = 8.5
PageHeight = 11
Unit = AutoFixImageResolutionUnit.Inch (the settings for the US letter paper size)
MinResolution = 96

If a Load method or RasterImage.AutoFixResolution is called:

If the image is 3000 x 4000 and 72 DPI -> The image will be converted to fit inside an 8.5" x 11" rectangle, so the resolution will be updated to 352 DPI.
If the image is 4000 x 3000 and 72 DPI -> The image will be converted to fit inside an 11" x 8.5" rectangle, so the resolution will be updated to 352 DPI.
If the image is 4000 x 3000 and 150 DPI -> The image will be left unchanged, so the resulting resolution will still be 150 DPI.
If the image is 3000 x 4000 and 96 DPI -> The image will be left unchanged, so the resulting resolution will still be 96 DPI.

Example

The following example shows how to instruct LEADTOOLS to automatically convert the resolution in digital photos (images with a resolution less than 96):

Java

using Leadtools; 
using Leadtools.Codecs; 
 
 
public static void AutoFixImageResolutionOptions_Example() 
{ 
	// Simulate a digital camera image 
	string fileName = Path.Combine(LEAD_VARS.ImagesDir, "digital-camera.jpg"); 
	int pixelWidth = 3042; 
	int pixelHeight = 4032; 
	int resolution = 72; 
	using (var rasterImage = RasterImage.Create(pixelWidth, pixelHeight, 24, resolution, RasterColor.White)) 
	{ 
		using (var codecs = new RasterCodecs()) 
		{ 
			codecs.Save(rasterImage, fileName, RasterImageFormat.ExifJpeg411, 24); 
		} 
	} 
 
	Console.WriteLine("Default"); 
 
	// Load it using the default values, it should be the original size 
	using (var codecs = new RasterCodecs()) 
	{ 
		using (var rasterImage = codecs.Load(fileName, 1)) 
		{ 
			Console.WriteLine("image size {0} by {1} pixels at {2} DPI", rasterImage.Width, rasterImage.Height, rasterImage.XResolution); 
			// Show its size in inches 
			double inchesWidth = (double)rasterImage.Width / rasterImage.XResolution; 
			double inchesHeight = (double)rasterImage.Height / rasterImage.YResolution; 
			Console.WriteLine("size in inches {0} by {1}", inchesWidth, inchesHeight); 
			Debug.Assert(rasterImage.Width == pixelWidth); 
			Debug.Assert(rasterImage.Height == pixelHeight); 
			Debug.Assert(rasterImage.XResolution == resolution); 
			Debug.Assert(rasterImage.YResolution == resolution); 
		} 
	} 
 
	Console.WriteLine("Fixing the resolution"); 
 
	// Automatically fix its resolution next time we load it 
	AutoFixImageResolutionOptions options = RasterDefaults.GetAutoFixImageResolutionOptions(); 
	options.PageWidth = 8.5; 
	options.PageHeight = 11; 
	options.Unit = AutoFixImageResolutionUnit.Inch; 
	options.MinResolution = 96; 
	RasterDefaults.SetAutoFixImageResolutionOptions(options); 
 
	using (var codecs = new RasterCodecs()) 
	{ 
		// Use the option with this RasterCodecs 
		codecs.Options.Load.AutoFixImageResolution = true; 
		using (var rasterImage = codecs.Load(fileName, 1)) 
		{ 
			Console.WriteLine("image size {0} by {1} pixels at {2} DPI", rasterImage.Width, rasterImage.Height, rasterImage.XResolution); 
			// Show its size in inches 
			double inchesWidth = (double)rasterImage.Width / rasterImage.XResolution; 
			double inchesHeight = (double)rasterImage.Height / rasterImage.YResolution; 
			Console.WriteLine("size in inches {0} by {1}", inchesWidth, inchesHeight); 
			Debug.Assert(rasterImage.Width == pixelWidth); 
			Debug.Assert(rasterImage.Height == pixelHeight); 
			Debug.Assert((int)inchesWidth <= 8.5); 
			Debug.Assert((int)inchesHeight <= 11); 
		} 
	} 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.IOException; 
import java.nio.file.Files; 
import java.nio.file.Path; 
import java.nio.file.Paths; 
 
import org.junit.*; 
import org.junit.Test; 
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.*; 
 
 
public void rasterDefaultsAutoFixImageResolutionOptionsExample() { 
   // Simulate a digital camera image 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   String fileName = combine(LEAD_VARS_IMAGES_DIR, "digital-camera.jpg"); 
   int pixelWidth = 3042; 
   int pixelHeight = 4032; 
   int resolution = 72; 
   RasterImage rasterImage = RasterImage.create(pixelWidth, pixelHeight, 24, resolution, RasterColor.WHITE); 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.save(rasterImage, fileName, RasterImageFormat.EXIF_JPEG_411, 24); 
 
   System.out.println("Default"); 
 
   // Load it using the default values, it should be the original size 
   RasterImage rasterImage2 = codecs.load(fileName, 1); 
   System.out.printf("image size %d by %d pixels at %d DPI\n", rasterImage2.getWidth(), rasterImage2.getHeight(), 
         rasterImage2.getXResolution()); 
 
   // Show its size in inches 
   double inchesWidth = (double) rasterImage2.getWidth() / rasterImage2.getXResolution(); 
   double inchesHeight = (double) rasterImage2.getHeight() / rasterImage2.getYResolution(); 
   System.out.printf("size in inches %f by %f", inchesWidth, inchesHeight); 
   assertTrue(rasterImage2.getWidth() == pixelWidth); 
   assertTrue(rasterImage2.getHeight() == pixelHeight); 
   assertTrue(rasterImage2.getXResolution() == resolution); 
   assertTrue(rasterImage2.getYResolution() == resolution); 
 
   System.out.println("Fixing the resolution"); 
 
   // Automatically fix its resolution next time we load it 
   AutoFixImageResolutionOptions options = RasterDefaults.getAutoFixImageResolutionOptions(); 
   options.setPageWidth(8.5); 
   options.setPageHeight(11); 
   options.setUnit(AutoFixImageResolutionUnit.INCH); 
   options.setMinResolution(96); 
   RasterDefaults.setAutoFixImageResolutionOptions(options); 
 
   // Use the option with this RasterCodecs 
   codecs.getOptions().getLoad().setAutoFixImageResolution(true); 
   RasterImage rasterImage3 = codecs.load(fileName, 1); 
   System.out.printf("image size %d by %d pixels at %d DPI", rasterImage3.getWidth(), rasterImage3.getHeight(), 
         rasterImage3.getXResolution()); 
   // Show its size in inches 
   double inchesWidth2 = (double) rasterImage3.getWidth() / rasterImage3.getXResolution(); 
   double inchesHeight2 = (double) rasterImage3.getHeight() / rasterImage3.getYResolution(); 
   System.out.printf("size in inches %f by %f", inchesWidth, inchesHeight); 
   assertTrue(rasterImage3.getWidth() == pixelWidth); 
   assertTrue(rasterImage3.getHeight() == pixelHeight); 
   assertTrue((int) inchesWidth2 <= 8.5); 
   assertTrue((int) inchesHeight2 <= 11); 
}

Requirements

Target Platforms

Reference

Leadtools Namespace

Download our FREE evaluation

Help Version 23.0.2024.5.22

Leadtools Assembly

Introduction

Getting Started

Namespaces

Leadtools Namespace

Leadtools.ImageProcessing Namespace

Assemblies