Skip to content

message.setDICOMSequence

Signature: message.setDICOMSequence(nodePath, value, instance*, forceNode*)

Returns: void

Set the value as a JS Array of DICOM Message models that matches the nodePath.

Note

When the optional instance value is specified, the nodePath should not include an instance identifier.

Parameters

Type Name Description Default
String nodePath the DICOM node path
DICOM Message or DICOM Message[] value the new node value of either a DICOM Message or a JS Array of DICOM Messages
Integer instance* (optional) the match instance to set. Use 1 for the first instance. 1
Boolean forceNode* (optional) create the node if it doesn't exist true

Example

// Example: Set a DICOM sequence using one or more DICOM messages.

// assumes `message` is a DICOM message model object


// Example: value as a single DICOM Message
var singleSequenceItem = qie.parseDICOMFile("/tmp/sequence1.dcm", true);

message.setDICOMSequence(
   "0040,0275",        // nodePath - DICOM tag (sequence)
   singleSequenceItem  // value (single DICOM Message)
);


// Example: value as DICOM Message[] (JS array of DICOM messages)
var sequenceMessages = [
   qie.parseDICOMFile("/tmp/sequence1.dcm", true),
   qie.parseDICOMFile("/tmp/sequence2.dcm", true)
];

message.setDICOMSequence(
   "0040,0275",      // nodePath
   sequenceMessages  // value (DICOM Message[])
);


// Example: specify instance (1-based index)
message.setDICOMSequence(
   "0040,0275",      // nodePath
   sequenceMessages, // value
   1                 // instance (first match)
);


// Example: create node if it does not exist (forceNode = true)
message.setDICOMSequence(
   "0040,0280",      // nodePath (new sequence tag)
   sequenceMessages, // value
   1,                // instance
   true              // forceNode - create if missing
);


// Example: do NOT create node if it does not exist
message.setDICOMSequence(
   "0040,0290",
   sequenceMessages,
   1,
   false             // forceNode - will NOT create tag
);