BaseTractBuilder

class lsst.skymap.BaseTractBuilder(config)

Bases: object

Base class for algorithms that define patches within the tract.

Parameters

configlsst.pexConfig.Config

Input for configuring the algorithm

Methods Summary

getPackedConfig(config)	Get a packed config suitable for using in a sha1.
getPatchBorder()
getPatchIndexPair(sequentialIndex)	Convert sequential index into patch index (x,y) pair.
getPatchInfo(index, tractWcs)	Return information for the specified patch.
getPatchInnerDimensions()	Get dimensions of inner region of the patches (all are the same)
getSequentialPatchIndex(patchInfo)	Return a single integer that uniquely identifies the given patch within this tract.
getSequentialPatchIndexFromPair(index)	Return a single integer that uniquely identifies the patch index within the tract.
setupPatches(minBBox, wcs)	Set up the patches of a particular size in a tract.

Methods Documentation

abstract getPackedConfig(config)

Get a packed config suitable for using in a sha1.

Parameters

config : lsst.skymap.BaseTractBuilderConfig

Returns

configPacked : bytes

getPatchBorder()

getPatchIndexPair(sequentialIndex)

Convert sequential index into patch index (x,y) pair.

Parameters

sequentialIndex : int

Returns

x, y : lsst.skymap.Index2D

abstract getPatchInfo(index, tractWcs)

Return information for the specified patch.

Parameters

indexlsst.skymap.Index2D or Iterable of 2 int

Index of patch, as Index2D or pair of ints; or a sequential index as returned by getSequentialPatchIndex; negative values are not supported.

tractWcslsst.afw.geom.SkyWcs

WCS associated with the tract.

Returns

resultlsst.skymap.PatchInfo

The patch info for that index.

Raises

IndexError

Raised if index is out of range.

getPatchInnerDimensions()

Get dimensions of inner region of the patches (all are the same)

getSequentialPatchIndex(patchInfo)

Return a single integer that uniquely identifies the given patch within this tract.

Parameters

patchInfo : lsst.skymap.PatchInfo

Returns

sequentialIndex : int

getSequentialPatchIndexFromPair(index)

Return a single integer that uniquely identifies the patch index within the tract.

Parameters

index : lsst.skymap.Index2D or Iterable of 2 int

Returns

sequentialIndex : int

setupPatches(minBBox, wcs)

Set up the patches of a particular size in a tract.

We grow the tract bounding box to hold an exact multiple of the desired size (patchInnerDimensions or numCellsPerPatchInner*cellInnerDimensions), while keeping the center roughly the same. We return the final tract bounding box, and the number of patches in each dimension (as an Index2D).

Parameters

minBBoxlsst.geom.Box2I

Minimum bounding box for tract.

wcslsst.afw.geom.SkyWcs

Wcs object.

Returns

bboxlsst.geom.Box2I

final bounding box, number of patches.

numPatches : lsst.skymap.Index2D