nojuman / imageprocessing

MicaSense RedEdge image processing tutorials

README

MicaSense RedEdge Image Processing Tutorials

Tutorial for redEdge image processing

How do I get set up?

First, check out this repository, as it has all of the code and examples you'll need.

To do that you'll need git

Once you have git installed and the repository cloned, you are ready to start with the first tutorial. The setup tutorial will walk through installing and checking the necessary tools to run the remaining tutorials.

Tutorial Articles

1. MicaSense Image Processing Setup
2. MicaSense Image Processing Tutorial #1

Running this code

The code in these tutorials consists of two parts. First, the tutorials generally end in .ipynb and are the ipython (now Jupyter) notebooks that were used to create the web page tutorials linked below. You can run this code by opening a command line (linux) or Anaconda Command Prompt (Windows), navigating to the folder you cloned the git repository into, and running

jupyter notebook .

That command should open a web browser window showing the set of files and folder in the repository. Click the ...Setup.ipynb notebook to get started.

Second, a set of helper utilities is available in the micasense folder that can be used both with these tutorials as well as separtely. The purpose of this code is readability and clarity to help others develop processing workflows, therefore performance may not be optimal.

Contribution guidelines

Find an issue with the tutorial? Create an issue on github.

Have a question? Double-check that you're able to run the setup notebook successfully, and then check the MicaSense Knowledgebase before contacting support.

For (Tutorial) Developers

To generate the HTML pages after updating the jupyter notebooks, run the following command in the repository directory:

jupyter nbconvert --to html --output-dir docs --execute *.ipynb

License

The MIT License (MIT)

Copyright (c) 2017 MicaSense, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.