lsst.pipe.tasks g59f6dce098+83b7f37e51
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Attributes | List of all members
lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask Class Reference
Inheritance diagram for lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask:

Public Member Functions

def __init__ (self, **kwargs)
 
def runQuantum (self, butlerQC, inputRefs, outputRefs)
 
def run (self, skymap, tract, source_table_ref_dict)
 

Static Public Attributes

IsolatedStarAssociationConfig ConfigClass = IsolatedStarAssociationConfig
 

Protected Member Functions

def _make_all_star_sources (self, tract_info, source_table_ref_dict)
 
def _get_source_table_visit_column_names (self)
 
def _match_primary_stars (self, primary_bands, star_source_cat)
 
def _remove_neighbors (self, primary_star_cat)
 
def _match_sources (self, bands, star_source_cat, primary_star_cat)
 
def _compute_unique_ids (self, skymap, tract, nstar)
 
def _get_primary_dtype (self, primary_bands)
 

Static Protected Attributes

str _DefaultName = 'isolatedStarAssociation'
 

Detailed Description

Associate sources into isolated star catalogs.

Definition at line 173 of file isolatedStarAssociation.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 179 of file isolatedStarAssociation.py.

Member Function Documentation

◆ _compute_unique_ids()

def 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 558 of file isolatedStarAssociation.py.

◆ _get_primary_dtype()

def 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 583 of file isolatedStarAssociation.py.

◆ _get_source_table_visit_column_names()

def 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 331 of file isolatedStarAssociation.py.

◆ _make_all_star_sources()

def lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask._make_all_star_sources (   self,
  tract_info,
  source_table_ref_dict 
)
protected
Make a catalog of all the star sources.

Parameters
----------
tract_info : `lsst.skymap.TractInfo`
    Information about the tract.
source_table_ref_dict : `dict`
    Dictionary of source_table refs.  Key is visit, value is dataref.

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

Definition at line 278 of file isolatedStarAssociation.py.

◆ _match_primary_stars()

def 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 359 of file isolatedStarAssociation.py.

◆ _match_sources()

def 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 483 of file isolatedStarAssociation.py.

◆ _remove_neighbors()

def 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 445 of file isolatedStarAssociation.py.

◆ run()

def lsst.pipe.tasks.isolatedStarAssociation.IsolatedStarAssociationTask.run (   self,
  skymap,
  tract,
  source_table_ref_dict 
)
Run the isolated star association task.

Parameters
----------
skymap : `lsst.skymap.SkyMap`
    Skymap object.
tract : `int`
    Tract number.
source_table_ref_dict : `dict`
    Dictionary of source_table refs.  Key is visit, value is dataref.

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

Definition at line 217 of file isolatedStarAssociation.py.

◆ runQuantum()

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

Definition at line 186 of file isolatedStarAssociation.py.

Member Data Documentation

◆ _DefaultName

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

Definition at line 177 of file isolatedStarAssociation.py.

◆ ConfigClass

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

Definition at line 176 of file isolatedStarAssociation.py.


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