API documentation

gaiaunlimited.scanninglaw Module

Functions

make_rotmat(fov1_xyz, fov2_xyz)	Make rotational matrix from ICRS to Gaia body frame(ish).
obmt2tcbgaia(obmt)	Calculate Gaia Barycenter coordinate time (TCB, days) from OnBoard Mission Time (OBMT, revs).
angle2dist3d(sepangle)	Get equivalent 3d distance of an angle on a unit sphere.
check_gaps(gaps, x)	Check if values of array x falls in any gaps.
cartesian_to_spherical(xyz)	Convert cartesian XYZ to (longitude,latitude).

Classes

GaiaScanningLaw([version, gaplist])

Initialize a version of Gaia's scanning law.

gaiaunlimited.selectionfunctions Package

Functions

apogee_sf(apparentH, unreddenedJK, position)	Returns the probability that a star of given intrinsic colour (J-K)_0 and apparent magnitude H and given position on the sky was targeted by APOGEE or APOGEE-2.
build_patch_map(coord, radius[, min_points])	Query the Gaia database and create a high-resolution healpix map of the M_10 parameter for a given circular patch of sky.
m10_to_completeness(G, m10)	Predicts the completeness at magnitude G, given a value of M_10 read from a precomputed map.
sigmoid(G, G0, invslope, shape)	Generalized sigmoid function.

Classes

DR2SelectionFunction()	DR2 selection function developed by the Gaiaverse team.
DR3RVSSelectionFunction()	Internal selection function for the RVS sample in DR3.
DR3SelectionFunction(*args, **kwargs)	DR3 selection function developed by the Gaiaverse team.
DR3SelectionFunctionTCG([mode, coord, ...])	Model of the Gaia DR3 survey selection function calibrated on DECaPS.
EDR3RVSSelectionFunction()	Internal selection function for the RVS sample in EDR3.
SelectionFunctionBase(ds)	Base class for Gaia selection functions.
SubsampleSelectionFunction(subsample_query, ...)	Internal selection function for any sample of DR3.
SubsampleSelectionFunctionHMLE([...])	Hierarchical maximum-likelihood estimate for the subsample selection function.

gaiaunlimited.utils Module

Functions

coord2healpix(coords, frame, nside[, nest])	Calculate HEALPix indices from an astropy SkyCoord.
get_healpix_centers(order[, nest])	Get centers of HEALPix as astropy coordinates.

Classes

SimulateGaiaSource(ra, dec[, period, ...])

Forward model to estimate RUWE for single sources or binary systems in Gaia DR3.

gaiaunlimited.fetch_utils Module

Functions

download(url, file[, desc, chunk_size, md5sum])	Download file from a url.
download_scanninglaw(name)	Download scanning law datafiles if it does not already exist.
get_datadir()	Get gaiasf data directory as Path.