Enhance Your Applications with the wzesk/littoral_refine Cognitive Actions

24 Apr 2025
Enhance Your Applications with the wzesk/littoral_refine Cognitive Actions

In the realm of image processing, accurately refining and enhancing satellite-derived shorelines is crucial for geographical analysis and environmental monitoring. The wzesk/littoral_refine API provides a robust set of Cognitive Actions tailored to improve shoreline delineation through advanced image processing techniques. By leveraging these pre-built actions, developers can save time and resources while achieving high-quality results in their applications.

Prerequisites

To utilize the Cognitive Actions from the wzesk/littoral_refine API, you will need an API key to authenticate your requests. Conceptually, this involves passing the API key in the headers of your HTTP requests. Ensure you have access to the necessary image and mask files, which should be hosted at publicly accessible URIs.

Cognitive Actions Overview

Enhance Satellite Shorelines

The Enhance Satellite Shorelines action is designed to refine and enhance satellite-derived shorelines by improving boundary precision. This action takes an image and a corresponding mask as inputs and allows for boundary smoothing and simplification options.

Input: The required and optional fields for this action are defined in the following schema:

{
  "imagePath": "https://example.com/image.png",
  "maskFilePath": "https://example.com/mask.png",
  "smoothing": 2,
  "simplification": 0.5
}
  • imagePath (required): A URI pointing to the input image for shoreline refinement. This image must be publicly accessible.
  • maskFilePath (required): A URI pointing to the input mask image file, also publicly accessible.
  • smoothing (optional): A numeric factor ranging from 0 to 10 that controls the level of boundary smoothing. The default value is 2.
  • simplification (optional): A numeric factor ranging from 0 to 10 that dictates the level of boundary simplification. The default value is 0.5.

Example Input:

{
  "imagePath": "https://raw.github.com/Wzesk/littoral_refine/2b77e90e1701e9da1ecf9142724ac1007848e9d1/sample/20241211T052119_20241211T052515_T43NCE_sr.png",
  "maskFilePath": "https://raw.github.com/Wzesk/littoral_refine/2b77e90e1701e9da1ecf9142724ac1007848e9d1/sample/20241211T052119_20241211T052515_T43NCE_mask.png",
  "smoothing": 2,
  "simplification": 0.5
}

Output: The action returns a URI pointing to the enhanced shoreline image. For example:

https://assets.cognitiveactions.com/invocations/8ab80a85-a568-4c62-85c4-f56aa9ff0be8/b7922259-8be6-439e-8f4e-74d598102561.png

Conceptual Usage Example (Python): Here’s a conceptual Python code snippet demonstrating how to invoke the Enhance Satellite Shorelines action:

import requests
import json

# Replace with your Cognitive Actions API key and endpoint
COGNITIVE_ACTIONS_API_KEY = "YOUR_COGNITIVE_ACTIONS_API_KEY"
COGNITIVE_ACTIONS_EXECUTE_URL = "https://api.cognitiveactions.com/actions/execute" # Hypothetical endpoint

action_id = "0a2940e7-4a2f-4e46-9a3e-b72a9c9c4254" # Action ID for Enhance Satellite Shorelines

# Construct the input payload based on the action's requirements
payload = {
    "imagePath": "https://raw.github.com/Wzesk/littoral_refine/2b77e90e1701e9da1ecf9142724ac1007848e9d1/sample/20241211T052119_20241211T052515_T43NCE_sr.png",
    "maskFilePath": "https://raw.github.com/Wzesk/littoral_refine/2b77e90e1701e9da1ecf9142724ac1007848e9d1/sample/20241211T052119_20241211T052515_T43NCE_mask.png",
    "smoothing": 2,
    "simplification": 0.5
}

headers = {
    "Authorization": f"Bearer {COGNITIVE_ACTIONS_API_KEY}",
    "Content-Type": "application/json"
}

try:
    response = requests.post(
        COGNITIVE_ACTIONS_EXECUTE_URL,
        headers=headers,
        json={"action_id": action_id, "inputs": payload} # Hypothetical structure
    )
    response.raise_for_status() # Raise an exception for bad status codes (4xx or 5xx)

    result = response.json()
    print("Action executed successfully:")
    print(json.dumps(result, indent=2))

except requests.exceptions.RequestException as e:
    print(f"Error executing action {action_id}: {e}")
    if e.response is not None:
        print(f"Response status: {e.response.status_code}")
        try:
            print(f"Response body: {e.response.json()}")
        except json.JSONDecodeError:
            print(f"Response body: {e.response.text}")

In this code, you'll need to replace YOUR_COGNITIVE_ACTIONS_API_KEY with your actual API key. The payload variable is constructed according to the schema requirements for the action.

Conclusion

The wzesk/littoral_refine Cognitive Actions provide powerful tools for developers looking to enhance shoreline delineation in their applications. With capabilities for image refinement and the ease of integrating these actions into existing workflows, developers can significantly streamline their processes. Explore the potential of these actions and consider how they might fit into your next project!

← Back to All Articles