icepyx.Query.avail_granules

Query.avail_granules(ids=False, cycles=False, tracks=False, cloud=False)

Obtain information about the available granules for the query object’s parameters. By default, a complete list of available granules is obtained and stored in the object, but only summary information is returned. Lists of granule IDs, cycles and RGTs can be obtained using the boolean triggers.

Parameters:

idsboolean, default False

Indicates whether the function should return a list of granule IDs.

cyclesboolean, default False

Indicates whether the function should return a list of orbital cycles.

tracksboolean, default False

Indicates whether the function should return a list of RGTs.

cloudboolean, default False

Indicates whether the function should return data available in the cloud. Note: except in rare cases while data is in the process of being appended to, data available in the cloud and for download via on-premesis will be identical.

Examples

>>> reg_a = ipx.Query('ATL06',[-55, 68, -48, 71],['2019-02-20','2019-02-28'])
>>> reg_a.avail_granules()
{'Number of available granules': 4,
'Average size of granules (MB)': 55.166646003723145,
'Total size of all granules (MB)': 220.66658401489258}

>>> reg_a = ipx.Query('ATL06',[-55, 68, -48, 71],['2019-02-20','2019-02-23'])
>>> reg_a.avail_granules(ids=True)
[['ATL06_20190221121851_08410203_006_01.h5', 'ATL06_20190222010344_08490205_006_01.h5']]
>>> reg_a.avail_granules(cycles=True)
[['02', '02']]
>>> reg_a.avail_granules(tracks=True)
[['0841', '0849']]