InitInputDatasetField

lsst.pipe.base.InitInputDatasetField(doc, name, storageClass, check=None)

Factory function to create Config class instances of InitInputDatasetConfig

This function servers as syntactic sugar for creating Configurable fields which are InitInputDatasetConfig. The naming of this function violates the normal convention of a lowercase first letter in the function name, as this function is intended to sit in the same place as ConfigField classes, and consistency in declaration syntax is important.

The input arguments for this class are a combination of the arguments for ConfigField and InitInputDatasetConfig. The arguments doc and check come from ConfigField, while name and storageClass come from InitInputDatasetConfig.

Parameters:

doc : str

Documentation string for the InitInputDatasetConfig

name : str

Name of the DatasetType in the returned InitInputDatasetConfig

storageClass : str

Name of the StorageClass in the InitInputDatasetConfig

check : callable

A callable to be called with the field value that returns False if the value is invalid.

Returns:

result : ConfigField

Instance of a ConfigField with InputDatasetConfig as a dtype