Query Class

Constructors

GenQuery([spatial_extent, date_range, ...])

Base class for querying data.

Query([product, spatial_extent, date_range, ...])

Query and get ICESat-2 data

Attributes

Query.CMRparams

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

Query.cycles

Return the unique ICESat-2 orbital cycle.

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.granules

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

Query.order_vars

Return the order variables object.

Query.product

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

Query.product_version

Return the product version of the data object.

Query.reqparams

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

Query.spatial

Return the spatial object, which provides the underlying functionality for validating and formatting geospatial objects.

Query.spatial_extent

Return an array showing the spatial extent of the query object. Spatial extent is returned as an input type (which depends on how you initially entered your spatial data) followed by the geometry data. Bounding box data is [lower-left-longitude, lower-left-latitute, ... upper-right-longitude, upper-right-latitude]. Polygon data is [longitude1, latitude1, longitude2, latitude2, ... longitude_n,latitude_n, longitude1,latitude1].

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.temporal

Return the Temporal object containing date/time range information for the query object.

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.download_granules(path[, verbose, ...])

Downloads the data ordered using order_granules.

Query.earthdata_login([uid, email, s3token])

Authenticate with NASA Earthdata to enable data ordering and download.

Query.latest_version()

A reference function to is2ref.latest_version.

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

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

Query.product_all_info()

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

Query.product_summary_info()

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

Query.show_custom_options([dictview])

Display customization/subsetting options available for this product.

Query.visualize_spatial_extent()

Creates a map displaying the input spatial extent

Query.visualize_elevation()

Visualize elevation requested from OpenAltimetry API using datashader based on cycles https://holoviz.org/tutorial/Large_Data.html