Skip to content
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

Jump to bottom

Documentation correction: Not all built-in compositors derive from GenericCompositor #2274

Merged
merged 1 commit into from Nov 18, 2022
Merged

Documentation correction: Not all built-in compositors derive from GenericCompositor #2274

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 11 additions & 5 deletions doc/source/composites.rst
View file
Open in desktop
Expand Up @@ -14,12 +14,12 @@ Built-in Compositors

.. py:currentmodule:: satpy.composites

There are several built-in compositors available in SatPy.
All of them use the :class:`GenericCompositor` base class
There are many built-in compositors available in Satpy.
The majority use the :class:`GenericCompositor` base class
which handles various image modes (`L`, `LA`, `RGB`, and
`RGBA` at the moment) and updates attributes.

The below sections summarize the composites that come with SatPy and
The below sections summarize the composites that come with Satpy and
show basic examples of creating and using them with an existing
:class:`~satpy.scene.Scene` object. It is recommended that any composites
that are used repeatedly be configured in YAML configuration files.
Expand Down Expand Up @@ -59,6 +59,12 @@ is generated. To get an image out of the above composite::
This part is called `enhancement`, and is covered in more detail in
:doc:`enhancements`.

Single channel composites can also be generated with the
:class:`GenericCompositor`, but in some cases, the
:class:`SingleBandCompositor` may be more appropriate. For example,
the :class:`GenericCompositor` removes attributes such as ``units``
because they are typically not meaningful for an RGB image. Such attributes
are retained in the :class:`SingleBandCompositor`.

DifferenceCompositor
--------------------
Expand Down Expand Up @@ -492,7 +498,7 @@ Enhancing the images
After the composite is defined and created, it needs to be converted
to an image. To do this, it is necessary to describe how the data
values are mapped to values stored in the image format. This
procedure is called ``stretching``, and in SatPy it is implemented by
procedure is called ``stretching``, and in Satpy it is implemented by
``enhancements``.

The first step is to convert the composite to an
Expand Down Expand Up @@ -553,7 +559,7 @@ the file) as::
the default, in case the default should change in future versions of
Satpy.

More examples can be found in SatPy source code directory
More examples can be found in Satpy source code directory
``satpy/etc/enhancements/generic.yaml``.

See the :doc:`enhancements` documentation for more information on
Expand Down