Class TiffFrame
Contents
[
Hide
]TiffFrame class
The tiff frame.
public sealed class TiffFrame : RasterCachedImage, IHasExifData
Constructors
| Name | Description |
|---|---|
| TiffFrame(RasterImage) | Initializes a new instance of the TiffFrame class. |
| TiffFrame(Stream) | Initializes a new instance of the TiffFrame class. |
| TiffFrame(string) | Initializes a new instance of the TiffFrame class. |
| TiffFrame(RasterImage, TiffOptions) | Initializes a new instance of the TiffFrame class. |
| TiffFrame(Stream, TiffOptions) | Initializes a new instance of the TiffFrame class. |
| TiffFrame(string, TiffOptions) | Initializes a new instance of the TiffFrame class. |
| TiffFrame(TiffOptions, int, int) | Initializes a new instance of the TiffFrame class. |
Properties
| Name | Description |
|---|---|
| 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. |
| 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 from frame. |
| virtual FileFormat { get; } | Gets a value of file format |
| FrameOptions { get; } | Gets the frame create options. |
| override HasAlpha { get; } | Gets a value indicating whether this instance has alpha. |
| virtual HasBackgroundColor { get; set; } | Gets or sets a value indicating whether image has background color. |
| override HasTransparentColor { get; set; } | Gets a value indicating whether image has transparent color. |
| override Height { get; } | Gets the image height. |
| override HorizontalResolution { get; set; } | Gets or sets the horizontal resolution, in pixels per inch, of this RasterImage. |
| virtual ImageOpacity { get; } | Gets opacity of this image. |
| InterruptMonitor { get; set; } | Gets or sets the interrupt monitor. |
| override IsCached { get; } | Gets a value indicating whether image data is cached currently. |
| IsRawDataAvailable { get; } | Gets a value indicating whether raw data loading is available. |
| Palette { get; set; } | Gets or sets the color palette. The color palette is not used when pixels are represented directly. |
| PathResources { get; set; } | Gets or sets the path resources. |
| virtual PremultiplyComponents { get; set; } | Gets or sets a value indicating whether the image 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 or sets the vertical resolution, in pixels per inch, of this RasterImage. |
| override Width { get; } | Gets the image width. |
| override XmpData { get; set; } | Gets or sets Xmp data. |
Methods
| Name | Description |
|---|---|
| static CopyFrame(TiffFrame) | Copies the entire frame (duplicates). |
| static CreateFrameFrom(TiffFrame, TiffOptions) | Creates the frame from specified tiffFrame using the specified options. The pixel data is preserved but converted to the desired format. |
| 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 |
| Blend(Point, RasterImage, byte) | Blends this image instance with the overlay image. |
| override Blend(Point, RasterImage, Rectangle, byte) | Blends this image instance with the overlay image. |
| override CacheData() | Caches the data and ensures no additional data loading will be performed from the underlying DataStreamContainer. |
| 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. |
| virtual 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. |
| virtual 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. |
| virtual GetSerializedStream(ImageOptionsBase, Rectangle, out int) | Converts to aps. |
| 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 |
| 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. |
| LoadPartialArgb64Pixels(Rectangle, IPartialArgb64PixelLoader) | Loads 64-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. |
| virtual 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. |
| override RemoveMetadata() | Removes this image instance metadata by setting this XmpData and ExifData values to null. |
| ReplaceColor(Color, byte, Color) | Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges. |
| virtual ReplaceColor(int, byte, int) | Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges. |
| 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. |
| virtual 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. |
| virtual ResizeHeightProportionally(int, ResizeType) | Resizes the height proportionally. |
| ResizeWidthProportionally(int) | Resizes the width proportionally. The default NearestNeighbourResample is used. |
| virtual ResizeWidthProportionally(int, ImageResizeSettings) | Resizes the width proportionally. |
| virtual 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 image. |
| 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. |
| virtual SetResolution(double, double) | Sets the resolution for this RasterImage. |
| virtual ToBitmap() | Converts raster image to the bitmap. This method is not supported in versions from .Net7.0 and higher |
| 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
This example shows how to create a TIFF image from scratch and save it to a file.
[C#]
string dir = "c:\\temp\\";
Aspose.Imaging.ImageOptions.TiffOptions createOptions = new Aspose.Imaging.ImageOptions.TiffOptions(Imaging.FileFormats.Tiff.Enums.TiffExpectedFormat.Default);
// Set 8 bits for each color component.
createOptions.BitsPerSample = new ushort[] { 8, 8, 8 };
// Set the Big Endian byte order (Motorola)
createOptions.ByteOrder = Aspose.Imaging.FileFormats.Tiff.Enums.TiffByteOrder.BigEndian;
// Set the LZW compression.
createOptions.Compression = Aspose.Imaging.FileFormats.Tiff.Enums.TiffCompressions.Lzw;
// Set the RGB color model.
createOptions.Photometric = Aspose.Imaging.FileFormats.Tiff.Enums.TiffPhotometrics.Rgb;
// All color components will be stored within a single plane.
createOptions.PlanarConfiguration = Aspose.Imaging.FileFormats.Tiff.Enums.TiffPlanarConfigs.Contiguous;
// Create a TIFF Frame of 100x100 px.
// Note that you don't have to dispose a frame explicitly if it is included into TiffImage.
// When the container is disposed all frames will be disposed automatically.
Aspose.Imaging.FileFormats.Tiff.TiffFrame firstFrame = new Aspose.Imaging.FileFormats.Tiff.TiffFrame(createOptions, 100, 100);
// Fill the entire frame with the blue-yellow gradient.
Aspose.Imaging.Brushes.LinearGradientBrush gradientBrush = new Aspose.Imaging.Brushes.LinearGradientBrush(
new Aspose.Imaging.Point(0, 0),
new Aspose.Imaging.Point(firstFrame.Width, firstFrame.Height),
Aspose.Imaging.Color.Blue,
Aspose.Imaging.Color.Yellow);
Aspose.Imaging.Graphics graphics = new Aspose.Imaging.Graphics(firstFrame);
graphics.FillRectangle(gradientBrush, firstFrame.Bounds);
// Create a TIFF image.
using (Aspose.Imaging.FileFormats.Tiff.TiffImage tiffImage = new Aspose.Imaging.FileFormats.Tiff.TiffImage(firstFrame))
{
tiffImage.Save(dir + "output.tif");
}
See Also
- class RasterCachedImage
- interface IHasExifData
- namespace Aspose.Imaging.FileFormats.Tiff
- assembly Aspose.Imaging
