layup.visualize

Attributes

logger
DASH_THREAD

Functions

build_fig_caches(rows, orbit_format, input_plane, ...)
visualize_cli(input[, num_orbs, block_size, n_points, ...])	Create visualisation plots of a given set of input orbits from the command line
visualize_notebook(data[, num_orbs, block_size, ...])	Create visualisation plots of a given set of input orbits in a Jupyter notebook

Module Contents

logger

DASH_THREAD = None

build_fig_caches(rows: numpy.ndarray, orbit_format: str, input_plane: Literal['equatorial', 'ecliptic'], input_origin: Literal['heliocentric', 'barycentric'], special_rows: numpy.ndarray | None = None, n_points: int = 500, r_max: float = 50.0, cache_dir: str | None = None)

visualize_cli(input: str, num_orbs: int = 100, block_size: int = 10000, n_points: int = 500, r_max: float = 50.0, random: bool = False, cache_dir: str | None = None, special: str | None = None)

Create visualisation plots of a given set of input orbits from the command line

Parameters:

• input (str) – Input file path

• num_orbs (int, optional (default=100)) – Number of orbits to plot at once

• block_size (int, optional (default=10000)) – Number of rows to read per time in the input file reader

• n_points (int, optional (default=500)) – Number of points sampled when constructing the line

• r_max (float, optional (default=50 au)) – Maximum distance to render hyperbolic orbits out to

• random (bool, optional (default=False)) – Flag to turn on/off random orbit plotting

• cache_dir (str, optional (default=None)) – Path to directory of cached auxiliary data

• special (str, optional (default=None)) – Path to a second orbit file whose orbits are highlighted in a distinct accent colour; regular orbits are greyed out when this is supplied

visualize_notebook(data: str | pathlib.Path | numpy.ndarray, num_orbs: int = 100, block_size: int = 10000, n_points: int = 500, r_max: float = 50.0, random: bool = False, cache_dir: str | None = None, special: str | pathlib.Path | numpy.ndarray | None = None)

Create visualisation plots of a given set of input orbits in a Jupyter notebook

Parameters:

• data (str, Path, or numpy structured array) – Input file path or structured array with a FORMAT column

• num_orbs (int, optional (default=100)) – Number of orbits to plot at once

• block_size (int, optional (default=10000)) – Number of rows to read per time in the input file reader

• n_points (int, optional (default=500)) – Number of points sampled when constructing the line

• r_max (float, optional (default=50 au)) – Maximum distance to render hyperbolic orbits out to

• random (bool, optional (default=False)) – Flag to turn on/off random orbit plotting

• cache_dir (str, optional (default=None)) – Path to directory of cached auxiliary data