lsst.pipe.tasks  13.0-66-gfbf2f2ce+5
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.exampleCmdLineTask.ExampleCmdLineTask Class Reference

Example command-line task that computes simple statistics on an image. More...

Inheritance diagram for lsst.pipe.tasks.exampleCmdLineTask.ExampleCmdLineTask:

Public Member Functions

def __init__ (self, args, kwargs)
 
def run (self, dataRef)
 Compute a few statistics on the image plane of an exposure. More...
 

Static Public Attributes

 ConfigClass = ExampleCmdLineConfig
 

Detailed Description

Example command-line task that computes simple statistics on an image.

Contents

Description

Example command-line task that computes simple statistics on an image.

This task was written as an example for the documents How to Write a Task and How to Write a Command-Line Task. The task reads in a "calexp" (a calibrated science exposure), computes statistics on the image plane, and logs and returns the statistics. In addition, if debugging is enabled, it displays the image in ds9.

The image statistics are computed using a subtask, in order to show how to call subtasks and how to retarget (replace) them with variant subtasks.

The main method is run.

Configuration parameters

See ExampleCmdLineConfig

Debug variables

This task supports the following debug variables:

display
If True then display the exposure in ds9

To enable debugging, see baseDebug.

A complete example of using ExampleCmdLineTask

This code is in examples/exampleCmdLineTask.py, and can be run as follows:

examples/exampleCmdLineTask.py $OBS_TEST_DIR/data/input --id
# that will process all data; you can also try any combination of these flags:
--id filter=g
--config doFail=True --doraise
--show config data

Definition at line 55 of file exampleCmdLineTask.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.exampleCmdLineTask.ExampleCmdLineTask.__init__ (   self,
  args,
  kwargs 
)
Construct an ExampleCmdLineTask

Call the parent class constructor and make the "stats" subtask from the config field of the same name.

Definition at line 108 of file exampleCmdLineTask.py.

Member Function Documentation

◆ run()

def lsst.pipe.tasks.exampleCmdLineTask.ExampleCmdLineTask.run (   self,
  dataRef 
)

Compute a few statistics on the image plane of an exposure.

Parameters
dataRefdata reference for a calibrated science exposure ("calexp")
Returns
a pipeBase Struct containing:
  • mean: mean of image plane
  • meanErr: uncertainty in mean
  • stdDev: standard deviation of image plane
  • stdDevErr: uncertainty in standard deviation

Definition at line 117 of file exampleCmdLineTask.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.exampleCmdLineTask.ExampleCmdLineTask.ConfigClass = ExampleCmdLineConfig
static

Definition at line 105 of file exampleCmdLineTask.py.


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