lsst.pipe.tasks.multiBandUtils Namespace Reference

Classes
class	CullPeaksConfig
	Configuration for culling garbage peaks after merging footprints. More...
class	MergeSourcesRunner

Functions
def	makeMergeArgumentParser (name, dataset)
	Create a suitable ArgumentParser. More...
def	getInputSchema (task, butler=None, schema=None)
	Obtain the input schema either directly or froma butler reference. More...
def	getShortFilterName (name)
def	readCatalog (task, patchRef)
	Read input catalog. More...

Function Documentation

getInputSchema()

def lsst.pipe.tasks.multiBandUtils.getInputSchema	(		task,
			butler = None,
			schema = None
	)

Obtain the input schema either directly or froma butler reference.

Parameters

[in]	butler	butler reference to obtain the input schema from
[in]	schema	the input schema

Definition at line 127 of file multiBandUtils.py.

def getInputSchema(task, butler=None, schema=None):
    """!
    @brief Obtain the input schema either directly or froma  butler reference.
 
    @param[in]  butler   butler reference to obtain the input schema from
    @param[in]  schema   the input schema
    """
    if schema is None:
        assert butler is not None, "Neither butler nor schema specified"
        schema = butler.get(task.config.coaddName + "Coadd_" + task.inputDataset + "_schema",
                            immediate=True).schema
    return schema
 
 

getShortFilterName()

def lsst.pipe.tasks.multiBandUtils.getShortFilterName

(

name

)

Given a longer, camera-specific filter name (e.g. "HSC-I") return its shorthand name ("i").

Definition at line 141 of file multiBandUtils.py.

def getShortFilterName(name):
    """Given a longer, camera-specific filter name (e.g. "HSC-I") return its shorthand name ("i").
    """
    # I'm not sure if this is the way this is supposed to be implemented, but it seems to work,
    # and its the only way I could get it to work.
    try:
        return afwImage.Filter(name).getFilterProperty().getName()
    except pexExceptions.NotFoundError:
        # No mapping could be found, try proceeding with given name
        return name
 
 

makeMergeArgumentParser()

def lsst.pipe.tasks.multiBandUtils.makeMergeArgumentParser	(		name,
			dataset
	)

Create a suitable ArgumentParser.

We will use the ArgumentParser to get a provide a list of data references for patches; the RunnerClass will sort them into lists of data references for the same patch

Definition at line 112 of file multiBandUtils.py.

def makeMergeArgumentParser(name, dataset):
    """!
    @brief Create a suitable ArgumentParser.
 
    We will use the ArgumentParser to get a provide a list of data
    references for patches; the RunnerClass will sort them into lists
    of data references for the same patch
    """
    parser = ArgumentParser(name)
    parser.add_id_argument("--id", "deepCoadd_" + dataset,
                           ContainerClass=ExistingCoaddDataIdContainer,
                           help="data ID, e.g. --id tract=12345 patch=1,2 filter=g^r^i")
    return parser
 
 

readCatalog()

def lsst.pipe.tasks.multiBandUtils.readCatalog	(		task,
			patchRef
	)

Read input catalog.

We read the input dataset provided by the 'inputDataset' class variable.

Parameters

[in]

patchRef

data reference for patch

Returns

tuple consisting of the filter name and the catalog

Definition at line 153 of file multiBandUtils.py.

def readCatalog(task, patchRef):
    """!
    @brief Read input catalog.
 
    We read the input dataset provided by the 'inputDataset'
    class variable.
 
    @param[in]  patchRef   data reference for patch
    @return tuple consisting of the filter name and the catalog
    """
    filterName = patchRef.dataId["filter"]
    catalog = patchRef.get(task.config.coaddName + "Coadd_" + task.inputDataset, immediate=True)
    task.log.info("Read %d sources for filter %s: %s" % (len(catalog), filterName, patchRef.dataId))
    return filterName, catalog