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.

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

Document behaviour on default enhancement #2247

Merged
merged 3 commits into from Nov 2, 2022
Merged
Changes from 2 commits
Commits
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
17 changes: 17 additions & 0 deletions doc/source/composites.rst
Expand Up @@ -536,6 +536,23 @@ the file) as::
kwargs:
gamma: [1.7, 1.7, 1.7]

.. warning::
If you define a composite with no matching enhancement, Satpy will by
default apply a crude stretch enhancement. If you want no enhancement
gerritholl marked this conversation as resolved.
Show resolved Hide resolved
at all (maybe you are enhancing a composite based on
:class:`DayNightCompositor` where the components have their own
enhancements defined), you need to define an enhancement that does
nothing::

enhancements:
day_x:
standard_name: day_x
operations: []

It is recommended to define an enhancement even if you intend to use
the default, in case the default should change in future versions of
Satpy.

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

Expand Down