lsst.meas.astrom.refit_pointing.RefitPointingTask Class Reference

Inheritance diagram for lsst.meas.astrom.refit_pointing.RefitPointingTask:

Public Member Functions
	__init__ (self, config=None, *, schema, **kwargs)
	run (self, *, catalog, camera)

Static Public Attributes
	ConfigClass = RefitPointingConfig

Protected Member Functions
	_fit_pointing (self, catalog, camera)
	_compute_pointing_residual (self, transform, from_xyz, to_xyz)
	_null_bad (self, catalog)
	_make_visit_geometry (self, boresight, orientation, catalog, camera)
tuple[np.ndarray, np.ndarray]	_make_grid (self, detector, spacing)

Protected Attributes
	_detector_pointing_residual_key
	_visit_pointing_residual_key
	_rejected_key
	_rejection_threshold = self.config.rejection_threshold * arcseconds
	_nulling_threshold = self.config.nulling_threshold * arcseconds

Static Protected Attributes
str	_DefaultName = "refitPointing"

Detailed Description

A task that uses the available WCSs of the detectors in a visit to
re-fit the pointing for that visit and compute new visit regions for the butler.

Definition at line 101 of file refit_pointing.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.astrom.refit_pointing.RefitPointingTask.__init__	(		self,
			config = None,
		*	,
			schema,
		**	kwargs )

Definition at line 109 of file refit_pointing.py.

Member Function Documentation

_compute_pointing_residual()

lsst.meas.astrom.refit_pointing.RefitPointingTask._compute_pointing_residual ( self, transform, from_xyz, to_xyz )

protected

Definition at line 312 of file refit_pointing.py.

_fit_pointing()

lsst.meas.astrom.refit_pointing.RefitPointingTask._fit_pointing ( self, catalog, camera )

protected

Fit the pointing for a visit from the detectors in that visit that
have a fitted WCS.

Parameters
----------
catalog : `lsst.afw.table.ExposureCatalog`
    A catalog of per-detector records for the visit.
camera : `lsst.afw.cameraGeom.Camera`
    Camera geometry.

Returns
-------
boresight : `lsst.geom.SpherePoint`
    New boresight location.
orientation : `lsst.geom.Angle`
    New orientation angle.

Definition at line 193 of file refit_pointing.py.

_make_grid()

tuple[np.ndarray, np.ndarray] lsst.meas.astrom.refit_pointing.RefitPointingTask._make_grid ( self, detector, spacing )

protected

Definition at line 378 of file refit_pointing.py.

_make_visit_geometry()

lsst.meas.astrom.refit_pointing.RefitPointingTask._make_visit_geometry ( self, boresight, orientation, catalog, camera )

protected

Create new sky regions for the visit and its detectors.

Parameters
----------
boresight : `lsst.geom.SpherePoint`
    New boresight location.
orientation : `lsst.geom.Angle`
    New orientation angle.
catalog : `lsst.afw.table.ExposureCatalog`
    A catalog of per-detector records for the visit with WCSs
    A repointed raw-like WCS will be used for any detectors not in the
    catalog or for which the catalog record does not have a WCS.
camera : `lsst.afw.cameraGeom.Camera`
    Camera geometry.

Returns
-------
regions : `lsst.obs.base.visit_geometry.VisitGeometry`
    Updated regions for the visit and all detectors in the camera.

Definition at line 334 of file refit_pointing.py.

_null_bad()

lsst.meas.astrom.refit_pointing.RefitPointingTask._null_bad ( self, catalog )

protected

Definition at line 323 of file refit_pointing.py.

run()

lsst.meas.astrom.refit_pointing.RefitPointingTask.run	(		self,
		*	,
			catalog,
			camera )

Re-fit the pointing from the WCSs in a visit.

Parameters
----------
catalog : `lsst.afw.table.ExposureCatalog`
    A catalog of per-detector records for the visit.  Columns with WCS
    diagnostics are updatd in-place, and WCSs may be set to `None` if
    they do not satisfy the `~RefitPointingConfig.nulling_threshold`.
camera : `lsst.afw.cameraGeom.Camera`
    Camera geometry.

Returns
-------
results : `lsst.pipe.base.Struct`
    A struct with the following attributes:

    - boresight (`lsst.geom.SpherePoint`): new boresight location
    - orientation (`lsst.geom.Angle`): new orientation angle
    - catalog (`lsst.afw.table.ExposureCatalog`): the same catalog that
      was passed in, after modification in-place.
    - regions (`lsst.obs.base.VisitGeometry`): updated regions for the
      visit and all detectors.

Raises
------
NoVisitWcs
    Raised if ``catalog`` is empty or if there are no WCSs for any
    detectors.

Definition at line 140 of file refit_pointing.py.

Member Data Documentation

_DefaultName

str lsst.meas.astrom.refit_pointing.RefitPointingTask._DefaultName = "refitPointing"

staticprotected

Definition at line 106 of file refit_pointing.py.

_detector_pointing_residual_key

lsst.meas.astrom.refit_pointing.RefitPointingTask._detector_pointing_residual_key

protected

Initial value:

=  schema.addField(
            self.config.schema_prefix + "wcs_detector_pointing_residual",
            type="Angle",
            doc=(
                "Maximum difference (on the pointing-fit grid) between the target WCS position and "
                "the position predicted by camera geometry, after re-pointing using the target WCS "
                "for this detector only."
            ),
        )

Definition at line 111 of file refit_pointing.py.

_nulling_threshold

lsst.meas.astrom.refit_pointing.RefitPointingTask._nulling_threshold = self.config.nulling_threshold * arcseconds

protected

Definition at line 138 of file refit_pointing.py.

_rejected_key

lsst.meas.astrom.refit_pointing.RefitPointingTask._rejected_key

protected

Initial value:

=  schema.addField(
            self.config.schema_prefix + "wcs_detector_pointing_rejected",
            type="Flag",
            doc=(
                "Flag set if this detector was rejected from the pointing fit due to its "
                "wcs_detector_pointing_residual value."
            ),
        )

Definition at line 129 of file refit_pointing.py.

_rejection_threshold

lsst.meas.astrom.refit_pointing.RefitPointingTask._rejection_threshold = self.config.rejection_threshold * arcseconds

protected

Definition at line 137 of file refit_pointing.py.

_visit_pointing_residual_key

lsst.meas.astrom.refit_pointing.RefitPointingTask._visit_pointing_residual_key

protected

Initial value:

=  schema.addField(
            self.config.schema_prefix + "wcs_visit_pointing_residual",
            type="Angle",
            doc=(
                "Maximum difference (on the pointing-fit grid) between the target WCS position and "
                "the position predicted by camera geometry, after re-pointing using the target WCS "
                "of all non-rejected detectors in the visit."
            ),
        )

Definition at line 120 of file refit_pointing.py.

ConfigClass

lsst.meas.astrom.refit_pointing.RefitPointingTask.ConfigClass = RefitPointingConfig

static

Definition at line 107 of file refit_pointing.py.

---

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

• python/lsst/meas/astrom/refit_pointing.py