Skip to content

Commit

Permalink
Update read_geotif.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HaleySchuhl committed Apr 15, 2024
1 parent 5790b22 commit a79ee6f
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/read_geotif.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@

Read in data (from tif format, most likely georeferenced image data).

**plantcv.geospatial.read_geotif**(*filename, mode="rgb"*)
**plantcv.geospatial.read_geotif**(*filename, bands="rgb"*)

**returns** [PlantCV Spectral_data](https://plantcv.readthedocs.io/en/latest/Spectral_data/) object instance

- **Parameters:**
- filename - Filepath to .tif data
- mode - Mode for geotif reading
- bands - Comma separated string representing the order of image bands (default bands="R,G,B"), or a list of wavelengths (e.g. bands=[650,560,480])
- Supported keys for bands and their default_wavelengths = {"R": 650, "G": 560, "B": 480, "RE": 717, "N": 842, "NIR": 842}

- **Example use:**
- below
Expand All @@ -19,7 +20,7 @@ import plantcv.plantcv as pcv
import plantcv.geospatial as geo

# Read geotif in
marker = geo.read_geotif(filename="./data/example_img.tif", mode="rgb")
marker = geo.read_geotif(filename="./data/example_img.tif", bands="r,g,b,NIR,RE")

```

Expand Down

0 comments on commit a79ee6f

Please sign in to comment.