Utils

This module defines utility functions for the analysis classes.

collapse_coords(coords)

Collapse coordinates into a single SkyCoord object.

Parameters:

Name	Type	Description	Default
coords	Any	List of coordinates to collapse.	required

Returns:

Type	Description
SkyCoord	Collapsed SkyCoord object.

Source code in commensurability/utils.py

def collapse_coords(coords: Any) -> c.SkyCoord:
    """
    Collapse coordinates into a single SkyCoord object.

    Args:
        coords: List of coordinates to collapse.

    Returns:
        Collapsed SkyCoord object.
    """
    if isinstance(coords, c.SkyCoord):
        return coords
    return c.concatenate(coords)

make_quantity(obj, unit)

Convert object to a Quantity with specified unit.

Parameters:

Name	Type	Description	Default
obj	Any	Object to convert.	required
unit	Unit	Unit to convert to.	required

Returns:

Type	Description
Quantity	Quantity with specified unit.

Source code in commensurability/utils.py

def make_quantity(obj: Any, unit: u.Unit) -> u.Quantity:
    """
    Convert object to a Quantity with specified unit.

    Args:
        obj: Object to convert.
        unit (astropy.units.Unit): Unit to convert to.

    Returns:
        Quantity with specified unit.
    """
    if isinstance(obj, u.Quantity):
        return obj
    return obj * unit