Jp2Encoder Class

Note: This API is now obsolete.

The class derived from ImageEncoder that encodes JPEG2000 images.

Inheritance Hierarchy

System.Object
Atalasoft.Imaging.Codec.ImageEncoder
Atalasoft.Imaging.Codec.Jpeg2000.Jp2Encoder

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

Syntax

Copy

[ObsoleteAttribute("Jpeg2000Encoder should be used.", true)]
public class Jp2Encoder : ImageEncoder

<ObsoleteAttribute("Jpeg2000Encoder should be used.", true)>
Public Class Jp2Encoder
	Inherits ImageEncoder

The Jp2Encoder type exposes the following members.

Constructors

	Name	Description
	Jp2Encoder()	Creates a new instance of a Jp2Encoder.
	Jp2Encoder(Double)	Creates a new instance of a Jp2Encoder specifying the compression rate.

Top

Properties

	Name	Description
	Compression
	CompressionMode	Gets or Sets the Jp2CompressionMode to use when compressing an image.
	EncoderOptions	Gets or sets encoder specific options that will be used by default for the entire image.
	EnhancedRegions	Gets a collection of Enhanced Regions that can be set at a higher quality level than the rest of the image during compression.
	FileFormat	Gets or sets the file format to generate (JP2, JPEG2000 codestream, or JPX).
	IPData	Gets or sets intellectual property rights data to be encoded with the image.
	IptcTags	Gets or sets IPTC data that will be stored in the encoded image.
	Precision	Gets or sets a value indicating the precision of the wavelet coefficients.
	QualityStyle	Gets or sets a value indicating the quality mode during lossy compression.
	ResolutionParams	Set property for storing information of resolution. Refer to definition of Jp2ResolutionParams.
	SpeedMode	Gets or sets the speed mode (Fast or Accurate) to use during lossy compression.
	SupportedPixelFormats	Returns an array of PixelFormats supported by the Jp2Encoder. (Overrides ImageEncoder.SupportedPixelFormats.)
	TileSize	Gets or sets the size in pixels of each individual tile.
	UuidBoxes	Gets or sets UuidBox metadata to be stored in the encoded image.
	UuidInfoBoxes	Gets or sets UuidInfoBox metadata to be stored in the encoded image.
	WriteTileLengthMarker	Gets or sets a value indicating if a tile length marker is written to the encoded image.
	XmlBoxes	Gets or sets XML metadata to be stored with the image.

Top

Methods

	Name	Description
	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.)
	GetEncoderOptions	Returns the encoder options for a specific tile and component.
	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.)
	PixelFormatIsSupported
	Save	Encodes an AtalaImage into the specified stream as a JPEG2000 image. (Overrides ImageEncoder.Save(Stream, AtalaImage, ProgressEventHandler).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

To encode JPEG2000 images, invoke the [!:Jp2Encoder.Save] method of the Jp2Encoder or create an instance of a Jp2Encoder, and pass it into one of the save methods in an AtalaImage, Workspace, or [!:WorkspaceViewer] object.

To specify compression, set the [!:Jp2Encoder.Compression] property to a value between 0.0 and 100.0.

Reference

Atalasoft.Imaging.Codec.Jpeg2000 Namespace