icepyx.Variables.append

Variables.append(defaults=False, var_list=None, beam_list=None, keyword_list=None)

Add to the list of desired variables using user specified beams and variable list. A pregenerated default variable list can be used by setting defaults to True. Note: The calibrated backscatter cab_prof is not in the default list for ATL09

Parameters:

defaultsboolean, default False

Include the variables in the default variable list. Defaults are defined per-data product. When specified in conjuction with a var_list, default variables not on the user- specified list will be added to the order.

var_listlist of strings, default None

A list of variables to request, if not all available variables are wanted. A list of available variables can be obtained by entering var_list=[‘’] into the function.

beam_listlist of strings, default None

A list of beam strings, if only selected beams are wanted (the default value of None will automatically include all beams). For ATL09, acceptable values are [‘profile_1’, ‘profile_2’, ‘profile_3’]. For ATL11, acceptable values are [‘pt1’,’pt2’,’pt3’]. For all other products, acceptable values are [‘gt1l’, ‘gt1r’, ‘gt2l’, ‘gt2r’, ‘gt3l’, ‘gt3r’].

keyword_listlist of strings, default None

A list of subdirectory names (keywords), from any heirarchy level within the data structure, to select variables within the product that include that keyword in their path. A list of availble keywords can be obtained by entering keyword_list=[‘’] into the function.

Notes

See also the IS2_data_access2-subsetting example notebook

Examples

>>> reg_a = ipx.Query('ATL06',[-55, 68, -48, 71],['2019-02-20','2019-02-28']) 

To add all variables related to a specific ICESat-2 beam

>>> reg_a.order_vars.append(beam_list=['gt1r']) 

To include the default variables:

>>> reg_a.order_vars.append(defaults=True) 

To add specific variables in orbit_info

>>> reg_a.order_vars.append(keyword_list=['orbit_info'],var_list=['sc_orient_time']) 

To add all variables and paths in ancillary_data

>>> reg_a.order_vars.append(keyword_list=['ancillary_data'])