Developer Reference Manual#

Release:

0.6.0

Date:

Sep 16, 2026

This is the developer reference guide for AIDAS which covers most of the available functions, modules, and classes.

io Module#

Module containing functions to load and preprocess radar data for inference.

aidas.io (aidas.io)#

This module handles the preprocessing of radar data.

RadarImage()

This class contains the basic data for predicting the lake-breeze front location from radar.

preprocess_radar_image(radar[, rad_time, ...])

This module will preprocess the NEXRAD radar data for inference into the lake-breeze prediction model of AIDAS.

preprocess_radar_image_batch(file[, ...])

This module will preprocess the NEXRAD radar data for inference into the lake-breeze prediction model of AIDAS.

get_previous_scan(radar[, rad_time, bucket_name])

Fetch the volume collected immediately before a given scan.

model Module#

Main module for inference.

aidas.model (aidas.model)#

This module handles the detection of mesoscale features in radar data: the lake breeze, inferred with a fine-tuned ResNet50, and radial velocity wave signatures, detected by differencing consecutive scans.

infer_lake_breeze(radar_scan[, model_name, ...])

This module will infer the location of the lake breeze from a radar image.

infer_lake_breeze_batch(radar_list[, ...])

This module will infer the location of the lake breeze from a batch of radar images.

detect_velocity_waves(radar_scan[, ...])

Detect radial velocity wave signatures by differencing two consecutive scans.

vis Module#

Main module for visualization.

aidas.vis (aidas.vis)#

This module handles the visualization of detection masks on radar data.

visualize_lake_breeze(radar_scan[, ...])

This module will visualize the lake breeze using PyART's pyart.graph.RadarMapDisplay().

visualize_velocity_waves(radar_scan[, ...])

This module will visualize the radial velocity wave mask alongside the velocity field it was derived from.

plot_velocity_wave_mask(radar_scan[, ax, ...])

Draw the radial velocity wave mask on its own map.

triggering Module#

Main module for triggering lidar scans.

AIDAS Triggering Module#

This module handles the generation of scan strategies and triggering of the lidar based on radar data.

make_scan_file(elevations, azimuths, ...[, ...])

Makes a CSM scanning strategy file for a Halo Photonics Doppler Lidar.

send_scan(file_name, lidar_ip_addr, ...[, ...])

Sends a scan to the lidar

trigger_lidar_ppis_from_mask(rad_scan, ...)

Triggers a PPI scan on the lidar using a scan strategy generated from a detection mask.

trigger_lidar_rhi_from_mask(rad_scan, ...[, ...])

Triggers an RHI scan on the lidar using a scan strategy generated from a detection mask.

testing Module#

Main module for testing.

aidas.testing (aidas.testing)#

This module handles testing utilities for AIDAS.

FakeSSHClient()

A fake SSH client for testing purposes.

FakeSFTP()

A fake SFTP client for testing purposes.

TEST_RHI_FILE

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

TEST_PPI_FILE

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

TEST_PPI_TRIGGERED_SCAN

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

TEST_RHI_TRIGGERED_SCAN

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

util Module#

Module with various utilities.

AIDAS Utility Functions (aidas.util)#

This module contains utility functions for the AIDAS package.

azimuth_point(instrument_lon, ...[, index, ...])

Calculate the azimuth angle from the radar instrument to each pixel in the radar image.

azimuth_from_ellipse(instrument_lon, ...[, ...])

Fit an ellipse to the detection mask via PCA, find the endpoints of the major axis (leftmost and rightmost mask pixels projected onto that axis), and return the azimuth from the instrument perpendicular to the major axis.

aeqd_to_lonlat(x, y, lon_0, lat_0)

Convert azimuthal equidistant coordinates to longitude and latitude on the WGS84 ellipsoid.