Skip to content

grasp.instrument.lidar

grasp.instrument.lidar.lidar_geoms

Pathlike module-attribute

Pathlike = Union[Path, str]

load_lidar_geoms

load_lidar_geoms(site_name: str, start_date: Optional[Union[str, date]] = None, end_date: Optional[Union[str, date]] = None, base_path: Optional[Pathlike] = None) -> xr.Dataset

Used to easily load lidar GEOMS files stored on the cloud server's archive without needing to know where to find it.

Parameters:

Name Type Description Default
site_name str

Full name of the site you are looking for.

required
start_date Optional[Union[str, date]]

Measurement start date of the data you are looking for.

None
end_date Optional[Union[str, date]]

Measurement end date of the data you are looking for.

None
base_path Optional[Pathlike]

Default is the lidar geoms path on the cloud server, can be adjusted if needed.

None

Returns:

Type Description
Dataset

An xarray.Datset of the data in the loaded GEOMS file.

find_lidar_archive_dates

find_lidar_archive_dates(site_name: str, start_date: Optional[Union[str, date]] = None, end_date: Optional[Union[str, date]] = None, base_path: Optional[Pathlike] = None) -> List[datetime.date]

grasp.instrument.lidar.lidar

Pathlike module-attribute

Pathlike = Union[Path, str]

Lidar

Access Lidar data.

__init__

__init__(dpath: Pathlike) -> None

read_lidar

read_lidar() -> None

LidarG

time instance-attribute

time = time

heights instance-attribute

heights = heights

angle instance-attribute

angle = angle

station_altitude instance-attribute

station_altitude = station_altitude

station_latitude instance-attribute

station_latitude = station_latitude

station_longitude instance-attribute

station_longitude = station_longitude

ls_wavelengths instance-attribute

ls_wavelengths = ls_wavelengths

attenuated_backscatter instance-attribute

attenuated_backscatter = attenuated_backscatter

attenuated_backscatter_avg instance-attribute

attenuated_backscatter_avg = mean(attenuated_backscatter, axis=0)

fname instance-attribute

fname = fname

heights_smoothed instance-attribute

heights_smoothed = array(mean()[0][(window - 1):])

attenuated_backscatter_avg_smoothed instance-attribute

attenuated_backscatter_avg_smoothed = array([mean()[(window - 1):][1], mean()[(window - 1):][2], mean()[(window - 1):][3]])

lidar_ok instance-attribute

lidar_ok = all(norm_backscatter[i, :] > 0)

__init__

__init__(time, heights, angle, station_altitude, station_latitude, station_longitude, ls_wavelengths, attenuated_backscatter, fname) -> None

calc_norm_backscatter

calc_norm_backscatter(steps=60) -> None

plot_bs_profiles

plot_bs_profiles(vmin=0, vmax=2e-06, powerlimits=(-2, 2)) -> None

__plot_bs

__plot_bs(bs_type, heights_type) -> None

plot_attenuated_backscatter_avg

plot_attenuated_backscatter_avg() -> None

plot_attenuated_backscatter_avg_smoothed

plot_attenuated_backscatter_avg_smoothed() -> None

plot_norm_backscatter

plot_norm_backscatter() -> None

from_query classmethod

from_query(station, datestr, root_path=None, timestamp=None, mask_heights=None)

from_file classmethod

from_file(fname, timestamp=None, mask_heights=None)

grasp.instrument.lidar.utils

mjd2k_to_datetime

mjd2k_to_datetime(mjd2k)

Convert modified julian date 2000 to datetime object.

Parameters:

Name Type Description Default
mjd2k

The modified julian date

required

Returns:

Type Description

A datetime.datetime object

earth_sun_distance

earth_sun_distance(date=datetime.datetime.now())

datestr2archivepath

datestr2archivepath(datestr) -> Path

query2archivepath

query2archivepath(network, station, datestr, network_root_path=None) -> Path

get_filename_from_query

get_filename_from_query(network, station, datestr, pattern, nw_root_path=None)