io.ATL03

  • Reads ICESat-2 ATL03 Global Geolocated Photons

  • Interpolates ATL09 Atmospheric Characteristics to ATL03 segments

Calling Sequence

from icesat2_toolkit.io import ATL03
IS2_atl03_mds,IS2_atl03_attrs,IS2_atl03_beams = ATL03.read_granule(FILENAME)

Source code

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

Reads ICESat-2 ATL03 Global Geolocated Photons data files

Parameters
FILENAME: str

full path to ATL03 file

ATTRIBUTES: bool, default False

read file, group and variable attributes

KEEP: bool, default False

keep file object open

Returns
IS2_atl03_mds: dict

ATL03 variables

IS2_atl03_attrs: dict

ATL03 attributes

IS2_atl03_beams: list

valid ICESat-2 beams within ATL03 file

icesat2_toolkit.io.ATL03.interpolate_ATL09(FILENAME, pfl, dtime, ATTRIBUTES=True, KEEP=False, **kwargs)[source]

Reads ICESat-2 ATL09 Atmospheric Characteristics data files and interpolates a subset of variables to ATL03 segment lengths

Parameters
FILENAME: str

full path to ATL03 file

pfl: str

profile for a given beam

dtime: float

ATL03 reference photon delta_time

ATTRIBUTES: bool, default True

read file, group and variable attributes

KEEP: bool, default False

keep file object open

Returns
IS2_atl09_mds: dict

ATL09 variables remapped to ATL03 segments

IS2_atl09_attrs: dict

ATL09 attributes

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

Find valid beam groups within ICESat-2 ATL03 Global Geolocated Photons data files

Parameters
FILENAME: str

full path to ATL03 file

KEEP: bool, default False

keep file object open

Returns
IS2_atl03_beams: list

valid ICESat-2 beams within ATL03 file

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

Reads ICESat-2 ATL03 Global Geolocated Photons data files for only the main-level variables and not the beam-level data

Parameters
FILENAME: str

full path to ATL03 file

ATTRIBUTES: bool, default False

read file, group and variable attributes

KEEP: bool, default False

keep file object open

Returns
IS2_atl03_mds: dict

ATL03 main-level variables

IS2_atl03_attrs: dict

ATL03 main-level attributes

IS2_atl03_beams: list

valid ICESat-2 beams within ATL03 file

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

Reads ICESat-2 ATL03 Global Geolocated Photons data files for a specific beam

Parameters
FILENAME: str

full path to ATL03 file

gtx: str

beam name based on ground track and position

  • 'gt1l'

  • 'gt1r'

  • 'gt2l'

  • 'gt2r'

  • 'gt3l'

  • 'gt3r'

ATTRIBUTES: bool, default False

read file, group and variable attributes

KEEP: bool, default False

keep file object open

Returns
IS2_atl03_mds: dict

ATL03 beam-level variables

IS2_atl03_attrs: dict

ATL03 beam-level attributes