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

Document the TiffImages.load keyword arguments #22

Merged
merged 1 commit into from
Dec 11, 2024
Merged

Document the TiffImages.load keyword arguments #22

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
7 changes: 5 additions & 2 deletions src/load.jl
View file
Open in desktop
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
Loading