ICESat-2 Data Analysis for Land and Vegetation
![[R logo]](../../../doc/html/Rlogo.svg)
![[Up]](../../../doc/html/left.jpg)
![[Top]](../../../doc/html/up.jpg)
Documentation for package ‘ICESat2VegR’ version 0.0.1
Help Pages
A B C D E F G I L M P R S T V W misc
| ICESat2VegR-package | ICESat2VegR: NASA ICESat-2 data for land & vegetation |
-- A --
| addEEImage | Add an Earth Engine Image to a leaflet map |
| ANNIndex | ANNIndex Class |
| aspect | Compute terrain aspect (degrees) from a DEM image |
| atan2.ee.ee_number.Number | Calculates the angle formed by the 2D vector [x, y] |
| ATL03_ATL08_compute_seg_attributes_dt_segStat | Statistics of ATL03 and ATL08 labeled photons at the segment level |
| ATL03_ATL08_photons_attributes_dt_clipBox | Clip joined ATL03 and ATL08 photons by bounding extent |
| ATL03_ATL08_photons_attributes_dt_clipGeometry | Clip Joined ATL03 and ATL08 by Geometry |
| ATL03_ATL08_photons_attributes_dt_gridStat | Statistics of ATL03 and ATL08 photon attributes |
| ATL03_ATL08_photons_attributes_dt_join | Join ATL03 and ATL08 photons attributes |
| ATL03_ATL08_photons_attributes_dt_LAS | Export Merged ICESat-2 ATL03/ATL08 Photon Data to LAS Files |
| ATL03_ATL08_photons_attributes_dt_polyStat | Statistics of ATL03 and ATL08 joined photons attributes within a given area |
| ATL03_ATL08_photons_seg_dt_fitground | Fit and estimate ground elevation for photons or arbitrary distances from the track beginning |
| ATL03_ATL08_photons_seg_dt_height_normalize | Normalize photon heights relative to estimated ground elevation |
| ATL03_ATL08_segment_create | Compute segments id for a given segment length |
| ATL03_ATL08_seg_attributes_dt_clipBox | Clip joined ATL03/ATL08 segment attributes by bounding extent |
| ATL03_ATL08_seg_attributes_dt_clipGeometry | Clip joined ATL03/ATL08 segment attributes by geometry |
| ATL03_ATL08_seg_cover_dt_compute | Compute canopy cover from ATL03/ATL08 classified photons |
| ATL03_h5_clipBox | Clip ICESat-2 ATL03 HDF5 Data Using a Bounding Extent |
| ATL03_h5_clipGeometry | Clip ICESat-2 ATL03 HDF5 Data Using Geometry-Based Boundaries |
| ATL03_photons_attributes_dt | ATL03 photon attributes |
| ATL03_photons_attributes_dt_clipBox | Clip ATL03 photons by bounding extent |
| ATL03_photons_attributes_dt_clipGeometry | Clip ATL03 photons by Coordinates |
| ATL03_photons_attributes_dt_LAS | Export ICESat-2 ATL03 Photon Data to LAS Files |
| ATL03_read | Read ICESat-2 ATL03 data |
| ATL03_read-method | Read ICESat-2 ATL03 data from a local HDF5 file |
| ATL03_read-method | Read ICESat-2 ATL03 data from a single cloud granule |
| ATL03_seg_metadata_dt | ATL03 geolocation segment metadata |
| ATL08_h5_clipBox | Clip ICESat-2 ATL08 HDF5 Data Using a Bounding Extent |
| ATL08_h5_clipGeometry | Clips ICESat-2 ATL08 data |
| ATL08_photons_attributes_dt | ATL08 computed photons attributes |
| ATL08_photons_attributes_dt_LAS | Export ICESat-2 ATL08 photon attributes to LAS files |
| ATL08_read | Read ICESat-2 ATL08 data |
| ATL08_read-method | Read ICESat-2 ATL08 data from a local HDF5 file |
| ATL08_read-method | Read ICESat-2 ATL08 data from a single granule in the cloud |
| ATL08_read-method | Read ICESat-2 ATL08 data from multiple granules |
| ATL08_seg_attributes_dt | ATL08 Terrain and Canopy Attributes |
| ATL08_seg_attributes_dt_clipBox | Clip ATL08 terrain and canopy attributes by bounding extent |
| ATL08_seg_attributes_dt_clipGeometry | Clip ATL08 Terrain and Canopy Attributes by Geometry |
| ATL08_seg_attributes_dt_gridStat | Statistics of ATL08 terrain and canopy attributes at grid level |
| ATL08_seg_attributes_dt_LAS | Export ICESat-2 ATL08 Segment Data to LAS Files |
| ATL08_seg_attributes_dt_polyStat | Statistics of ATL08 Terrain and Canopy Attributes by Geometry |
| ATL08_seg_attributes_h5_gridStat | Rasterize ATL08 canopy attributes from h5 files at large scale |
| ATLAS_dataDownload | Download ICESat-2 ATL03/ATL08 data |
| ATLAS_dataFinder | ICESat-2 ATL03 and ATL08 data finder for either direct download or cloud computing |
-- B --
| build_ee_forest | Convert an R randomForest model to a Google Earth Engine randomForest classifier |
-- C --
| clip | Clip ICESat-2 ATL03/ATL08 data ( h5, attributes, or ATL03-ATL08 join) by box or geometry |
| clip-method | Clip ATL03 photons by Coordinates |
| clip-method | Clip ATL03 photons by bounding extent |
| clip-method | Clip ATL03 photons by bounding extent |
| clip-method | Clip ICESat-2 ATL03 HDF5 Data Using Geometry-Based Boundaries |
| clip-method | Clip ICESat-2 ATL03 HDF5 Data Using a Bounding Extent |
| clip-method | Clip ICESat-2 ATL03 HDF5 Data Using a Bounding Extent |
| clip-method | Clip Joined ATL03 and ATL08 by Geometry |
| clip-method | Clip joined ATL03 and ATL08 photons by bounding extent |
| clip-method | Clip joined ATL03 and ATL08 photons by bounding extent |
| clip-method | Clip ATL08 Terrain and Canopy Attributes by Geometry |
| clip-method | Clip ATL08 terrain and canopy attributes by bounding extent |
| clip-method | Clip ATL08 terrain and canopy attributes by bounding extent |
| clip-method | Clips ICESat-2 ATL08 data |
| clip-method | Clip ICESat-2 ATL08 HDF5 Data Using a Bounding Extent |
| clip-method | Clip ICESat-2 ATL08 HDF5 Data Using a Bounding Extent |
| close-method | Safely closes the ICESat2.h5 base classes |
| close.GDALDataset | Method to close GDALDataset |
| close.icesat2.predict_h5 | Closes the HDF5 file pointer to release resources |
| createDataset | Creates a new GDALDataset |
-- D --
| dt_to_las | Convert ICESat-2 ATL03 and ATL08 data.table objects to LAS files |
-- E --
| earthdata_login | Get or Create a '.netrc' File for NASA Earthdata Login |
| ee | The pointer to the 'earth-engine-api' python reticulate module |
| ee_build_AlphaEarth_embedding_terrain_stack | Stack Alpha Earth embedding and terrain ancillary layers |
| ee_build_hls_s1c_terrain_stack | Build HLS, Sentinel-1C and terrain ancillary stack in Earth Engine |
| ee_check_task_status | One-shot task status check |
| ee_initialize | Initializes the Google Earth Engine API Initialize Earth Engine for this R session |
| ee_number | Creates an Earth Engine server number |
| ee_rect_to_sf | Convert an EE Rectangle to an sf polygon (EPSG:4326) |
| extract | Given a geometry with point samples and images from Earth Engine retrieve the point geometry with values for the images |
| ext_to_ee | Convert a terra extent or spatial object to an Earth Engine Rectangle |
-- F --
| fit_metrics | Model fit metrics |
| fit_model | Fit a Random Forest with optional resampling, tuning, and progress bars |
| formulaCalculate | Calculate raster values based on a formula |
-- G --
| GDALDataset | R6 Class GDALDataset wrapping |
| GDALDataType | List of datatypes supported by the GDALDataset R6 class |
| GDALOpen | Open GDAL raster |
| GDALRasterBand | R6 Class GDALRasterBand wrapping |
| geomSampling | Get observations sampled within polygon features |
| getTileUrl | Retrieve Google Earth Engine's tile url for an Image or ImageCollection |
| get_catalog_id | Retrieve the Google Earth Engine image catalog id |
| glcmTexture | Maps to 'ee.Image.glcmTexture' |
| gridSampling | Get samples stratified by grid cells of specified size |
-- I --
| icesat2.atl03atl08_dt-class | Class for joined ATL03 and ATL08 attributes |
| icesat2.atl03_atl08_seg_dt-class | Class that represent custom segments created from ATL03 and ATL08 joined data |
| icesat2.atl03_dt-class | Class for ATL03 attributes |
| icesat2.atl03_h5-class | Class for ICESat-2 ATL03 |
| icesat2.atl03_seg_dt-class | Class for ATL03 segment attributes |
| icesat2.atl08_dt-class | Class for ATL08 attributes |
| icesat2.atl08_h5-class | Class for ICESat-2 ATL08 |
| icesat2.h5-class | Base class for all ICESat2VegR package's H5 files for generic functions that can be run on any H5 |
| ICESat2.h5ds_cloud | Class representing dataset opened from the cloud using h5py |
| ICESat2.h5ds_local | Class representing dataset opened from locally using hdf5r |
| ICESat2.h5_cloud | The class representing the h5 file opened from the cloud for cloud computing |
| ICESat2.h5_local | The class representing the h5 file opened from local files |
| ICESat2VegR | ICESat2VegR: NASA ICESat-2 data for land & vegetation |
| ICESat2VegR_configure | Configure Python environment for ICESat2VegR cloud features |
-- L --
| length-method | Returns the number of images in an ImageCollection |
-- M --
| map_create | Create a prediction map in Google Earth Engine using a fitted Random Forest model |
| map_download | map_download: create task -> start -> (monitor) -> download/return id |
| map_view | Compose a leaflet map from multiple layers (EE rasters and/or vectors) |
-- P --
| plot-method | Plot photons from ATL03 and ATL08 joined products |
| plot.varSel | Plot variable importance for 'varSel' objects |
| plot_icesat2_orbit_animation | Plot ICESat-2 orbital tracks as a 3D globe animation |
| predict_h5 | Model prediction over data.tables using HDF5 file as output |
| predict_h5-method | S4 method for predicting using HDF5 file as output |
| predict_h5-method | S4 method for predicting using HDF5 file as output |
| prepend_class | Prepend a class to an object's list of classes |
-- R --
| randomSampling | Pure random sampling method |
| rasterize_h5 | Rasterizes the model prediction saved in the HDF5 file |
| rasterize_h5-method | Rasterizes the model prediction saved in the HDF5 file |
| rasterSampling | Get observations sampled by raster class |
| rbindlist2 | Row-bind a list of objects while preserving class |
| rgt_extract | Extract Reference Ground Track from ICESat-2 ATL03 or ATL08 Data |
-- S --
| sample | Sample method for applying multiple sampling methods |
| sample_ATL_granules_by_year | Sample ICESat-2 ATL granule URLs by year |
| search_datasets | Search for Google Earth Engine datasets |
| seg_ancillary_extract | Given a stack image raster from GEE retrieve the point geometry with values for the images |
| slope | Compute terrain slope (degrees) from a DEM image |
| spacedSampling | Get observations with a minimum radius distance between samples |
| stratifiedSampling | Get samples stratified by a variable binning histogram |
-- T --
| to_vect | Convert ICESat-2 classes, data.frame/data.table, and sf to terra::SpatVector |
| to_vect-method | Convert ICESat-2 classes, data.frame/data.table, and sf to terra::SpatVector |
-- V --
| varSel | Random Forest Variable Selection (Breiman-only) |
| vect_as_ee | Convert vector data to Google Earth Engine FeatureCollection (no rgee) |
-- W --
| write_geojson | Safely write a GeoJSON file from a lon/lat table |
-- misc --
| .as_ee_geom | Convert R geometry objects to an Earth Engine geometry |
| .ee_ping | Check if Google Earth Engine is initialized |
| [-method | Subset Granules |
| [[-method | Extract Granules |
| [[.GDALDataset | GDALDataset [[]] accessor |
| [[.GDALRasterBand | GDALRasterBand [[]] getter |
| [[<-.GDALRasterBand | GDALRasterBand [[]]= setter |