Skip to content

Commit

Permalink
Merge pull request #203 from lsst/tickets/DM-21855
Browse files Browse the repository at this point in the history 
DM-21855: Move daf.butler.instrument to obs_base
  • Loading branch information
@parejkoj
parejkoj committed Nov 9, 2019
2 parents 489d7af + 586b8fe commit 4bec85e
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 410 deletions.
220 changes: 1 addition & 219 deletions python/lsst/daf/butler/instrument.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,132 +19,11 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.

__all__ = ("Instrument", "makeExposureRecordFromObsInfo", "makeVisitRecordFromObsInfo",
"ObservationDimensionPacker", "addUnboundedCalibrationLabel")
__all__ = ["ObservationDimensionPacker"]

import os.path
from datetime import datetime
from abc import ABCMeta, abstractmethod
from lsst.daf.butler import DataCoordinate, DimensionPacker


# TODO: all code in this module probably needs to be moved to a higher-level
# package (perhaps obs_base), but it is needed by the gen2convert subpackage.
# We should probably move that as well.


class Instrument(metaclass=ABCMeta):
"""Base class for instrument-specific logic for the Gen3 Butler.
Concrete instrument subclasses should be directly constructable with no
arguments.
"""

configPaths = []
"""Paths to config files to read for specific Tasks.
The paths in this list should contain files of the form `task.py`, for
each of the Tasks that requires special configuration.
"""

@property
@abstractmethod
def filterDefinitions(self):
"""`~lsst.obs.base.FilterDefinitionCollection`, defining the filters
for this instrument.
"""
return None

def __init__(self, *args, **kwargs):
self.filterDefinitions.defineFilters()

@classmethod
@abstractmethod
def getName(cls):
raise NotImplementedError()

@abstractmethod
def getCamera(self):
"""Retrieve the cameraGeom representation of this instrument.
This is a temporary API that should go away once obs_ packages have
a standardized approach to writing versioned cameras to a Gen3 repo.
"""
raise NotImplementedError()

@abstractmethod
def register(self, registry):
"""Insert instrument, physical_filter, and detector entries into a
`Registry`.
"""
raise NotImplementedError()

def _registerFilters(self, registry):
"""Register the physical and abstract filter Dimension relationships.
This should be called in the ``register`` implementation.
Parameters
----------
registry : `lsst.daf.butler.core.Registry`
The registry to add dimensions to.
"""
registry.insertDimensionData(
"physical_filter",
*[
{
"instrument": self.getName(),
"name": filter.physical_filter,
"abstract_filter": filter.abstract_filter,
}
for filter in self.filterDefinitions
]
)

@abstractmethod
def getRawFormatter(self, dataId):
"""Return the Formatter class that should be used to read a particular
raw file.
Parameters
----------
dataId : `DataCoordinate`
Dimension-based ID for the raw file or files being ingested.
Returns
-------
formatter : `Formatter` class
Class to be used that reads the file into an
`lsst.afw.image.Exposure` instance.
"""
raise NotImplementedError()

@abstractmethod
def writeCuratedCalibrations(self, butler):
"""Write human-curated calibration Datasets to the given Butler with
the appropriate validity ranges.
This is a temporary API that should go away once obs_ packages have
a standardized approach to this problem.
"""
raise NotImplementedError()

def applyConfigOverrides(self, name, config):
"""Apply instrument-specific overrides for a task config.
Parameters
----------
name : `str`
Name of the object being configured; typically the _DefaultName
of a Task.
config : `lsst.pex.config.Config`
Config instance to which overrides should be applied.
"""
for root in self.configPaths:
path = os.path.join(root, f"{name}.py")
if os.path.exists(path):
config.load(path)


class ObservationDimensionPacker(DimensionPacker):
"""A `DimensionPacker` for visit+detector or exposure+detector, given an
instrument.
Expand Down Expand Up @@ -184,100 +63,3 @@ def unpack(self, packedId):
},
graph=self.dimensions
)


def makeExposureRecordFromObsInfo(obsInfo, universe):
"""Construct an exposure DimensionRecord from
`astro_metadata_translator.ObservationInfo`.
Parameters
----------
obsInfo : `astro_metadata_translator.ObservationInfo`
A `~astro_metadata_translator.ObservationInfo` object corresponding to
the exposure.
universe : `DimensionUniverse`
Set of all known dimensions.
Returns
-------
record : `DimensionRecord`
A record containing exposure metadata, suitable for insertion into
a `Registry`.
"""
dimension = universe["exposure"]
return dimension.RecordClass.fromDict({
"instrument": obsInfo.instrument,
"id": obsInfo.exposure_id,
"name": obsInfo.observation_id,
"datetime_begin": obsInfo.datetime_begin.to_datetime(),
"datetime_end": obsInfo.datetime_end.to_datetime(),
"exposure_time": obsInfo.exposure_time.to_value("s"),
"dark_time": obsInfo.dark_time.to_value("s"),
"observation_type": obsInfo.observation_type,
"physical_filter": obsInfo.physical_filter,
"visit": obsInfo.visit_id,
})


def makeVisitRecordFromObsInfo(obsInfo, universe, *, region=None):
"""Construct a visit `DimensionRecord` from
`astro_metadata_translator.ObservationInfo`.
Parameters
----------
obsInfo : `astro_metadata_translator.ObservationInfo`
A `~astro_metadata_translator.ObservationInfo` object corresponding to
the exposure.
universe : `DimensionUniverse`
Set of all known dimensions.
region : `lsst.sphgeom.Region`, optional
Spatial region for the visit.
Returns
-------
record : `DimensionRecord`
A record containing visit metadata, suitable for insertion into a
`Registry`.
"""
dimension = universe["visit"]
return dimension.RecordClass.fromDict({
"instrument": obsInfo.instrument,
"id": obsInfo.visit_id,
"name": obsInfo.observation_id,
"datetime_begin": obsInfo.datetime_begin.to_datetime(),
"datetime_end": obsInfo.datetime_end.to_datetime(),
"exposure_time": obsInfo.exposure_time.to_value("s"),
"physical_filter": obsInfo.physical_filter,
"region": region,
})


def addUnboundedCalibrationLabel(registry, instrumentName):
"""Add a special 'unbounded' calibration_label dimension entry for the
given camera that is valid for any exposure.
If such an entry already exists, this function just returns a `DataId`
for the existing entry.
Parameters
----------
registry : `Registry`
Registry object in which to insert the dimension entry.
instrumentName : `str`
Name of the instrument this calibration label is associated with.
Returns
-------
dataId : `DataId`
New or existing data ID for the unbounded calibration.
"""
d = dict(instrument=instrumentName, calibration_label="unbounded")
try:
return registry.expandDataId(d)
except LookupError:
pass
entry = d.copy()
entry["datetime_begin"] = datetime.min
entry["datetime_end"] = datetime.max
registry.insertDimensionData("calibration_label", entry)
return registry.expandDataId(d)
101 changes: 0 additions & 101 deletions python/lsst/daf/butler/instrument_tests.py
View file

This file was deleted.

0 comments on commit 4bec85e

Please sign in to comment.