Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
banesullivan committed Oct 6, 2018
1 parent 83834ce commit 92bbc95
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion espatools/raster.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,8 @@ class ColorSchemes(object):


class RasterSet(properties.HasProperties):
"""The main class to hold a set of raster data. This contains all of the bands
for a given set of rasters. This is generated by the ``RasterSetReader``.
version = properties.String('version', required=False)
Expand All @@ -127,7 +129,18 @@ class RasterSet(properties.HasProperties):
def GetRGB(self, scheme='infrared', names=None):
"""Get an RGB color scheme based on predefined presets or specify your
own band names to use. A given set of names always overrides a scheme."""
own band names to use. A given set of names always overrides a scheme.

Note:
Available schemes are defined in ``RGB_SCHEMES`` and include:

- ``true``
- ``infrared``
- ``false_a``
- ``false_b``
- ``false_c``

"""
if names is not None:
if not isinstance(names, (list, tuple)) or len(names) != 3:
raise RuntimeError('RGB band names improperly defined.')
Expand Down

0 comments on commit 92bbc95

Please sign in to comment.