hombit/ztf-bts-xmatch
TDABench ZTF BTS HATS Catalog Collection TODO: Add description. ZTF BTS crossmatched with multiple optical catalogs Access the catalog We recommend the use of the LSDB Python framework to access HATS catalogs. LSDB can be installed via pip install lsdb or conda install conda-forge::lsdb, see more details in the docs. The following code provides a minimal example of opening this catalog: import lsdb # Full sky coverage. catalog =… See the full description on the dataset page: https://huggingface.co/datasets/hombit/ztf-bts-xmatch.
configs:
- configname: default datadir: bts-xmatch/dataset
- configname: bts-xmatch5arcs datadir: bts-xmatch5arcs/dataset tags:
- astronomy ---
TDABench ZTF BTS HATS Catalog Collection
TODO: Add description. ZTF BTS crossmatched with multiple optical catalogs
Access the catalog
We recommend the use of the LSDB Python framework to access HATS catalogs. LSDB can be installed via pip install lsdb or conda install conda-forge::lsdb, see more details in the docs. The following code provides a minimal example of opening this catalog:
import lsdb
# Full sky coverage.
catalog = lsdb.open_catalog("hf://datasets/hombit/ztf-bts-xmatch")
# One-degree cone.
catalog = lsdb.open_catalog(
"hf://datasets/hombit/ztf-bts-xmatch",
search_filter=lsdb.ConeSearch(ra=135.0, dec=1.0, radius_arcsec=3600.0),
)Each catalog in this collection is represented as a separate Apache Parquet dataset and can be accessed with a variety of tools, including pandas, pyarrow, dask, Spark, DuckDB.
File structure
This catalog is represented by the following files and directories:
- `collection.properties` — textual metadata file describing the HATS collection of catalogs
- `bts-xmatch` — main HATS catalog directory
- `dataset/` — Apache Parquet dataset directory for the main catalog
- ... parquet metadata and data files in sub directories ...
- `hats.properties` — textual metadata file describing the main HATS catalog
- `partition_info.csv` — CSV file with a list of catalog HEALPix tiles (catalog partitions)
- `skymap.fits` — HEALPix skymap FITS file with row-counts per HEALPix tile of fixed order 8
- `bts-xmatch_5arcs/` — default margin catalog to ensure data completeness in cross-matching, the margin threshold is 5.0 arcseconds
- ... margin catalog files and directories ...
Catalog metadata
Metadata of the main HATS catalog, excluding margins and indexes:
Catalog columns
The main HATS catalog contains the following columns:
"Nested" indicates whether the column is stored as a nested field inside another "struct" column.
"Value count" may be different from the total number of rows for nested columns: each nested element is counted as a single value. "Null count" also refers to "elementary" values, not to rows.
