lsst.obs.base  17.0.1-13-g3ef030a+3
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.obs.base.gen3.bootstrapRepo.BootstrapRepoTask Class Reference
Inheritance diagram for lsst.obs.base.gen3.bootstrapRepo.BootstrapRepoTask:

Public Member Functions

def __init__ (self, config=None, butler, kwds)
 
def getButler (self, collection=None)
 
def run (self, inputs)
 
def bootstrapInstrument (self, instrument)
 
def bootstrapSkyMaps (self)
 
def bootstrapRaws (self, files)
 
def computeRawSkyPixels (self)
 
def bootstrapRefCats (self, root)
 
def computeRawTracts (self, skymap)
 
def bootstrapBrightObjectMasks (self, instrument, root)
 
def bootstrapCalibrations (self, instrument, root)
 

Public Attributes

 butler
 
 skyMaps
 

Static Public Attributes

 ConfigClass = BootstrapRepoConfig
 

Detailed Description

A Task that populates a Gen3 repo with the minimum content needed to
run the DRP pipelines.

BootstrapRepoTask currently relies on Gen2 data repository information
for both bright object masks and master calibrations, but nothing else;
unlike dedicated Gen2->Gen3 conversion code, it will be updated in the
future as more pure-Gen3 approaches become available.

Like other Gen3 Tasks that are not PipelineTasks, BootstrapRepoTask does
not yet have a dedicated, general-purpose command-line driver.  At least
for now, it is instead expected that custom driver scripts will be written
for different contexts and predefined datasets.

Parameters
----------
config : `BootstrapRepoConfig`
    Configuration for the task.
butler : `lsst.daf.butler.Butler`
    Gen3 Butler defining the repository to populate.  New butlers with
    different output collections will be created as necessary from this
    butler to match the output collections defined in the configuration.
kwds
    Additional keyword arguments are forwarded to the
    `lsst.pipe.base.Task` constructor.

Definition at line 147 of file bootstrapRepo.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.gen3.bootstrapRepo.BootstrapRepoTask.__init__ (   self,
  config = None,
  butler,
  kwds 
)

Definition at line 178 of file bootstrapRepo.py.

Member Function Documentation

◆ bootstrapBrightObjectMasks()

def lsst.obs.base.gen3.bootstrapRepo.BootstrapRepoTask.bootstrapBrightObjectMasks (   self,
  instrument,
  root 
)
Ingest bright object masks from a Gen2 data repository.

This step must be run after `bootstrapRaws` if the
``filterByRawRegions`` config option is `True` for any reference
catalog, and must always be run after `bootstrapSkyMaps`.

Parameters
----------
root : `str`
    Root of the Gen2 repository containing bright object masks.
instrument : `lsst.daf.butler.instrument.Instrument`
    Instrument subclass instance; used to relate Gen2 filter
    strings to Gen3 physical_filters and abstract_filters.

Definition at line 348 of file bootstrapRepo.py.

◆ bootstrapCalibrations()

def lsst.obs.base.gen3.bootstrapRepo.BootstrapRepoTask.bootstrapCalibrations (   self,
  instrument,
  root 
)
Ingest master calibrations from a Gen2 calibration data repository.

At present, all master calibrations in the Gen2 repostory are
transferred, even those unrelated to the ingested raws.

This step must be run after `bootstrapInstrument`.

Parameters
----------
instrument : `lsst.daf.butler.instrument.Instrument`
    Instrument subclass instance for the raws and calibrations to be
    included in the initial repo.
root : `str`
    Root of the Gen2 calibration data repository.

Definition at line 381 of file bootstrapRepo.py.

◆ bootstrapInstrument()

def lsst.obs.base.gen3.bootstrapRepo.BootstrapRepoTask.bootstrapInstrument (   self,
  instrument 
)
Add an instrument, associated metadata, and human-curated
calibrations to the repository.

Parameters
----------
instrument : `lsst.daf.butler.instrument.Instrument`
    Instrument class that defines detectors, physical filters, and
    curated calibrations to ingest.

Definition at line 218 of file bootstrapRepo.py.

◆ bootstrapRaws()

def lsst.obs.base.gen3.bootstrapRepo.BootstrapRepoTask.bootstrapRaws (   self,
  files 
)
Ingest raw images.

This step must be run after `bootstrapInstrument`, but may be run
multiple times with different arguments (which may be overlapping if
the nested `RawIngestTask` is configured to ignore duplicates).

Parameters
----------
files : sequence of `str`
    The complete path names of the files to be ingested.

Definition at line 252 of file bootstrapRepo.py.

◆ bootstrapRefCats()

def lsst.obs.base.gen3.bootstrapRepo.BootstrapRepoTask.bootstrapRefCats (   self,
  root 
)
Ingest reference catalogs.

This step must be run after `bootstrapRaws` if the
``filterByRawRegions`` config option is `True` for any reference
catalog.

Parameters
----------
root : `str`
    Root of the directory containing the reference catalogs, with
    immediate subdirectories that correspond to different reference
    catalogs.

Definition at line 278 of file bootstrapRepo.py.

◆ bootstrapSkyMaps()

def lsst.obs.base.gen3.bootstrapRepo.BootstrapRepoTask.bootstrapSkyMaps (   self)
Add configured SkyMaps to the repository.

This both registers skymap dimension entries (the skymap, tract, and
patch tables, and their associated join tables) and adds a
``<something>Coadd_skyMap`` dataset.

Definition at line 233 of file bootstrapRepo.py.

◆ computeRawSkyPixels()

def lsst.obs.base.gen3.bootstrapRepo.BootstrapRepoTask.computeRawSkyPixels (   self)
Compute and return the skypix dimension entries that overlap
already-ingested visits.

Definition at line 267 of file bootstrapRepo.py.

◆ computeRawTracts()

def lsst.obs.base.gen3.bootstrapRepo.BootstrapRepoTask.computeRawTracts (   self,
  skymap 
)
Compute and return the tract dimension entries that overlap
already-ingested visits.

Definition at line 336 of file bootstrapRepo.py.

◆ getButler()

def lsst.obs.base.gen3.bootstrapRepo.BootstrapRepoTask.getButler (   self,
  collection = None 
)
Create a new butler that writes into the given collection.

Parameters
----------
collection : `str`, optional
    The new output collection.  If `None`, ``self.butler`` is returned
    directly.

Returns
-------
butler : `lsst.daf.butler.Butler`
    Butler instance pointing at the same repository as
    ``self.butler``, but possibly a different collection.

Definition at line 184 of file bootstrapRepo.py.

◆ run()

def lsst.obs.base.gen3.bootstrapRepo.BootstrapRepoTask.run (   self,
  inputs 
)
Run all steps involved in populating the new repository.

Parameters
----------
inputs : `BootstrapRepoInputs`
    Filenames and paths for the data to be ingested.

Definition at line 203 of file bootstrapRepo.py.

Member Data Documentation

◆ butler

lsst.obs.base.gen3.bootstrapRepo.BootstrapRepoTask.butler

Definition at line 180 of file bootstrapRepo.py.

◆ ConfigClass

lsst.obs.base.gen3.bootstrapRepo.BootstrapRepoTask.ConfigClass = BootstrapRepoConfig
static

Definition at line 174 of file bootstrapRepo.py.

◆ skyMaps

lsst.obs.base.gen3.bootstrapRepo.BootstrapRepoTask.skyMaps

Definition at line 182 of file bootstrapRepo.py.


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