Skip to content

Commit

Permalink
fix: typo
Browse files Browse the repository at this point in the history
  • Loading branch information
daron1337 committed Dec 18, 2024
1 parent 5139da6 commit e0289d9
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
3 changes: 1 addition & 2 deletions docs/api/loading.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ These functions are essential for setting up the system to load DICOM (and non D
The `updateLoadedStack` function is a critical part of the Larvitar core API, responsible for managing the loading and organization of series data during parsing. It initializes series stacks, tracks metadata, handles multiframe and single-frame files, and ensures that image IDs and instance data are correctly ordered and stored.

#### Purpose

This function updates the `allSeriesStack` object with series and instance information based on the provided seriesData. It:

1. **Initializes New Series:** Creates a new entry in allSeriesStack for previously unseen series.
Expand All @@ -39,7 +40,6 @@ This function updates the `allSeriesStack` object with series and instance infor
#### Key Steps in the Function

1. **Extract Metadata:** The function extracts important metadata from seriesData to identify and classify the series:

- Identifiers: Series, study, and instance UIDs.
- Attributes: Number of slices, frames, modality, whether the data is multiframe, or part of a staged protocol.
- Special Handling: Identifies 4D datasets, PDFs, color images, and anonymized data.
Expand Down Expand Up @@ -68,7 +68,6 @@ This function updates the `allSeriesStack` object with series and instance infor

2. **4D Dataset Handling:** Uses ContentTime for secondary ordering when dealing with temporal datasets.


3. **Staged Protocols:** Recognizes staged protocols (e.g., multi-view acquisitions) and stores additional metadata like stage and view numbers.

4. **Error Handling:** Throws an error if a unique series ID cannot be determined.
Expand Down
6 changes: 3 additions & 3 deletions docs/api/modules/store.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ The `StoreSeries` type includes the following key properties:

The `StoreViewport` [type](https://github.com/dvisionlab/Larvitar/blob/master/imaging/types.d.ts#L34) includes the following key properties:

| Property | Type | Description |
|-------------------------------|---------------|---------------------------------------------------------------------------|
| `loading` | `number` | Caching progress of the series from 0% to 100 %, initialized to null. |
| Property | Type | Description |
|-------------------------------|--------------- |---------------------------------------------------------------------------|
| `loading` | `number` | Caching progress of the series from 0% to 100 %, initialized to null. |
| `ready` | `boolean` | True when the viewport is ready and imageId has been rendered. |
| `seriesUID` | `string?` | Unique identifier for the series. |
| `modality` | `string` | Modality of the image (e.g., "CT"). |
Expand Down

0 comments on commit e0289d9

Please sign in to comment.