Query Class

Constructor

Query([dataset, spatial_extent, date_range, …])

ICESat-2 Data object to query, obtain, and perform basic operations on available ICESat-2 datasets using temporal and spatial input parameters.

Attributes

Query.CMRparams

Display the CMR key:value pairs that will be submitted.

Query.cycles

Return the unique ICESat-2 orbital cycle.

Query.dataset

Return the short name dataset ID string associated with the query object.

Query.dataset_version

Return the dataset version of the data object.

Query.dates

Return an array showing the date range of the query object.

Query.end_time

Return the end time specified for the end date.

Query.file_vars

Return the file variables object.

Query.granules

Return the granules object, which provides the underlying funtionality for searching, ordering, and downloading granules for the specified dataset.

Query.orbit_number

Return the ICESat-2 CMR orbit number

Query.order_vars

Return the order variables object.

Query.reqparams

Display the required key:value pairs that will be submitted.

Query.spatial_extent

Return an array showing the spatial extent of the query object.

Query.subsetparams(**kwargs)

Display the subsetting key:value pairs that will be submitted.

Query.start_time

Return the start time specified for the start date.

Query.tracks

Return the unique ICESat-2 Reference Ground Tracks

Methods

Query.avail_granules([ids, cycles, tracks])

Obtain information about the available granules for the query object’s parameters.

Query.dataset_all_info()

Display all metadata about the dataset of interest (the collection).

Query.dataset_summary_info()

Display a summary of selected metadata for the specified version of the dataset of interest (the collection).

Query.download_granules(path[, verbose, …])

Downloads the data ordered using order_granules.

Query.earthdata_login(uid, email)

Log in to NSIDC EarthData to access data.

Query.latest_version()

Determine the most recent version available for the given dataset.

Query.order_granules([verbose, subset, email])

Place an order for the available granules for the query object.

Query.show_custom_options([dictview])

Display customization/subsetting options available for this dataset.

Query.visualize_spatial_extent()

Creates a map displaying the input spatial extent