DicomObjects.NetStandard Documentation
DicomObjects.Codecs Namespace / Jpeg2000CompressionOptions Class / OptionsFromImage Method
The image/dataset to analyse
The frame number to analyse



In This Topic
    OptionsFromImage Method
    In This Topic
    Discover information about a JPEG 2000 encoded image
    Syntax
    'Declaration
     
    
    Public Shared Function OptionsFromImage( _
       ByVal DataSet As DicomDataSet, _
       ByVal Frame As Integer _
    ) As Jpeg2000CompressionOptions
    'Usage
     
    
    Dim DataSet As DicomDataSet
    Dim Frame As Integer
    Dim value As Jpeg2000CompressionOptions
     
    value = Jpeg2000CompressionOptions.OptionsFromImage(DataSet, Frame)
    public static Jpeg2000CompressionOptions OptionsFromImage( 
       DicomDataSet DataSet,
       int Frame
    )
    public:
    static Jpeg2000CompressionOptions^ OptionsFromImage( 
       DicomDataSet^ DataSet,
       int Frame
    ) 

    Parameters

    DataSet
    The image/dataset to analyse
    Frame
    The frame number to analyse

    Return Value

    An object representing the compressionoptions used, or null if no JPEG 2000 data exists
    Remarks

    This is a little simplistic, as the JPEG 2000 standard allows huge flexibility, including even the ability to have different options for different tiles of an image, but only data from the "top level" is included here. Similarly, whilst JPEG 2000 allows different precinct sizes for different resolution levels, only the highest level is returned from this method (and -1 is returned if MaxPrecinct size is specified)

    At present, the data filled in by this method includes only:

    • Progression
    • Layers
    • Levels
    • PrecinctSize

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also