Skip to content

Add openslide.barcode property #360

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
bgilbert merged 2 commits into from
Jun 6, 2026
+38 −33
Merged

Add openslide.barcode property #360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65905b0
Sort property name attributes
bgilbert May 31, 2026
336a200
Add openslide.barcode property
bgilbert May 31, 2026
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
54 changes: 29 additions & 25 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,26 +288,38 @@ Standard properties
The :mod:`openslide` module provides attributes containing the names of
some commonly-used OpenSlide properties.

.. data:: PROPERTY_NAME_COMMENT
.. data:: PROPERTY_NAME_BACKGROUND_COLOR

The name of the property containing a slide's comment, if any.
The name of the property containing a slide's background color, if any.
It is represented as an RGB hex triplet.

.. data:: PROPERTY_NAME_VENDOR
.. data:: PROPERTY_NAME_BARCODE

The name of the property containing an identification of the vendor.
The name of the property containing a slide's barcode, if any.

.. data:: PROPERTY_NAME_QUICKHASH1
.. data:: PROPERTY_NAME_BOUNDS_HEIGHT

The name of the property containing the "quickhash-1" sum.
The name of the property containing the height of the rectangle bounding
the non-empty region of the slide, if available.

.. data:: PROPERTY_NAME_BACKGROUND_COLOR
.. data:: PROPERTY_NAME_BOUNDS_WIDTH

The name of the property containing a slide's background color, if any.
It is represented as an RGB hex triplet.
The name of the property containing the width of the rectangle bounding
the non-empty region of the slide, if available.

.. data:: PROPERTY_NAME_OBJECTIVE_POWER
.. data:: PROPERTY_NAME_BOUNDS_X

The name of the property containing a slide's objective power, if known.
The name of the property containing the X coordinate of the rectangle
bounding the non-empty region of the slide, if available.

.. data:: PROPERTY_NAME_BOUNDS_Y

The name of the property containing the Y coordinate of the rectangle
bounding the non-empty region of the slide, if available.

.. data:: PROPERTY_NAME_COMMENT

The name of the property containing a slide's comment, if any.

.. data:: PROPERTY_NAME_MPP_X

Expand All @@ -319,25 +331,17 @@ some commonly-used OpenSlide properties.
The name of the property containing the number of microns per pixel in
the Y dimension of level 0, if known.

.. data:: PROPERTY_NAME_BOUNDS_X

The name of the property containing the X coordinate of the rectangle
bounding the non-empty region of the slide, if available.

.. data:: PROPERTY_NAME_BOUNDS_Y
.. data:: PROPERTY_NAME_OBJECTIVE_POWER

The name of the property containing the Y coordinate of the rectangle
bounding the non-empty region of the slide, if available.
The name of the property containing a slide's objective power, if known.

.. data:: PROPERTY_NAME_BOUNDS_WIDTH
.. data:: PROPERTY_NAME_QUICKHASH1

The name of the property containing the width of the rectangle bounding
the non-empty region of the slide, if available.
The name of the property containing the "quickhash-1" sum.

.. data:: PROPERTY_NAME_BOUNDS_HEIGHT
.. data:: PROPERTY_NAME_VENDOR

The name of the property containing the height of the rectangle bounding
the non-empty region of the slide, if available.
The name of the property containing an identification of the vendor.


Exceptions
Expand Down
17 changes: 9 additions & 8 deletions openslide/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,17 +44,18 @@

__library_version__ = lowlevel.get_version()

PROPERTY_NAME_COMMENT = 'openslide.comment'
PROPERTY_NAME_VENDOR = 'openslide.vendor'
PROPERTY_NAME_QUICKHASH1 = 'openslide.quickhash-1'
PROPERTY_NAME_BACKGROUND_COLOR = 'openslide.background-color'
PROPERTY_NAME_OBJECTIVE_POWER = 'openslide.objective-power'
PROPERTY_NAME_MPP_X = 'openslide.mpp-x'
PROPERTY_NAME_MPP_Y = 'openslide.mpp-y'
PROPERTY_NAME_BARCODE = 'openslide.barcode'
PROPERTY_NAME_BOUNDS_HEIGHT = 'openslide.bounds-height'
PROPERTY_NAME_BOUNDS_WIDTH = 'openslide.bounds-width'
PROPERTY_NAME_BOUNDS_X = 'openslide.bounds-x'
PROPERTY_NAME_BOUNDS_Y = 'openslide.bounds-y'
PROPERTY_NAME_BOUNDS_WIDTH = 'openslide.bounds-width'
PROPERTY_NAME_BOUNDS_HEIGHT = 'openslide.bounds-height'
PROPERTY_NAME_COMMENT = 'openslide.comment'
PROPERTY_NAME_MPP_X = 'openslide.mpp-x'
PROPERTY_NAME_MPP_Y = 'openslide.mpp-y'
PROPERTY_NAME_OBJECTIVE_POWER = 'openslide.objective-power'
PROPERTY_NAME_QUICKHASH1 = 'openslide.quickhash-1'
PROPERTY_NAME_VENDOR = 'openslide.vendor'

_T = TypeVar('_T')

Expand Down
Loading