lsst.pipe.tasks g8b9e2231ea+fa07cb600e
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Attributes | List of all members
lsst.pipe.tasks.makeDiscreteSkyMap.MakeDiscreteSkyMapTask Class Reference

Make a DiscreteSkyMap in a repository, using the bounding box of a set of calexps. More...

Inheritance diagram for lsst.pipe.tasks.makeDiscreteSkyMap.MakeDiscreteSkyMapTask:

Public Member Functions

def __init__ (self, **kwargs)
 
def runDataRef (self, butler, dataRefList)
 
def run (self, wcs_bbox_tuple_list, oldSkyMap=None)
 

Static Public Attributes

MakeDiscreteSkyMapConfig ConfigClass = MakeDiscreteSkyMapConfig
 
MakeDiscreteSkyMapRunner RunnerClass = MakeDiscreteSkyMapRunner
 

Protected Member Functions

def _getConfigName (self)
 
def _getMetadataName (self)
 
def _makeArgumentParser (cls)
 

Static Protected Attributes

str _DefaultName = "makeDiscreteSkyMap"
 

Detailed Description

Make a DiscreteSkyMap in a repository, using the bounding box of a set of calexps.

The command-line and run signatures and config are sufficiently different from MakeSkyMapTask
that we don't inherit from it, but it is a replacement, so we use the same config/metadata names.

Definition at line 118 of file makeDiscreteSkyMap.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.makeDiscreteSkyMap.MakeDiscreteSkyMapTask.__init__ (   self,
**  kwargs 
)

Definition at line 128 of file makeDiscreteSkyMap.py.

Member Function Documentation

◆ _getConfigName()

def lsst.pipe.tasks.makeDiscreteSkyMap.MakeDiscreteSkyMapTask._getConfigName (   self)
protected
Return None to disable saving config

There's only one SkyMap per repository, so the config is redundant, and checking it means we can't
easily overwrite or append to an existing repository.

Definition at line 231 of file makeDiscreteSkyMap.py.

◆ _getMetadataName()

def lsst.pipe.tasks.makeDiscreteSkyMap.MakeDiscreteSkyMapTask._getMetadataName (   self)
protected
Return None to disable saving metadata

The metadata is not interesting, and by not saving it we can eliminate a dataset type.

Definition at line 239 of file makeDiscreteSkyMap.py.

◆ _makeArgumentParser()

def lsst.pipe.tasks.makeDiscreteSkyMap.MakeDiscreteSkyMapTask._makeArgumentParser (   cls)
protected

Definition at line 247 of file makeDiscreteSkyMap.py.

◆ run()

def lsst.pipe.tasks.makeDiscreteSkyMap.MakeDiscreteSkyMapTask.run (   self,
  wcs_bbox_tuple_list,
  oldSkyMap = None 
)
Make a SkyMap from the bounds of the given set of calexp metadata.

Parameters
----------
wcs_bbox_tuple_list : iterable
   A list of tuples with each element expected to be a (Wcs, Box2I) pair
oldSkyMap : `lsst.skymap.DiscreteSkyMap`, option
   The SkyMap to extend if appending
Returns
-------
struct : `lsst.pipe.base.Struct
   The returned struct has one attribute, ``skyMap``, which holds the returned SkyMap

Definition at line 167 of file makeDiscreteSkyMap.py.

◆ runDataRef()

def lsst.pipe.tasks.makeDiscreteSkyMap.MakeDiscreteSkyMapTask.runDataRef (   self,
  butler,
  dataRefList 
)
Make a skymap from the bounds of the given set of calexps using the butler.

Parameters
----------
butler : `lsst.daf.persistence.Butler`
   Gen2 data butler used to save the SkyMap
dataRefList : iterable
   A list of Gen2 data refs of calexps used to determin the size and pointing of the SkyMap
Returns
-------
struct : `lsst.pipe.base.Struct`
   The returned struct has one attribute, ``skyMap``, which holds the returned SkyMap

Definition at line 131 of file makeDiscreteSkyMap.py.

Member Data Documentation

◆ _DefaultName

str lsst.pipe.tasks.makeDiscreteSkyMap.MakeDiscreteSkyMapTask._DefaultName = "makeDiscreteSkyMap"
staticprotected

Definition at line 125 of file makeDiscreteSkyMap.py.

◆ ConfigClass

MakeDiscreteSkyMapConfig lsst.pipe.tasks.makeDiscreteSkyMap.MakeDiscreteSkyMapTask.ConfigClass = MakeDiscreteSkyMapConfig
static

Definition at line 124 of file makeDiscreteSkyMap.py.

◆ RunnerClass

MakeDiscreteSkyMapRunner lsst.pipe.tasks.makeDiscreteSkyMap.MakeDiscreteSkyMapTask.RunnerClass = MakeDiscreteSkyMapRunner
static

Definition at line 126 of file makeDiscreteSkyMap.py.


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