Inheritance diagram for lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask:

Public Member Functions
def	__init__ (self, butler, args, kwargs)

def	loadSkyCircle (self, ctrCoord, radius, filterName=None)
	Load reference objects that overlap a circular sky region. More...

def	get_shards (self, id_list)
	Get all shards that touch a circular aperture. More...

def	loadPixelBox (self, bbox, wcs, filterName=None, calib=None)
	Load reference objects that overlap a pixel-based rectangular region. More...

def	getMetadataBox (self, bbox, wcs, filterName=None, calib=None)
	Return metadata about the load. More...

def	getMetadataCircle (self, coord, radius, filterName, calib=None)
	Return metadata about the load. More...

def	joinMatchListWithCatalog (self, matchCat, sourceCat)
	Relink an unpersisted match list to sources and reference objects. More...

Static Public Member Functions
def	makeMinimalSchema (filterNameList, addFluxSigma=False, addIsPhotometric=False, addIsResolved=False, addIsVariable=False)
	Make the standard schema for reference object catalogs. More...

Public Attributes
	indexer

	ref_dataset_name

	butler

Static Public Attributes
	ConfigClass = LoadIndexedReferenceObjectsConfig

Detailed Description

Definition at line 41 of file loadIndexedReferenceObjects.py.

Constructor & Destructor Documentation

◆ init()

def lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.__init__	(	self,
		butler,
		args,
		kwargs
	)

Definition at line 45 of file loadIndexedReferenceObjects.py.

Member Function Documentation

◆ get_shards()

def lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.get_shards	(	self,
		id_list
	)

Get all shards that touch a circular aperture.

Parameters

[in] id_list A list of integer pixel ids

Returns: a list of SourceCatalogs for each pixel, None if not data exists

Definition at line 108 of file loadIndexedReferenceObjects.py.

◆ getMetadataBox()

def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.getMetadataBox	(	self,
		bbox,
		wcs,
		filterName = `None`,
		calib = `None`
	)

inherited

Return metadata about the load.

This metadata is used for reloading the catalog (e.g., for reconstituting a normalised match list.

Parameters

[in]	bbox	bounding box for pixels (an lsst.geom.Box2I or Box2D)
[in]	wcs	WCS (an lsst.afw.geom.SkyWcs)
[in]	filterName	name of camera filter, or None or blank for the default filter
[in]	calib	calibration, or None if unknown

Returns: metadata (lsst.daf.base.PropertyList)

Definition at line 377 of file loadReferenceObjects.py.

◆ getMetadataCircle()

def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.getMetadataCircle	(	self,
		coord,
		radius,
		filterName,
		calib = `None`
	)

inherited

Return metadata about the load.

This metadata is used for reloading the catalog (e.g., for reconstituting a normalised match list.

Parameters

[in]	coord	ICRS centr of circle (lsst.geom.SpherePoint)
[in]	radius	radius of circle (lsst.geom.Angle)
[in]	filterName	name of camera filter, or None or blank for the default filter
[in]	calib	calibration, or None if unknown

Returns: metadata (lsst.daf.base.PropertyList)

Definition at line 392 of file loadReferenceObjects.py.

◆ joinMatchListWithCatalog()

def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.joinMatchListWithCatalog	(	self,
		matchCat,
		sourceCat
	)

inherited

Relink an unpersisted match list to sources and reference objects.

A match list is persisted and unpersisted as a catalog of IDs produced by afw.table.packMatches(), with match metadata (as returned by the astrometry tasks) in the catalog's metadata attribute. This method converts such a match catalog into a match list (an lsst.afw.table.ReferenceMatchVector) with links to source records and reference object records.

Parameters

[in]	matchCat	Unperisted packed match list (an lsst.afw.table.BaseCatalog). matchCat.table.getMetadata() must contain match metadata, as returned by the astrometry tasks.
[in,out]	sourceCat	Source catalog (an lsst.afw.table.SourceCatalog). As a side effect, the catalog will be sorted by ID.

Returns: the match list (an lsst.afw.table.ReferenceMatchVector)

Definition at line 413 of file loadReferenceObjects.py.

◆ loadPixelBox()

def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.loadPixelBox	(	self,
		bbox,
		wcs,
		filterName = `None`,
		calib = `None`
	)

inherited

Load reference objects that overlap a pixel-based rectangular region.

The search algorithm works by searching in a region in sky coordinates whose center is the center of the bbox and radius is large enough to just include all 4 corners of the bbox. Stars that lie outside the bbox are then trimmed from the list.

Parameters

[in]	bbox	bounding box for pixels (an lsst.geom.Box2I or Box2D)
[in]	wcs	WCS (an lsst.afw.geom.SkyWcs)
[in]	filterName	name of camera filter, or None or blank for the default filter
[in]	calib	calibration, or None if unknown

Returns

an lsst.pipe.base.Struct containing:

refCat a catalog of reference objects with the standard schema as documented in LoadReferenceObjects, including photometric, resolved and variable; hasCentroid is False for all objects.
fluxField = name of flux field for specified filterName

Definition at line 185 of file loadReferenceObjects.py.

◆ loadSkyCircle()

def lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.loadSkyCircle	(	self,
		ctrCoord,
		radius,
		filterName = `None`
	)

Load reference objects that overlap a circular sky region.

Parameters

[in]	ctrCoord	center of search region (an lsst.geom.SkyWcs)
[in]	radius	radius of search region (an lsst.geom.Angle)
[in]	filterName	name of filter, or None for the default filter; used for flux values in case we have flux limits (which are not yet implemented)

Returns

an lsst.pipe.base.Struct containing:

refCat a catalog of reference objects with the standard schema as documented in LoadReferenceObjects, including photometric, resolved and variable; hasCentroid is False for all objects.
fluxField = name of flux field for specified filterName. None if refCat is None.

Definition at line 55 of file loadIndexedReferenceObjects.py.

◆ makeMinimalSchema()

def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.makeMinimalSchema	(	filterNameList,
		addFluxSigma = `False`,
		addIsPhotometric = `False`,
		addIsResolved = `False`,
		addIsVariable = `False`
	)

staticinherited

Make the standard schema for reference object catalogs.

Parameters

[in]	filterNameList	list of filter names; used to create filterName_flux fields
[in]	addFluxSigma	if True then include flux sigma fields
[in]	addIsPhotometric	if True add field "photometric"
[in]	addIsResolved	if True add field "resolved"
[in]	addIsVariable	if True add field "variable"