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 57 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 69 of file repoConverter.py.

    def __init__(self, instrument: str, visits: Set[int]):
        self.instrument = instrument
        self.visits = visits
        self.regions = None
        self.tracts = {}
        self.skypix = {}
 

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 76 of file repoConverter.py.

    def addSkyMap(self, registry: Registry, name: str):
        """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.
        """
        tracts = set()
        self.tracts[name] = tracts
        for visit in self.visits:
            for dataId in registry.queryDataIds(["tract"],
                                                dataId={"skymap": name,
                                                        "instrument": self.instrument,
                                                        "visit": visit}):
                tracts.add(dataId["tract"])
 

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 96 of file repoConverter.py.

    def addSkyPix(self, registry: Registry, dimension: SkyPixDimension):
        """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.
        """
        if self.regions is None:
            self.regions = []
            for visit in self.visits:
                dataId = registry.expandDataId(instrument=self.instrument, visit=visit)
                self.regions.append(dataId.region)
        ranges = RangeSet()
        for region in self.regions:
            ranges = ranges.union(dimension.pixelization.envelope(region))
        self.skypix[dimension] = ranges
 

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 117 of file repoConverter.py.

    def isRelated(self, dataId: DataCoordinate) -> bool:
        """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.
        """
        if self.visits is None:
            # We're not filtering at all.
            return True
        if "visit" in dataId.graph and dataId["visit"] not in self.visits:
            return False
        if "tract" in dataId.graph and dataId["tract"] not in self.tracts[dataId["skymap"]]:
            return False
        for dimension, ranges in self.skypix.items():
            if dimension in dataId.graph and not ranges.intersects(dataId[dimension]):
                return False
        return True
 

Member Data Documentation

instrument

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

Definition at line 70 of file repoConverter.py.

regions

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

Definition at line 72 of file repoConverter.py.

skypix

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

Definition at line 74 of file repoConverter.py.

tracts

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

Definition at line 73 of file repoConverter.py.

visits

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

Definition at line 71 of file repoConverter.py.

---

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

• /j/snowflake/release/lsstsw/stack/0.2.1/Linux64/obs_base/21.0.0-27-gbbd0d29+ae871e0f33/python/lsst/obs/base/gen2to3/repoConverter.py