icepyx.Variables.remove

Variables.remove(all=False, var_list=None, beam_list=None, keyword_list=None)

Remove the variables and paths from the wanted list using user specified beam, keyword,

and variable lists.

Parameters:

allboolean, default False

Remove all variables and paths from the wanted list.

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.

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 clear the list of wanted variables

>>> reg_a.order_vars.remove(all=True) 

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

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

To remove specific variables in orbit_info

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

To remove all variables and paths in ancillary_data

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