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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating Docstrings and Readme file #14

Merged
merged 9 commits into from
Aug 5, 2016
Merged

Updating Docstrings and Readme file #14

merged 9 commits into from
Aug 5, 2016

Conversation

virginiayung
Copy link
Collaborator

@virginiayung virginiayung commented Aug 5, 2016

This PR updates as README.md file and docstrings as discussed in #12 and #6

  • README.md
  • docstrings
  • 馃憖 cc @jacquestardie @dnomadb
  • Merge

Proposed Typos/Doc Changes:

  • numpy 2D with shape == (pan_height, pan_width) - > numpy 2D array with shape == (pan_height, pan_width) @jacquestardie
  • In Comparison of Different Pansharpening Methods section in the README, take out the 2 Brovey methods and move comparison.md live within a docs/ folder, like in https://github.com/mapbox/rasterio/tree/master/docs @jacquestardie
  • Update link to comparison.md once merged into master @virginiayung

This was referenced Aug 5, 2016
## Comparison of Different Pansharpening Methods
We've implemented the Weighted Brovey Transform for pansharpening, which is appropriate for data like Landsat where the panchromatic band is relatively similar in resolution to the color bands.

For more information on other pansharpening methods such as IHS, PCA, P+XS, Wavelet, VWP, Wavelet with Canny Edge Detector etc, please read our notes [here]().
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reminder: Add the correct link to comparison_pansharp_method once merged into master.

cc @jacquestardie

@virginiayung virginiayung merged commit 72f2299 into master Aug 5, 2016
@virginiayung virginiayung deleted the docdocodc branch August 5, 2016 21:34
@virginiayung
Copy link
Collaborator Author

馃殺 Thanks @jacquestardie!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants