lsst.pipe.tasks.ssp.ssobject Namespace Reference

Functions
	nJy_to_mag (f_njy)
	nJy_err_to_mag_err (f_njy, f_err_njy)
	compute_ssobject_entry (row, sss)
	compute_ssobject (sss, dia, mpcorb)
	main ()

Variables
list	DIA_COLUMNS
list	DIA_DTYPES = [int, float, float, float, float, str, float, float]
str	input_dir = "./analysis/inputs"
str	output_dir = "./analysis/outputs"
	sss
	num = len(sss)
	dia
	mpcorb
	obj = compute_ssobject(sss, dia, mpcorb)

Function Documentation

compute_ssobject()

lsst.pipe.tasks.ssp.ssobject.compute_ssobject	(		sss,
			dia,
			mpcorb )

Compute solar system object properties by joining and processing
SSSource, DiaSource, and MPC orbit data.

This function takes a pre-grouped SSSource table, joins it with
DiaSource data, computes per-object quantities, and calculates
additional orbital parameters like Tisserand J and Minimum Orbit
Intersection Distance (MOID) with Earth for matching objects.

Parameters
----------
sss : pandas.DataFrame
    SSSource table, pre-grouped by 'ssObjectId'. Must be sorted by
    'ssObjectId' for correct grouping. Contains columns like
    'ssObjectId', 'diaSourceId', etc.
dia : pandas.DataFrame
    DiaSource table with columns prefixed as 'dia_' in the join.
    Must include 'dia_diaSourceId', 'dia_psfFlux', 'dia_psfFluxErr',
    etc.
mpcorb : pandas.DataFrame
    MPC orbit data with columns like
    'unpacked_primary_provisional_designation', 'q', 'e', 'i',
    'node', 'argperi'.

Returns
-------
numpy.ndarray
    Array of ssObject records with dtype schema.ssObjectDtype,
    containing computed properties for each unique ssObjectId,
    including magnitudes, orbital elements, Tisserand J, and
    MOID-related values.

Raises
------
AssertionError
    If 'sss' is not pre-grouped by 'ssObjectId', or if DiaSources
    are missing after join.

Notes
-----
- The function assumes 'sss' is large and avoids internal
  sorting/copying for efficiency.
- Tisserand J and MOID are computed only for objects matching
  designations in 'mpcorb'.
- MOID computation uses a MOIDSolver for each matched object.

Definition at line 127 of file ssobject.py.

compute_ssobject_entry()

lsst.pipe.tasks.ssp.ssobject.compute_ssobject_entry	(		row,
			sss )

Definition at line 56 of file ssobject.py.

main()

lsst.pipe.tasks.ssp.ssobject.main

(

)

CLI entry point for building SSObject table from SSSource,
DiaSource, and MPC orbit data.

Definition at line 244 of file ssobject.py.

nJy_err_to_mag_err()

lsst.pipe.tasks.ssp.ssobject.nJy_err_to_mag_err	(		f_njy,
			f_err_njy )

Convert flux error in nanoJanskys to magnitude error.

Parameters
----------
f_njy : float
    Flux in nanoJanskys.
f_err_njy : float
    Flux error in nanoJanskys.

Returns
-------
float
    Magnitude error.

Definition at line 37 of file ssobject.py.

nJy_to_mag()

lsst.pipe.tasks.ssp.ssobject.nJy_to_mag

(

f_njy

)

Convert flux density in nanoJanskys (nJy) to AB magnitude.

Parameters
----------
f_njy : float or array-like
    Flux density in nanoJanskys.

Returns
-------
float or array-like
    AB magnitude corresponding to the input flux density.

Definition at line 20 of file ssobject.py.

Variable Documentation

dia

lsst.pipe.tasks.ssp.ssobject.dia

Initial value:

=  pd.read_parquet(
        f"{input_dir}/dia_sources.parquet", engine="pyarrow", dtype_backend="pyarrow", columns=DIA_COLUMNS
    ).reset_index(drop=True)

Definition at line 354 of file ssobject.py.

DIA_COLUMNS

list lsst.pipe.tasks.ssp.ssobject.DIA_COLUMNS

Initial value:

=  [
    "diaSourceId", "midpointMjdTai", "ra", "dec", "extendedness",
    "band", "psfFlux", "psfFluxErr"
]

Definition at line 13 of file ssobject.py.

DIA_DTYPES

list lsst.pipe.tasks.ssp.ssobject.DIA_DTYPES = [int, float, float, float, float, str, float, float]

Definition at line 17 of file ssobject.py.

input_dir

str lsst.pipe.tasks.ssp.ssobject.input_dir = "./analysis/inputs"

Definition at line 340 of file ssobject.py.

mpcorb

lsst.pipe.tasks.ssp.ssobject.mpcorb

Initial value:

=  pd.read_parquet(
        f"{input_dir}/mpc_orbits.parquet",
        engine="pyarrow",
        dtype_backend="pyarrow",
        columns=[
            "unpacked_primary_provisional_designation",
            "a",
            "q",
            "e",
            "i",
            "node",
            "argperi",
            "peri_time",
            "mean_anomaly",
            "epoch_mjd",
            "h",
            "g",
        ],
    ).reset_index(drop=True)

Definition at line 364 of file ssobject.py.

num

lsst.pipe.tasks.ssp.ssobject.num = len(sss)

Definition at line 351 of file ssobject.py.

obj

lsst.pipe.tasks.ssp.ssobject.obj = compute_ssobject(sss, dia, mpcorb)

Definition at line 387 of file ssobject.py.

output_dir

str lsst.pipe.tasks.ssp.ssobject.output_dir = "./analysis/outputs"

Definition at line 341 of file ssobject.py.

sss

lsst.pipe.tasks.ssp.ssobject.sss

Initial value:

=  pd.read_parquet(
        f"{output_dir}/sssource.parquet", engine="pyarrow", dtype_backend="pyarrow"
    ).reset_index(drop=True)

Definition at line 348 of file ssobject.py.