Results of a scene search

Returned by `M2MDataset$search()`. Holds the matching scenes and is the bridge to discovering downloadable products. Not created directly.

Public fields

scenes

A tibble of the matching scenes.

total_hits

The total number of scenes the API reported as matching, which exceeds `nrow(scenes)` when `max_results` was set.

Methods

Public methods

• M2MSceneSearch$new()

• M2MSceneSearch$dataset()

• M2MSceneSearch$filter()

• M2MSceneSearch$combine()

• M2MSceneSearch$products()

• M2MSceneSearch$print()

• M2MSceneSearch$clone()

---

M2MSceneSearch$new()

Wrap search results. Use `M2MDataset$search()` instead.

Usage

M2MSceneSearch$new(session, dataset, results, total_hits)

Arguments

session

The parent [M2MSession].

dataset

The [M2MDataset] that was searched.

results

A tibble of matching scenes.

total_hits

Total matches reported by the API.

---

M2MSceneSearch$dataset()

The dataset these scenes came from.

Usage

M2MSceneSearch$dataset()

Returns

An [M2MDataset] object.

---

M2MSceneSearch$filter()

Subset the scenes before requesting products, using `dplyr::filter()` semantics against the `scenes` tibble.

Usage

M2MSceneSearch$filter(...)

Arguments

...

Expressions passed to `dplyr::filter()`.

Returns

A new [M2MSceneSearch] with the subset applied.

---

M2MSceneSearch$combine()

Combine these scenes with those of other searches, so one `$products()` call and one download order covers all of them.

Scenes appearing in more than one search are kept once, so searches that overlap do not double-count. All the searches must be of the same dataset, since a set of products is discovered per dataset.

Usage

M2MSceneSearch$combine(...)

Arguments

...

Other [M2MSceneSearch] objects.

Returns

A new [M2MSceneSearch] holding every scene.

---

M2MSceneSearch$products()

Discover the products (bands and related files) available for these scenes. This registers a scene list server-side first, which the M2M API requires before download options can be listed.

Usage

M2MSceneSearch$products(band_group = TRUE)

Arguments

band_group

Whether to include secondary file groups, i.e. the individual bands. `TRUE` by default.

Returns

An [M2MDownloadOptions] object.

---

M2MSceneSearch$print()

Print a summary of the search results.

Usage

M2MSceneSearch$print(...)

Arguments

...

Ignored.

---

M2MSceneSearch$clone()

The objects of this class are cloneable with this method.

Usage

M2MSceneSearch$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.