lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask Class Reference

Inheritance diagram for lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask:

Public Member Functions
	__init__ (self, **kwargs)
	runQuantum (self, butlerQC, inputRefs, outputRefs)
	run (self, skymap, tract, source_table_handle_dict)

Static Public Attributes
	ConfigClass = IsolatedStarAssociationConfig

Protected Member Functions
	_make_all_star_sources (self, tract_info, source_table_handle_dict)
	_get_source_table_visit_column_names (self)
	_match_primary_stars (self, primary_bands, star_source_cat)
	_remove_neighbors (self, primary_star_cat)
	_match_sources (self, bands, star_source_cat, primary_star_cat)
	_compute_unique_ids (self, skymap, tract, nstar)
	_get_primary_dtype (self, primary_bands)

Static Protected Attributes
str	_DefaultName = 'isolatedStarAssociation'

Detailed Description

Associate sources into isolated star catalogs.

Definition at line 195 of file isolatedStarAssociation.py.

Constructor & Destructor Documentation

__init__()

lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask.__init__	(		self,
		**	kwargs )

Definition at line 201 of file isolatedStarAssociation.py.

Member Function Documentation

_compute_unique_ids()

lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask._compute_unique_ids ( self, skymap, tract, nstar )

protected

Compute unique star ids.

This is a simple hash of the tract and star to provide an
id that is unique for a given processing.

Parameters
----------
skymap : `lsst.skymap.Skymap`
    Skymap object.
tract : `int`
    Tract id number.
nstar : `int`
    Number of stars.

Returns
-------
ids : `np.ndarray`
    Array of unique star ids.

Definition at line 619 of file isolatedStarAssociation.py.

_get_primary_dtype()

lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask._get_primary_dtype ( self, primary_bands )

protected

Get the numpy datatype for the primary star catalog.

Parameters
----------
primary_bands : `list` [`str`]
    List of primary bands.

Returns
-------
dtype : `numpy.dtype`
    Datatype of the primary catalog.

Definition at line 644 of file isolatedStarAssociation.py.

_get_source_table_visit_column_names()

lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask._get_source_table_visit_column_names ( self )

protected

Get the list of sourceTable_visit columns from the config.

Returns
-------
all_columns : `list` [`str`]
    All columns to read
persist_columns : `list` [`str`]
    Columns to persist (excluding selection columns)

Definition at line 354 of file isolatedStarAssociation.py.

_make_all_star_sources()

lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask._make_all_star_sources ( self, tract_info, source_table_handle_dict )

protected

Make a catalog of all the star sources.

Parameters
----------
tract_info : `lsst.skymap.TractInfo`
    Information about the tract.
source_table_handle_dict : `dict`
    Dictionary of source_table handles.  Key is visit, value is
    a `lsst.daf.butler.DeferredDatasetHandle`.

Returns
-------
star_source_cat : `np.ndarray`
    Catalog of star sources.

Definition at line 301 of file isolatedStarAssociation.py.

_match_primary_stars()

lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask._match_primary_stars ( self, primary_bands, star_source_cat )

protected

Match primary stars.

Parameters
----------
primary_bands : `list` [`str`]
    Ordered list of primary bands.
star_source_cat : `np.ndarray`
    Catalog of star sources.

Returns
-------
primary_star_cat : `np.ndarray`
    Catalog of primary star positions

Definition at line 384 of file isolatedStarAssociation.py.

_match_sources()

lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask._match_sources ( self, bands, star_source_cat, primary_star_cat )

protected

Match individual sources to primary stars.

Parameters
----------
bands : `list` [`str`]
    List of bands.
star_source_cat : `np.ndarray`
    Array of star sources.
primary_star_cat : `np.ndarray`
    Array of primary stars.

Returns
-------
star_source_cat_sorted : `np.ndarray`
    Sorted and cropped array of star sources.
primary_star_cat : `np.ndarray`
    Catalog of isolated stars, with indexes to star_source_cat_cut.

Definition at line 544 of file isolatedStarAssociation.py.

_remove_neighbors()

lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask._remove_neighbors ( self, primary_star_cat )

protected

Remove neighbors from the primary star catalog.

Parameters
----------
primary_star_cat : `np.ndarray`
    Primary star catalog.

Returns
-------
primary_star_cat_cut : `np.ndarray`
    Primary star cat with neighbors removed.

Definition at line 506 of file isolatedStarAssociation.py.

run()

lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask.run	(		self,
			skymap,
			tract,
			source_table_handle_dict )

Run the isolated star association task.

Parameters
----------
skymap : `lsst.skymap.SkyMap`
    Skymap object.
tract : `int`
    Tract number.
source_table_handle_dict : `dict`
    Dictionary of source_table handles.  Key is visit, value is
    a `lsst.daf.butler.DeferredDatasetHandle`.

Returns
-------
struct : `lsst.pipe.base.struct`
    Struct with outputs for persistence.

Definition at line 239 of file isolatedStarAssociation.py.

runQuantum()

lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask.runQuantum	(		self,
			butlerQC,
			inputRefs,
			outputRefs )

Definition at line 208 of file isolatedStarAssociation.py.

Member Data Documentation

_DefaultName

str lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask._DefaultName = 'isolatedStarAssociation'

staticprotected

Definition at line 199 of file isolatedStarAssociation.py.

ConfigClass

lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask.ConfigClass = IsolatedStarAssociationConfig

static

Definition at line 198 of file isolatedStarAssociation.py.

---

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

• python/lsst/pipe/tasks/isolatedStarAssociation.py