Skip to content

ndi.util.datasetSummary

  DATASETSUMMARY - create a summary structure of an ndi.dataset object

  SUMMARY = NDI.UTIL.DATASETSUMMARY(DATASET_OBJ)

  Returns a structure SUMMARY containing key fields and properties
  of the NDI.DATASET object DATASET_OBJ. This structure is intended
  for symmetry testing between different NDI language implementations.

  The summary includes:
    - numSessions: number of sessions in the dataset
    - references: cell array of session reference strings
    - sessionIds: cell array of session ID strings
    - sessionSummaries: cell array of session summary structs
      (produced by ndi.util.sessionSummary for each session)
    - documentCounts (optional): cell array of structs with
      sessionId and count fields, one per session

  This function accepts name-value pair arguments:
    'includeDocumentCounts' - Logical (default false). If true,
        also counts documents per session and includes them in the
        summary as a 'documentCounts' field.