ipxapi

The icepyx Python API ipxapi.py is used to access the services provided by the sliderule-icesat2 plugin for SlideRule using the icepyx library. It mirrors functions provided in the icesat2.py module, and provides a simplified interface that accepts icepyx Query objects (regions).

The module can be imported via:

from sliderule import ipxapi

For more information about icepyx, go to icepyx GitHub or icepyx ReadTheDocs.

---

atl06p

sliderule.ipxapi.atl06p(ipx_region, parm)

Performs ATL06-SR processing in parallel on ATL03 data and returns geolocated elevations. The list of granules to be processed is identified by the ipx_region object.

See the atl06p function for more details.

Parameters:

• ipx_region (Query) – icepyx region object defining the query of granules to be processed

• parm (dict) – parameters used to configure ATL06-SR algorithm processing (see Parameters)

Returns:

geolocated elevations (see Elevations)

Return type:

GeoDataFrame

---

atl03sp

sliderule.ipxapi.atl03sp(ipx_region, parm)

Performs ATL03 subsetting in parallel on ATL03 data and returns photon segment data.

See the atl03sp function for more details.

Parameters:

• ipx_region (Query) – icepyx region object defining the query of granules to be processed

• parm (dict) –

  parameters used to configure ATL03 subsetting (see Parameters)

Returns:

ATL03 segments (see Photon Segments)

Return type:

list

to_region

sliderule.ipxapi.to_region(ipx_region)

Extract subsetting extents from an icepyx region

Parameters:

ipx_region (Query) – icepyx region object defining the query of granules to be processed

Returns:

polygon defining region of interest (can be passed into icesat2 api functions)

Return type:

list