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

geotiffimage: stop mentioning that readRGB() forces interleaving #426

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

geotiffimage: stop mentioning that readRGB() forces interleaving #426

Show file tree
Hide file tree
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,8 +360,7 @@ YCbCr, and CIE L*a*b.

geotiff.js provides a method to automatically convert these images to RGB:
`readRGB()`. This method is very similar to the `readRasters` method with
distinction that the `interleave` option is now always `true` and the
`samples` are automatically chosen.
distinction the `samples` are automatically chosen.

```javascript
const rgb = await image.readRGB({
Expand Down
3 changes: 1 addition & 2 deletions src/geotiffimage.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -615,8 +615,7 @@ class GeoTIFFImage {
}

/**
* Reads raster data from the image as RGB. The result is always an
* interleaved typed array.
* Reads raster data from the image as RGB.
* Colorspaces other than RGB will be transformed to RGB, color maps expanded.
* When no other method is applicable, the first sample is used to produce a
* grayscale image.
Expand Down
Loading