io.ATL12

  • Reads ICESat-2 ATL12 Ocean Surface Height data files

from icesat2_toolkit.io import ATL12
IS2_atl12_mds,IS2_atl12_attrs,IS2_atl12_beams = ATL12.read_granule(FILENAME)

Source code

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

Reads ICESat-2 ATL12 (Ocean Surface Height) data files

Parameters
FILENAME: str

full path to ATL12 file

ATTRIBUTES: bool, default False

read HDF5 attributes for groups and variables

KEEP: bool, default False

keep file object open

Returns
IS2_atl12_mds: dict

ATL12 variables

IS2_atl12_attrs: dict

TL12 attributes

IS2_atl12_beams: list

valid ICESat-2 beams within ATL12 file

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

Find valid beam groups within ICESat-2 ATL12 (Ocean Surface Height) data files

Parameters
FILENAME: str

full path to ATL12 file

KEEP: bool, default False

keep file object open

Returns
IS2_atl12_beams: list

valid ICESat-2 beams within ATL12 file

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

Reads ICESat-2 ATL12 (Ocean Surface Height) data files for a specific beam

Parameters
FILENAME: str

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

KEEP: bool, default False

keep file object open

Returns
IS2_atl12_mds: dict

ATL12 variables

IS2_atl12_attrs:

ATL12 attributes