lsst.ap.association  master-g965b868a3d+3
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.ap.association.l1dbproto.AssociationL1DBProtoTask Class Reference
Inheritance diagram for lsst.ap.association.l1dbproto.AssociationL1DBProtoTask:

Public Member Functions

def __init__ (self, kwargs)
 
def load_dia_objects (self, exposure)
 
def load_dia_sources (self, dia_obj_ids)
 
def store_dia_objects (self, dia_objects, compute_spatial_index=False, exposure=None)
 
def compute_indexer_id (self, sphere_point)
 
def store_dia_sources (self, dia_sources, associated_ids=None, exposure=None)
 
def dia_object_afw_schema (self)
 
def dia_source_afw_schema (self)
 

Public Attributes

 indexer
 
 db
 

Static Public Attributes

 ConfigClass = AssociationL1DBProtoConfig
 

Detailed Description

Task wrapping `lsst.dax.ppdb` enabling it to be used in ap_association.

Handles computation of HTM indices, trimming of DIAObject catalogs to the
CCD geometry, and assuring input DIASource catalog schemas are compatible
with the db.

Member Function Documentation

◆ compute_indexer_id()

def lsst.ap.association.l1dbproto.AssociationL1DBProtoTask.compute_indexer_id (   self,
  sphere_point 
)
Compute the pixel index of the given point.

Parameters
----------
sphere_point : `lsst.afw.geom.SpherePoint`
    Point to compute pixel index for.

Returns
-------
index : `int`
    Index of the pixel the point is contained in.

◆ dia_object_afw_schema()

def lsst.ap.association.l1dbproto.AssociationL1DBProtoTask.dia_object_afw_schema (   self)
Retrieve the Schema of the DIAObjects in this database.

Returns
-------
schema : `lsst.afw.table.Schema`
    Schema of the DIAObjects in this database.

◆ dia_source_afw_schema()

def lsst.ap.association.l1dbproto.AssociationL1DBProtoTask.dia_source_afw_schema (   self)
Retrieve the Schema of the DIASources in this database.

Returns
-------
schema : `lsst.afw.table.Schema`
    Schema of the DIASources in this database.

◆ load_dia_objects()

def lsst.ap.association.l1dbproto.AssociationL1DBProtoTask.load_dia_objects (   self,
  exposure 
)
Load all DIAObjects within the exposure.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    An exposure with a solved WCS representing the area on the sky to
    load DIAObjects.

Returns
-------
dia_objects : `lsst.afw.table.SourceCatalog`
    Catalog of DIAObjects that are contained with the the bounding
    box defined by the exposure bounding box.

◆ load_dia_sources()

def lsst.ap.association.l1dbproto.AssociationL1DBProtoTask.load_dia_sources (   self,
  dia_obj_ids 
)
Retrieve all DIASources associated with this collection of DIAObject
ids.

Parameters
----------
dia_obj_ids : array-like of `int`s
    Id of the DIAObject that is associated with the DIASources
    of interest.

Returns
-------
dia_sources : `lsst.afw.table.SourceCatalog`
    SourceCatalog of DIASources

◆ store_dia_objects()

def lsst.ap.association.l1dbproto.AssociationL1DBProtoTask.store_dia_objects (   self,
  dia_objects,
  compute_spatial_index = False,
  exposure = None 
)
Store all DIAObjects in this SourceCatalog.

Parameters
----------
dia_objects : `lsst.afw.table.SourceCatalog`
    Catalog of DIAObjects to store.
compute_spatial_index : `bool`
    If True, compute the spatial search indices using the
    indexer specified at class instantiation.
exposure: `lsst.afw.image.Exposure` (optional)
    CcdExposure associated with these DIAObjects being inserted.
    Inserts the CcdVisitInfo for this exposure in the CcdVisitTable.

◆ store_dia_sources()

def lsst.ap.association.l1dbproto.AssociationL1DBProtoTask.store_dia_sources (   self,
  dia_sources,
  associated_ids = None,
  exposure = None 
)
Store all DIASources in this SourceCatalog.

Parameters
----------
dia_sources : `lsst.afw.table.SourceCatalog`
    Catalog of DIASources to store.
associated_ids : array-like of `int`s (optional)
    DIAObject ids that have been associated with these DIASources
exposure : `lsst.afw.image.Exposure`
    Exposure object the DIASources were detected in.

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