drb-image 1.0.0

DRB Image Extractor

DRB Image Extractor

It's an applicative part using DRB allowing to extract image from data according its topic.

Metadata

Packaging

The package python containing an addon image of a DRB topic must have the following instruction:

• a drb.image entry point whose its value is the targeted Python package containing the cortex.yaml file

How to define an addon image ?

Addon Image are defined in a cortex.yaml file following the template:

topic: <topic_uuid>                        # target topic
image:
  <name>:                              # Variable name
     source:
      - <extractor>: <extractor_content>       # An extractor
---
topic: <topic_uuid>                        # target topic
default: <name>                            # Default nome to extract
image:
  <name>:                                  # Variable name
    freq: [270, 300]                       # Frequency of the image
    source:
      - <extractor>: <extractor_content>       # An extractor
  <name_2>:                                # Variable name
    freq: [310, 405]                       # Frequency of the image
    source:
      - <extractor>: <extractor_content>       # An extractor
---
topic: <topic_uuid>
image:  
  <name>:                                  # Variable name
    source:
      - <extractor>: <extractor_content> # An extractor
        resolution: <resolution>         # Add a resolution value
      - <extractor>: <extractor_content> # An extractor
        resolution: <resolution>         # Add a resolution value
        <another_otion> : ...            # Add another option

How to extract an image ?

For the following addon description.

topic: b0dad6fa-9ae4-4694-b00b-449cd456d32a # Sentinel-1A Interferometric Wide Swath Level 1 S Product
default: thumbnail
image:  
  QuickLook:                                  
    source:
      - xquery: /preview/quick-look.png
        resolution: 10m         
      - script: sentinel1.image_addon:my_method 
        resolution: 20m
  thumbnail:
    source:
      - xquery: /thumbnail.png

The different image node can be extract with this:

from drb.image import AddonImage
import drb.topics.resolver as resolver


if __name__ == '__main__':
    node = resolver.create('S1A_IW_RAW__0SDH_20220201T101715_20220201T101734_041718_04F6C6_A26E.SAFE')
    
    # Retrieve the addon image corresponding to the product
    extract = AddonImage.create(node)
    
    # Retrieve the drb-driver-image node corresponding to the addon using the default extraction, here thumbnail
    base_node = extract.node(node) 

    # Retrieve the drb-driver-image node corresponding to the image name and by default the first resolution
    base_node = extract.node(node=node, image_name='QuickLook') 

    # Retrieve the drb-driver-image node corresponding to the image_name and resolution given in argument
    base_node = extract.node(node=node, image_name='QuickLook', resolution='10m')
    
    # This will raise an DrbException because it can't find any image addon
    base_node = extract.node(node=node, image_name='Not_existing_image')

Extractor

All the information about extractor can be found here