Skip to content

Update indices documentation with latest schemas #283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fedorov merged 1 commit into from
Jul 11, 2026
Merged

Update indices documentation with latest schemas #283

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions docs/indices_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This page provides a comprehensive reference for all index tables available in
`idc-index`. The documentation is automatically generated from the schemas
provided by `idc-index-data` (version 24.2.0).
provided by `idc-index-data` (version 24.2.2).

> **Note:** Column descriptions are sourced directly from the `idc-index-data`
> package schemas. If you notice any missing or incorrect descriptions, please
Expand Down Expand Up @@ -208,7 +208,10 @@ AWS S3 bucket and URL to download the series.
- **`StudyDescription`** (`STRING`, NULLABLE): textual description of the study
content (DICOM attribute)
- **`BodyPartExamined`** (`STRING`, NULLABLE): body part imaged (not applicable
for SM series) (DICOM attribute)
for SM series) (DICOM attribute). For derived series (SEG, RTSTRUCT) this
reflects the source acquisition, not the segmented anatomy -- what was
segmented is recorded in the seg_index table
(SegmentedPropertyType_CodeMeanings) and in rtstruct_index.
- **`Modality`** (`STRING`, NULLABLE): acquisition modality (DICOM attribute)
- **`SOPClassUID`** (`STRING`, NULLABLE): SOP Class UID identifying the type of
DICOM object (e.g., CT Image Storage, Segmentation Storage); more specific
Expand All @@ -224,6 +227,14 @@ AWS S3 bucket and URL to download the series.
Transfer Syntax (e.g., "JPEG 2000", "Explicit VR Little Endian");
comma-separated when a series contains instances with different encodings;
derived from TransferSyntaxUID
- **`PhotometricInterpretation`** (`STRING`, NULLABLE): intended interpretation
of the pixel data, e.g., MONOCHROME2 (grayscale), RGB or YBR_FULL_422 (color);
NULL for non-image objects (e.g., SEG, SR, RTSTRUCT); comma-separated when a
series contains instances with different values (DICOM attribute)
- **`PixelRepresentation`** (`STRING`, NULLABLE): data representation of pixel
sample values: "0" for unsigned integers, "1" for signed integers; NULL for
non-image objects; comma-separated when a series contains instances with
different values (DICOM attribute)
- **`Manufacturer`** (`STRING`, NULLABLE): manufacturer of the equipment that
produced the series (DICOM attribute)
- **`ManufacturerModelName`** (`STRING`, NULLABLE): model name of the equipment
Expand Down
Loading