io.ATL10

  • Reads ICESat-2 ATL10 Sea Ice Freeboard data files

Calling Sequence

from icesat2_toolkit.io import ATL10
IS2_atl10_mds,IS2_atl10_attrs,IS2_atl10_beams = ATL10.read_granule(FILENAME)

Source code

icesat2_toolkit.io.ATL10.read_granule(FILENAME, ATTRIBUTES=False, **kwargs)[source]

Reads ICESat-2 ATL10 (Sea Ice Freeboard) data files

Parameters
FILENAME: str

full path to ATL10 file

ATTRIBUTES: bool, default False

read HDF5 attributes for groups and variables

Returns
IS2_atl10_mds: dict

ATL10 variables

IS2_atl10_attrs:

ATL10 attributes

IS2_atl10_beams: list

valid ICESat-2 beams within ATL10 file

icesat2_toolkit.io.ATL10.find_beams(FILENAME, **kwargs)[source]

Find valid beam groups within ICESat-2 ATL10 (Sea Ice Freeboard) data files

Parameters
FILENAME: str

full path to ATL10 file

Returns
IS2_atl10_beams: list

valid ICESat-2 beams within ATL10 file

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

Reads ICESat-2 ATL10 (Sea Ice Freeboard) data files for a specific beam

Parameters
FILENAME: str

full path to ATL10 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

Returns
IS2_atl10_mds: dict

ATL10 variables

IS2_atl10_attrs:

ATL10 attributes