Class DicomDirectory

java.lang.Object
com.pixelmed.dicom.DicomDirectory
All Implemented Interfaces:
TreeModel

public class DicomDirectory extends Object implements TreeModel
  • Field Details

    • mapOfDirectoryRecordsToSequenceItems

      protected HashMap mapOfDirectoryRecordsToSequenceItems
  • Constructor Details

    • DicomDirectory

      public DicomDirectory(String[] fileNames)

      Create a new DicomDirectory from a list of existing DICOM files contained within the current working directory.

      The filenames must be relative to the current working directory, and not absolute paths, since the full name will be used in the DICOMDIR records.

      Filenames are NOT checked for compliance with restrictions on length and character set.

      Parameters:
      fileNames - the names of the DICOM files (relative to the current working directory)
    • DicomDirectory

      public DicomDirectory(File rootDirectory, String[] fileNames)

      Create a new DicomDirectory from a list of existing DICOM files contained within a specified root directory.

      The specified root directory will NOT be included in the referenced file name in the DICOMDIR records.

      Filenames are NOT checked for compliance with restrictions on length and character set.

      Parameters:
      rootDirectory - the name of the directory to use as the root, which contains the DICOM file
      fileNames - the names of the DICOM files (relative to rootDirectory)
    • DicomDirectory

      public DicomDirectory()
      Create an empty DicomDirectory
    • DicomDirectory

      public DicomDirectory(AttributeList list) throws DicomException
      Create a DicomDirectory from a DICOMDIR instance already read as an AttributeList
      Parameters:
      list - a list of attributes describing a DICOMDIR instance
      Throws:
      DicomException - if error in DICOM encoding
    • DicomDirectory

      public DicomDirectory(AttributeList list, boolean doConcatenations) throws DicomException
      Create a DicomDirectory from a DICOMDIR instance already read as an AttributeList, optionally creating synthetic concatenation records
      Parameters:
      list - a list of attributes describing a DICOMDIR instance
      doConcatenations - true if synthetic concatenation records are to be created
      Throws:
      DicomException - if error in DICOM encoding
  • Method Details

    • getChild

      public Object getChild(Object node, int index)
      Specified by:
      getChild in interface TreeModel
    • getIndexOfChild

      public int getIndexOfChild(Object parent, Object child)
      Specified by:
      getIndexOfChild in interface TreeModel
    • getRoot

      public Object getRoot()
      Specified by:
      getRoot in interface TreeModel
    • getChildCount

      public int getChildCount(Object parent)
      Specified by:
      getChildCount in interface TreeModel
    • isLeaf

      public boolean isLeaf(Object node)
      Specified by:
      isLeaf in interface TreeModel
    • valueForPathChanged

      public void valueForPathChanged(TreePath path, Object newValue)
      Specified by:
      valueForPathChanged in interface TreeModel
    • addTreeModelListener

      public void addTreeModelListener(TreeModelListener tml)
      Specified by:
      addTreeModelListener in interface TreeModel
    • removeTreeModelListener

      public void removeTreeModelListener(TreeModelListener tml)
      Specified by:
      removeTreeModelListener in interface TreeModel
    • readDicomFileAndAddToDirectory

      public void readDicomFileAndAddToDirectory(File rootDirectory, String fileName) throws DicomException, IOException
      Read DICOM file and add it to this directory.
      Parameters:
      rootDirectory - the name of the directory to use as the root, which contains the DICOM file
      fileName - the name of the DICOM file (relative to rootDirectory)
      Throws:
      IOException - if an I/O error occurs
      DicomException - if error in DICOM encoding
    • readDicomFileAndAddToDirectory

      public void readDicomFileAndAddToDirectory(String fileName) throws DicomException, IOException
      Read DICOM file and add it to this directory.
      Parameters:
      fileName - the name of the DICOM file (relative to the current working directory)
      Throws:
      IOException - if an I/O error occurs
      DicomException - if error in DICOM encoding
    • addAttributeListFromDicomFileToDirectory

      public void addAttributeListFromDicomFileToDirectory(AttributeList list, String fileName) throws DicomException, IOException
      Add an instance described by a list of attributes to this directory. Builds the necessary patient, study, series and instance level directory records, with the instance level record being the appropriate type for the SOP Class.
      Parameters:
      list - the list of attributes containing the attributes to add to this directory
      fileName - the name of the DICOM file
      Throws:
      IOException - if an I/O error occurs
      DicomException - if error in DICOM encoding, or the SOP Class is not recognized, or the instance already exists in the directory
    • write

      public void write(String name) throws IOException, DicomException

      Write the directory to the named file.

      Parameters:
      name - the file name to write to
      Throws:
      IOException - if an I/O error occurs
      DicomException - if error in DICOM encoding
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • getMapOfSOPInstanceUIDToReferencedFileName

      public Map<String,String> getMapOfSOPInstanceUIDToReferencedFileName(String parentFilePath)

      Build a map of file names indexed by SOP Instance UID.

      Parameters:
      parentFilePath - the path to the root of the file names encoded in this directory
      Returns:
      a map of SOP Instance UID keys to file names including the supplied parentFilePath
    • getReferencedFileNameForSOPInstanceUID

      public String getReferencedFileNameForSOPInstanceUID(String sopInstanceUID) throws DicomException

      Get the file name for the specified SOP Instance UID.

      Parameters:
      sopInstanceUID - the SOP Instance UID wanted
      Returns:
      the referenced file name, or null if not found
      Throws:
      DicomException - if map has not been initialized
    • findAllContainedReferencedFileNamesAndTheirRecords

      public static HashMap<String,DicomDirectoryRecord> findAllContainedReferencedFileNamesAndTheirRecords(DicomDirectoryRecord record, String parentFilePath)

      Get all the referenced file names at or below the specified directory record, and a map to the directory records that reference them.

      Parameters:
      record - directory record to start at
      parentFilePath - the folder in which the DICOMDIR lives (i.e., the base for contained references)
      Returns:
      a HashMap whose keys are String file names fully qualified by the specified parent, mapped to DicomDirectoryRecords
    • findAllContainedReferencedFileNamesAndTheirRecords

      public HashMap<String,DicomDirectoryRecord> findAllContainedReferencedFileNamesAndTheirRecords(String parentFilePath)

      Get all the referenced file names in the entire directory, and a map to the directory records that reference them.

      Parameters:
      parentFilePath - the folder in which the DICOMDIR lives (i.e., the base for contained references)
      Returns:
      a HashMap whose keys are String file names fully qualified by the specified parent, mapped to DicomDirectoryRecords
    • findAllContainedReferencedFileNames

      public static Vector<String> findAllContainedReferencedFileNames(DicomDirectoryRecord record, String parentFilePath)

      Get all the referenced file names at or below the specified directory record.

      Parameters:
      record - directory record to start at
      parentFilePath - the folder in which the DICOMDIR lives (i.e., the base for contained references)
      Returns:
      a Vector of String file names fully qualified by the specified parent
    • findAllContainedReferencedFileNames

      public Vector<String> findAllContainedReferencedFileNames(String parentFilePath)

      Get all the referenced file names in the entire directory.

      Parameters:
      parentFilePath - the folder in which the DICOMDIR lives (i.e., the base for contained references)
      Returns:
      a Vector of String file names fully qualified by the specified parent
    • findAllImagesForFrameOfReference

      public Vector<AttributeList> findAllImagesForFrameOfReference(String frameOfReferenceUID)

      Get the attribute lists from all the IMAGE level directory records which have a particular FrameOfReferenceUID.

      Useful for finding potential localizers and orthogonal images.

      Note that even though FrameOfReference is a series level entity, in the CT/MR profiles it is specified at the IMAGE directory record level.

      Parameters:
      frameOfReferenceUID - the frame of reference UID to search for
      Returns:
      a Vector of AttributeList
    • main

      public static void main(String[] arg)

      Read DICOM files and create a DICOMDIR.

      Parameters:
      arg - optionally the folder in which the files and DICOMDIR are rooted, the filename of the DICOMDIR to be created, then optionally a list of all the filenames of the DICOM files to include (otherwise the folder will be searched)