lsst.pipe.tasks.script.registerDcrSubfilters Namespace Reference

Classes
class	InsertResults

Functions
def	registerDcrSubfilters (repo, num_subfilters, band_names)

Variables
string	registeredMsg = "Registered subfilters {subfilters} for filter band \"{band}\"."
	notRegisteredMsg = \

Function Documentation

registerDcrSubfilters()

def lsst.pipe.tasks.script.registerDcrSubfilters.registerDcrSubfilters	(		repo,
			num_subfilters,
			band_names
	)

Construct a set of subfilters for chromatic modeling and add them to a
registry.

Parameters
----------
repo : `str`
    URI to the location to read the repo.
num_subfilters : `int`
    The number of subfilters to add.
band_names : `list` [`str`]
    The filter band names to add.

Returns
-------
insertResults : ``InsertResults``
    A class that contains the results of the subfilters that were inserted
    or already exist in each filter band, that has a __str__ method so it
    can be easily printed to the CLI output.

Definition at line 97 of file registerDcrSubfilters.py.

def registerDcrSubfilters(repo, num_subfilters, band_names):
    """Construct a set of subfilters for chromatic modeling and add them to a
    registry.
 
    Parameters
    ----------
    repo : `str`
        URI to the location to read the repo.
    num_subfilters : `int`
        The number of subfilters to add.
    band_names : `list` [`str`]
        The filter band names to add.
 
    Returns
    -------
    insertResults : ``InsertResults``
        A class that contains the results of the subfilters that were inserted
        or already exist in each filter band, that has a __str__ method so it
        can be easily printed to the CLI output.
    """
    butler = Butler(repo, writeable=True)
    results = InsertResults()
    for filterName in band_names:
        try:
            with butler.registry.transaction():
                for sub in range(num_subfilters):
                    butler.registry.insertDimensionData("subfilter", {"band": filterName, "subfilter": sub})
                    results.add(filterName, sub, True)
        except IntegrityError:
            records = butler.registry.queryDimensionRecords("subfilter", dataId={"band": filterName})
            for record in records:
                results.add(filterName, record.id, False)
 
    return results

Variable Documentation

notRegisteredMsg

lsst.pipe.tasks.script.registerDcrSubfilters.notRegisteredMsg = \

Definition at line 34 of file registerDcrSubfilters.py.

registeredMsg

string lsst.pipe.tasks.script.registerDcrSubfilters.registeredMsg = "Registered subfilters {subfilters} for filter band \"{band}\"."

Definition at line 33 of file registerDcrSubfilters.py.