lsst.obs.base  20.0.0-21-g52834e7+2
Public Member Functions | Public Attributes | List of all members
lsst.obs.base.gen2to3.repoConverter.ConversionSubset Class Reference

Public Member Functions

def __init__ (self, str instrument, Set[int] visits)
 
def addSkyMap (self, Registry registry, str name)
 
def addSkyPix (self, Registry registry, SkyPixDimension dimension)
 
bool isRelated (self, DataCoordinate dataId)
 

Public Attributes

 instrument
 
 visits
 
 regions
 
 tracts
 
 skypix
 

Detailed Description

A helper class for `ConvertRepoTask` and `RepoConverter` that maintains
lists of related data ID values that should be included in the conversion.

Parameters
----------
instrument : `str`
    Instrument name used in Gen3 data IDs.
visits : `set` of `int`
    Visit IDs that define the filter.

Definition at line 56 of file repoConverter.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.gen2to3.repoConverter.ConversionSubset.__init__ (   self,
str  instrument,
Set[int]  visits 
)

Definition at line 68 of file repoConverter.py.

Member Function Documentation

◆ addSkyMap()

def lsst.obs.base.gen2to3.repoConverter.ConversionSubset.addSkyMap (   self,
Registry  registry,
str  name 
)
Populate the included tract IDs for the given skymap from those that
overlap the visits the `ConversionSubset` was initialized with.

Parameters
----------
registry : `lsst.daf.butler.Registry`
    Registry that can be queried for visit/tract overlaps.
name : `str`
    SkyMap name used in Gen3 data IDs.

Definition at line 75 of file repoConverter.py.

◆ addSkyPix()

def lsst.obs.base.gen2to3.repoConverter.ConversionSubset.addSkyPix (   self,
Registry  registry,
SkyPixDimension  dimension 
)
Populate the included skypix IDs for the given dimension from those
that overlap the visits the `ConversionSubset` was initialized with.

Parameters
----------
registry : `lsst.daf.butler.Registry`
    Registry that can be queried for visit regions.
name : `str`
    SkyMap name used in Gen3 data IDs.

Definition at line 95 of file repoConverter.py.

◆ isRelated()

bool lsst.obs.base.gen2to3.repoConverter.ConversionSubset.isRelated (   self,
DataCoordinate  dataId 
)
Test whether the given data ID is related to this subset and hence
should be included in a repository conversion.

Parameters
----------
dataId : `lsst.daf.butler.DataCoordinate`
    Data ID to test.

Returns
-------
related : `bool`
    `True` if this data ID should be included in a repository
    conversion.

Notes
-----
More formally, this tests that the given data ID is not unrelated;
if a data ID does not involve tracts, visits, or skypix dimensions,
we always include it.

Definition at line 116 of file repoConverter.py.

Member Data Documentation

◆ instrument

lsst.obs.base.gen2to3.repoConverter.ConversionSubset.instrument

Definition at line 69 of file repoConverter.py.

◆ regions

lsst.obs.base.gen2to3.repoConverter.ConversionSubset.regions

Definition at line 71 of file repoConverter.py.

◆ skypix

lsst.obs.base.gen2to3.repoConverter.ConversionSubset.skypix

Definition at line 73 of file repoConverter.py.

◆ tracts

lsst.obs.base.gen2to3.repoConverter.ConversionSubset.tracts

Definition at line 72 of file repoConverter.py.

◆ visits

lsst.obs.base.gen2to3.repoConverter.ConversionSubset.visits

Definition at line 70 of file repoConverter.py.


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