Inheritance diagram for lsst.meas.algorithms.starSelector.BaseStarSelectorTask:

Public Member Functions
	__init__ (self, schema, **kwds)

	run (self, exposure, sourceCat, matches=None, isStarField=None)

	selectStars (self, exposure, sourceCat, matches=None)

Static Public Attributes
bool	usesMatches = False

	ConfigClass = BaseStarSelectorConfig

Static Protected Attributes
str	_DefaultName = "starSelector"

Detailed Description

Base class for star selectors

Register all star selectors with the starSelectorRegistry using:
    starSelectorRegistry.register(name, class)

Definition at line 47 of file starSelector.py.

Constructor & Destructor Documentation

◆ init()

lsst.meas.algorithms.starSelector.BaseStarSelectorTask.__init__	(		self,
			schema,
		**	kwds )

Definition at line 58 of file starSelector.py.

    def __init__(self, schema, **kwds):
        # catch code that passed config positionally before schema argument was added
        assert isinstance(schema, Schema)
        pipeBase.Task.__init__(self, **kwds)
 

Member Function Documentation

◆ run()

lsst.meas.algorithms.starSelector.BaseStarSelectorTask.run	(	self,
		exposure,
		sourceCat,
		matches = None,
		isStarField = None )

Select stars and set a flag field True for stars in the input catalog.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    the exposure containing the sources
sourceCat : `lsst.afw.table.SourceCatalog`
    catalog of sources that may be stars
matches : `lsst.afw.table.ReferenceMatchVector` or None
    astrometric matches; ignored by this star selector. Some star selectors
    will ignore this argument, others may require it. See the
    usesMatches class variable.
isStarField : `str`
    name of flag field to set True for stars, or None to not set a field;
    the field is left unchanged for non-stars

Returns
-------
struct : `lsst.pipe.base.Struct`
Result struct containing:

    - starCat  catalog of stars that were selected as stars and successfuly made into PSF candidates
                (a subset of sourceCat whose records are shallow copies)

Definition at line 63 of file starSelector.py.

    def run(self, exposure, sourceCat, matches=None, isStarField=None):
        """Select stars and set a flag field True for stars in the input catalog.
 
        Parameters
        ----------
        exposure : `lsst.afw.image.Exposure`
            the exposure containing the sources
        sourceCat : `lsst.afw.table.SourceCatalog`
            catalog of sources that may be stars
        matches : `lsst.afw.table.ReferenceMatchVector` or None
            astrometric matches; ignored by this star selector. Some star selectors
            will ignore this argument, others may require it. See the
            usesMatches class variable.
        isStarField : `str`
            name of flag field to set True for stars, or None to not set a field;
            the field is left unchanged for non-stars
 
        Returns
        -------
        struct : `lsst.pipe.base.Struct`
        Result struct containing:
 
            - starCat  catalog of stars that were selected as stars and successfuly made into PSF candidates
                        (a subset of sourceCat whose records are shallow copies)
        """
        result = self.selectStars(exposure=exposure, sourceCat=sourceCat, matches=matches)
 
        if isStarField is not None:
            isStarKey = sourceCat.schema[isStarField].asKey()
            for star in result.starCat:
                star.set(isStarKey, True)
 
        return pipeBase.Struct(starCat=result.starCat)
 

◆ selectStars()

lsst.meas.algorithms.starSelector.BaseStarSelectorTask.selectStars	(	self,
		exposure,
		sourceCat,
		matches = None )

Return a catalog of stars: a subset of sourceCat whose records are shallow copies

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    The exposure containing the sources.
sourceCat : `lsst.afw.table.SourceCatalog`
    Catalog of sources that may be stars.
matches : `lsst.afw.table.ReferenceMatchVector` or None
    astrometric matches; ignored by this star selector. Some star selectors
    will ignore this argument, others may require it. See the usesMatches class variable.

Returns
-------
struct : `lsst.pipe.base.Struct`
    Result `~lsst.pipe.base.Struct` containing:

    ``starCat``
        Catalog of stars that were selected as stars and successfuly made into PSF candidates
        (a subset of sourceCat whose records are shallow copies).
        (`lsst.afw.table.SourceCatalog`)

Notes
-----
Warning: The returned catalog must have records that are shallow copies
(fortunately this is the default behavior when you add a record from one catalog to another);
otherwise the run method cannot set the isStarField flag in the original source catalog.

Definition at line 98 of file starSelector.py.

    def selectStars(self, exposure, sourceCat, matches=None):
        """Return a catalog of stars: a subset of sourceCat whose records are shallow copies
 
        Parameters
        ----------
        exposure : `lsst.afw.image.Exposure`
            The exposure containing the sources.
        sourceCat : `lsst.afw.table.SourceCatalog`
            Catalog of sources that may be stars.
        matches : `lsst.afw.table.ReferenceMatchVector` or None
            astrometric matches; ignored by this star selector. Some star selectors
            will ignore this argument, others may require it. See the usesMatches class variable.
 
        Returns
        -------
        struct : `lsst.pipe.base.Struct`
            Result `~lsst.pipe.base.Struct` containing:
 
            ``starCat``
                Catalog of stars that were selected as stars and successfuly made into PSF candidates
                (a subset of sourceCat whose records are shallow copies).
                (`lsst.afw.table.SourceCatalog`)
 
        Notes
        -----
        Warning: The returned catalog must have records that are shallow copies
        (fortunately this is the default behavior when you add a record from one catalog to another);
        otherwise the run method cannot set the isStarField flag in the original source catalog.
        """
        raise NotImplementedError("BaseStarSelectorTask is abstract, subclasses must override this method")
 
 

Member Data Documentation

◆ _DefaultName

str lsst.meas.algorithms.starSelector.BaseStarSelectorTask._DefaultName = "starSelector"

staticprotected

Definition at line 56 of file starSelector.py.

◆ ConfigClass

lsst.meas.algorithms.starSelector.BaseStarSelectorTask.ConfigClass = BaseStarSelectorConfig

static

Definition at line 55 of file starSelector.py.

◆ usesMatches

bool lsst.meas.algorithms.starSelector.BaseStarSelectorTask.usesMatches = False

static

Definition at line 54 of file starSelector.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_algorithms/ge6526c86ff+0d71447b4b/python/lsst/meas/algorithms/starSelector.py

Public Member Functions

Static Public Attributes

Static Protected Attributes