TiffImage

TiffImage class

The tiff image.

public sealed class TiffImage : RasterCachedMultipageImage, IMultipageImageExt

Constructors

Name Description
TiffImage(TiffFrame) Initializes a new instance of the TiffImage class.
TiffImage(TiffFrame[]) Initializes a new instance of the TiffImage class.

Properties

Name Description
ActiveFrame { get; set; } Gets or sets the active frame.
AutoAdjustPalette { get; set; } Gets or sets a value indicating whether automatic adjust palette.
override BackgroundColor { get; set; } Gets or sets a value for the background color.
override BitsPerPixel { get; } Gets the image bits per pixel count.
Bounds { get; } Gets the image bounds.
BufferSizeHint { get; set; } Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
ByteOrder { get; set; } Gets or sets a value indicating the tiff byte order.
Container { get; } Gets the Image container.
DataStreamContainer { get; } Gets the object’s data stream.
Disposed { get; } Gets a value indicating whether this instance is disposed.
ExifData { get; set; } Gets or sets EXIF data for the active frame.
override FileFormat { get; } Gets a value of file format
Frames { get; } Gets Frames array of the image.
override HasAlpha { get; } Gets the Has alpha channel.
virtual HasBackgroundColor { get; set; } Gets or sets a value indicating whether image has background color.
override HasTransparentColor { get; } Gets a value indicating whether image has transparent color.
override Height { get; } Gets the image height.
override HorizontalResolution { get; set; } Gets the horizontal resolution, in pixels per inch, of this Image.
override ImageOpacity { get; } Gets opacity of this image.
InterruptMonitor { get; set; } Gets or sets the interrupt monitor.
IsCached { get; } Gets a value indicating whether image data is cached currently.
IsRawDataAvailable { get; } Gets a value indicating whether raw data loading is available.
override PageCount { get; } Gets the page count.
virtual PageExportingAction { get; set; } Gets or sets the page exporting action. Please note that setting this method will automatically release page resources after it is executed. It will be executed just before each page is saved.
override Pages { get; } Gets the pages.
Palette { get; set; } Gets or sets the color palette. The color palette is not used when pixels are represented directly.
override PremultiplyComponents { get; set; } Gets or sets a value indicating whether components must be premultiplied.
RawCustomColorConverter { get; set; } Gets or sets the custom color converter
virtual RawDataFormat { get; } Gets the raw data format.
RawDataSettings { get; } Gets the current raw data settings. Note when using these settings the data loads without conversion.
RawFallbackIndex { get; set; } Gets or sets the fallback index to use when palette index is out of bounds
RawIndexedColorConverter { get; set; } Gets or sets the indexed color converter
virtual RawLineSize { get; } Gets the raw line size in bytes.
Size { get; } Gets the image size.
virtual TransparentColor { get; set; } Gets the image transparent color.
virtual UpdateXmpData { get; set; } Gets or sets a value indicating whether to update the XMP metadata.
override UsePalette { get; } Gets a value indicating whether the image palette is used.
virtual UseRawData { get; set; } Gets or sets a value indicating whether to use raw data loading when the raw data loading is available.
override VerticalResolution { get; set; } Gets the vertical resolution, in pixels per inch, of this Image.
override Width { get; } Gets the image width.
override XmpData { get; set; } Gets or sets XMP data from frame.

Methods

Name Description
Add(TiffImage) Adds the specified image’s frames to current frame.
AddFrame(TiffFrame) Adds the frame to image
AddFrames(TiffFrame[]) Adds the frames array to image
AddPage(RasterImage) Adds page to the image.
override AdjustBrightness(int) Adjust of a brightness for image.
override AdjustContrast(float) Image contrasting
override AdjustGamma(float) Gamma-correction of an image.
override AdjustGamma(float, float, float) Gamma-correction of an image.
AlignResolutions() Helper method to make horizontal and vertical resolutions equal.
override BinarizeBradley(double) Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding
override BinarizeBradley(double, int) Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding
override BinarizeFixed(byte) Binarization of an image with predefined threshold
override BinarizeOtsu() Binarization of an image with Otsu thresholding
override CacheData() Caches the data private.
CanSave(ImageOptionsBase) Determines whether image can be saved to the specified file format represented by the passed save options.
override Crop(Rectangle) Cropping the image.
override Crop(int, int, int, int) Crop image with shifts.
Dispose() Disposes the current instance.
Dither(DitheringMethod, int) Performs dithering on the current image.
override Dither(DitheringMethod, int, IColorPalette) Performs dithering on the current image.
override Filter(Rectangle, FilterOptionsBase) Filters the specified rectangle.
GetArgb32Pixel(int, int) Gets an image 32-bit ARGB pixel.
GetDefaultArgb32Pixels(Rectangle) Gets the default 32-bit ARGB pixels array.
virtual GetDefaultOptions(object[]) Gets the default options.
GetDefaultPixels(Rectangle, IPartialArgb32PixelLoader) Gets the default pixels array using partial pixel loader.
GetDefaultRawData(Rectangle, RawDataSettings) Gets the default raw data array.
GetDefaultRawData(Rectangle, IPartialRawDataLoader, RawDataSettings) Gets the default raw data array using partial pixel loader.
virtual GetModifyDate(bool) Gets the date and time the resource image was last modified.
override GetOriginalOptions() Gets the options based on the original file settings. This can be helpful to keep bit-depth and other parameters of the original image unchanged. For example, if we load a black-white PNG image with 1 bit per pixel and then save it using the Save method, the output PNG image with 8-bit per pixel will be produced. To avoid it and save PNG image with 1-bit per pixel, use this method to get corresponding saving options and pass them to the Save method as the second parameter.
GetPixel(int, int) Gets an image pixel.
GetSkewAngle() Gets the skew angle. This method is applicable to scanned text documents, to determine the skew angle when scanning.
override Grayscale() Transformation of an image to its grayscale representation
InsertFrame(int, TiffFrame) The insert frame.
LoadArgb32Pixels(Rectangle) Loads 32-bit ARGB pixels.
LoadArgb64Pixels(Rectangle) Loads 64-bit ARGB pixels.
LoadCmyk32Pixels(Rectangle) Loads pixels in CMYK format.
LoadPartialArgb32Pixels(Rectangle, IPartialArgb32PixelLoader) Loads 32-bit ARGB pixels partially by packs.
LoadPartialPixels(Rectangle, IPartialPixelLoader) Loads pixels partially by packs.
LoadPixels(Rectangle) Loads pixels.
LoadRawData(Rectangle, RawDataSettings, IPartialRawDataLoader) Loads raw data.
LoadRawData(Rectangle, Rectangle, RawDataSettings, IPartialRawDataLoader) Loads raw data.
NormalizeAngle() Normalizes the angle. This method is applicable to scanned text documents to get rid of the skewed scan. This method uses GetSkewAngle and Rotate methods.
override NormalizeAngle(bool, Color) Normalizes the angle. This method is applicable to scanned text documents to get rid of the skewed scan. This method uses GetSkewAngle and Rotate methods.
ReadArgb32ScanLine(int) Reads the whole scan line by the specified scan line index.
ReadScanLine(int) Reads the whole scan line by the specified scan line index.
RemoveFrame(int) Removes the frame by its index.
RemoveFrame(TiffFrame) Removes the specified frame.
ReplaceColor(Color, byte, Color) Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
override ReplaceColor(int, byte, int) Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
ReplaceFrame(int, TiffFrame) Replaces the frame at the specified position.
ReplaceNonTransparentColors(Color) Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges. Note: if you use it on images without transparency, all colors will be replaced with a single one.
override ReplaceNonTransparentColors(int) Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges. Note: if you use it on images without transparency, all colors will be replaced with a single one.
Resize(int, int) Resizes the image. The default NearestNeighbourResample is used.
override Resize(int, int, ImageResizeSettings) Resizes the image.
override Resize(int, int, ResizeType) Resizes the image.
ResizeHeightProportionally(int) Resizes the height proportionally. The default NearestNeighbourResample is used.
virtual ResizeHeightProportionally(int, ImageResizeSettings) Resizes the height proportionally.
override ResizeHeightProportionally(int, ResizeType) Resizes the width proportionally.
ResizeProportional(int, int, ResizeType) Performs proportional resize on the image. The proportional resize will resize each frame according to the ratio of newWidth/width and newHeight/height.
ResizeWidthProportionally(int) Resizes the width proportionally. The default NearestNeighbourResample is used.
virtual ResizeWidthProportionally(int, ImageResizeSettings) Resizes the width proportionally.
override ResizeWidthProportionally(int, ResizeType) Resizes the width proportionally.
virtual Rotate(float) Rotate image around the center.
override Rotate(float, bool, Color) Rotate image around the center.
override RotateFlip(RotateFlipType) Rotates, flips, or rotates and flips the Active frame only.
Save() Saves the image data to the underlying stream.
Save(Stream) Saves the object’s data to the specified stream.
override Save(string) Saves the image to the specified file location.
Save(Stream, ImageOptionsBase) Saves the image’s data to the specified stream in the specified file format according to save options.
virtual Save(string, bool) Saves the object’s data to the specified file location.
virtual Save(string, ImageOptionsBase) Saves the object’s data to the specified file location in the specified file format according to save options.
override Save(Stream, ImageOptionsBase, Rectangle) Saves the image’s data to the specified stream in the specified file format according to save options.
virtual Save(string, ImageOptionsBase, Rectangle) Saves the object’s data to the specified file location in the specified file format according to save options.
SaveArgb32Pixels(Rectangle, int[]) Saves the 32-bit ARGB pixels.
SaveCmyk32Pixels(Rectangle, int[]) Saves the pixels.
SavePixels(Rectangle, Color[]) Saves the pixels.
SaveRawData(byte[], int, Rectangle, RawDataSettings) Saves the raw data.
SetArgb32Pixel(int, int, int) Sets an image 32-bit ARGB pixel for the specified position.
override SetPalette(IColorPalette, bool) Sets the image palette.
SetPixel(int, int, Color) Sets an image pixel for the specified position.
override SetResolution(double, double) Sets the resolution for this RasterImage.
virtual ToBitmap() Converts raster image to the bitmap.
WriteArgb32ScanLine(int, int[]) Writes the whole scan line to the specified scan line index.
WriteScanLine(int, Color[]) Writes the whole scan line to the specified scan line index.

Examples

Create Graphics Path from Path Resources in TIFF image.

[C#]

using (var image = (TiffImage)Image.Load("Bottle.tif"))
{
    // Create the GraphicsPath using PathResources from TIFF image
    var graphicsPath = PathResourceConverter.ToGraphicsPath(image.ActiveFrame.PathResources.ToArray(), image.ActiveFrame.Size);
    var graphics = new Graphics(image);

    // Draw red line and save the image
    graphics.DrawPath(new Pen(Color.Red, 10), graphicsPath);
    image.Save("BottleWithRedBorder.tif");
}

Create Path Resources using Graphics Path.

[C#]

static void Main(string[] args)
{
    using (var image = (TiffImage)Image.Load("Bottle.tif"))
    {
        // Create rectangular Figure for GraphicsPath
        var figure = new Figure();
        figure.AddShape(CreateBezierShape(100f, 100f, 500f, 100f, 500f, 1000f, 100f, 1000f));

        // Create GraphicsPath using our Figure
        var graphicsPath = new GraphicsPath();
        graphicsPath.AddFigure(figure);

        // Set PathResources using GraphicsPath
        var pathResouze = PathResourceConverter.FromGraphicsPath(graphicsPath, image.Size);
        image.ActiveFrame.PathResources = new List<PathResource>(pathResouze);

        // Save the image
        image.Save("BottleWithRectanglePath.tif");
    }
}

private static BezierShape CreateBezierShape(params float[] coordinates)
{
    var bezierPoints = CoordinatesToBezierPoints(coordinates).ToArray();
    return new BezierShape(bezierPoints, true);
}

private static IEnumerable<PointF> CoordinatesToBezierPoints(float[] coordinates)
{
    for (var coordinateIndex = 0; coordinateIndex < coordinates.Length; coordinateIndex += 2)
        for (var index = 0; index < 3; index++)
            yield return new PointF(coordinates[coordinateIndex], coordinates[coordinateIndex + 1]);
}

See Also