DicomObjects.NET.V8
DicomObjects Namespace / DicomDataSet Class / AddToDirectory Method / AddToDirectory(DicomImage,String,String,Int16) 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 6 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

The size of the icon image to be included in the DICOMDIR � use 0 for no icon




AddToDirectory(DicomImage,String,String,Int16) Method
Simplified DICOMDIR creation with specified Image, Path, TransferSyntax and IconSize
Syntax
public DicomDataSetCollection AddToDirectory( 
   DicomImage Image,
   string Path,
   string TransferSyntax,
   short IconSize
)
public:
DicomDataSetCollection^ AddToDirectory( 
   DicomImage^ Image,
   String^ Path,
   String^ TransferSyntax,
   short IconSize
) 
'Declaration
 
Public Overloads Function AddToDirectory( _
   ByVal Image As DicomImage, _
   ByVal Path As String, _
   ByVal TransferSyntax As String, _
   ByVal IconSize As Short _
) As DicomDataSetCollection
 
'Usage
 
Dim instance As DicomDataSet
Dim Image As DicomImage
Dim Path As String
Dim TransferSyntax As String
Dim IconSize As Short
Dim value As DicomDataSetCollection
 
value = instance.AddToDirectory(Image, Path, TransferSyntax, IconSize)

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 6 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

IconSize

The size of the icon image to be included in the DICOMDIR � use 0 for no icon

Return Value

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.

Requirements

Target Platforms: .NET CLR 3.5 or higher

See Also