Jb2Encoder Class

This class, derived from MultiFramedImageEncoder, compresses a bi-tonal (black and white) image using JBIG2 compression.

Inheritance Hierarchy

SystemObject
  Atalasoft.Imaging.CodecImageEncoder
    Atalasoft.Imaging.CodecMultiFramedImageEncoder
      Atalasoft.Imaging.Codec.Jbig2Jb2Encoder

Namespace: Atalasoft.Imaging.Codec.Jbig2
Assembly: Atalasoft.dotImage.Jbig2 (in Atalasoft.dotImage.Jbig2.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

public class Jb2Encoder : MultiFramedImageEncoder, IAppendable, 
	IDisposable

Public Class Jb2Encoder
	Inherits MultiFramedImageEncoder
	Implements IAppendable, IDisposable

The Jb2Encoder type exposes the following members.

Constructors

	Name	Description
	Jb2Encoder	Creates a gcnew instance of a Jb2Encoder.
	Jb2Encoder(Jb2EncodingMode)	Creates a gcnew instance of a Jb2Encoder.

Top

Properties

	Name	Description
	Append	Get or sets a value indicating if the image should be appended to the end of an existing file.
	BitmapCoder	Gets or sets the bitmap coder to be used during compression.
	EncodingMode	Gets or sets a value indicating if the encoded image will be lossless or lossy.
	ExportFormat	Gets or sets a value indicating the file format for compressed data (JBIG2, PDF, or PDF Stream).
	GenericTemplate	Gets or sets the context template to use when coding generic region using arithmetic coder.
	SupportedPixelFormats	(Overrides ImageEncoderSupportedPixelFormats.)
	SymbolDictionary	Gets or sets the context template to use when coding dictionary symbols using arithmetic coder.
	SymbolTemplate	Gets or sets the template to use when coding dictionary symbols using arithmetic coder.

Top

Methods

	Name	Description
	Dispose	Releases all resources used by the Jb2Encoder
	Dispose(Boolean)	Releases the unmanaged resources used by the Jb2Encoder and optionally releases the managed resources
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsPixelFormatSupported	Returns true if the given PixelFormat can be encoded with the derived encoder. (Inherited from ImageEncoder.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnSetEncoderCompression	Called when the encoder needs to select a compression. (Inherited from MultiFramedImageEncoder.)
	Save(Stream, AtalaImage, ProgressEventHandler)	Compresses a single AtalaImage as a JBIG2 encoded file. (Overrides ImageEncoderSave(Stream, AtalaImage, ProgressEventHandler).)
	Save(Stream, ImageCollection, ProgressEventHandler)	Compresses an ImageCollection as a JBIG2 encoded file. (Overrides MultiFramedImageEncoderSave(Stream, ImageCollection, ProgressEventHandler).)
	Save(Stream, ImageSource, ProgressEventHandler)	(Overrides MultiFramedImageEncoderSave(Stream, ImageSource, ProgressEventHandler).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	SetEncoderCompression	Occurs when the encoder needs to select a compression. (Inherited from MultiFramedImageEncoder.)

Top

Examples

[New Example] (C#)

Copy

using Atalasoft.Imaging.Codec.Jbig2
...
AtalaImage image = new AtalaImage("image.tif");
image.Save("image.jb2", new Jbig2Encoder(Jb2EncodingMode.Lossy), null);

[New Example] (Visual Basic)

Copy

Imports Atalasoft.Imaging.Codec.Jbig2
...
Dim image As AtalaImage = New AtalaImage("image.tif")
image.Save("image.jb2", New Jbig2Encoder(Jb2EncodingMode.Lossy), Nothing)

[New Example] (CPP)

Copy

using namespace Atalasoft::Imaging::Codec::Jbig2;
... 
AtalaImage* image = new AtalaImage(S"image.tif"); 
image->Save(S"image.jb2", new Jbig2Encoder(Jb2EncodingMode::Lossy), 0);

Reference

Atalasoft.Imaging.Codec.Jbig2 Namespace