LEADTOOLS Image File Support (Leadtools.Codecs assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
CodecsTiffOptions Class
See Also  Members  
Leadtools.Codecs Namespace : CodecsTiffOptions Class



Provides extra options for loading and saving TIFF images.

Object Model

CodecsTiffOptions ClassCodecsTiffLoadOptions ClassCodecsTiffSaveOptions Class

Syntax

Visual Basic (Declaration) 
Public Class CodecsTiffOptions
Visual Basic (Usage)Copy Code
Dim instance As CodecsTiffOptions
C# 
public class CodecsTiffOptions
C++/CLI 
public ref class CodecsTiffOptions

Example

Visual BasicCopy Code
Public Sub CodecsTiffOptionsExample()
      Dim codecs As RasterCodecs = New RasterCodecs()

      Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "OCR1.TIF")

      ' Get all Information about the Tiff file that you want to load.
      Dim imageInfo As CodecsImageInfo = codecs.GetInformation(srcFileName, True)

      If imageInfo.Tiff.IsImageFileDirectoryOffsetValid Then
         codecs.Options.Tiff.Load.ImageFileDirectoryOffset = imageInfo.Tiff.ImageFileDirectoryOffset
         codecs.Options.Tiff.Save.ImageFileDirectoryOffset = imageInfo.Tiff.ImageFileDirectoryOffset
      End If

      codecs.Options.Tiff.Load.UseImageFileDirectoryOffset = imageInfo.Tiff.IsImageFileDirectoryOffsetValid
      codecs.Options.Tiff.Save.UseImageFileDirectoryOffset = imageInfo.Tiff.IsImageFileDirectoryOffsetValid

      codecs.Options.Tiff.Load.IgnorePhotometricInterpretation = True

      Dim image As RasterImage = codecs.Load(srcFileName)

      codecs.Options.Tiff.Save.NoPalette = imageInfo.Tiff.HasNoPalette
      codecs.Options.Tiff.Save.PreservePalette = imageInfo.Tiff.HasNoPalette

      'Set the tiffSave options
      codecs.Options.Tiff.Save.NoPageNumber = False
      codecs.Options.Tiff.Save.NoSubFileType = False
      codecs.Options.Tiff.Save.UsePhotometricInterpretation = True
      codecs.Options.Tiff.Save.PhotometricInterpretation = CodecsTiffPhotometricInterpretation.YcbCr
      codecs.Options.Tiff.Save.UseTileSize = True
      codecs.Options.Tiff.Save.TileHeight = 200
      codecs.Options.Tiff.Save.TileWidth = 200

      'saving the image
      codecs.Save(image, Path.Combine(LEAD_VARS.ImagesDir, "testtiff1.TIF"), RasterImageFormat.Tif, image.BitsPerPixel, 1, image.PageCount, 1, CodecsSavePageMode.Overwrite)

      'change some tiffsave options.
      codecs.Options.Tiff.Save.NoPageNumber = True
      codecs.Options.Tiff.Save.NoSubFileType = True
      codecs.Options.Tiff.Save.UsePhotometricInterpretation = False
      codecs.Options.Tiff.Save.UseTileSize = False
      codecs.Options.Tiff.Save.NoPalette = False
      codecs.Options.Tiff.Save.PreservePalette = True
      codecs.Options.Tiff.Save.PhotometricInterpretation = CodecsTiffPhotometricInterpretation.Palette

      'save the image with different name.
      codecs.Save(image, Path.Combine(LEAD_VARS.ImagesDir, "testtiff2.TIF"), RasterImageFormat.CcittGroup4, image.BitsPerPixel, 1, image.PageCount, 1, CodecsSavePageMode.Overwrite)

      ' 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
C#Copy Code
public void CodecsTiffOptionsExample()
   {
      RasterCodecs codecs = new RasterCodecs();

      string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "OCR1.TIF");

      // Get all Information about the Tiff file that you want to load.
      CodecsImageInfo imageInfo = codecs.GetInformation(srcFileName, true);

      if (imageInfo.Tiff.IsImageFileDirectoryOffsetValid)
      {
         codecs.Options.Tiff.Load.ImageFileDirectoryOffset = imageInfo.Tiff.ImageFileDirectoryOffset;
         codecs.Options.Tiff.Save.ImageFileDirectoryOffset = imageInfo.Tiff.ImageFileDirectoryOffset;
      }

      codecs.Options.Tiff.Load.UseImageFileDirectoryOffset = imageInfo.Tiff.IsImageFileDirectoryOffsetValid;
      codecs.Options.Tiff.Save.UseImageFileDirectoryOffset = imageInfo.Tiff.IsImageFileDirectoryOffsetValid;

      codecs.Options.Tiff.Load.IgnorePhotometricInterpretation = true;

      RasterImage image = codecs.Load(srcFileName);

      codecs.Options.Tiff.Save.NoPalette = imageInfo.Tiff.HasNoPalette;
      codecs.Options.Tiff.Save.PreservePalette = imageInfo.Tiff.HasNoPalette;

      //Set the tiffSave options
      codecs.Options.Tiff.Save.NoPageNumber = false;
      codecs.Options.Tiff.Save.NoSubFileType = false;
      codecs.Options.Tiff.Save.UsePhotometricInterpretation = true;
      codecs.Options.Tiff.Save.PhotometricInterpretation = CodecsTiffPhotometricInterpretation.YcbCr;
      codecs.Options.Tiff.Save.UseTileSize = true;
      codecs.Options.Tiff.Save.TileHeight = 200;
      codecs.Options.Tiff.Save.TileWidth = 200;

      //saving the image
      codecs.Save(image,  Path.Combine(LEAD_VARS.ImagesDir, "testtiff1.TIF"), RasterImageFormat.Tif, image.BitsPerPixel, 1, image.PageCount, 1, CodecsSavePageMode.Overwrite);

      //change some tiffsave options.
      codecs.Options.Tiff.Save.NoPageNumber = true;
      codecs.Options.Tiff.Save.NoSubFileType = true;
      codecs.Options.Tiff.Save.UsePhotometricInterpretation = false;
      codecs.Options.Tiff.Save.UseTileSize = false;
      codecs.Options.Tiff.Save.NoPalette = false;
      codecs.Options.Tiff.Save.PreservePalette = true;
      codecs.Options.Tiff.Save.PhotometricInterpretation = CodecsTiffPhotometricInterpretation.Palette;

      //save the image with different name.
      codecs.Save(image, Path.Combine(LEAD_VARS.ImagesDir, "testtiff2.TIF"), RasterImageFormat.CcittGroup4, image.BitsPerPixel, 1, image.PageCount, 1, CodecsSavePageMode.Overwrite);

      // Clean up
      image.Dispose();
      codecs.Dispose();
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}
SilverlightCSharpCopy Code
public void CodecsTiffOptionsExample(Stream inStreamTif, Stream outStreamTif, Stream outStreamCcittG4)
{
   RasterCodecs codecs = new RasterCodecs();
   // Get all Information about the Tiff file that you want to load.
   CodecsImageInfo imageInfo = codecs.GetInformation(inStreamTif, true);

   if (imageInfo.Tiff.IsImageFileDirectoryOffsetValid)
   {
      codecs.Options.Tiff.Load.ImageFileDirectoryOffset = imageInfo.Tiff.ImageFileDirectoryOffset;
      codecs.Options.Tiff.Save.ImageFileDirectoryOffset = imageInfo.Tiff.ImageFileDirectoryOffset;
   }

   codecs.Options.Tiff.Load.UseImageFileDirectoryOffset = imageInfo.Tiff.IsImageFileDirectoryOffsetValid;
   codecs.Options.Tiff.Save.UseImageFileDirectoryOffset = imageInfo.Tiff.IsImageFileDirectoryOffsetValid;

   codecs.Options.Tiff.Load.IgnorePhotometricInterpretation = true;

   RasterImage image = codecs.Load(inStreamTif);

   codecs.Options.Tiff.Save.NoPalette = imageInfo.Tiff.HasNoPalette;
   codecs.Options.Tiff.Save.PreservePalette = imageInfo.Tiff.HasNoPalette;

   //Set the tiffSave options
   codecs.Options.Tiff.Save.NoPageNumber = false;
   codecs.Options.Tiff.Save.NoSubFileType = false;
   codecs.Options.Tiff.Save.UsePhotometricInterpretation = true;
   codecs.Options.Tiff.Save.PhotometricInterpretation = CodecsTiffPhotometricInterpretation.YcbCr;
   codecs.Options.Tiff.Save.UseTileSize = true;
   codecs.Options.Tiff.Save.TileHeight = 200;
   codecs.Options.Tiff.Save.TileWidth = 200;

   //saving the image
   codecs.Save(image, outStreamTif, RasterImageFormat.Tif, image.BitsPerPixel, 1, image.PageCount, 1, CodecsSavePageMode.Overwrite);

   //change some tiffsave options.
   codecs.Options.Tiff.Save.NoPageNumber = true;
   codecs.Options.Tiff.Save.NoSubFileType = true;
   codecs.Options.Tiff.Save.UsePhotometricInterpretation = false;
   codecs.Options.Tiff.Save.UseTileSize = false;
   codecs.Options.Tiff.Save.NoPalette = false;
   codecs.Options.Tiff.Save.PreservePalette = true;
   codecs.Options.Tiff.Save.PhotometricInterpretation = CodecsTiffPhotometricInterpretation.Palette;

   //save the image with different name.
   codecs.Save(image, outStreamCcittG4, RasterImageFormat.CcittGroup4, image.BitsPerPixel, 1, image.PageCount, 1, CodecsSavePageMode.Overwrite);

   // Clean up
   image.Dispose();
}
SilverlightVBCopy Code
Public Sub CodecsTiffOptionsExample(ByVal inStreamTif As Stream, ByVal outStreamTif As Stream, ByVal outStreamCcittG4 As Stream)
   Dim codecs As RasterCodecs = New RasterCodecs()
   ' Get all Information about the Tiff file that you want to load.
   Dim imageInfo As CodecsImageInfo = codecs.GetInformation(inStreamTif, True)

   If imageInfo.Tiff.IsImageFileDirectoryOffsetValid Then
      codecs.Options.Tiff.Load.ImageFileDirectoryOffset = imageInfo.Tiff.ImageFileDirectoryOffset
      codecs.Options.Tiff.Save.ImageFileDirectoryOffset = imageInfo.Tiff.ImageFileDirectoryOffset
   End If

   codecs.Options.Tiff.Load.UseImageFileDirectoryOffset = imageInfo.Tiff.IsImageFileDirectoryOffsetValid
   codecs.Options.Tiff.Save.UseImageFileDirectoryOffset = imageInfo.Tiff.IsImageFileDirectoryOffsetValid

   codecs.Options.Tiff.Load.IgnorePhotometricInterpretation = True

   Dim image As RasterImage = codecs.Load(inStreamTif)

   codecs.Options.Tiff.Save.NoPalette = imageInfo.Tiff.HasNoPalette
   codecs.Options.Tiff.Save.PreservePalette = imageInfo.Tiff.HasNoPalette

   'Set the tiffSave options
   codecs.Options.Tiff.Save.NoPageNumber = False
   codecs.Options.Tiff.Save.NoSubFileType = False
   codecs.Options.Tiff.Save.UsePhotometricInterpretation = True
   codecs.Options.Tiff.Save.PhotometricInterpretation = CodecsTiffPhotometricInterpretation.YcbCr
   codecs.Options.Tiff.Save.UseTileSize = True
   codecs.Options.Tiff.Save.TileHeight = 200
   codecs.Options.Tiff.Save.TileWidth = 200

   'saving the image
   codecs.Save(image, outStreamTif, RasterImageFormat.Tif, image.BitsPerPixel, 1, image.PageCount, 1, CodecsSavePageMode.Overwrite)

   'change some tiffsave options.
   codecs.Options.Tiff.Save.NoPageNumber = True
   codecs.Options.Tiff.Save.NoSubFileType = True
   codecs.Options.Tiff.Save.UsePhotometricInterpretation = False
   codecs.Options.Tiff.Save.UseTileSize = False
   codecs.Options.Tiff.Save.NoPalette = False
   codecs.Options.Tiff.Save.PreservePalette = True
   codecs.Options.Tiff.Save.PhotometricInterpretation = CodecsTiffPhotometricInterpretation.Palette

   'save the image with different name.
   codecs.Save(image, outStreamCcittG4, RasterImageFormat.CcittGroup4, image.BitsPerPixel, 1, image.PageCount, 1, CodecsSavePageMode.Overwrite)

   ' Clean up
   image.Dispose()
End Sub

Inheritance Hierarchy

System.Object
   Leadtools.Codecs.CodecsTiffOptions

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also