Module pyucrio.tools.site_map

Obtain FoVs of ASIs and create plots.

Classes

class SiteMapManager (ucrio_obj)
Expand source code 
class SiteMapManager:
    """
    The SiteMapManager object is initialized within every PyAuroraX object. It acts as a way to access 
    the submodules and carry over configuration information in the super class.
    """

    def __init__(self, ucrio_obj):
        self.__ucrio_obj = ucrio_obj

    def create_map(self,
                   cartopy_projection: cartopy.crs.Projection,
                   instrument_array: Union[Literal["swan_hsr", "norstar_riometer"], List[str]],
                   site_uid_list: Optional[Union[List[str], List[List[str]]]] = None,
                   color: Union[str, List[str]] = 'black',
                   symbol: Union[str, List[str]] = 'o',
                   sym_size: Union[int, List[int]] = 1) -> SiteMap:
        """
        Create a SiteMap object.

        Args:
            
            cartopy_projection (cartopy.crs.Projection): 
                The cartopy projection to use when creating the FoV map.

            site_uid_list (str or list of str): 
                List of site UIDs to include in the map.

            instrument_array (str): 
                The instrument array that the site_uid_list sites are a part of.

            color (str): 
                String specifying a matplotlib color to associate with site locations
                for plotting.

            symbol (int): 
                Integer giving the linewidth to associate with site locations for plotting.

            sym_size (str): 
                String specifying a matplotlib linestyle to associate with site locations
                for plotting.

        Returns:
            The generated `pyaurorax.tools.SiteMap` object.

        Raises:
            ValueError: issues encountered with supplied parameters
            pyaurorax.exceptions.AuroraXError: general issue encountered
        """
        return func_create_map(self.__ucrio_obj, cartopy_projection, site_uid_list, instrument_array, color, symbol, sym_size)

The SiteMapManager object is initialized within every PyAuroraX object. It acts as a way to access the submodules and carry over configuration information in the super class.

Methods

def create_map(self,
cartopy_projection: cartopy.crs.Projection,
instrument_array: Literal['swan_hsr', 'norstar_riometer'] | List[str],
site_uid_list: List[str] | List[List[str]] | None = None,
color: str | List[str] = 'black',
symbol: str | List[str] = 'o',
sym_size: int | List[int] = 1) ‑> SiteMap
Expand source code 
def create_map(self,
               cartopy_projection: cartopy.crs.Projection,
               instrument_array: Union[Literal["swan_hsr", "norstar_riometer"], List[str]],
               site_uid_list: Optional[Union[List[str], List[List[str]]]] = None,
               color: Union[str, List[str]] = 'black',
               symbol: Union[str, List[str]] = 'o',
               sym_size: Union[int, List[int]] = 1) -> SiteMap:
    """
    Create a SiteMap object.

    Args:
        
        cartopy_projection (cartopy.crs.Projection): 
            The cartopy projection to use when creating the FoV map.

        site_uid_list (str or list of str): 
            List of site UIDs to include in the map.

        instrument_array (str): 
            The instrument array that the site_uid_list sites are a part of.

        color (str): 
            String specifying a matplotlib color to associate with site locations
            for plotting.

        symbol (int): 
            Integer giving the linewidth to associate with site locations for plotting.

        sym_size (str): 
            String specifying a matplotlib linestyle to associate with site locations
            for plotting.

    Returns:
        The generated `pyaurorax.tools.SiteMap` object.

    Raises:
        ValueError: issues encountered with supplied parameters
        pyaurorax.exceptions.AuroraXError: general issue encountered
    """
    return func_create_map(self.__ucrio_obj, cartopy_projection, site_uid_list, instrument_array, color, symbol, sym_size)

Create a SiteMap object.

Args

cartopy_projection : cartopy.crs.Projection
The cartopy projection to use when creating the FoV map.
site_uid_list : str or list of str
List of site UIDs to include in the map.
instrument_array : str
The instrument array that the site_uid_list sites are a part of.
color : str
String specifying a matplotlib color to associate with site locations for plotting.
symbol : int
Integer giving the linewidth to associate with site locations for plotting.
sym_size : str
String specifying a matplotlib linestyle to associate with site locations for plotting.

Returns

The generated pyaurorax.tools.SiteMap object.

Raises

ValueError
issues encountered with supplied parameters
pyaurorax.exceptions.AuroraXError
general issue encountered