DicomObjects.NetStandard Documentation
DicomObjects.Codecs Namespace / ICompressor Interface / PrepareFunction Method
Standard argument for PrepareCompress



In This Topic
    PrepareFunction Method (ICompressor)
    In This Topic
    Make any changes to the main dataset, before doing the frame-by-frame compression, and inform DicomObjects of any preprocessing required.
    Syntax
    'Declaration
     
    
    Sub PrepareFunction( _
       ByVal ModificationArguments As ModificationArguments _
    ) 
    'Usage
     
    
    Dim instance As ICompressor
    Dim ModificationArguments As ModificationArguments
     
    instance.PrepareFunction(ModificationArguments)

    Parameters

    ModificationArguments
    Standard argument for PrepareCompress
    Remarks
    Details vary according to the compression method, but examples include:
    • For some compression methods, a transform is needed to bring the data into the 12 bit unsigned range (e.g. JPEG lossy extended)
    • For colour images, the photometric interpretation of the dataset may need to be changed to (e.g. to YBR_FULL_422 for JPEG lossy)

    By changing the values in ModificationArguments, a compressor can control how the pixel data is passed to it by DicomObjects, or how some other values are later changed:

    Setting ModificationArgs.LossyDescription to a human description and and ModificationArgs.LossyMethod to a codec values (e.g. "ISO_10918_1" for JPEG)

    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