io.ATL11
Reads ICESat-2 ATL11 Annual Land Ice Height data files
from icesat2_toolkit.io import ATL11
IS2_atl11_mds,IS2_atl11_attrs,IS2_atl11_pairs = ATL11.read_granule(FILENAME,
GROUPS=['cycle_stats','crossing_track_data'], VERBOSE=True)
- icesat2_toolkit.io.ATL11.read_granule(FILENAME, GROUPS=['cycle_stats'], ATTRIBUTES=False, REFERENCE=False, CROSSOVERS=False, SUBSETTING=False, KEEP=False, **kwargs)[source]
Reads ICESat-2 ATL11 (Annual Land Ice Height) data files
- Parameters
- FILENAME: str
full path to ATL11 file
- GROUPS: list, default [‘cycle_stats’]
HDF5 groups to read for each beam pair
- ATTRIBUTES: bool, default False
read HDF5 attributes for groups and variables
- REFERENCE: bool, default False
read ATL11 reference surface variables
- CROSSOVERS: bool, default False
read ATL11 crossover height variables
- SUBSETTING: bool, default False
read ATL11 subsetting variables
- KEEP: bool, default False
keep file object open
- Returns
- IS2_atl11_mds:
ATL11 variables
- IS2_atl11_attrs:
ATL11 attributes
- IS2_atl11_pairs: list
valid ICESat-2 beam pairs within ATL11 file
- icesat2_toolkit.io.ATL11.find_pairs(FILENAME, KEEP=False, **kwargs)[source]
Find valid beam pair groups within ICESat-2 ATL11 (Annual Land Ice Height) data files
- Parameters
- FILENAME: str
full path to ATL11 file
- KEEP: bool, default False
keep file object open
- Returns
- IS2_atl11_pairs: list
valid ICESat-2 beam pairs within ATL11 file
- icesat2_toolkit.io.ATL11.read_pair(FILENAME, ptx, GROUPS=['cycle_stats'], ATTRIBUTES=False, REFERENCE=False, CROSSOVERS=False, SUBSETTING=False, KEEP=False, **kwargs)[source]
Reads ICESat-2 ATL11 (Annual Land Ice Height) data files for a specific beam pair
- Parameters
- FILENAME: str
full path to ATL11 file
- ptx: str
beam pair name
'pt1'
'pt2'
'pt3'
- GROUPS: list, default [‘cycle_stats’]
HDF5 groups to read for each beam pair
- ATTRIBUTES: bool, default False
read HDF5 attributes for groups and variables
- REFERENCE: bool, default False
read ATL11 reference surface variables
- CROSSOVERS: bool, default False
read ATL11 crossover height variables
- SUBSETTING: bool, default False
read ATL11 subsetting variables
- KEEP: bool, default False
keep file object open
- Returns
- IS2_atl11_mds: dict
ATL11 variables
- IS2_atl11_attrs: dict
ATL11 attributes