API reference¶

Api¶

Interact with various remote sensing data query and download APIs

Register datasets to the datacube database.

`indexing.add_product`
`indexing.add_product_from_yaml`
`indexing.add_product_from_recipe`
`indexing.add_dataset`
`indexing.wkt_to_proj4`
`indexing.metadict_from_netcdf`

Generate metadata to prepare indexing/ingestion of datasets

`ingestion.bioclimatics.metadata_convert`
`ingestion.landsat_espa.metadata_convert`
`ingestion.srtm_cgiar.metadata_convert`
`ingestion.s2_l2a_20m.metadata_convert`

Read and write data

`io.vector_db.from_geobox`
`io.vector_db.VectorDb`
`io.vector_db.VectorDb.load_training_from_dataset`

Interface to perform Land cover change detection and classication

`lcc.bitemporal.BaseBiChange`
`lcc.bitemporal.BaseBiChange.from_geoarray`
`lcc.bitemporal.BaseBiChange.run`
`lcc.bitemporal.BaseBiChange.filter_mmu`
`lcc.bitemporal.BaseBiChange.label_change`
`lcc.bitemporal.BaseBiChange.filter_no_change`
`lcc.bitemporal.BaseBiChange.to_db`
`lcc.bitemporal.BaseBiChange.read_land_cover`

`lcc.bitemporal.distance.BiChange`
`lcc.bitemporal.imadmaf.BiChange`

A standardized interface to perform transformation of single arrays or between two arrays

`lcc.transform.TransformBase`
`lcc.transform.TransformBase.transform`
`lcc.transform.BitransformBase`
`lcc.transform.BitransformBase.transform`

`lcc.transform.elliptic.Transform`
`lcc.transform.irmad.Transform`
`lcc.transform.kapur.Transform`
`lcc.transform.mad.Transform`
`lcc.transform.maf.Transform`

Interface to various statistical models running on numpy arrays

`modeling.BaseModel`
`modeling.BaseModel.fit`
`modeling.BaseModel.predict`
`modeling.BaseModel.load`
`modeling.BaseModel.save`
`modeling.BaseModel.from_db`
`modeling.BaseModel.to_db`
`modeling.BaseModel.hot_encode_training`
`modeling.BaseModel.hot_encode_predict`
`modeling.BaseModel.remove_outliers`

`modeling.supervised.rf.Model`
`modeling.supervised.xgb.Model`
`modeling.supervised.lgb.Model`

Overlay operations: conversions (vector to raster to vector) and extractions

`overlay.conversions.rasterize_xarray`
`overlay.conversions.train_object_to_feature`
`overlay.conversions.predict_object_to_feature`
`overlay.extractions.calculate_zonal_statistics`
`overlay.extractions.zonal_stats_xarray`

Interface to various segmentation algorithms operating on numpy arrays and xarray ```Dataset``s

`segmentation.BaseSegmentation`
`segmentation.BaseSegmentation.from_geoarray`
`segmentation.BaseSegmentation.segment`
`segmentation.BaseSegmentation.polygonize`
`segmentation.BaseSegmentation.to_db`

`segmentation.slic.Segmentation`
`segmentation.bis.Segmentation`

Utilities to compute validation metrics on existing results

`validation.prepare_validation`
`validation.validate`
`validation.query_validation_intersect`
`validation.pprint_val_dict`

Wrapper functions to be called in scripts and command lines

Various utils

`util.randomword`
`util.yaml_to_dict`
`util.mid_date`
`util.parser_extra_args`
`util.chunk`
`util.pprint_args`
`util.fill_and_copy`
`util.join_dicts`
`util.datacube.var_to_ind`
`util.local.aware_download`
`util.local.extract_zip`
`util.local.aware_make_dir`
`util.local.basename`
`util.local.filter_files_from_folder`
`util.xarray.to_float`
`util.xarray.to_int`
`util.numpy.groupby`
`util.spatial.feature_transform`
`util.spatial.geometry_transform`
`util.spatial.get_geom_bbox`
`util.spatial.grid_gen`
`util.s3.list_folders`
`util.s3.list_files`
`util.s3.build_rasterio_path`
`util.s3.read_file`
`util.s3.write_raster`
`util.db.classification_to_cmap`
`util.db.get_label_encoding`
`util.db.get_validation_scheme_name`
`util.parsers.postgis_box_parser`