com.pixelmed.dicom
Class MultiFrameImageFactory

java.lang.Object
  com.pixelmed.dicom.MultiFrameImageFactory

public class MultiFrameImageFactory
extends 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.

Constructor Summary

MultiFrameImageFactory()

Method Summary

static 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 File[]	convertImages(File[] files, File outputFolder) Create a new set of instances, converting to enhanced images when possible, from a set of DICOM files.
static File[]	convertImages(Set<File> files, File outputFolder) Create a new set of instances, converting to enhanced images when possible, from a set of DICOM files.
static File[]	convertImages(String[] inputPaths, String outputPath) Create a new set of instances, converting to enhanced images when possible, from a set of DICOM files.
static File	createEnhancedImageFromFrameSet(FrameSet frameSet, File outputFolder, Map<String,File> filesBySOPInstanceUID, Map<String,HierarchicalImageReference> multiFrameReferenceBySingleFrameUID) Create an enhanced image from a set of DICOM single image files in a FrameSet.
static AttributeList	createEnhancedImageFromFrameSet(FrameSet frameSet, Map<String,File> filesBySOPInstanceUID, Map<String,AttributeList> listsBySOPInstanceUID, Map<String,HierarchicalImageReference> multiFrameReferenceBySingleFrameUID) Create an enhanced image from a set of DICOM single image files or AttributeLists in a FrameSet.
static void	main(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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultiFrameImageFactory

public MultiFrameImageFactory()

Method Detail

chooseAppropriateConvertedSOPClassUID

public static 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 return the SOP Class UID

createEnhancedImageFromFrameSet

public static AttributeList createEnhancedImageFromFrameSet(FrameSet frameSet,
                                                            Map<String,File> filesBySOPInstanceUID,
                                                            Map<String,AttributeList> listsBySOPInstanceUID,
                                                            Map<String,HierarchicalImageReference> multiFrameReferenceBySingleFrameUID)
                                                     throws DicomException,
                                                            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

Throws:

DicomException - if an input file cannot be found for a frame, or it cannot be parsed

IOException - if an input file cannot be read

createEnhancedImageFromFrameSet

public static File createEnhancedImageFromFrameSet(FrameSet frameSet,
                                                   File outputFolder,
                                                   Map<String,File> filesBySOPInstanceUID,
                                                   Map<String,HierarchicalImageReference> multiFrameReferenceBySingleFrameUID)
                                            throws DicomException,
                                                   IOException

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

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

Throws:

DicomException - if an input file cannot be found for a frame, or it cannot be parsed

IOException - if an input file cannot be read

convertImages

public static File[] convertImages(Set<File> files,
                                   File outputFolder)
                            throws DicomException,
                                   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

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

IOException - if an input file cannot be read

convertImages

public static File[] convertImages(File[] files,
                                   File outputFolder)
                            throws DicomException,
                                   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

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

IOException - if an input file cannot be read

convertImages

public static File[] convertImages(String[] inputPaths,
                                   String outputPath)
                            throws DicomException,
                                   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

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

IOException - if an input file cannot be read

main

public static void main(String[] arg)

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

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