lsst.pipe.tasks g540474b770+e939cf0e26
Loading...
Searching...
No Matches
lsst.pipe.tasks.split_primary.SplitPrimaryTask Class Reference
Inheritance diagram for lsst.pipe.tasks.split_primary.SplitPrimaryTask:

Public Member Functions

Struct run (self, *, astropy.table.Table full)
 

Static Public Attributes

ClassVar ConfigClass = SplitPrimaryConfig
 

Static Protected Attributes

ClassVar _DefaultName = "splitPrimary"
 

Detailed Description

A task that splits its input table into "primary" and "nonprimary"
row-subset tables based on the value of a boolean column, dropping that
column and optionally others from the two outputs.

Definition at line 120 of file split_primary.py.

Member Function Documentation

◆ run()

Struct lsst.pipe.tasks.split_primary.SplitPrimaryTask.run ( self,
* ,
astropy.table.Table full )
Run the task.

Parameters
----------
full : `astropy.table.Table`
    Table to split into row subsets.

Returns
-------
result : `lsst.pipe.base.Struct`
    Structure with two attributes:

    - ``primary`` (`astropy.table.Table`) table with rows where the
      `SplitPrimaryConfig.primary_flag_column` is `True`.

    - ``nonprimary`` (`astropy.table.Table`) table with rows where the
      `SplitPrimaryConfig.primary_flag_column` is `False`.

Definition at line 130 of file split_primary.py.

Member Data Documentation

◆ _DefaultName

ClassVar lsst.pipe.tasks.split_primary.SplitPrimaryTask._DefaultName = "splitPrimary"
staticprotected

Definition at line 128 of file split_primary.py.

◆ ConfigClass

ClassVar lsst.pipe.tasks.split_primary.SplitPrimaryTask.ConfigClass = SplitPrimaryConfig
static

Definition at line 126 of file split_primary.py.


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