Granules

# Base.Filesystem.rm — Method.

rm(granule::Granule)

Remove the file associated with granule from the local filesystem.

source

# SpaceLiDAR.download — Function.

download(granules::Vector{<:Granule}, folder=".")

Like download, but for a vector of granules.

source

# SpaceLiDAR.download — Function.

download(granule::Granule, folder=".")

Download the file associated with granule to the folder, from an http(s) location if it doesn't already exists locally. Returns a new granule. See download! for a mutating version.

Will require credentials (netrc) which can be set with netrc!.

source

# SpaceLiDAR.download! — Function.

download!(granule::Granule, folder=".")

Download the file associated with granule to the folder, from an http(s) location if it doesn't already exists locally.

Will require credentials (netrc) which can be set with netrc!.

source

# SpaceLiDAR.download! — Function.

download!(granules::Vector{<:Granule}, folder=".")

Like download!, but for a vector of granules. Will make use of aria2c (parallel).

source

# SpaceLiDAR.sync — Function.

sync(folder::AbstractString, all::Bool=false; kwargs...)
sync(folders::AbstractVector{<:AbstractString}, all::Bool=false; kwargs...)
sync(product::Symbol, folder::AbstractString, all::Bool=false; kwargs...)
sync(product::Symbol, folders::AbstractVector{<:AbstractString}, all::Bool=false; kwargs...)

Syncronize an existing archive of local granules in folder(s) with the latest granules available. Specifically, this will run search and download for any granules not yet present in folder(s), to the first folder in the list.

Warning

Using sync could result in downloading significant (TB+) amounts of data.

Assumes all folders contain granules of the same product. If not, pass the product as Symbol: sync(::Symbol, folders, all) instead.

When all is false (the default), sync will search only for granules past the date of the latest granule found in folders. If true, it will search for all granules. Note that ICESat granules are not timestamped, so sync will try to download all ICESat granules not yet present, regardless of this setting.

Any kwargs... are passed to the search function. This enables sync to only download granules within a certain extent, for example.

source

# SpaceLiDAR.ICESat_Granule — Type.

ICESat_Granule{product} <: Granule

A granule of the ICESat product product. Normally created automatically from either find, granule_from_file or granules_from_folder.

source

# SpaceLiDAR.info — Method.

info(g::ICESat_Granule)

Derive info based on the filename. The name is built up as follows: ATL03[yyyymmdd][hhmmss][ttttccss][vvvrr].h5. See section 1.2.5 in the user guide.

source

# SpaceLiDAR.ICESat2_Granule — Type.

ICESat2_Granule{product} <: Granule

A granule of the ICESat-2 product product. Normally created automatically from either find, granule_from_file or granules_from_folder.

source

# Base.convert — Method.

Base.convert(product::Symbol, g::ICESat2_Granule{T})

Converts the granule g to the product product, by guessing the correct name.

source

# SpaceLiDAR.bounds — Method.

bounds(granule::ICESat2_Granule)

Retrieves the bounding box of the granule.

Warning

This opens the .h5 file, so it is slow.

Example

julia> bounds(g)
g = ICESat2_Granule()

source

# SpaceLiDAR.info — Method.

info(g::ICESat2_Granule)

Derive info based on the filename. The name is built up as follows: ATL03_[yyyymmdd][hhmmss]_[ttttccss]_[vvv_rr].h5. See section 1.2.5 in the user guide.

source

# SpaceLiDAR.GEDI_Granule — Type.

GEDI_Granule{product} <: Granule

A granule of the GEDI product product. Normally created automatically from either find, granule_from_file or granules_from_folder.

source

# SpaceLiDAR.info — Method.

info(g::GEDI_Granule)

Derive info based on the filename. This is built up as follows: GEDI02_A_2019110014613_O01991_T04905_02_001_01.h5 or in case of v"2": GEDI02_A_2019242104318_O04046_01_T02343_02_003_02_V002.h5. See section 2.4 in the user guide.

source