icepyx.Quest

class icepyx.Quest(spatial_extent, date_range, start_time=None, end_time=None, proj='default')

QUEST - Query Unify Explore SpatioTemporal - object to query, obtain, and perform basic operations on datasets (i.e. Argo, BGC Argo, MODIS, etc) for combined analysis with ICESat-2 data products. A new dataset can be added using the dataset.py template. QUEST expands the icepyx GenQuery superclass.

See the doc page for GenQuery for details on temporal and spatial input parameters.

Parameters:: proj (proj4 string) – Geospatial projection. Not yet implemented
Return type:: quest object

Examples

Initializing Quest with a bounding box.

>>> reg_a_bbox = [-55, 68, -48, 71]
>>> reg_a_dates = ['2019-02-20','2019-02-28']
>>> reg_a = Quest(spatial_extent=reg_a_bbox, date_range=reg_a_dates)
>>> print(reg_a)
Extent type: bounding_box
Coordinates: [-55.0, 68.0, -48.0, 71.0]
Date range: (2019-02-20 00:00:00, 2019-02-28 23:59:59)
Data sets: None

Add datasets to the quest object.

>>> reg_a.datasets = {'ATL07':None, 'Argo':None}
>>> print(reg_a)
Extent type: bounding_box
Coordinates: [-55.0, 68.0, -48.0, 71.0]
Date range: (2019-02-20 00:00:00, 2019-02-28 23:59:59)
Data sets: ATL07, Argo

See also

GenQuery

__init__(spatial_extent, date_range, start_time=None, end_time=None, proj='default'): Tells QUEST to initialize data given the user input spatiotemporal data.

Methods

`__init__`(spatial_extent, date_range[, ...])	Tells QUEST to initialize data given the user input spatiotemporal data.
`add_argo`([params, presRange])	Adds Argo (including Argo-BGC) to QUEST structure.
`add_icesat2`(product[, start_time, end_time, ...])	Adds ICESat-2 datasets to QUEST structure.
`download_all`([path])	Downloads requested dataset(s).
`save_all`(path)	Saves all datasets according to their respective .save() functionality.
`search_all`(**kwargs)	Searches for required dataset within platform (i.e. ICESat-2, Argo) of interest.

Attributes

`dates`	Return an array showing the date range of the query object.
`end_time`	Return the end time specified for the end date.
`spatial`	Return the spatial object, which provides the underlying functionality for validating and formatting geospatial objects.
`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].
`start_time`	Return the start time specified for the start date.
`temporal`	Return the Temporal object containing date/time range information for the query object.