Skip to content

Commit

Permalink
Document the 'TiffImages.load' keyword arguments (#22)
Browse files Browse the repository at this point in the history
  • Loading branch information
eliascarv authored Dec 11, 2024
1 parent 3f02e03 commit 8520cfd
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions src/load.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,14 @@
# -----------------------------------------------------------------

"""
GeoTIFF.load(fname; kwargs...)
GeoTIFF.load(fname; verbose=true, mmap=false, lazyio=false)
Load a GeoTIFF file returning an image with the processed GeoTIFF metadata.
If the file contains more than one image, an iterator of images will be returned.
The keyword arguments are forward to the `TiffImages.load` function.
Use the `verbose` option to show or hide the loading bar,
and use the `mmap` or `lazyio` option to enable memory-mapping or lazy I/O.
For more details, check the TiffImages.jl documentation.
See also [`GeoTIFF.GeoTIFFImage`](@ref), [`GeoTIFF.GeoTIFFImageIterator`](@ref).
Expand Down

0 comments on commit 8520cfd

Please sign in to comment.