Class MultiFrameImageFactory


  • public class MultiFrameImageFactory
    extends java.lang.Object

    A class to create a set of instances, which when given unenhanced ("classic") images creates one or more enhanced multiframe image instances from them where possible, otherwise leaves them alone but includes them in the set.

    Each enhanced image corresponds to one FrameSet.

    Files are written in Explicit VR Little Endian Transfer Syntax.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void addStack​(AttributeList list, java.util.Map<java.lang.String,​com.pixelmed.dicom.StackOfSlices> stacks)  
      static void addStackIfNotAlreadyPresent​(AttributeList list, java.util.Map<java.lang.String,​com.pixelmed.dicom.StackOfSlices> stacks)  
      static java.lang.String chooseAppropriateConvertedSOPClassUID​(AttributeList list)
      Given the Attributes of a "classic" single frame instance, choose an appropriate multi-frame (enhanced) image SOP Class to convert it to.
      static java.io.File[] convertImages​(java.io.File[] files, java.io.File outputFolder)
      Create a new set of instances, converting to enhanced images when possible, from a set of DICOM files.
      static java.io.File[] convertImages​(java.lang.String[] inputPaths, java.lang.String outputPath)
      Create a new set of instances, converting to enhanced images when possible, from a set of DICOM files.
      static java.io.File[] convertImages​(java.util.Set<java.io.File> files, java.io.File outputFolder)
      Create a new set of instances, converting to enhanced images when possible, from a set of DICOM files.
      static java.io.File createEnhancedImageFromFrameSet​(FrameSet frameSet, java.io.File outputFolder, java.util.Map<java.lang.String,​java.io.File> filesBySOPInstanceUID, java.util.Map<java.lang.String,​HierarchicalImageReference> multiFrameReferenceBySingleFrameUID, boolean useRandomFrameOrder, boolean doNotEncodeStackInformation)
      Create an enhanced image from a set of DICOM single image files in a FrameSet.
      static java.io.File createEnhancedImageFromFrameSet​(FrameSet frameSet, java.io.File outputFolder, java.util.Map<java.lang.String,​java.io.File> filesBySOPInstanceUID, java.util.Map<java.lang.String,​HierarchicalImageReference> multiFrameReferenceBySingleFrameUID, java.util.Map<java.lang.String,​com.pixelmed.dicom.StackOfSlices> stacks, boolean useRandomFrameOrder, boolean doNotEncodeStackInformation)
      Create an enhanced image from a set of DICOM single image files in a FrameSet.
      static AttributeList createEnhancedImageFromFrameSet​(FrameSet frameSet, java.util.Map<java.lang.String,​java.io.File> filesBySOPInstanceUID, java.util.Map<java.lang.String,​AttributeList> listsBySOPInstanceUID, java.util.Map<java.lang.String,​HierarchicalImageReference> multiFrameReferenceBySingleFrameUID, boolean useRandomFrameOrder, boolean doNotEncodeStackInformation)
      Create an enhanced image from a set of DICOM single image files or AttributeLists in a FrameSet.
      static AttributeList createEnhancedImageFromFrameSet​(FrameSet frameSet, java.util.Map<java.lang.String,​java.io.File> filesBySOPInstanceUID, java.util.Map<java.lang.String,​AttributeList> listsBySOPInstanceUID, java.util.Map<java.lang.String,​HierarchicalImageReference> multiFrameReferenceBySingleFrameUID, java.util.Map<java.lang.String,​com.pixelmed.dicom.StackOfSlices> stacks, boolean useRandomFrameOrder, boolean doNotEncodeStackInformation)
      Create an enhanced image from a set of DICOM single image files or AttributeLists in a FrameSet.
      static void main​(java.lang.String[] arg)
      For testing, read all DICOM files and convert them to enhanced images when possible.
      • Methods inherited from class java.lang.Object

        clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • useRandomFrameOrderOption

        protected static boolean useRandomFrameOrderOption
      • doNotEncodeStackInformationOption

        protected static boolean doNotEncodeStackInformationOption
      • nextStackID

        protected static int nextStackID
    • Constructor Detail

      • MultiFrameImageFactory

        public MultiFrameImageFactory()
    • Method Detail

      • chooseAppropriateConvertedSOPClassUID

        public static java.lang.String chooseAppropriateConvertedSOPClassUID​(AttributeList list)

        Given the Attributes of a "classic" single frame instance, choose an appropriate multi-frame (enhanced) image SOP Class to convert it to.

        If nothing modality-specific is found, default to multi-frame secondary capture if the Pixel Data characteristics are appropriate, otherwise in the worst case the SOPClass.RawDataStorage is returned.

        Parameters:
        list - the attributes of the single frame instance
        Returns:
        the SOP Class UID
      • addStack

        public static void addStack​(AttributeList list,
                                    java.util.Map<java.lang.String,​com.pixelmed.dicom.StackOfSlices> stacks)
      • addStackIfNotAlreadyPresent

        public static void addStackIfNotAlreadyPresent​(AttributeList list,
                                                       java.util.Map<java.lang.String,​com.pixelmed.dicom.StackOfSlices> stacks)
      • createEnhancedImageFromFrameSet

        public static AttributeList createEnhancedImageFromFrameSet​(FrameSet frameSet,
                                                                    java.util.Map<java.lang.String,​java.io.File> filesBySOPInstanceUID,
                                                                    java.util.Map<java.lang.String,​AttributeList> listsBySOPInstanceUID,
                                                                    java.util.Map<java.lang.String,​HierarchicalImageReference> multiFrameReferenceBySingleFrameUID,
                                                                    java.util.Map<java.lang.String,​com.pixelmed.dicom.StackOfSlices> stacks,
                                                                    boolean useRandomFrameOrder,
                                                                    boolean doNotEncodeStackInformation)
                                                             throws DicomException,
                                                                    java.io.IOException

        Create an enhanced image from a set of DICOM single image files or AttributeLists in a FrameSet.

        Parameters:
        frameSet - an existing set of frames (single images) to convert that have already been determined to be a FrameSet
        filesBySOPInstanceUID - an existing map of the SOP Instance UIDs of the single images to the files that contain them (null if listsBySOPInstanceUID supplied)
        listsBySOPInstanceUID - an existing map of the SOP Instance UIDs of the single images to the AttributeLists that contain them (null if filesBySOPInstanceUID supplied)
        multiFrameReferenceBySingleFrameUID - an existing (possibly empty) map to which is added mappings from each single frame SOP Instance UIDs to converted UIDs + frame number references
        stacks - an existing (possibly empty) set of stacks from other FrameSets, which will be extended or re-used if a stack is found
        useRandomFrameOrder - order frames in encoded pixel data in random order rather than by source instance number
        doNotEncodeStackInformation - do not include stack information in enhanced images even if used for frame order sorting
        Returns:
        a list that is an enhanced multiframe image
        Throws:
        DicomException - if an input file cannot be found for a frame, or it cannot be parsed
        java.io.IOException - if an input file cannot be read
      • createEnhancedImageFromFrameSet

        public static AttributeList createEnhancedImageFromFrameSet​(FrameSet frameSet,
                                                                    java.util.Map<java.lang.String,​java.io.File> filesBySOPInstanceUID,
                                                                    java.util.Map<java.lang.String,​AttributeList> listsBySOPInstanceUID,
                                                                    java.util.Map<java.lang.String,​HierarchicalImageReference> multiFrameReferenceBySingleFrameUID,
                                                                    boolean useRandomFrameOrder,
                                                                    boolean doNotEncodeStackInformation)
                                                             throws DicomException,
                                                                    java.io.IOException

        Create an enhanced image from a set of DICOM single image files or AttributeLists in a FrameSet.

        Files are written in Explicit VR Little Endian Transfer Syntax.

        Parameters:
        frameSet - an existing set of frames (single images) to convert that have already been determined to be a FrameSet
        filesBySOPInstanceUID - an existing map of the SOP Instance UIDs of the single images to the files that contain them (null if listsBySOPInstanceUID supplied)
        listsBySOPInstanceUID - an existing map of the SOP Instance UIDs of the single images to the AttributeLists that contain them (null if filesBySOPInstanceUID supplied)
        multiFrameReferenceBySingleFrameUID - an existing (possibly empty) map to which is added mappings from each single frame SOP Instance UIDs to converted UIDs + frame number references
        useRandomFrameOrder - order frames in encoded pixel data in random order rather than by source instance number
        doNotEncodeStackInformation - do not include stack information in enhanced images even if used for frame order sorting
        Returns:
        a list that is an enhanced multiframe image
        Throws:
        DicomException - if an input file cannot be found for a frame, or it cannot be parsed
        java.io.IOException - if an input file cannot be read
      • createEnhancedImageFromFrameSet

        public static java.io.File createEnhancedImageFromFrameSet​(FrameSet frameSet,
                                                                   java.io.File outputFolder,
                                                                   java.util.Map<java.lang.String,​java.io.File> filesBySOPInstanceUID,
                                                                   java.util.Map<java.lang.String,​HierarchicalImageReference> multiFrameReferenceBySingleFrameUID,
                                                                   java.util.Map<java.lang.String,​com.pixelmed.dicom.StackOfSlices> stacks,
                                                                   boolean useRandomFrameOrder,
                                                                   boolean doNotEncodeStackInformation)
                                                            throws DicomException,
                                                                   java.io.IOException

        Create an enhanced image from a set of DICOM single image files in a FrameSet.

        Files are written in Explicit VR Little Endian Transfer Syntax.

        Parameters:
        frameSet - an existing set of frames (single images) to convert that have already been determined to be a FrameSet
        outputFolder - a folder in which to store converted files (which must already exist)
        filesBySOPInstanceUID - an existing map of the SOP Instance UIDs of the single images to the files that contain them
        multiFrameReferenceBySingleFrameUID - an existing (possibly empty) map to which is added mappings from each single frame SOP Instance UIDs to converted UIDs + frame number references
        stacks - an existing (possibly empty) set of stacks from other FrameSets, which will be extended or re-used if a stack is found
        useRandomFrameOrder - order frames in encoded pixel data in random order rather than by source instance number
        doNotEncodeStackInformation - do not include stack information in enhanced images even if used for frame order sorting
        Returns:
        a file that is an enhanced multiframe image that was created
        Throws:
        DicomException - if an input file cannot be found for a frame, or it cannot be parsed
        java.io.IOException - if an input file cannot be read
      • createEnhancedImageFromFrameSet

        public static java.io.File createEnhancedImageFromFrameSet​(FrameSet frameSet,
                                                                   java.io.File outputFolder,
                                                                   java.util.Map<java.lang.String,​java.io.File> filesBySOPInstanceUID,
                                                                   java.util.Map<java.lang.String,​HierarchicalImageReference> multiFrameReferenceBySingleFrameUID,
                                                                   boolean useRandomFrameOrder,
                                                                   boolean doNotEncodeStackInformation)
                                                            throws DicomException,
                                                                   java.io.IOException

        Create an enhanced image from a set of DICOM single image files in a FrameSet.

        Files are written in Explicit VR Little Endian Transfer Syntax.

        Parameters:
        frameSet - an existing set of frames (single images) to convert that have already been determined to be a FrameSet
        outputFolder - a folder in which to store converted files (which must already exist)
        filesBySOPInstanceUID - an existing map of the SOP Instance UIDs of the single images to the files that contain them
        multiFrameReferenceBySingleFrameUID - an existing (possibly empty) map to which is added mappings from each single frame SOP Instance UIDs to converted UIDs + frame number references
        useRandomFrameOrder - order frames in encoded pixel data in random order rather than by source instance number
        doNotEncodeStackInformation - do not include stack information in enhanced images even if used for frame order sorting
        Returns:
        a file that is an enhanced multiframe image that was created
        Throws:
        DicomException - if an input file cannot be found for a frame, or it cannot be parsed
        java.io.IOException - if an input file cannot be read
      • convertImages

        public static java.io.File[] convertImages​(java.util.Set<java.io.File> files,
                                                   java.io.File outputFolder)
                                            throws DicomException,
                                                   java.io.IOException

        Create a new set of instances, converting to enhanced images when possible, from a set of DICOM files.

        Non-DICOM files and problems parsing files are ignored, rather than causing failure

        Files are written in Explicit VR Little Endian Transfer Syntax.

        Parameters:
        files - a set of files (not folders) to convert
        outputFolder - a folder in which to store converted files (which must already exist)
        Returns:
        the files created
        Throws:
        DicomException - if folder in which to store converted files does not exist
        java.io.IOException - if an input file cannot be read
      • convertImages

        public static java.io.File[] convertImages​(java.io.File[] files,
                                                   java.io.File outputFolder)
                                            throws DicomException,
                                                   java.io.IOException

        Create a new set of instances, converting to enhanced images when possible, from a set of DICOM files.

        Non-DICOM files and problems parsing files are ignored, rather than causing failure

        Files are written in Explicit VR Little Endian Transfer Syntax.

        Parameters:
        files - an array of files (not folders) to convert
        outputFolder - a folder in which to store converted files (which must already exist)
        Returns:
        the files created
        Throws:
        DicomException - if folder in which to store converted files does not exist
        java.io.IOException - if an input file cannot be read
      • convertImages

        public static java.io.File[] convertImages​(java.lang.String[] inputPaths,
                                                   java.lang.String outputPath)
                                            throws DicomException,
                                                   java.io.IOException

        Create a new set of instances, converting to enhanced images when possible, from a set of DICOM files.

        Non-DICOM files and problems parsing files are ignored, rather than causing failure

        Files are written in Explicit VR Little Endian Transfer Syntax.

        Parameters:
        inputPaths - a set of paths of filenames and/or folder names of files containing the images to convert
        outputPath - a path in which to store converted files (which must already exist)
        Returns:
        the files created
        Throws:
        DicomException - if folder in which to store converted files does not exist
        java.io.IOException - if an input file cannot be read
      • main

        public static void main​(java.lang.String[] arg)

        For testing, read all DICOM files and convert them to enhanced images when possible.

        Files are written in Explicit VR Little Endian Transfer Syntax.

        Parameters:
        arg - the filenames and/or folder names of files containing the images to partition, followed by the path in which to store the converted instances