LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.base.forcedMeasurement.ForcedPlugin Class Reference
Inheritance diagram for lsst.meas.base.forcedMeasurement.ForcedPlugin:

Public Member Functions

def __init__
 
def measure
 
def measureN
 

Static Public Attributes

tuple registry = PluginRegistry(ForcedPluginConfig)
 
 ConfigClass = ForcedPluginConfig
 

Detailed Description

Definition at line 64 of file forcedMeasurement.py.

Constructor & Destructor Documentation

def lsst.meas.base.forcedMeasurement.ForcedPlugin.__init__ (   self,
  config,
  name,
  schemaMapper,
  metadata 
) 
Initialize the measurement object.

@param[in]  config       An instance of this class's ConfigClass.
@param[in]  name         The string the plugin was registered with.
@param[in,out]  schemaMapper  A SchemaMapper that maps reference catalog fields to output
                      catalog fields.  Output fields should be added to the
                      output schema.  While most plugins will not need to map
                      fields from the reference schema, if they do so, those fields
                      will be transferred before any plugins are run.
@param[in]  metadata     Plugin metadata that will be attached to the output catalog

Definition at line 71 of file forcedMeasurement.py.

71 
72  def __init__(self, config, name, schemaMapper, metadata):
73  """Initialize the measurement object.
74 
75  @param[in] config An instance of this class's ConfigClass.
76  @param[in] name The string the plugin was registered with.
77  @param[in,out] schemaMapper A SchemaMapper that maps reference catalog fields to output
78  catalog fields. Output fields should be added to the
79  output schema. While most plugins will not need to map
80  fields from the reference schema, if they do so, those fields
81  will be transferred before any plugins are run.
82  @param[in] metadata Plugin metadata that will be attached to the output catalog
83  """
84  BasePlugin.__init__(self, config, name)

Member Function Documentation

def lsst.meas.base.forcedMeasurement.ForcedPlugin.measure (   self,
  measRecord,
  exposure,
  refRecord,
  refWcs 
) 
Measure the properties of a source on a single image, given data from a
reference record.

@param[in] exposure       lsst.afw.image.ExposureF, containing the pixel data to
                  be measured and the associated Psf, Wcs, etc.  All
                  other sources in the image will have been replaced by
                  noise according to deblender outputs.
@param[in,out] measRecord lsst.afw.table.SourceRecord to be filled with outputs,
                  and from which previously-measured quantities can be
                  retreived.
@param[in] refRecord      lsst.afw.table.SimpleRecord that contains additional
                  parameters to define the fit, as measured elsewhere.
@param[in] refWcs         The coordinate system for the reference catalog values.
                  An afw.geom.Angle may be passed, indicating that a
                  local tangent Wcs should be created for each object
                  using afw.image.makeLocalWcs and the given angle as
                  a pixel scale.

In the normal mode of operation, the source centroid will be set to the
WCS-transformed position of the reference object, so plugins that only
require a reference position should not have to access the reference object
at all.

Definition at line 85 of file forcedMeasurement.py.

85 
86  def measure(self, measRecord, exposure, refRecord, refWcs):
87  """Measure the properties of a source on a single image, given data from a
88  reference record.
89 
90  @param[in] exposure lsst.afw.image.ExposureF, containing the pixel data to
91  be measured and the associated Psf, Wcs, etc. All
92  other sources in the image will have been replaced by
93  noise according to deblender outputs.
94  @param[in,out] measRecord lsst.afw.table.SourceRecord to be filled with outputs,
95  and from which previously-measured quantities can be
96  retreived.
97  @param[in] refRecord lsst.afw.table.SimpleRecord that contains additional
98  parameters to define the fit, as measured elsewhere.
99  @param[in] refWcs The coordinate system for the reference catalog values.
100  An afw.geom.Angle may be passed, indicating that a
101  local tangent Wcs should be created for each object
102  using afw.image.makeLocalWcs and the given angle as
103  a pixel scale.
104 
105  In the normal mode of operation, the source centroid will be set to the
106  WCS-transformed position of the reference object, so plugins that only
107  require a reference position should not have to access the reference object
108  at all.
109  """
110  raise NotImplementedError()
def lsst.meas.base.forcedMeasurement.ForcedPlugin.measureN (   self,
  measCat,
  exposure,
  refCat,
  refWcs 
) 
Measure the properties of a group of blended sources on a single image,
given data from a reference record.

@param[in] exposure      lsst.afw.image.ExposureF, containing the pixel data to
                 be measured and the associated Psf, Wcs, etc.  Sources
                 not in the blended hierarchy to be measured will have
                 been replaced with noise using deblender outputs.
@param[in,out] measCat   lsst.afw.table.SourceCatalog to be filled with outputs,
                 and from which previously-measured quantities can be
                 retrieved, containing only the sources that should be
                 measured together in this call.
@param[in] refCat        lsst.afw.table.SimpleCatalog that contains additional
                 parameters to define the fit, as measured elsewhere.
                 Ordered such that zip(sources, references) may be used.
@param[in] refWcs        The coordinate system for the reference catalog values.
                 An afw.geom.Angle may be passed, indicating that a
                 local tangent Wcs should be created for each object
                 using afw.image.makeLocalWcs and the given Angle as
                 a pixel scale.

In the normal mode of operation, the source centroids will be set to the
WCS-transformed position of the reference object, so plugins that only
require a reference position should not have to access the reference object
at all.

Definition at line 111 of file forcedMeasurement.py.

111 
112  def measureN(self, measCat, exposure, refCat, refWcs):
113  """Measure the properties of a group of blended sources on a single image,
114  given data from a reference record.
115 
116  @param[in] exposure lsst.afw.image.ExposureF, containing the pixel data to
117  be measured and the associated Psf, Wcs, etc. Sources
118  not in the blended hierarchy to be measured will have
119  been replaced with noise using deblender outputs.
120  @param[in,out] measCat lsst.afw.table.SourceCatalog to be filled with outputs,
121  and from which previously-measured quantities can be
122  retrieved, containing only the sources that should be
123  measured together in this call.
124  @param[in] refCat lsst.afw.table.SimpleCatalog that contains additional
125  parameters to define the fit, as measured elsewhere.
126  Ordered such that zip(sources, references) may be used.
127  @param[in] refWcs The coordinate system for the reference catalog values.
128  An afw.geom.Angle may be passed, indicating that a
129  local tangent Wcs should be created for each object
130  using afw.image.makeLocalWcs and the given Angle as
131  a pixel scale.
132 
133  In the normal mode of operation, the source centroids will be set to the
134  WCS-transformed position of the reference object, so plugins that only
135  require a reference position should not have to access the reference object
136  at all.
137  """
138  raise NotImplementedError()

Member Data Documentation

lsst.meas.base.forcedMeasurement.ForcedPlugin.ConfigClass = ForcedPluginConfig
static

Definition at line 69 of file forcedMeasurement.py.

tuple lsst.meas.base.forcedMeasurement.ForcedPlugin.registry = PluginRegistry(ForcedPluginConfig)
static

Definition at line 67 of file forcedMeasurement.py.

The documentation for this class was generated from the following file:
Generated on Thu Sep 24 2015 02:29:40 for LSSTApplications by   doxygen 1.8.5