AssociationDBSqliteTask¶

class lsst.ap.association.AssociationDBSqliteTask(**kwargs)¶

Bases: lsst.pipe.base.Task

Enable storage of and reading of DIAObjects and DIASources from a sqlite database.

Create a simple sqlite database and implement wrappers to store and retrieve DIAObjects and DIASources from within that database. This task functions as a testing ground for the L1 database and should mimic this database’s eventual functionality. This specific database implementation is useful for the verification packages which may not be run with access to L1 database.

Attributes Summary

`dia_object_afw_schema`	Retrieve the Schema of the DIAObjects in this database.
`dia_source_afw_schema`	Retrieve the Schema of the DIASources in this database.

Methods Summary

`close`()	Close the connection to the sqlite database.
`compute_indexer_id`(sphere_point)	Compute the pixel index of the given point.
`create_tables`()	If no sqlite database with the correct tables exists we can create one using this method.
`emptyMetadata`()	Empty (clear) the metadata for this Task and all sub-Tasks.
`getAllSchemaCatalogs`()	Get schema catalogs for all tasks in the hierarchy, combining the results into a single dict.
`getFullMetadata`()	Get metadata for all tasks.
`getFullName`()	Get the task name as a hierarchical name including parent task names.
`getName`()	Get the name of the task.
`getSchemaCatalogs`()	Get the schemas generated by this task.
`getTaskDict`()	Get a dictionary of all tasks as a shallow copy.
`load_dia_objects`(exposure)	Load all DIAObjects within the exposure.
`load_dia_sources`(dia_obj_ids)	Retrieve all DIASources associated with this collection of DIAObject ids.
`makeField`(doc)	Make a `lsst.pex.config.ConfigurableField` for this task.
`makeSubtask`(name, **keyArgs)	Create a subtask as a new instance as the `name` attribute of this task.
`store_ccd_visit_info`(exposure)	Store information describing the exposure for this ccd, visit.
`store_dia_objects`(dia_objects[, …])	Store all DIAObjects in this SourceCatalog.
`store_dia_sources`(dia_sources[, …])	Store all DIASources in this SourceCatalog.
`timer`(name[, logLevel])	Context manager to log performance data for an arbitrary block of code.

Attributes Documentation

dia_object_afw_schema¶

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¶

Retrieve the Schema of the DIASources in this database.

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

Methods Documentation

close()¶: Close the connection to the sqlite database.

compute_indexer_id(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.

create_tables()¶

If no sqlite database with the correct tables exists we can create one using this method.

Returns:	succeeded : `bool` Successfully created a new database with specified tables.

emptyMetadata()¶: Empty (clear) the metadata for this Task and all sub-Tasks.

getAllSchemaCatalogs()¶

Get schema catalogs for all tasks in the hierarchy, combining the results into a single dict.

Returns:	schemacatalogs : `dict` Keys are butler dataset type, values are a empty catalog (an instance of the appropriate lsst.afw.table Catalog type) for all tasks in the hierarchy, from the top-level task down through all subtasks.

Notes

This method may be called on any task in the hierarchy; it will return the same answer, regardless.

The default implementation should always suffice. If your subtask uses schemas the override Task.getSchemaCatalogs, not this method.

getFullMetadata()¶

Get metadata for all tasks.

Returns:	metadata : `lsst.daf.base.PropertySet` The `PropertySet` keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc..

Notes

The returned metadata includes timing information (if @timer.timeMethod is used) and any metadata set by the task. The name of each item consists of the full task name with . replaced by :, followed by . and the name of the item, e.g.:

topLevelTaskName:subtaskName:subsubtaskName.itemName

using : in the full task name disambiguates the rare situation that a task has a subtask and a metadata item with the same name.

getFullName()¶

Get the task name as a hierarchical name including parent task names.

Returns:	fullName : `str` The full name consists of the name of the parent task and each subtask separated by periods. For example: The full name of top-level task “top” is simply “top”. The full name of subtask “sub” of top-level task “top” is “top.sub”. The full name of subtask “sub2” of subtask “sub” of top-level task “top” is “top.sub.sub2”.

getName()¶

Get the name of the task.

Returns:	taskName : `str` Name of the task.

See also

Task.getAllSchemaCatalogs

Notes

Warning

Subclasses that use schemas must override this method. The default implemenation returns an empty dict.

This method may be called at any time after the Task is constructed, which means that all task schemas should be computed at construction time, not when data is actually processed. This reflects the philosophy that the schema should not depend on the data.

Returning catalogs rather than just schemas allows us to save e.g. slots for SourceCatalog as well.

getTaskDict()¶

Get a dictionary of all tasks as a shallow copy.

Returns:	taskDict : `dict` Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc..

load_dia_objects(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 expMd.

load_dia_sources(dia_obj_ids)¶

Retrieve all DIASources associated with this collection of DIAObject ids.

Parameters:	dia_obj_ids : array-like of `int` Id of the DIAObject that is associated with the DIASources of interest.
Returns:	dia_sources : `lsst.afw.table.SourceCatalog` SourceCatalog of DIASources

classmethod makeField(doc)¶

Make a lsst.pex.config.ConfigurableField for this task.

Parameters:	doc : `str` Help text for the field.
Returns:	configurableField : `lsst.pex.config.ConfigurableField` A `ConfigurableField` for this task.

Examples

Provides a convenient way to specify this task is a subtask of another task.

Here is an example of use:

class OtherTaskConfig(lsst.pex.config.Config)
    aSubtask = ATaskClass.makeField("a brief description of what this task does")

makeSubtask(name, **keyArgs)¶

Create a subtask as a new instance as the name attribute of this task.

Parameters:	name : `str` Brief name of the subtask. keyArgs Extra keyword arguments used to construct the task. The following arguments are automatically provided and cannot be overridden: “config”. “parentTask”.

Notes

The subtask must be defined by Task.config.name, an instance of pex_config ConfigurableField or RegistryField.

store_ccd_visit_info(exposure)¶

Store information describing the exposure for this ccd, visit.

Parameters:	exposure : `lsst.afw.image.Exposure` Exposure to store information from.

store_dia_objects(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(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` (optional) DIAObject ids that have been associated with these DIASources exposure : `lsst.afw.image.Exposure` Exposure object the DIASources were detected in.

timer(name, logLevel=10000)¶

Context manager to log performance data for an arbitrary block of code.

Parameters:	name : `str` Name of code being timed; data will be logged using item name: `Start` and `End`. logLevel A `lsst.log` level constant.

Navigation

AssociationDBSqliteTask¶