io.ATL06

  • Reads ICESat-2 ATL06 Land Ice Elevation data files

Calling Sequence

from icesat2_toolkit.io import ATL06
IS2_atl06_mds,IS2_atl06_attrs,IS2_atl06_beams = ATL06.read_granule(FILENAME)

Source code

icesat2_toolkit.io.ATL06.read_granule(FILENAME, ATTRIBUTES=False, HISTOGRAM=False, QUALITY=False, KEEP=False, **kwargs)[source]

Reads ICESat-2 ATL06 (Land Ice Along-Track Height Product) data files

Parameters
FILENAME: str

full path to ATL06 file

ATTRIBUTES: bool, default False

read HDF5 attributes for groups and variables

HISTOGRAM: bool, default False

read ATL06 residual_histogram variables

QUALITY: bool, default False

read ATL06 segment_quality variables

KEEP: bool, default False

keep file object open

Returns
IS2_atl06_mds: dict

ATL06 variables

IS2_atl06_attrs:

ATL06 attributes

IS2_atl06_beams: list

valid ICESat-2 beams within ATL06 file

icesat2_toolkit.io.ATL06.find_beams(FILENAME, KEEP=False, **kwargs)[source]

Find valid beam groups within ICESat-2 ATL06 (Land Ice Along-Track Height Product) data files

Parameters
FILENAME: str

full path to ATL06 file

KEEP: bool, default False

keep file object open

Returns
IS2_atl06_beams: list

valid ICESat-2 beams within ATL06 file

icesat2_toolkit.io.ATL06.read_beam(FILENAME, gtx, ATTRIBUTES=False, KEEP=False, **kwargs)[source]

Reads ICESat-2 ATL06 (Land Ice Along-Track Height Product) data files for a specific beam

Parameters
FILENAME: str

full path to ATL06 file

gtx: str

beam name based on ground track and position

  • 'gt1l'

  • 'gt1r'

  • 'gt2l'

  • 'gt2r'

  • 'gt3l'

  • 'gt3r'

ATTRIBUTES: bool, default False

read HDF5 attributes for groups and variables

HISTOGRAM: bool, default False

read ATL06 residual_histogram variables

QUALITY: bool, default False

read ATL06 segment_quality variables

KEEP: bool, default False

keep file object open

Returns
IS2_atl06_mds: dict

ATL06 variables

IS2_atl06_attrs:

ATL06 attributes