adam.triggering.trigger_lidar_ppis_from_mask#

adam.triggering.trigger_lidar_ppis_from_mask(rad_scan, lidar_lat, lidar_lon, lidar_ip_addr, lidar_uname, lidar_pwd, elevations, az_width=30.0, out_file_name='user.txt', dyn_csm=False, max_distance=5000, client=None)[source]#

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

Parameters:

  • rad_scan (RadarImage) – The radar scan containing the lake breeze mask. The azimuth of the largest lake breeze region will be used to determine the center of the RHI scan.

  • lidar_lat (float) – The latitude of the lidar

  • lidar_lon (float) – The longitude of the lidar

  • lidar_ip_addr – IP address of the lidar

  • lidar_uname – The username of the lidar

  • lidar_password – The lidar’s password

  • out_file_name – The output file name on the lidar

  • dyn_csm (bool) – Set to True to assume Dynamic CSM mode

  • az_width (float) – The width of the azimuth scan in degrees. The scan will be centered around the azimuth of the largest lake breeze region as determined by the model’s radar image and the location of the lidar.

  • max_distance (float) – The maximum distance from the lidar to the lake breeze region for the scan to be triggered.

  • client (paramiko.SSHClient, optional) – An optional SSH client to use for the connection. If not provided, a new client will be created and closed within the send_scan function.

Returns:

Returns True if the scan was triggered, and False if the scan was not triggered due to the distance from the lidar to the lake breeze region being greater than max_distance.

Return type:

bool