lsst.cp.pipe
20.0.0-1-g32a200e+2
|
Classes | |
class | NonexistentDatasetTaskDataIdContainer |
class | PairedVisitListTaskRunner |
class | SingleVisitListTaskRunner |
Functions | |
def | countMaskedPixels (maskedIm, maskPlane) |
def | parseCmdlineNumberString (inputString) |
def | checkExpLengthEqual (exp1, exp2, v1=None, v2=None, raiseWithMessage=False) |
def | validateIsrConfig (isrTask, mandatory=None, forbidden=None, desirable=None, undesirable=None, checkTrim=True, logName=None) |
def lsst.cp.pipe.utils.checkExpLengthEqual | ( | exp1, | |
exp2, | |||
v1 = None , |
|||
v2 = None , |
|||
raiseWithMessage = False |
|||
) |
Check the exposure lengths of two exposures are equal. Parameters: ----------- exp1 : `lsst.afw.image.exposure.ExposureF` First exposure to check exp2 : `lsst.afw.image.exposure.ExposureF` Second exposure to check v1 : `int` or `str`, optional First visit of the visit pair v2 : `int` or `str`, optional Second visit of the visit pair raiseWithMessage : `bool` If True, instead of returning a bool, raise a RuntimeError if exposure times are not equal, with a message about which visits mismatch if the information is available. Raises: ------- RuntimeError Raised if the exposure lengths of the two exposures are not equal
def lsst.cp.pipe.utils.countMaskedPixels | ( | maskedIm, | |
maskPlane | |||
) |
def lsst.cp.pipe.utils.parseCmdlineNumberString | ( | inputString | ) |
def lsst.cp.pipe.utils.validateIsrConfig | ( | isrTask, | |
mandatory = None , |
|||
forbidden = None , |
|||
desirable = None , |
|||
undesirable = None , |
|||
checkTrim = True , |
|||
logName = None |
|||
) |
Check that appropriate ISR settings have been selected for the task. Note that this checks that the task itself is configured correctly rather than checking a config. Parameters ---------- isrTask : `lsst.ip.isr.IsrTask` The task whose config is to be validated mandatory : `iterable` of `str` isr steps that must be set to True. Raises if False or missing forbidden : `iterable` of `str` isr steps that must be set to False. Raises if True, warns if missing desirable : `iterable` of `str` isr steps that should probably be set to True. Warns is False, info if missing undesirable : `iterable` of `str` isr steps that should probably be set to False. Warns is True, info if missing checkTrim : `bool` Check to ensure the isrTask's assembly subtask is trimming the images. This is a separate config as it is very ugly to do this within the normal configuration lists as it is an option of a sub task. Raises ------ RuntimeError Raised if ``mandatory`` config parameters are False, or if ``forbidden`` parameters are True. TypeError Raised if parameter ``isrTask`` is an invalid type. Notes ----- Logs warnings using an isrValidation logger for desirable/undesirable options that are of the wrong polarity or if keys are missing.