Skip to content

Commit f91089a

Browse files
committed
Fixes to pydicom documentation page
1 parent c3d3a65 commit f91089a

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

docs/highdicom_and_pydicom.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,19 @@ There is a wide variety of DICOM objects defined in the standard, covering many
2626
types of images (X-Ray, CT, MRI, Microscopy, Ophthalmic images) as well as
2727
various types of image-derived information, such as Structured Reports,
2828
Annotations, Presentation States, Segmentations, and Parametric Maps. Formally,
29-
these "types" are known as Information Object Definitions (IODs). The standard
30-
requires different combinations of attributes are required for different IODs
31-
(e.g. the "Echo Time" attribute exists with the *MRImage* IOD but not within
32-
the *CTImage* IOD) ``pydicom`` represents all of these objects using a general
33-
``Dataset`` class, which implements behavior that is common to all of these
34-
objects. However, it does not attempt to specialize its representation to
35-
implement specific behaviors of these various IODs, leaving it up to the user
36-
to interpret the individual attributes in the file in each case.
29+
these "types" are known as Information Object Definitions (IODs). Each IOD in
30+
the standard requires different combinations of attributes. For example, the
31+
"Echo Time" attribute exists with the *MRImage* IOD but not within the
32+
*CTImage* IOD. ``pydicom`` represents all of these objects using the same
33+
general ``Dataset`` class, which implements behavior that is common to all
34+
DICOM objects However, it does not attempt to specialize its representation to
35+
implement IOD-specific behavior, leaving this up to the user.
3736

3837
The purpose of ``highdicom`` is to build upon ``pydicom`` to implement specific
39-
behaviors for various IODs, to make it easier to correctly create and work with
38+
behaviors for various IODs to make it easier to correctly create and work with
4039
**specific** types of DICOM object. ``highdicom`` defines sub-classes of
41-
``pydicom.Dataset`` that implement particular IODs, for example:
40+
``pydicom.Dataset`` that implement particular IODs, with a specific focus on
41+
IODs that store information derived from other images. For example:
4242

4343
- :class:`highdicom.Image` (this actually covers many IODs)
4444
- :class:`highdicom.seg.Segmentation`
@@ -63,11 +63,11 @@ they also have:
6363
ensuring correctness. The constructors guide you through which attributes are
6464
required and enforce inter-relationships between them required by the
6565
standard.
66-
- Several of these IODs also have further methods that allow you to search,
67-
filter, and access the information within them more easily.
66+
- Further methods that allow you to search, filter, and access the information
67+
within them more easily.
6868

69-
However, not all classes within ``highdicom`` are DICOM objects, and such
70-
objects are not sub-classes of ``pydicom.Dataset``. Notable examples include
69+
However, some classes within ``highdicom`` are not DICOM objects and as such
70+
are not sub-classes of ``pydicom.Dataset``. Notable examples include
7171
:class:`highdicom.Volume`,
7272
:class:`highdicom.spatial.ImageToReferenceTransformer` (and other similar
7373
objects), :class:`highdicom.io.ImageFileReader`.

0 commit comments

Comments
 (0)