lsst.obs.base  20.0.0-13-gfbf2cf9+1
Public Member Functions | Public Attributes | List of all members
lsst.obs.base.tests.ObsTests Class Reference
Inheritance diagram for lsst.obs.base.tests.ObsTests:
lsst.obs.base.butler_tests.ButlerGetTests lsst.obs.base.mapper_tests.MapperTests lsst.obs.base.camera_tests.CameraTests

Public Member Functions

def setUp_tests (self, butler, mapper, dataIds)
 
def tearDown (self)
 
def setUp_butler_get (self, ccdExposureId_bits=None, exposureIds=None, filters=None, exptimes=None, detectorIds=None, detector_names=None, detector_serials=None, dimensions=None, sky_origin=None, raw_subsets=None, good_detectorIds=None, bad_detectorIds=None, linearizer_type=None, raw_header_wcs=None)
 
def test_exposureId_bits (self)
 
def test_raw (self)
 
def test_bias (self)
 
def test_dark (self)
 
def test_flat (self)
 
def test_raw_header_wcs (self)
 
def test_raw_sub_bbox (self)
 
def test_subset_raw (self)
 
def test_get_linearizer (self)
 
def test_get_linearizer_bad_detectorIds (self)
 
def setUp_mapper (self, output=None, path_to_raw=None, keys=None, query_format=None, queryMetadata=None, metadata_output_path=None, map_python_type=None, map_python_std_type=None, map_cpp_type=None, map_storage_name=None, raw_filename=None, default_level=None, raw_levels=None, test_config_metadata=True)
 
def test_map_config_data (self)
 
def test_map_metadata_data (self)
 
def test_keys (self)
 
def test_get_dataset_types (self)
 
def test_get_keys_raw (self)
 
def test_get_default_level (self)
 
def test_map (self)
 
def test_query_metadata (self)
 
def test_can_standardize (self)
 
def test_validate (self)
 
def setUp_camera (self, camera_name=None, n_detectors=None, first_detector_name=None, plate_scale=None)
 
def test_iterable (self)
 
def test_camera_butler (self)
 
def test_plate_scale (self)
 

Public Attributes

 butler
 
 mapper
 
 dataIds
 
 log
 
 butler_get_data
 
 mapper_data
 
 camera_data
 

Detailed Description

Aggregator class for all of the obs_* test classes.

Inherit from this class, then lsst.utils.tests.TestCase, in that order.

Example subclass::

    class TestObsExample(lsst.obs.base.tests.ObsTests, lsst.utils.tests.TestCase):
        def setUp(self):
            self.setUp_tests(...)
            self.setUp_butler_get(...)
            self.setUp_mapper(...)
            self.setUp_camera(...)

Definition at line 41 of file tests.py.

Member Function Documentation

◆ setUp_butler_get()

def lsst.obs.base.butler_tests.ButlerGetTests.setUp_butler_get (   self,
  ccdExposureId_bits = None,
  exposureIds = None,
  filters = None,
  exptimes = None,
  detectorIds = None,
  detector_names = None,
  detector_serials = None,
  dimensions = None,
  sky_origin = None,
  raw_subsets = None,
  good_detectorIds = None,
  bad_detectorIds = None,
  linearizer_type = None,
  raw_header_wcs = None 
)
inherited
Set up the necessary variables for butlerGet tests.

All "exposure name" entries below should correspond to an entry in
self.dataIds.

Parameters
----------

ccdExposureId_bits : `int`
    expected value of ccdExposureId_bits
exposureIds : `dict`
    dict of exposure name : ccdExposureId (the number as returned by the butler)
filters : `dict`
    dict of exposure name : filter name
exptimes : `dict`
    dict of exposure name : exposure time
detector_names : `dict`
    dict of exposure name : detector name
detectorIds : `dict`
    dict of exposure name : detectorId
detector_serials : `dict`
    dict of exposure name : detector serial
dimensions : `dict`
    dict of exposure name : dimensions (as a geom.Extent2I)
sky_origin : `tuple` of `float`
    Longitude, Latitude of 'raw' exposure
raw_subsets : `tuple` of (kwargs, `int`)
    keyword args and expected number of subsets for
    ``butler.subset('raw', **kwargs)``
good_detectorIds : `list` of `int`
    list of valid ccd numbers
bad_detectorIds : `list` of `int`
    list of invalid ccd numbers
linearizer_type : `dict`
    dict of detectorId (usually `int`): LinearizerType
    (e.g. lsst.ip.isr.LinearizeLookupTable.LinearityType),
    or unittest.SkipTest to skip all linearizer tests.
raw_header_wcs : `lsst.afw.geom.SkyWcs`
    The SkyWcs object that should be returned by
    ``butler.get("raw_header_wcs", dataId=self.dataIds["raw"])``

Definition at line 37 of file butler_tests.py.

◆ setUp_camera()

def lsst.obs.base.camera_tests.CameraTests.setUp_camera (   self,
  camera_name = None,
  n_detectors = None,
  first_detector_name = None,
  plate_scale = None 
)
inherited
Set up the necessary variables for camera tests.

Parameters
----------

camera_name : `str`
    name of this camera
n_detectors : `int`
    number of detectors in this camera
first_detector_name : `str`
    name of the first detector in this camera
plate_scale : `lsst.geom.Angle`
    plate scale at center of focal plane, as angle-on-sky/mm

Definition at line 39 of file camera_tests.py.

◆ setUp_mapper()

def lsst.obs.base.mapper_tests.MapperTests.setUp_mapper (   self,
  output = None,
  path_to_raw = None,
  keys = None,
  query_format = None,
  queryMetadata = None,
  metadata_output_path = None,
  map_python_type = None,
  map_python_std_type = None,
  map_cpp_type = None,
  map_storage_name = None,
  raw_filename = None,
  default_level = None,
  raw_levels = None,
  test_config_metadata = True 
)
inherited
Set up the necessary variables for mapper tests.

Parameters
----------

output : `str`
    full path to output repository (can be the same as data_dir input repository)
path_to_raw : `str`
    full path to the raw file referenced by dataIds['raw']
keys : `set`
    dictionary keys that this mapper should contain
query_format : `list`
    format list for the results portion of queryMetadata
queryMetadata : `tuple` of (`dict`, `tuple`)
    dataIds and the results of calling them in queryMetadata
metadata_output_path : `str`
    path to metadata output associated with dataIds['raw']
map_python_type : `type`
    full python type specification returned by the mapper for dataIds['raw']
map_python_std_type : `type`
    full python type specification returned by the mapper for dataIds['raw'] after standardization
map_cpp_type : `str`
    C++ type specification returned by the mapper for dataIds['raw']
map_storage_name : `str`
    butler name for the storage type dataIds['raw']
raw_filename : `str`
    Name of the raw files returned by the mapper for dataIds['raw']
default_level : `str`
    value returned from mapper.getDefaultLevel
raw_levels : `tuple` of (`str`, `set` of `str`)
    (level, expect) level and expected mapper return for mapper.getKeys('raw', level)
test_config_metadata : `bool`
    Test persisted config and metadata?  These tests may not be appropriate for test stand data.
    Defaults to True.

Definition at line 43 of file mapper_tests.py.

◆ setUp_tests()

def lsst.obs.base.tests.ObsTests.setUp_tests (   self,
  butler,
  mapper,
  dataIds 
)
Set up the necessary shared variables used by multiple tests.

Parameters
----------
butler: lsst.daf.persistence.Butler
    A butler object, instantiated on the testdata repository for the
    obs package being tested.
mapper: lsst.obs.CameraMapper
    A CameraMapper object for your camera, instantiated on the testdata
    repository the obs package being tested.
dataIds: dict
    dictionary of (exposure name): (dataId of that exposure in the
    testdata repository), with unittest.SkipTest as the value for any
    exposures you do not have/do not want to test. It must contain a
    valid 'raw' dataId, in addition to 'bias','flat','dark', which may
    be set to SkipTest. For example::

  self.dataIds = {'raw': {'visit': 1, 'filter': 'g'},
                  'bias': {'visit': 1},
                  'flat': {'visit': 1},
                  'dark': unittest.SkipTest
                 }

Definition at line 57 of file tests.py.

◆ tearDown()

def lsst.obs.base.tests.ObsTests.tearDown (   self)

Definition at line 86 of file tests.py.

◆ test_bias()

def lsst.obs.base.butler_tests.ButlerGetTests.test_bias (   self)
inherited

Definition at line 163 of file butler_tests.py.

◆ test_camera_butler()

def lsst.obs.base.camera_tests.CameraTests.test_camera_butler (   self)
inherited
Check that the butler returns the right type of camera.

Definition at line 79 of file camera_tests.py.

◆ test_can_standardize()

def lsst.obs.base.mapper_tests.MapperTests.test_can_standardize (   self)
inherited

Definition at line 210 of file mapper_tests.py.

◆ test_dark()

def lsst.obs.base.butler_tests.ButlerGetTests.test_dark (   self)
inherited

Definition at line 166 of file butler_tests.py.

◆ test_exposureId_bits()

def lsst.obs.base.butler_tests.ButlerGetTests.test_exposureId_bits (   self)
inherited

Definition at line 129 of file butler_tests.py.

◆ test_flat()

def lsst.obs.base.butler_tests.ButlerGetTests.test_flat (   self)
inherited

Definition at line 169 of file butler_tests.py.

◆ test_get_dataset_types()

def lsst.obs.base.mapper_tests.MapperTests.test_get_dataset_types (   self)
inherited

Definition at line 158 of file mapper_tests.py.

◆ test_get_default_level()

def lsst.obs.base.mapper_tests.MapperTests.test_get_default_level (   self)
inherited

Definition at line 169 of file mapper_tests.py.

◆ test_get_keys_raw()

def lsst.obs.base.mapper_tests.MapperTests.test_get_keys_raw (   self)
inherited

Definition at line 164 of file mapper_tests.py.

◆ test_get_linearizer()

def lsst.obs.base.butler_tests.ButlerGetTests.test_get_linearizer (   self)
inherited
Test that we can get a linearizer for good detectorIds.

Definition at line 193 of file butler_tests.py.

◆ test_get_linearizer_bad_detectorIds()

def lsst.obs.base.butler_tests.ButlerGetTests.test_get_linearizer_bad_detectorIds (   self)
inherited
Do bad detectorIds raise?

Definition at line 205 of file butler_tests.py.

◆ test_iterable()

def lsst.obs.base.camera_tests.CameraTests.test_iterable (   self)
inherited
Simplest camera test: can we get a Camera instance, and does iterating return Detectors?

Definition at line 71 of file camera_tests.py.

◆ test_keys()

def lsst.obs.base.mapper_tests.MapperTests.test_keys (   self)
inherited

Definition at line 155 of file mapper_tests.py.

◆ test_map()

def lsst.obs.base.mapper_tests.MapperTests.test_map (   self)
inherited

Definition at line 184 of file mapper_tests.py.

◆ test_map_config_data()

def lsst.obs.base.mapper_tests.MapperTests.test_map_config_data (   self)
inherited

Definition at line 127 of file mapper_tests.py.

◆ test_map_metadata_data()

def lsst.obs.base.mapper_tests.MapperTests.test_map_metadata_data (   self)
inherited

Definition at line 142 of file mapper_tests.py.

◆ test_plate_scale()

def lsst.obs.base.camera_tests.CameraTests.test_plate_scale (   self)
inherited
Check the plate scale at center of focal plane

Check plate_scale using the FOCAL_PLANE to FIELD_ANGLE transform
from the camera.

Definition at line 86 of file camera_tests.py.

◆ test_query_metadata()

def lsst.obs.base.mapper_tests.MapperTests.test_query_metadata (   self)
inherited
Test expansion of incomplete information of the available data in this
obs package's testdata repo.

Definition at line 200 of file mapper_tests.py.

◆ test_raw()

def lsst.obs.base.butler_tests.ButlerGetTests.test_raw (   self)
inherited

Definition at line 151 of file butler_tests.py.

◆ test_raw_header_wcs()

def lsst.obs.base.butler_tests.ButlerGetTests.test_raw_header_wcs (   self)
inherited
Test that `raw_header_wcs` returns the unmodified raw image header.

Definition at line 172 of file butler_tests.py.

◆ test_raw_sub_bbox()

def lsst.obs.base.butler_tests.ButlerGetTests.test_raw_sub_bbox (   self)
inherited

Definition at line 180 of file butler_tests.py.

◆ test_subset_raw()

def lsst.obs.base.butler_tests.ButlerGetTests.test_subset_raw (   self)
inherited

Definition at line 188 of file butler_tests.py.

◆ test_validate()

def lsst.obs.base.mapper_tests.MapperTests.test_validate (   self)
inherited

Definition at line 220 of file mapper_tests.py.

Member Data Documentation

◆ butler

lsst.obs.base.tests.ObsTests.butler

Definition at line 81 of file tests.py.

◆ butler_get_data

lsst.obs.base.butler_tests.ButlerGetTests.butler_get_data
inherited

Definition at line 98 of file butler_tests.py.

◆ camera_data

lsst.obs.base.camera_tests.CameraTests.camera_data
inherited

Definition at line 60 of file camera_tests.py.

◆ dataIds

lsst.obs.base.tests.ObsTests.dataIds

Definition at line 83 of file tests.py.

◆ log

lsst.obs.base.tests.ObsTests.log

Definition at line 84 of file tests.py.

◆ mapper

lsst.obs.base.tests.ObsTests.mapper

Definition at line 82 of file tests.py.

◆ mapper_data

lsst.obs.base.mapper_tests.MapperTests.mapper_data
inherited

Definition at line 96 of file mapper_tests.py.


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