lsst.obs.base  21.0.0-23-ga70773b+94cdb500b3
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig Class Reference
Inheritance diagram for lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig:

Public Member Functions

def transfer (self)
 
def transfer (self, value)
 
def setDefaults (self)
 

Public Attributes

 transfer
 

Static Public Attributes

 raws
 
 defineVisits
 
 skyMaps
 
 rootSkyMapName
 
 runs
 
 runsForced
 
 storageClasses
 
 formatterClasses
 
 targetHandlerClasses
 
 doRegisterInstrument
 
 refCats
 
 fileIgnorePatterns
 
 rawDatasetType
 
 datasetIncludePatterns
 
 datasetIgnorePatterns
 
 ccdKey
 
 relatedOnly
 
 doMakeUmbrellaCollection
 
 extraUmbrellaChildren
 

Detailed Description

Definition at line 236 of file convertRepo.py.

Member Function Documentation

◆ setDefaults()

def lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.setDefaults (   self)

Definition at line 386 of file convertRepo.py.

◆ transfer() [1/2]

def lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.transfer (   self)

Definition at line 379 of file convertRepo.py.

◆ transfer() [2/2]

def lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.transfer (   self,
  value 
)

Definition at line 383 of file convertRepo.py.

Member Data Documentation

◆ ccdKey

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.ccdKey
static
Initial value:
= Field(
"Key used for the Gen2 equivalent of 'detector' in data IDs.",
dtype=str,
default="ccd",
)

Definition at line 352 of file convertRepo.py.

◆ datasetIgnorePatterns

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.datasetIgnorePatterns
static
Initial value:
= ListField(
"Glob-style patterns for dataset type names that should not be "
"converted despite matching a pattern in datasetIncludePatterns.",
dtype=str,
default=[]
)

Definition at line 346 of file convertRepo.py.

◆ datasetIncludePatterns

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.datasetIncludePatterns
static
Initial value:
= ListField(
"Glob-style patterns for dataset type names that should be converted.",
dtype=str,
default=["*"]
)

Definition at line 341 of file convertRepo.py.

◆ defineVisits

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.defineVisits
static
Initial value:
= ConfigurableField(
"Configuration for the subtask responsible for defining visits from "
"exposures.",
target=DefineVisitsTask,
)

Definition at line 242 of file convertRepo.py.

◆ doMakeUmbrellaCollection

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.doMakeUmbrellaCollection
static
Initial value:
= Field(
"If True (default), define an '<instrument>/defaults' CHAINED "
"collection that includes everything found in the root repo as well "
"as the default calibration collection.",
dtype=bool,
default=True,
)

Definition at line 364 of file convertRepo.py.

◆ doRegisterInstrument

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.doRegisterInstrument
static
Initial value:
= Field(
"If True (default), add dimension records for the Instrument and its "
"filters and detectors to the registry instead of assuming they are "
"already present.",
dtype=bool,
default=True,
)

Definition at line 315 of file convertRepo.py.

◆ extraUmbrellaChildren

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.extraUmbrellaChildren
static
Initial value:
= ListField(
"Additional child collections to include in the umbrella collection. "
"Ignored if doMakeUmbrellaCollection=False.",
dtype=str,
default=[]
)

Definition at line 371 of file convertRepo.py.

◆ fileIgnorePatterns

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.fileIgnorePatterns
static
Initial value:
= ListField(
"Filename globs that should be ignored instead of being treated as "
"datasets.",
dtype=str,
default=["README.txt", "*~?", "butler.yaml", "gen3.sqlite3",
"registry.sqlite3", "calibRegistry.sqlite3", "_mapper",
"_parent", "repositoryCfg.yaml"]
)

Definition at line 328 of file convertRepo.py.

◆ formatterClasses

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.formatterClasses
static
Initial value:
= DictField(
"Mapping from dataset type name to formatter class. "
"By default these are derived from the formatters listed in the"
" Gen3 datastore configuration.",
keytype=str,
itemtype=str,
default={}
)

Definition at line 301 of file convertRepo.py.

◆ rawDatasetType

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.rawDatasetType
static
Initial value:
= Field(
"Gen2 dataset type to use for raw data.",
dtype=str,
default="raw",
)

Definition at line 336 of file convertRepo.py.

◆ raws

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.raws
static
Initial value:
= ConfigurableField(
"Configuration for subtask responsible for ingesting raws and adding "
"exposure dimension entries.",
target=RawIngestTask,
)

Definition at line 237 of file convertRepo.py.

◆ refCats

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.refCats
static
Initial value:
= ListField(
"The names of reference catalogs (subdirectories under ref_cats) to "
"be converted",
dtype=str,
default=[]
)

Definition at line 322 of file convertRepo.py.

◆ relatedOnly

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.relatedOnly
static
Initial value:
= Field(
"If True (default), only convert datasets that are related to the "
"ingested visits. Ignored unless a list of visits is passed to "
"run().",
dtype=bool,
default=False,
)

Definition at line 357 of file convertRepo.py.

◆ rootSkyMapName

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.rootSkyMapName
static
Initial value:
= Field(
"Name of a Gen3 skymap (an entry in ``self.skyMaps``) to assume for "
"datasets in the root repository when no SkyMap is found there. ",
dtype=str,
optional=True,
default=None,
)

Definition at line 255 of file convertRepo.py.

◆ runs

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.runs
static
Initial value:
= DictField(
"A mapping from dataset type name to the RUN collection they should "
"be inserted into. This must include all datasets that can be found "
"in the root repository; other repositories will use per-repository "
"runs.",
keytype=str,
itemtype=str,
default={},
)

Definition at line 262 of file convertRepo.py.

◆ runsForced

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.runsForced
static
Initial value:
= DictField(
"Like ``runs``, but is used even when the dataset is present in a "
"non-root repository (i.e. rerun), overriding the non-root "
"repository's main collection.",
keytype=str,
itemtype=str,
default={
"brightObjectMask": "masks",
}
)

Definition at line 271 of file convertRepo.py.

◆ skyMaps

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.skyMaps
static
Initial value:
= ConfigDictField(
"Mapping from Gen3 skymap name to the parameters used to construct a "
"BaseSkyMap instance. This will be used to associate names with "
"existing skymaps found in the Gen2 repo.",
keytype=str,
itemtype=ConvertRepoSkyMapConfig,
default={}
)

Definition at line 247 of file convertRepo.py.

◆ storageClasses

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.storageClasses
static
Initial value:
= DictField(
"Mapping from dataset type name or Gen2 policy entry (e.g. 'python' "
"or 'persistable') to the Gen3 StorageClass name.",
keytype=str,
itemtype=str,
default={
"bias": "ExposureF",
"dark": "ExposureF",
"flat": "ExposureF",
"defects": "Defects",
"crosstalk": "CrosstalkCalib",
"BaseSkyMap": "SkyMap",
"BaseCatalog": "Catalog",
"BackgroundList": "Background",
"raw": "Exposure",
"MultilevelParquetTable": "DataFrame",
"ParquetTable": "DataFrame",
"SkyWcs": "Wcs",
}
)

Definition at line 281 of file convertRepo.py.

◆ targetHandlerClasses

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.targetHandlerClasses
static
Initial value:
= DictField(
"Mapping from dataset type name to target handler class.",
keytype=str,
itemtype=str,
default={}
)

Definition at line 309 of file convertRepo.py.

◆ transfer

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.transfer

Definition at line 387 of file convertRepo.py.


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