Utils

Shared helpers exported from hipscatalog_gen.utils. Most functions are prefixed with underscores but are re-exported via __all__ for pipeline use.

Example: resolve column names and validate RA/DEC:

from hipscatalog_gen.utils import _resolve_col_name, _validate_and_normalize_radec
ra = _resolve_col_name("RA", ddf, header=True)
dec = _resolve_col_name("DEC", ddf, header=True)
ddf = _validate_and_normalize_radec(ddf, ra, dec, log_fn)

hipscatalog_gen.utils._mkdirs

Create directory and parents if they do not exist.

hipscatalog_gen.utils._write_text

Write UTF-8 text to file.

hipscatalog_gen.utils._detect_hats_catalog_root

Best-effort detection of a HATS catalog root directory.

hipscatalog_gen.utils._now_str

Return current UTC time in HiPS-friendly ISO 8601 format.

hipscatalog_gen.utils._ts

Return local timestamp string for logging.

hipscatalog_gen.utils._fmt_dur

Format a duration in seconds as HH:MM:SS.mmm.

hipscatalog_gen.utils._log_depth_stats

Log a compact one-line summary for a depth and pipeline phase.

hipscatalog_gen.utils._get_dask_base

Prefer public Dask-like interfaces; fall back to LSDB ._ddf only when needed.

hipscatalog_gen.utils._score_deps

Return column names referenced in a score expression.

hipscatalog_gen.utils._resolve_col_name

Resolve a column spec that can be a name or 1-based index.

hipscatalog_gen.utils._get_meta_df

Return an empty DataFrame with same columns/dtypes as a collection.

hipscatalog_gen.utils._validate_and_normalize_radec

Validate RA/DEC ranges and normalize RA into [0, 360] if needed.