Package: rgd-client
rgd_client - Resonant GeoDataClientThergd_clientPython package is a well typed, easy to use, and extendable Python client for Resonant GeoData APIs.InstallationTo install the core clientpip install rgd-clientTo use other core modules or plugins, install the corresponding client packages. For example, the imagery client plugin is installed withpip install rgd-imagery-clientAll the functions added via a plugin are namespaced under a name defined by that plugin. For the imagery client plugin, this isimagery, so all of these plugin's features are accessed throughclient.imagery.*. Examples of this are shown below.UsageSearch and display resultsimportjsonimportmatplotlib.pyplotaspltimportnumpyasnpfromrgd_clientimportcreate_rgd_clientdefplot_geojson(gjs,*args,**kwargs):points=np.array(gjs['coordinates'])ifpoints.ndim==3:points=points[0]ifpoints.ndim==1:points=points.reshape((1,points.size,))returnplt.plot(points[:,0],points[:,1],*args,**kwargs)client=create_rgd_client(username='username',password='password')bbox={"type":"Polygon","coordinates":[[[-105.45091240368326,39.626245373878696],[-105.45091240368326,39.929904289147274],[-104.88775649170178,39.929904289147274],[-104.88775649170178,39.626245373878696],[-105.45091240368326,39.626245373878696]]]}q=client.rgd.search(query=json.dumps(bbox),predicate='intersects')forsinq:print(s['subentry_name'])plot_geojson(bbox,'k--',label='Search Region')forsinq:plot_geojson(s['footprint'],label=s['subentry_name'])plt.legend()plt.title(f'Count:{len(q)}')Inspect rasterPreview thumbnails of the rasterimportimageiofromioimportBytesIOraster=client.imagery.get_raster(q[0])plot_geojson(bbox,'k--')plot_geojson(raster['outline'],'r')load_image=lambdaimbytes:imageio.imread(BytesIO(imbytes))count=len(raster['parent_raster']['image_set']['images'])foriinrange(count):thumb_bytes=client.imagery.download_raster_thumbnail(q[0],band=i)thumb=load_image(thumb_bytes)plt.subplot(1,count,i+1)plt.imshow(thumb)plt.tight_layout()plt.show()Download RasterDownload the entire image set of the rasterimportrasteriofromrasterio.plotimportshowpaths=client.imagery.download_raster(q[0])rasters=[rasterio.open(im)foriminpaths.images]fori,srcinenumerate(rasters):plt.subplot(1,len(rasters),i+1)ax=plt.gca()show(src,ax=ax)plt.tight_layout()plt.show()STAC Item SupportThe Python client has a search endpoint specifically for Raster data that
returns each record in the search results as a STAC Item.q=client.imagery.search_raster_stac(query=json.dumps(bbox),predicate='intersects')print(q[0])# view result as STAC Item# Download using the search resultpaths=client.imagery.download_raster(q[0])print(paths)We can also upload new data in the STAC Item format. Here we simply pass back
the same STAC Item JSON which will not actually do anything because RGD
recognizes that these files are already present with a Raster.client.imagery.create_raster_stac(q[0])Please note that the assets in the STAC Item must already be uploaded to a
cloud storage provider with eithers3://orhttps://URLs. Further, the
images must have thedatatag on each asset. e.g.:{...# other STAC Item fields'assets':{'image-15030':{'href':'http://storage.googleapis.com/gcp-public-data-sentinel-2/tiles/17/S/MS/S2A_MSIL1C_20210302T161201_N0209_R140_T17SMS_20210302T200521.SAFE/GRANULE/L1C_T17SMS_A029738_20210302T161751/IMG_DATA/T17SMS_20210302T161201_B01.jp2','title':'GRANULE/L1C_T17SMS_A029738_20210302T161751/IMG_DATA/T17SMS_20210302T161201_B01.jp2','eo:bands':[{'name':'B1'}],'roles':['data'],},'image-15041':{'href':'http://storage.googleapis.com/gcp-public-data-sentinel-2/tiles/17/S/MS/S2A_MSIL1C_20210302T161201_N0209_R140_T17SMS_20210302T200521.SAFE/GRANULE/L1C_T17SMS_A029738_20210302T161751/IMG_DATA/T17SMS_20210302T161201_B02.jp2','title':'GRANULE/L1C_T17SMS_A029738_20210302T161751/IMG_DATA/T17SMS_20210302T161201_B02.jp2','eo:bands':[{'name':'B1'}],'roles':['data'],},...# ancillary files can lack a role but we like to see `metadata` used.'ancillary-30687':{'href':'http://storage.googleapis.com/gcp-public-data-sentinel-2/tiles/17/S/MS/S2A_MSIL1C_20210302T161201_N0209_R140_T17SMS_20210302T200521.SAFE/GRANULE/L1C_T17SMS_A029738_20210302T161751/QI_DATA/MSK_TECQUA_B03.gml','title':'GRANULE/L1C_T17SMS_A029738_20210302T161751/QI_DATA/MSK_TECQUA_B03.gml','roles':['metadata'],},}}Plugin DevelopmentFor instructions on how to develop a plugin forrgd_client, seePLUGINS.md.