Skip to content

Water Stress

Introduction

The Water Stress service is a tool that allows growers to assess the health and vigor of their crops. This service makes use of a common vegetation index, the Normalized Difference Water Index, or NDWI. When crops are well-hydrated and have enough water, NDWI tends to be higher. If the NDWI value drops, it might mean that the plants are stressed because they're not getting enough water. This could be due to things like drought or problems with irrigation.

NOTE:   The processWaterStress() mutation and retrieveWaterStress() query are only shortcuts to the processVegetationIndices() mutation and retrieveVegetationIndices() query. The Water Stress service endpoints call the VegetationIndices service endpoints with an indexType of NDWI.

image

Processing Water Stress Images

You can use the processWaterStress() mutation to process the water stress images. The endpoint can also be used for processing daily water stress estimates, for more information on daily estimation images, please refer to our documentation.

Usage

The processWaterStress() mutation is used to process water stress images based on the satellite data. The endpoint requires three arguments:

  • polygonId*: The polygonId is the unique ID generated when you register/create a polygon in the API. You use this unique identifier to specify the plot you want to analyse.
  • startDate*: This date specifies the start of the date range that you want to process.
  • endDate*: This date specifies the end of the date range that you want to process.
  • dailyEstimates: This optional parameter specificies if the daily estimates should be processed, or if the regular images based on the satellite imagery should be processed. For daily estimation images, it should be set to true.

The endpoint only returns the status of the request itself, with the requestId. The request can be tracked using the requestId using the retrieveRequestDetails() endpoint. For more information on monitoring requests, please refer to our monitoring documentation.

Example

mutation {
  processWaterStress(
    polygonId:         "PolygonId"
    startDate:         "2024-01-01"
    endDate:           "2024-05-01"
    dailyEstimates:    false
  )
  {
    IsSuccess
    Message
    Status
    Result {
      requestId
    }
  }
}

Retrieving Water Stress Images

You can use the retrieveWaterStress() mutation to retrieve the water stress images. The endpoint can also be used for retrieving daily water stress estimates, for more information on daily estimation images, please refer to our documentation.

Usage

The retrieveWaterStress() query is used to retrieve processed water stress images based on the satellite data. The endpoint requires three arguments:

  • polygonId*: The polygonId is the unique ID generated when you register/create a polygon in the API. You use this unique identifier to specify the plot you want to analyse.
  • startDate*: This date specifies the start of the date range that you want to retrieve.
  • endDate*: This date specifies the end of the date range that you want to retrieve.
  • dailyEstimates: This optional parameter specificies if the daily estimates should be retrieved, or if the regular images based on the satellite imagery should be retrieved. For daily estimation images, it should be set to true.

Example

mutation {
  retrieveWaterStress(
    polygonId:         "PolygonId"
    startDate:         "2024-01-01"
    endDate:           "2024-05-01"
    dailyEstimates:    false
  )
  {
    IsSuccess
    Message
    Status
    Result {
      colorlegend
      tif
      png
      json
    }
  }
}

Please refer to the Schema Documentation in the API Playground for more information.