Skip to content

Commit

Permalink
variable names should have single backtick
Browse files Browse the repository at this point in the history
  • Loading branch information
j9ac9k committed May 19, 2024
1 parent 0021cb7 commit 1db3afd
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions doc/source/api_reference/graphicsItems/imageitem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ adjustments, or with :class:`~pyqtgraph.HistogramLUTItem` or
table used to display the image.

An image can be placed into a plot area of a given extent directly through the
:meth:`ImageItem.setRect <pyqtgraph.ImageItem.setRect>` method or the ``rect`` keyword.
:meth:`ImageItem.setRect <pyqtgraph.ImageItem.setRect>` method or the `rect` keyword.
This is internally realized through assigning a :class:`QTransform`. For other
translation, scaling or rotations effects that persist for all later image data, the
user can also directly define and assign such a transform, as shown in the example
Expand All @@ -43,7 +43,7 @@ Performance
-----------

The performance of :class:`~pyqtgraph.ImageItem` can vary *significantly* based on
attributes of the ``image``, ``levels`` and ``lut`` input arguments. It should not be
attributes of the `image`, `levels` and `lut` input arguments. It should not be
assumed that the default parameters are the most performant, as the default values are
largely there to preserve backwards compatibility.

Expand All @@ -55,12 +55,12 @@ The following guidance should be observed if performance is an important factor
:python:`pyqtgraph.setConfigOption('imageAxisOrder', 'row-major')`

* Use C-contiguous image data.
* For 1 or 3 channel data, use `uint8`, `uint16`, `float32`, or `float64` ``image``
* For 1 or 3 channel data, use `uint8`, `uint16`, `float32`, or `float64` `image`
dtype.
* For 4-channel data, use `uint8` or `uint16` with :python:`levels=None`.
* ``levels`` should be set to either to ``None`` or to single channel ``[min, max]``
* `levels` should be set to either to ``None`` or to single channel ``[min, max]``

* Not setting ``levels`` will trigger autoLevels sampling
* Not setting `levels` will trigger autoLevels sampling

* If using LUTs (lookup tables), ensure they have a dtype of `uint8` and have 256
points or less. That can be accomplished with calling:
Expand All @@ -69,7 +69,7 @@ The following guidance should be observed if performance is an important factor
* :func:`ImageItem.setLookupTable <pyqtgraph.ImageItem.setLookupTable>` with
:python:`ColorMap.getLookupTable(nPts=256)` (default is :python:`nPts=512`)

* For floating point ``image`` arrays, prefer `float32` dtype to `float64` and avoid
* For floating point `image` arrays, prefer `float32` dtype to `float64` and avoid
``NaN`` values.
* Enable Numba with :python:`pyqtgraph.setConfigOption('useNumba', True)`

Expand Down

0 comments on commit 1db3afd

Please sign in to comment.