DicomObjects.NET.8.48 Documentation
DicomObjects Namespace / DicomDataSet Class / AddToDirectory Method / AddToDirectory(DicomDataSet,String,String) Method

Image from which to extract demographics, and (optionally) create an icon

The path is relative to where the DICOMDIR is to be written, and must conform to ISO9660/DICOM rules, and therefore be composed to up to 8 elements, each no more than 8 characters, with no extensions, separated by backslashes.

The format with which the image is to be written to disk

Example

In This Topic
    AddToDirectory(DicomDataSet,String,String) Method
    In This Topic
    Simplified DICOMDIR creation with specified Image, Path, TransferSyntax
    Syntax
    'Declaration
 

    Public Overloads Function AddToDirectory( _
   ByVal Image As DicomDataSet, _
   ByVal Path As System.String, _
   ByVal TransferSyntax As System.String _
) As DicomDataSetCollection
    public DicomDataSetCollection AddToDirectory( 
   DicomDataSet Image,
   System.string Path,
   System.string TransferSyntax
)

    Parameters

    Image

    Image from which to extract demographics, and (optionally) create an icon

    Path

    The path is relative to where the DICOMDIR is to be written, and must conform to ISO9660/DICOM rules, and therefore be composed to up to 8 elements, each no more than 8 characters, with no extensions, separated by backslashes.

    TransferSyntax

    The format with which the image is to be written to disk

    Return Value

    DicomDataSetCollection
    Remarks

    This method makes the creation of DICOMDIR files much easier than previously. Simply create a new DicomDataSet object, then call this method for each image to be added to the file set. A full 4-level hierarchy is automatically created.

    Note that this method does not write the image file to disk, it merely adds demographics from it, and possibly an icon to the DICOMDIR DicomDataSet.

    The return value is a DicomDataSetCollection object containing 4 values, referencing the PATIENT, STUDY, SERIES and IMAGE Levels of the DICOMDIR, allowing optional attributes to be added if wished.

    Example
    DicomDataSet ds = new DicomDataSet();
                    
DicomImage image = new DicomImage("image.dcm");
string path = @"IMAGES\STUDY\IMG00001"; // follows ISO9660 standard
string transferSyntax = "1.2.840.10008.1.2.1"; // Explicit VR Little Endian
                    
var dirRecords = ds.AddToDirectory(image, path, transferSyntax);
                    
// Optionally modify attributes (e.g. add Institution Name at Study level)
var studyDs = dirRecords[1];
studyDs.Add(Keyword.InstitutionName, "MC Medical Centre");
                    
// Optionally write DICOMDIR to disk
ds.Write(@"C:\Output\DICOMDIR");
    Requirements

    Target Platforms: .NET CLR 4.8 or higher

    See Also

    Reference

    DicomDataSet Class
    DicomDataSet Members
    Overload List

    Send Feedback