Click or drag to resize

Jp2Decoder Class

The class derives from ImageDecoder and decodes JPEG2000 images.
Inheritance Hierarchy
SystemObject
  Atalasoft.Imaging.CodecImageDecoder
    Atalasoft.Imaging.Codec.Jpeg2000Jp2Decoder

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
public class Jp2Decoder : ImageDecoder

The Jp2Decoder type exposes the following members.

Constructors
  NameDescription
Public methodJp2Decoder
Creates a new instance of a Jp2Decoder.
Top
Properties
  NameDescription
Public propertyByteOrder
Gets or sets the byte order of the decoded data from one of little endian, big endian, or machine automatic.
Public propertyCacheOption
Gets or sets a value specifying whether the compress data should be stored in an internal cache.
Public propertyEnableProgressiveDecompression
Gets or sets a value enabling the ability to progressively decode the image.
Public propertyPrecision
Gets or sets a value indicating the precision of the wavelet coefficients.
Public propertyProgressiveDecodeSteps
Gets or sets the number of progressive decompression steps.
Public propertyScaleDown
Gets or sets a factor that is used to scale downwards the image as it's decoded.
Public propertySupportedImageType Obsolete.
Returns the ImageType that the implemented decoder class supports.
(Inherited from ImageDecoder.)
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.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetImageInfo
Returns information about a JPEG2000 image such as width, height, and bit depth.
(Overrides ImageDecoderGetImageInfo(Stream).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsValidFormat
Returns true if the specified Stream is a JPEG2000 image.
(Overrides ImageDecoderIsValidFormat(Stream).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodNetworkRead
Protected methodNormalRead
Protected methodProgressiveRead
Public methodRead
Decodes a JPEG2000 image from a stream and returns an AtalaImage with the decoded image data.
(Overrides ImageDecoderRead(Stream, ProgressEventHandler).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventProgressiveImage
Fired for each intermediate step when decoding an image progressively.
Top
Remarks
To add the ability to decode JP2 images, simply add an instance of the Jp2Decoder to the DecoderDictionary collection in the RegisteredDecoders class. See the below example.
Examples
Usage example (VB)
Copy
Imports Atalasoft.Imaging.Codec.Jpeg2000
...
Dim jp2 As Jp2Decoder = New Jp2Decoder()
RegisteredDecoders.Decoders.Add(jp2)
Usage example (C#)
Copy
using Atalasoft.Imaging.Codec.Jpeg2000; 
... 
Jp2Decoder jp2 = new Jp2Decoder(); 
RegisteredDecoders.Decoders.Add(jp2);
See Also