pc module

A module for Microsoft Planetary Computer (PC).

get_bands(collection, item=None)

Get the bands of an item.

Parameters:

Name	Type	Description	Default
collection	str	The collection the item is in.	required
item	str	The item to get the bands of.	None

Returns:

Name	Type	Description
list	List[str]	A list of bands.

Source code in leafmap/pc.py

def get_bands(collection: str, item: Optional[str] = None) -> List[str]:
    """Get the bands of an item.

    Args:
        collection (str): The collection the item is in.
        item (str): The item to get the bands of.

    Returns:
        list: A list of bands.
    """
    if item is None:
        item = get_first_item(collection, return_id=True)
    return stac_bands(collection=collection, items=item)

get_first_item(collection, return_id=False)

Get the first item in a collection.

Parameters:

Name	Type	Description	Default
collection	str	The collection to get the first item from.	required
return_id	bool	If True, return the item's ID instead of the item itself.	False

Returns:

Type	Description
	pystac.Item: The first item in the collection.

Source code in leafmap/pc.py

def get_first_item(collection: str, return_id: Optional[bool] = False):
    """Get the first item in a collection.

    Args:
        collection (str): The collection to get the first item from.
        return_id (bool, optional): If True, return the item's ID instead of the item itself.

    Returns:
        pystac.Item: The first item in the collection.
    """
    catalog = Client.open(PC_ENDPOINT)
    col = catalog.get_child(collection)
    item = next(col.get_items())
    if return_id:
        return item.id
    else:
        return item

get_pc_collection_list()

Get a list of collections in the Microsoft Planetary Computer catalog.

Returns:

Name	Type	Description
list	List[str]	A list of collections.

Source code in leafmap/pc.py

def get_pc_collection_list() -> List[str]:
    """Get a list of collections in the Microsoft Planetary Computer catalog.

    Returns:
        list: A list of collections.
    """
    inventory = get_pc_inventory()

    names = []

    for key in inventory:
        names.append(f"{key} - {inventory[key]['title']}")
    names.sort()

    return names

get_pc_collections(verbose=False)

Get a list of all collections in the Microsoft Planetary Computer catalog.

Parameters:

Name	Type	Description	Default
verbose	bool	If True, print the collections to the console.	False

Returns:

Name	Type	Description
dict	dict[str, str]	A dictionary with collections IDs as keys and cllection titles as value.

Source code in leafmap/pc.py

def get_pc_collections(verbose: Optional[bool] = False) -> dict[str, str]:
    """Get a list of all collections in the Microsoft Planetary Computer catalog.

    Args:
        verbose (bool, optional): If True, print the collections to the console.

    Returns:
        dict: A dictionary with collections IDs as keys and cllection titles as value.
    """
    catalog = Client.open(PC_ENDPOINT)
    collections = catalog.get_children()
    result = {}
    for collection in collections:
        result[collection.id] = collection.title
        if verbose:
            print(f"{collection.id} - {collection.title}")

    return result

get_pc_inventory(refresh=False, verbose=False)

Get the inventory of the Microsoft Planetary Computer catalog.

Parameters:

Name	Type	Description	Default
refresh	bool	If True, refresh the inventory.	False
verbose	bool	If True, print the collections to the console.	False

Returns:

Name	Type	Description
dict	dict[str, dict[str, Union[str, list, str]]]	A dictionary of collections and their bands.

Source code in leafmap/pc.py

def get_pc_inventory(
    refresh: Optional[bool] = False, verbose: Optional[bool] = False
) -> dict[str, dict[str, Union[str, list, str]]]:
    """Get the inventory of the Microsoft Planetary Computer catalog.

    Args:
        refresh (bool, optional): If True, refresh the inventory.
        verbose (bool, optional): If True, print the collections to the console.

    Returns:
        dict: A dictionary of collections and their bands.
    """
    import importlib.resources

    pkg_dir = os.path.dirname(importlib.resources.files("leafmap") / "leafmap.py")
    filepath = os.path.join(pkg_dir, "data/pc_inventory.json")

    if refresh:
        catalog = Client.open(PC_ENDPOINT)
        collections = catalog.get_children()
        data = {}
        for collection in collections:
            try:
                if verbose:
                    print(f"{collection.id} - {collection.title}")
                first_item = get_first_item(collection.id, return_id=True)
                bands = stac_assets(collection=collection.id, item=first_item)
                if isinstance(bands, list):
                    data[collection.id] = {}
                    data[collection.id]["title"] = collection.title
                    data[collection.id]["first_item"] = first_item
                    data[collection.id]["bands"] = bands
            except Exception as e:
                if verbose:
                    print(f"{collection.id} has no bands.")

        with open(filepath, "w") as f:
            json.dump(data, f, indent=4)

    else:
        with open(filepath, "r") as f:
            data = json.load(f)

    return data