Skip to content

Plugin

When you open the Kan Imagery Catalog plugin, it will appear on the right side of the QGIS screen with the following sections:

Plugin Window

  • Configuration
  • Search Area
  • Catalog Selection
  • Filters
  • Listing

Configuration

To use the Kan Imagery Catalog plugin, the first thing to do is to configure the credentials that will be used to connect to different image providers.

Credentials UP42

At this point, we will proceed with configuring the credentials for UP42. To proceed, you need a username and password on the provider's platform. To sign up, you can visit https://console.up42.com/log-in.

Once you have enabled your user and loaded the first project, you can access the information required by the plugin to use it.

Plugin Window

The plugin requests the following information to connect to the provider:

  • Username
  • Password

Note

You can find this information on the UP42 portal > Projects > Developers.

After loading the necessary data, you can verify the credentials.

Plugin Window

If they are valid, you will see the message "Credentials are valid."

Credentials Sentinel Hub

At this point, we will proceed with configuring the credentials for Sentinel Hub. To proceed, you need a username and password on the provider's platform. To sign up, you can visit sentinel-hub account settings.

Once you have enabled your user, you need to register an OAuth Client in your account settings to access the information required by the plugin to use it.

Plugin Window

The plugin requests the following information to connect to the provider:

  • Client ID
  • Client secret

Tip

Follow sentinel-hub documentation.

After loading the necessary data, you can verify the credentials.

Plugin Window

If they are valid, you will see the message "Credentials are valid."

Credentials Microsoft

Microsoft Planetary Computer Data Catalog is freely accessible therefore is already incorporated in the plugin and credentials are not necessary.

Credentials Planet

Coming next

General Parameters

In addition to loading credentials, the user can set the following parameters:

  • Number of Query Days
  • Default Maximum Cloud Cover: Can vary between 0 and 100%.
  • Maximum Number of Catalogs
  • Maximum Number of Objects per Catalog

Plugin Window

Once the general parameters are set, apply the changes by clicking OK.

Search Area

With the search area, the user can define the bounding box where the plugin will search for image availability.

You can use the extent of what is currently visible in QGIS by selecting "Use visible area on screen," or choose a polygon geometry layer being used in the current QGIS project.

If the "Use visible area on screen" option is selected, the plugin will recognize the visible area in the canvas as the search area.

Plugin Window

To use the area of a vector layer, it must be loaded in the project. The user should deselect "Use visible area on screen," which will display a list of available layers.

Plugin Window

Tip

When using a vector layer as the search area, EPSG 4326 is recommended.

Note

In the case of multipolygon vector layers, if a spatial object is selected, the plugin will recognize it as the search area. Otherwise, the plugin will randomly select a spatial object from the layer to define the search area.

Catalog Selection

In this section, the user can select the catalogs and collections they want to query.

Plugin Window

In the search by name or description field, the user can filter by the value they enter. If left blank and filtered, all catalogs from the provider(s) being queried will be listed. For example, if you enter "Sentinel" in the search field and filter:

Plugin Window

By selecting the catalog in the first window and clicking "Add Selected," the collections will move to the second window. To proceed with these preferences, click "OK."

![Plugin Window](./image/up42_accept_search.png)

Remove Catalogs and Collections

If the user wants to exclude the collections they had previously set, they should reopen the Catalog Selection window, select the "Selected Collections," and remove them before clicking OK to save the changes.

Plugin Window

Filters

Before searching for collections, you can set various supplementary search criteria:

  • Start Date
  • End Date
  • Cloud Cover
  • Record Limit

Plugin Window

Start Date and End Date

In this case, you can specify the range of dates the plugin will use to search for images. By default, the plugin searches for images from 7 (seven) days before the query date.

Plugin Window

Cloud Cover

You can determine the maximum percentage of cloud cover the filtered collections should have.

Record Limit

You can set a maximum limit on the number of records for the collections you search for. The plugin is configured with a maximum of 10 records by default, but the user can modify it as desired.

Search and Listing

Once you have defined the search area, catalogs, collections, and filters, you can proceed with the search.

Plugin Window

The search results will display a maximum of 10 (ten) records, as set in the Filters.

Plugin Window

The results can be sorted in ascending or descending order based on the acquisition date.

If you have selected to use a polygon as search area, before beginning the search you should have selected the feature beforehand.

Plugin Window

Results Functions

You will find three functions:

  • Information
  • Quick View
  • Download

Information

The "i" icon refers to the general information of the selected collection.

Plugin Window

A window with additional information will open.

Plugin Window

Quick View

Using the eye icon button, the user can quickly view the selected image. The quick view includes a footprint (image coverage) and a raster preview.

Plugin Window

Plugin Window

Download

Using the download button, it sends you directly to the providers catalog in order to download the selected image.

Plugin Window