Planet Data Reader Parameters

The API key to access the Planet Data API.

Specify the Item Type to search within. Item Types typically have names that specify the satellite provider and imagery product.

For instance, REOrthoTile is for orthorectified tiles from RapidEye satellites, and PSScene3Band is for 3-band scene imagery from PlanetScope satellites.

Specify one or more Asset types to download. You must select an Item Type before available Asset types will be listed.

Assets correspond to feature types. Typical options include:

• visual: RGB rasters appropriate for visualization purposes.
• analytic: Rasters that include bands containing non-RGB sensor data.
• udm: Unusable data mask.
• thumbnails: This does not correspond to a true Asset type in the Planet Data API. Rather, it corresponds to the visual preview image available for each Item, which can be downloaded quickly and without an activation process.

Refer to Planet’s product specifications for information on how to interpret the bands available in different products and Asset types.

Note: The Planet Data Reader currently does not support all Asset types. Only supported ones are shown.

The oldest imagery acquisition date to include, in UTC. Optional.

Corresponds to a DateRangeFilter in the Item search.

The newest imagery acquisition date to include, in UTC. Optional.

Corresponds to a DateRangeFilter in the Item search.

Use this parameter to specify custom search filter criteria. The value of this parameter, if specified, must be valid JSON and follow the search filter structure defined at https://www.planet.com/docs/reference/data-api/search-api/#search-filters.

Custom filter criteria are included with the Start Date, End Date, and other criteria defined by the Planet Data Reader.

For instance, to specify a filter for minimum usable data, include this JSON:

{
   "type": "RangeFilter",
   "field_name": "usable_data",
   "config": {
      "gte": 0.9
   }
}

To specify multiple filters, put them all into a JSON array.

If set to Yes, then each feature will have a value for the planetdata_metadata_json attribute. The attribute contains the JSON definition for the Item that corresponds to the feature.

Enable this option to get access to properties that aren’t made available as a format attribute. FME’s JSON transformers can be used to parse the metadata attribute and extract values.

Default: No

Use this parameter to expose Format Attributes in Workbench when you create a workspace:

• In a dynamic scenario, it means these attributes can be passed to the output dataset at runtime.
• In a non-dynamic scenario where you have multiple feature types, it is convenient to expose additional attributes using this one parameter. For example, if you have ten feature types and want to expose the same attribute in each one, it is easier to define it once than it is to set each feature type individually in the workspace.

Using the minimum and maximum latitude and longitude parameters, define a bounding box that will be used to filter the input features. Only features that intersect with the bounding box are returned.

If all four coordinates of the search envelope are specified as 0, the search envelope will be disabled.

Coordinates must be in LL84. These parameters correspond to a GeometryFilter in the Planet Data API.