lsst.pipe.tasks.ssoAssociation.SolarSystemAssociationTask Class Reference

Inheritance diagram for lsst.pipe.tasks.ssoAssociation.SolarSystemAssociationTask:

Public Member Functions
	run (self, diaSourceCatalog, ssObjects, visitInfo, bbox, wcs)

Static Public Attributes
	ConfigClass = SolarSystemAssociationConfig

Protected Member Functions
	_maskToCcdRegion (self, ssObjects, bbox, wcs, marginArcsec)
	_radec_to_xyz (self, ras, decs)
	_return_empty (self, diaSourceCatalog, emptySolarSystemObjects, source_column)

Static Protected Attributes
str	_DefaultName = "ssoAssociation"

Detailed Description

Associate DIASources into existing SolarSystem Objects.

This task performs the association of detected DIASources in a visit
with known solar system objects.

Definition at line 64 of file ssoAssociation.py.

Member Function Documentation

_maskToCcdRegion()

lsst.pipe.tasks.ssoAssociation.SolarSystemAssociationTask._maskToCcdRegion ( self, ssObjects, bbox, wcs, marginArcsec )

protected

Mask the input SolarSystemObjects to only those in the exposure
bounding box.

Parameters
----------
ssObjects : `astropy.table.Table`
    SolarSystemObjects to mask to ``exposure``.
bbox :
    Exposure bbox used for masking
wcs :
    Exposure wcs used for masking
marginArcsec : `float`
    Maximum possible matching radius to pad onto the exposure bounding
    box. If greater than ``maxPixelMargin``, ``maxPixelMargin`` will
    be used.

Returns
-------
maskedSolarSystemObjects : `astropy.table.Table`
    Set of SolarSystemObjects contained within the exposure bounds.

Definition at line 407 of file ssoAssociation.py.

_radec_to_xyz()

lsst.pipe.tasks.ssoAssociation.SolarSystemAssociationTask._radec_to_xyz ( self, ras, decs )

protected

Convert input ra/dec coordinates to spherical unit-vectors.

Parameters
----------
ras : `array-like`
    RA coordinates of objects in degrees.
decs : `array-like`
    DEC coordinates of objects in degrees.

Returns
-------
vectors : `numpy.ndarray`, (N, 3)
    Output unit-vectors

Definition at line 442 of file ssoAssociation.py.

_return_empty()

lsst.pipe.tasks.ssoAssociation.SolarSystemAssociationTask._return_empty ( self, diaSourceCatalog, emptySolarSystemObjects, source_column )

protected

Return a struct with all appropriate empty values for no SSO associations.

Parameters
----------
diaSourceCatalog : `astropy.table.Table`
    Used for column names
emptySolarSystemObjects : `astropy.table.Table`
    Used for column names.
Returns
-------
results : `lsst.pipe.base.Struct`
    Results struct with components.
    - ``ssoAssocDiaSources`` : Empty. (`astropy.table.Table`)
    - ``unAssocDiaSources`` : Input DiaSources. (`astropy.table.Table`)
    - ``nTotalSsObjects`` : Zero. (`int`)
    - ``nAssociatedSsObjects`` : Zero.
    - ``associatedSsSources`` : Empty. (`Astropy.table.Table`)
    - ``unassociatedSsObjects`` : Empty. (`Astropy.table.Table`)


Raises
------
RuntimeError
    Raised if duplicate DiaObjects or duplicate DiaSources are found.

Definition at line 471 of file ssoAssociation.py.

run()

lsst.pipe.tasks.ssoAssociation.SolarSystemAssociationTask.run	(		self,
			diaSourceCatalog,
			ssObjects,
			visitInfo,
			bbox,
			wcs )

Create a searchable tree of unassociated DiaSources and match
to the nearest ssoObject.

Parameters
----------
diaSourceCatalog : `astropy.table.Table`
    Catalog of DiaSources. Modified in place to add ssObjectId to
    successfully associated DiaSources.
ssObjects : `astropy.table.Table`
    Set of solar system objects that should be within the footprint
    of the current visit.
visitInfo : `lsst.afw.image.VisitInfo`
    visitInfo of exposure used for exposure time
bbox : `lsst.geom.Box2I`
    bbox of exposure used for masking
wcs : `lsst.afw.geom.SkyWcs`
    wcs of exposure used for masking

Returns
-------
resultsStruct : `lsst.pipe.base.Struct`

    - ``ssoAssocDiaSources`` : DiaSources that were associated with
      solar system objects in this visit. (`astropy.table.Table`)
    - ``unAssocDiaSources`` : Set of DiaSources that were not
      associated with any solar system object. (`astropy.table.Table`)
    - ``nTotalSsObjects`` : Total number of SolarSystemObjects
      contained in the CCD footprint. (`int`)
    - ``nAssociatedSsObjects`` : Number of SolarSystemObjects
      that were associated with DiaSources. (`int`)
    - ``ssSourceData`` : ssSource table data. (`Astropy.table.Table`)

Definition at line 74 of file ssoAssociation.py.

Member Data Documentation

_DefaultName

str lsst.pipe.tasks.ssoAssociation.SolarSystemAssociationTask._DefaultName = "ssoAssociation"

staticprotected

Definition at line 71 of file ssoAssociation.py.

ConfigClass

lsst.pipe.tasks.ssoAssociation.SolarSystemAssociationTask.ConfigClass = SolarSystemAssociationConfig

static

Definition at line 70 of file ssoAssociation.py.

---

The documentation for this class was generated from the following file:

• python/lsst/pipe/tasks/ssoAssociation.py