Stream Order Module¶

File: computing/misc/stream_order.py

Overview¶

This module generates stream order raster and vector layers by clipping pan-India stream order data to specific regions. It produces both raster outputs and vector summaries with area percentages by stream order class.

Purpose¶

Processes stream network data for: - Hydrological analysis - Drainage network characterization - Watershed delineation - Distributes to GEE, GeoServer, and database

Architecture¶

flowchart TD
    A[Celery Task Triggered] --> B[ee_initialize]
    B --> C{Has state/district/block?}
    C -->|Yes| D[Build Standard ROI]
    C -->|No| E[Use Custom Project ROI]
    D --> F[Load MWS FeatureCollection]
    E --> G[Load Custom FeatureCollection]
    F --> H[Load Pan-India Stream Order Raster]
    G --> H
    H --> I[Clip to ROI]
    I --> J[stream_order_raster_generation]
    J --> K[Export Raster to GEE]
    K --> L[Sync to GCS]
    L --> M[Sync to GeoServer]
    M --> N[calculate_pixel_area_percentage]
    N --> O[stream_order_vector_generation]
    O --> P[Export Vector to GEE]
    P --> Q[sync_layer_to_geoserver]
    Q --> R[Return True]

Components¶

Main Task: generate_stream_order()¶

Location: Line 28

Parameters: | Parameter | Type | Description | |-----------|------|-------------| | state | str, optional | State name | | district | str, optional | District name | | block | str, optional | Block/tehsil name | | gee_account_id | int, optional | GEE account identifier | | proj_id | int, optional | Project ID for custom projects | | roi_path | str, optional | Custom ROI asset path | | asset_suffix | str, optional | Custom asset suffix | | asset_folder | list, optional | Custom asset folder | | app_type | str | Application type (default: "MWS") |

Returns: bool - Whether layer was successfully synced to GeoServer

Helper Functions¶

stream_order_raster_generation()¶

Location: Line 124

Handles raster export and synchronization.

stream_order_vector_generation()¶

Location: Line 185

Handles vector export and GeoServer sync.

calculate_pixel_area_percentage()¶

Location: Line 283

Calculates percentage area by stream order class for each MWS.

Processing Logic¶

1. Data Source¶

stream_order_raster = ee.Image(PAN_INDIA_SO)  # From constants.pan_india_path

2. Stream Order Classes¶

3. Area Calculation¶

For each stream order class:

flowchart LR
    A[Stream Order Raster] --> B[Create Class Mask]
    B --> C[Pixel Area Image]
    C --> D[reduceRegions]
    D --> E[Sum Area per MWS]
    E --> F[Calculate Percentage]

Processing:

for arg in class_labels:
    raster_band = raster.select(["b1"])
    mask = raster_band.eq(ee.Number(arg["value"]))
    class_area = pixel_area.updateMask(mask)

    fc_with_total = class_area.reduceRegions(
        collection=fc_with_total,
        reducer=ee.Reducer.sum(),
        scale=30,
        crs=raster.projection()
    )

    # Calculate percentage
    percentage = class_area_sum.divide(total_area).multiply(100)

Integration Points¶

computing/misc/stream_order.py
├── computing.utils
│   ├── save_layer_info_to_db()   # Database persistence
│   ├── update_layer_sync_status() # Status tracking
│   └── sync_layer_to_geoserver() # GeoServer sync
├── utilities.gee_utils
│   ├── ee_initialize()           # GEE authentication
│   ├── check_task_status()       # Task monitoring
│   ├── valid_gee_text()          # Text sanitization
│   ├── get_gee_asset_path()      # Asset path generation
│   ├── is_gee_asset_exists()     # Asset existence check
│   ├── sync_raster_to_gcs()      # GCS synchronization
│   ├── sync_raster_gcs_to_geoserver() # GeoServer sync
│   ├── export_raster_asset_to_gee() # Raster export
│   ├── make_asset_public()       # ACL management
│   ├── get_gee_dir_path()        # Directory path generation
│   └── export_vector_asset_to_gee() # Vector export
├── utilities.constants
│   └── GEE_PATHS                 # GEE path configurations
├── constants.pan_india_path
│   └── PAN_INDIA_SO              # Pan-India stream order path
└── projects.models
    └── Project                    # Project model for custom projects

Output¶

Raster Output¶

Dataset Name: Stream Order

Vector Output¶

Feature Properties¶

Each MWS feature contains:

{
  "uid": "unique_mws_id",
  "1": 12.5,
  "2": 18.3,
  "3": 25.7,
  "4": 15.2,
  "5": 10.8,
  "6": 8.4,
  "7": 5.2,
  "8": 2.8,
  "9": 1.1,
  "10": 0.0,
  "11": 0.0
}

All values are percentages of MWS area.

Usage¶

Standard Administrative Boundary¶

from computing.misc.stream_order import generate_stream_order

result = generate_stream_order.delay(
    state="Rajasthan",
    district="Jaipur",
    block="Sanganer",
    gee_account_id=1
)

Custom Project¶

result = generate_stream_order.delay(
    proj_id=123,
    roi_path="projects/earthengine-legacy/assets/projects/custom/roi",
    asset_suffix="project_123",
    asset_folder=["CustomProject"],
    app_type="WATERBODY",
    gee_account_id=1
)

Pattern Classification¶

This module follows the Raster-to-Vector Pattern:

flowchart TD
    subgraph Pattern
        A[Load Raster] --> B[Clip to ROI]
        B --> C[Export Raster]
        C --> D[Sync Raster to GeoServer]
        D --> E[Calculate Class Areas]
        E --> F[Export Vector]
        F --> G[Sync Vector to GeoServer]
    end

This pattern is shared with: - restoration_opportunity.py

Dependencies¶

• ee (Google Earth Engine Python API)
• Celery - Distributed task queue
• projects.models.Project - For custom project support