lsst.obs.base  19.0.0-8-g608b899+3
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 instrument (self)
 
def instrument (self, value)
 
def setDefaults (self)
 

Public Attributes

 transfer
 

Static Public Attributes

 raws
 
 skyMaps
 
 collections
 
 storageClasses
 
 doRegisterInstrument
 
 doWriteCuratedCalibrations
 
 refCats
 
 fileIgnorePatterns
 
 datasetIncludePatterns
 
 datasetIgnorePatterns
 
 ccdKey
 
 relatedOnly
 

Detailed Description

Definition at line 93 of file convertRepo.py.

Member Function Documentation

◆ instrument() [1/2]

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

Definition at line 191 of file convertRepo.py.

◆ instrument() [2/2]

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

Definition at line 195 of file convertRepo.py.

◆ setDefaults()

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

Definition at line 198 of file convertRepo.py.

◆ transfer() [1/2]

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

Definition at line 183 of file convertRepo.py.

◆ transfer() [2/2]

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

Definition at line 187 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 169 of file convertRepo.py.

◆ collections

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.collections
static
Initial value:
= DictField(
"Special collections (values) for certain dataset types (keys). "
"These are used in addition to rerun collections for datasets in "
"reruns. The 'raw' dataset must have an entry here if it is to be "
"converted.",
keytype=str,
itemtype=str,
default={
"deepCoadd_skyMap": "skymaps",
"brightObjectMask": "masks",
}
)

Definition at line 107 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 163 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 158 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 132 of file convertRepo.py.

◆ doWriteCuratedCalibrations

lsst.obs.base.gen2to3.convertRepo.ConvertRepoConfig.doWriteCuratedCalibrations
static
Initial value:
= Field(
"If True (default), ingest human-curated calibrations directly via "
"the Instrument interface. Note that these calibrations are never "
"converted from Gen2 repositories.",
dtype=bool,
default=True,
)

Definition at line 139 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"]
)

Definition at line 152 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 "
"visit and exposure dimension entries.",
target=RawIngestTask,
)

Definition at line 94 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 146 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 174 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 associated names with "
"existing skymaps found in the Gen2 repo.",
keytype=str,
itemtype=ConvertRepoSkyMapConfig,
default={}
)

Definition at line 99 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={
"BaseSkyMap": "SkyMap",
"BaseCatalog": "Catalog",
"BackgroundList": "Background",
"raw": "Exposure",
"MultilevelParquetTable": "DataFrame",
}
)

Definition at line 119 of file convertRepo.py.

◆ transfer

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

Definition at line 199 of file convertRepo.py.


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