Click or drag to resize

Jpeg2000Encoder Class

The class derived from ImageEncoder that encodes JPEG2000 images.
Inheritance Hierarchy
SystemObject
  Atalasoft.Imaging.CodecImageEncoder
    Atalasoft.Imaging.Codec.Jpeg2000Jpeg2000Encoder

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
public class Jpeg2000Encoder : ImageEncoder

The Jpeg2000Encoder type exposes the following members.

Constructors
  NameDescription
Public methodJpeg2000Encoder
Creates a new instance of a Jpeg2000Encoder.
Public methodJpeg2000Encoder(Jp2CompressionMode, UInt32)
Creates a new instance of a Jpeg2000Encoder specifying the compression rate.
Top
Properties
  NameDescription
Public propertyCompressionMode
Gets or Sets the Jp2CompressionMode to use when compressing an image.
Public propertyCode exampleCompressionQuality
Gets or sets the compression quality to use when compressing an image if CompressionMode = Quality.
Public propertyCode exampleCompressionSize
Gets or sets the compression size to use when compressing an image if CompressionMode = Size.
Public propertyEncoderOptions
Gets or sets encoder specific options that will be used by default for the entire image.
Public propertyEnhancedRegions
Gets a collection of Enhanced Regions that can be set at a higher quality level than the rest of the image during compression.
Public propertyFileFormat
Gets or sets the file format to generate (JP2, JPEG2000 codestream, or JPX).
Public propertyIPData
Gets or sets intellectual property rights data to be encoded with the image.
Public propertyIptcTags
Gets or sets IPTC data that will be stored in the encoded image.
Public propertyPrecision
Gets or sets a value indicating the precision of the wavelet coefficients.
Public propertyQualityStyle
Gets or sets a value indicating the quality mode during lossy compression.
Public propertyResolutionParams
Set property for storing information of resolution. Refer to definition of Jp2ResolutionParams.
Public propertySpeedMode
Gets or sets the speed mode (Fast or Accurate) to use during lossy compression.
Public propertySupportedPixelFormats
Returns an array of PixelFormats supported by the Jpeg2000Encoder.
(Overrides ImageEncoderSupportedPixelFormats.)
Public propertyTileSize
Gets or sets the size in pixels of each individual tile.
Public propertyUuidBoxes
Gets or sets UuidBox metadata to be stored in the encoded image.
Public propertyUuidInfoBoxes
Gets or sets UuidInfoBox metadata to be stored in the encoded image.
Public propertyWriteTileLengthMarker
Gets or sets a value indicating if a tile length marker is written to the encoded image.
Public propertyXmlBoxes
Gets or sets XML metadata to be stored with the image.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetEncoderOptions
Returns the encoder options for a specific tile and component.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsPixelFormatSupported
Returns true if the given PixelFormat can be encoded with the derived encoder.
(Inherited from ImageEncoder.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodPixelFormatIsSupported
Public methodSave
Encodes an AtalaImage into the specified stream as a JPEG2000 image.
(Overrides ImageEncoderSave(Stream, AtalaImage, ProgressEventHandler).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

To encode JPEG2000 images, invoke the Save(Stream, AtalaImage, ProgressEventHandler) method of the Jpeg2000Encoder or create an instance of a Jpeg2000Encoder, and pass it into one of the save methods in an AtalaImage, Workspace, or WorkspaceViewer object.

See Also