Skip to content

Commit 22b0b79

Browse files
Fix documentation typos and grammar errors (#392)
* Initial plan * Fix documentation typos and grammar issues Co-authored-by: DimitriPapadopoulos <3234522+DimitriPapadopoulos@users.noreply.github.com> * Fix additional documentation typos and grammar issues Co-authored-by: DimitriPapadopoulos <3234522+DimitriPapadopoulos@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
1 parent 74aebc8 commit 22b0b79

11 files changed

Lines changed: 21 additions & 21 deletions

File tree

docs/coding.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ value in `pydicom`:
7979
8080
tumor_code = codes.SCT.Tumor
8181
print(tumor_code.value)
82-
# '1083690006'
82+
# '108369006'
8383
print(tumor_code.scheme_designator)
8484
# 'SCT'
8585
print(tumor_code.meaning)

docs/development.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Pull requests
2323

2424
We encourage contributions from the users of the library (provided that they fit within the scope of the project).
2525

26-
If you are planning to make a contribution to the library, we encourage you to leave an issue first on the `issue tracker <https://github.com/ImagingDataCommons/higdicom/issues>`_ detailing your proposed contribution.
26+
If you are planning to make a contribution to the library, we encourage you to leave an issue first on the `issue tracker <https://github.com/ImagingDataCommons/highdicom/issues>`_ detailing your proposed contribution.
2727
This way, the maintainers can vet your proposal, make sure it is within the scope of the project, and guide you through the process of creating a successful pull request.
2828
Before creating a pull request on Github, read the coding style guideline, run the tests and check PEP8 compliance.
2929

docs/generalsr.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ supports structured reports through the :mod:`highdicom.sr` sub-package.
99

1010
SRs are highly complex, and this page attempts to give a basic introduction
1111
while also describing the implementation within `highdicom`. A more thorough
12-
explanation my be found in:
12+
explanation may be found in:
1313

1414
* *DICOM Structured Reporting*. David Clunie. PixelMed Publishing, 2000.
15-
Digital copy available
15+
Digital copy available
1616
`here <https://www.dclunie.com/pixelmed/DICOMSR.book.pdf>`_.
1717

1818
Content Items
@@ -53,7 +53,7 @@ item. The classes representing these content items in `highdicom` are:
5353
- :class:`highdicom.sr.UIDRefContentItem`: The value is a UID (unique
5454
identifier).
5555

56-
These classes are all subclasses pf ``pydicom.Dataset`` and you can view and
56+
These classes are all subclasses of ``pydicom.Dataset`` and you can view and
5757
interact with their attributes as you can with any pydicom dataset.
5858

5959
You can look at the API for each class to see how to construct content items of

docs/image.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ frames of the image:
7272
(see :doc:`pixel_transforms` for more details on pixel transforms), but by
7373
default any pixel transform found in the dataset except the value-of-interest
7474
(VOI) transform is applied. This should be your default way of accessing
75-
image frames in most cases, since it will typtically return the pixels as the
75+
image frames in most cases, since it will typically return the pixels as the
7676
creator of the object intended them to be understood. By default, the
7777
returned frames have datatype ``numpy.float64``, but this can be controlled
7878
using the ``dtype`` parameter.

docs/release_notes.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,13 +113,13 @@ systems, which are shifted by 0.5 pixels.
113113
1. **Pixel indices**: (column, row) indices into the pixel matrix. The values
114114
are zero-based integers in the range [0, Columns - 1] and [0, Rows - 1].
115115
Pixel indices are defined relative to the centers of pixels and the (0, 0)
116-
index is located at the center of the top left corner hand pixel of the
116+
index is located at the center of the top left corner pixel of the
117117
total pixel matrix.
118118
2. **Image coordinates**: (column, row) coordinates in the pixel matrix at
119119
sub-pixel resolution. The values are floating-point numbers in the range
120120
[0, Columns] and [0, Rows]. Image coordinates are defined relative to the
121121
top left corner of the pixels and the (0.0, 0.0) point is located at the top
122-
left corner of the top left corner hand pixel of the total pixel matrix.
122+
left corner of the top left corner pixel of the total pixel matrix.
123123

124124
To account for these differences, introduced two additional transformer classes
125125
in highdicom 0.14.1. and made changes to the existing ones.

docs/remote.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ spatial patch from a large whole slide image from the IDC.
5959
with blob.open(mode="rb", chunk_size=500_000) as reader:
6060
im = hd.imread(reader, lazy_frame_retrieval=True)
6161
62-
# Grab an arbitrary region of tile full pixel matrix
62+
# Grab an arbitrary region of the full pixel matrix
6363
region = im.get_total_pixel_matrix(
6464
row_start=15000,
6565
row_end=15512,
@@ -163,11 +163,11 @@ the ``s3fs`` documentation for details).
163163
# URL to a whole slide image from the IDC "CCDS MCI" collection on AWS S3
164164
url = 's3://idc-open-data/763fe058-7d25-4ba7-9b29-fd3d6c41dc4b/210f0529-c767-4795-9acf-bad2f4877427.dcm'
165165
166-
# Read the imge directly from the blob
166+
# Read the image directly from the blob
167167
with s3_client.open(url, mode="rb") as reader:
168168
im = hd.imread(reader, lazy_frame_retrieval=True)
169169
170-
# Grab an arbitrary region of tile full pixel matrix
170+
# Grab an arbitrary region of the full pixel matrix
171171
region = im.get_total_pixel_matrix(
172172
row_start=15000,
173173
row_end=15512,

docs/seg.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ are numbered with consecutive segment numbers starting at 1 (i.e., 1, 2, 3,
5353
...). Additionally, each segment present is accompanied by information
5454
describing what the segment represents. This information is placed in the
5555
"SegmentsSequence" (0062, 0002) attribute of the segmentation file. In
56-
*highdcom*, we use the :class:`highdicom.seg.SegmentDescription` class to hold
56+
*highdicom*, we use the :class:`highdicom.seg.SegmentDescription` class to hold
5757
this information. This is not to be confused with the DICOM "Segment
5858
Description" attribute, which is a plain text string. When you construct a
5959
DICOM SEG image using *highdicom*, you must construct a single

docs/tid1500.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The TID1500 Measurement Report Template
44
=======================================
55

66
The `TID1500 "Measurement Report" <tid1500def_>`_ template is a general-purpose
7-
template for communicating measurements and qualitative qualitative evaluations
7+
template for communicating measurements and qualitative evaluations
88
derived from one or more images or regions of images. It is recommended to read
99
the previous page on :ref:`generalsr` before this page.
1010

@@ -460,7 +460,7 @@ type (some have been omitted for brevity):
460460
- ``measurements``: (Sequence of :class:`highdicom.sr.Measurement`, optional)
461461
Numeric measurements
462462
- ``qualitative_evaluations``: (Sequence of :class:`highdicom.sr.CodedConcept`, optional)
463-
Coded name-value pairs that describe qualitative qualitative_evaluations
463+
Coded name-value pairs that describe qualitative evaluations
464464
- ``finding_category``: (:class:`highdicom.sr.CodedConcept`, optional)
465465
Category of observed finding, e.g., anatomic structure or
466466
morphologically abnormal structure
@@ -482,7 +482,7 @@ Qualitative Evaluations
482482
A Qualitative Evaluation is essentially a categorical value inferred from an
483483
image. For example, this could represent a diagnosis derived from the
484484
referenced region or a severity grading. These are represented in *highdicom*
485-
using the class :class:`highdicom.sr.QualitativeEvalution`, which is
485+
using the class :class:`highdicom.sr.QualitativeEvaluation`, which is
486486
essentially a single :class:`highdicom.sr.CodeContentItem` within a special
487487
template.
488488

@@ -495,15 +495,15 @@ parameters as coded values:
495495
from pydicom.sr.codedict import codes
496496
497497
# An evaluation of disease severity as "mild"
498-
severity_item = hd.sr.QualitativeEvalution(
498+
severity_item = hd.sr.QualitativeEvaluation(
499499
name=codes.SCT.Severity,
500500
value=codes.SCT.Mild,
501501
)
502502
503503
# An evaluation of tumor morphology as adenocarcinoma
504-
morphology_item = hd.sr.QualitativeEvalution(
504+
morphology_item = hd.sr.QualitativeEvaluation(
505505
name=codes.SCT.AssociatedMorphology,
506-
value=codes.SCT.Anenocarcinoma,
506+
value=codes.SCT.Adenocarcinoma,
507507
)
508508
509509
Measurements (`TID300 <tid300def_>`_)

docs/tid1500parsing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ A volumetric group returns a :class:`highdicom.sr.VolumeSurface` or list of
233233
:class:`highdicom.sr.ImageRegion` objects, depending on the reference type. If
234234
instead, a planar/volumetric measurement group uses the ``ReferencedSegment``
235235
reference type, the referenced segment can be accessed by the
236-
``group.referenced_segmention_frame`` property (for planar groups) or
236+
``group.referenced_segmentation_frame`` property (for planar groups) or
237237
``group.referenced_segment`` property (for volumetric groups), which return
238238
objects of type :class:`highdicom.sr.ReferencedSegmentationFrame` and
239239
:class:`highdicom.sr.ReferencedSegment` respectively.

docs/volume.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ to "LPS" convention for you.
8181

8282
The top-left 3x3 matrix of the affine matrix consists of three orthogonal
8383
column vectors that give the vector travelled when incrementing the voxel
84-
indices in each o the three dimensions. The top three elements of the last
84+
indices in each of the three dimensions. The top three elements of the last
8585
column give the position of the voxel at index ``(0, 0, 0)``. The bottom row is
8686
always ``[0., 0., 0., 1.]``. The :meth:`highdicom.Volume.from_components()`
8787
method allows you to construct a volume by specifying these components of the

0 commit comments

Comments
 (0)