Skip to content

Utils

check_sat_FOV(region, FOV)

Check if the region is within the Field of View (FOV) of the satellite.

Parameters:

Name Type Description Default
region Tuple[int, int, int, int]

The region (lon_min, lat_min, lon_max, lat_max) to check if it is within the FOV

 required
FOV Tuple[int, int]

The Field of View (FOV) (lon_min, lat_min, lon_max, lat_max) of the satellite.

 required

Returns:

Name Type Description
bool bool

True if the region is within the FOV, False otherwise.
Source code in rs_tools/_src/geoprocessing/utils.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
def check_sat_FOV(region: Tuple[int, int, int, int], FOV: Tuple[int, int, int, int]) -> bool:
    """
    Check if the region is within the Field of View (FOV) of the satellite.

    Args:
        region (Tuple[int, int, int, int]): The region (lon_min, lat_min, lon_max, lat_max) to check if it is within the FOV
        FOV (Tuple[int, int]): The Field of View (FOV) (lon_min, lat_min, lon_max, lat_max) of the satellite.

    Returns:
        bool: True if the region is within the FOV, False otherwise.
    """
    # Check if the region is within the Field of View (FOV) of the satellite.
    if abs(region[0]) <= abs(FOV[0]) and abs(region[1]) <= abs(FOV[1]) and abs(region[2]) <= abs(FOV[2]) and abs(region[3]) <= abs(FOV[3]):
        return True
    else:
        return False

convert_units(ds, wavelengths)

Function to convert units from mW/m^2/sr/cm^-1 to W/m^2/sr/um. Acts on each band separately.

Parameters:

Name Type Description Default
ds Dataset

The input dataset to be converted.

 required
wavelengths Dict[float]

Dictionary of wavelengths of data for each band (i).

 required

Returns:

Type Description
Dataset

xr.Dataset: The converted dataset.
Source code in rs_tools/_src/geoprocessing/utils.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
def convert_units(ds: xr.Dataset, wavelengths: Dict) -> xr.Dataset:
    """
    Function to convert units from mW/m^2/sr/cm^-1 to W/m^2/sr/um.
    Acts on each band separately.

    Parameters:
        ds (xr.Dataset): The input dataset to be converted.
        wavelengths (Dict[float]): Dictionary of wavelengths of data for each band (i).

    Returns:
        xr.Dataset: The converted dataset.
    """
    for band in ds.data_vars:
        ds[band] = ds[band] * 0.001  # to convert mW to W
        ds[band] = ds[band] * 10000 / wavelengths[band]**2  # to convert cm^-1 to um
    return ds