LSSTApplications  20.0.0
LSSTDataManagementBasePackage
Classes | Functions | Variables
lsst.dax.apdb.apdbSchema Namespace Reference

Classes

class  ApdbSchema
 

Functions

def make_minimal_dia_object_schema ()
 
def make_minimal_dia_source_schema ()
 

Variables

 ColumnDef = namedtuple('ColumnDef', 'name type nullable default description unit ucd')
 
 IndexDef = namedtuple('IndexDef', 'name type columns')
 
 TableDef = namedtuple('TableDef', 'name description columns indices')
 

Function Documentation

◆ make_minimal_dia_object_schema()

def lsst.dax.apdb.apdbSchema.make_minimal_dia_object_schema ( )
Define and create the minimal schema required for a DIAObject.

Returns
-------
schema : `lsst.afw.table.Schema`
    Minimal schema for DIAObjects.

Definition at line 69 of file apdbSchema.py.

70  """Define and create the minimal schema required for a DIAObject.
71 
72  Returns
73  -------
74  schema : `lsst.afw.table.Schema`
75  Minimal schema for DIAObjects.
76  """
77  schema = afwTable.SourceTable.makeMinimalSchema()
78  schema.addField("pixelId", type='L',
79  doc='Unique spherical pixelization identifier.')
80  schema.addField("nDiaSources", type='L')
81  return schema
82 
83 

◆ make_minimal_dia_source_schema()

def lsst.dax.apdb.apdbSchema.make_minimal_dia_source_schema ( )
Define and create the minimal schema required for a DIASource.

Returns
-------
schema : `lsst.afw.table.Schema`
    Minimal schema for DIASources.

Definition at line 84 of file apdbSchema.py.

85  """ Define and create the minimal schema required for a DIASource.
86 
87  Returns
88  -------
89  schema : `lsst.afw.table.Schema`
90  Minimal schema for DIASources.
91  """
92  schema = afwTable.SourceTable.makeMinimalSchema()
93  schema.addField("diaObjectId", type='L',
94  doc='Unique identifier of the DIAObject this source is '
95  'associated to.')
96  schema.addField("ccdVisitId", type='L',
97  doc='Id of the exposure and ccd this object was detected '
98  'in.')
99  schema.addField("psFlux", type='D',
100  doc='Calibrated PSF flux of this source.')
101  schema.addField("psFluxErr", type='D',
102  doc='Calibrated PSF flux err of this source.')
103  schema.addField("flags", type='L',
104  doc='Quality flags for this DIASource.')
105  schema.addField("pixelId", type='L',
106  doc='Unique spherical pixelization identifier.')
107  return schema
108 
109 
110 @compiles(CreateTable, "oracle")

Variable Documentation

◆ ColumnDef

lsst.dax.apdb.apdbSchema.ColumnDef = namedtuple('ColumnDef', 'name type nullable default description unit ucd')

Definition at line 53 of file apdbSchema.py.

◆ IndexDef

lsst.dax.apdb.apdbSchema.IndexDef = namedtuple('IndexDef', 'name type columns')

Definition at line 59 of file apdbSchema.py.

◆ TableDef

lsst.dax.apdb.apdbSchema.TableDef = namedtuple('TableDef', 'name description columns indices')

Definition at line 66 of file apdbSchema.py.

lsst.dax.apdb.apdbSchema.make_minimal_dia_object_schema
def make_minimal_dia_object_schema()
Definition: apdbSchema.py:69
lsst.dax.apdb.apdbSchema.make_minimal_dia_source_schema
def make_minimal_dia_source_schema()
Definition: apdbSchema.py:84