lsst.pipe.tasks.script.registerDcrSubfilters.InsertResults Class Reference

Classes
class	InsertedSubfilters

Public Member Functions
	__init__ (self)
	add (self, filterName, subfilter, inserted)
	__str__ (self)

Public Attributes
	filters

Detailed Description

Represents the results of adding subfilters to a filter band.

Definition at line 38 of file registerDcrSubfilters.py.

Constructor & Destructor Documentation

__init__()

lsst.pipe.tasks.script.registerDcrSubfilters.InsertResults.__init__

(

self

)

Definition at line 55 of file registerDcrSubfilters.py.

    def __init__(self):
        self.filters = defaultdict(self.InsertedSubfilters)
 

Member Function Documentation

__str__()

lsst.pipe.tasks.script.registerDcrSubfilters.InsertResults.__str__

(

self

)

Get the results formated for CLI output.

Returns
-------
results : `str`
    The results formatted for CLI output.

Definition at line 77 of file registerDcrSubfilters.py.

    def __str__(self):
        """Get the results formated for CLI output.
 
        Returns
        -------
        results : `str`
            The results formatted for CLI output.
        """
        ret = ""
        for filterName, subs in self.filters.items():
            if ret:
                ret += "\n"
            if subs.inserted:
                ret += registeredMsg.format(band=filterName, subfilters=subs.inserted)
            if subs.existing:
                subs.existing.sort()
                ret += notRegisteredMsg.format(band=filterName, subfilters=subs.existing)
        return ret
 
 

add()

lsst.pipe.tasks.script.registerDcrSubfilters.InsertResults.add	(		self,
			filterName,
			subfilter,
			inserted )

Add result information about attemping to add a subfilter to a
filter band.

Parameters
----------
filterName : `str`
    The name of the filter band.
subfilter : `int`
    The subfilter id.
inserted : `bool`
    `True` if the subfilter was inserted, or `False` if this is the id
    of a subfilter that already existed.

Definition at line 58 of file registerDcrSubfilters.py.

    def add(self, filterName, subfilter, inserted):
        """Add result information about attemping to add a subfilter to a
        filter band.
 
        Parameters
        ----------
        filterName : `str`
            The name of the filter band.
        subfilter : `int`
            The subfilter id.
        inserted : `bool`
            `True` if the subfilter was inserted, or `False` if this is the id
            of a subfilter that already existed.
        """
        if inserted:
            self.filters[filterName].inserted.append(subfilter)
        else:
            self.filters[filterName].existing.append(subfilter)
 

Member Data Documentation

filters

lsst.pipe.tasks.script.registerDcrSubfilters.InsertResults.filters

Definition at line 56 of file registerDcrSubfilters.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/gc07e1c2157+a98bf949bb/python/lsst/pipe/tasks/script/registerDcrSubfilters.py