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	runDataRef (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.

\section pipeTasks_ExampleCmdLineTask_Contents Contents

 - \ref pipeTasks_ExampleCmdLineTask_Purpose
 - \ref pipeTasks_ExampleCmdLineTask_Config
 - \ref pipeTasks_ExampleCmdLineTask_Debug
 - \ref pipeTasks_ExampleCmdLineTask_Example

\section pipeTasks_ExampleCmdLineTask_Purpose Description

\copybrief ExampleCmdLineTask

This task was written as an example for the documents \ref pipeTasks_writeTask
and \ref pipeTasks_writeCmdLineTask.
The task reads in a "calexp" (a calibrated science \ref lsst::afw::image::Exposure "exposure"),
computes statistics on the image plane, and logs and returns the statistics.
In addition, if debugging is enabled, it displays the image in current display backend.

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

The main method is \ref ExampleCmdLineTask.runDataRef "runDataRef".

\section pipeTasks_ExampleCmdLineTask_Config    Configuration parameters

See \ref ExampleCmdLineConfig

\section pipeTasks_ExampleCmdLineTask_Debug     Debug variables

This task supports the following debug variables:
<dl>
    <dt>`display`
    <dd>If True then display the exposure in current display backend
</dl>

To enable debugging, see \ref baseDebug.

\section pipeTasks_ExampleCmdLineTask_Example A complete example of using ExampleCmdLineTask

This code is in examples/exampleCmdLineTask.py, and can be run as follows:
\code
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
\endcode

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.

     def __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.
         """
         pipeBase.CmdLineTask.__init__(self, *args, **kwargs)
         self.makeSubtask("stats")
  

Member Function Documentation

◆ runDataRef()

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

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

    @param dataRef: data reference for a calibrated science exposure ("calexp")
    @return 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.

     def runDataRef(self, dataRef):
         """!Compute a few statistics on the image plane of an exposure
  
         @param dataRef: data reference for a calibrated science exposure ("calexp")
         @return a pipeBase Struct containing:
         - mean: mean of image plane
         - meanErr: uncertainty in mean
         - stdDev: standard deviation of image plane
         - stdDevErr: uncertainty in standard deviation
         """
         self.log.info("Processing data ID %s", dataRef.dataId)
         if self.config.doFail:
             raise pipeBase.TaskError("Raising TaskError by request (config.doFail=True)")
  
         # Unpersist the raw exposure pointed to by the data reference
         rawExp = dataRef.get("raw")
         maskedImage = rawExp.getMaskedImage()
  
         # Support extra debug output.
         # -
         import lsstDebug
         display = lsstDebug.Info(__name__).display
         if display:
             frame = 1
             disp = afwDisplay.Display(frame=frame)
             disp.mtv(rawExp, title="exposure")
  
         # return the pipe_base Struct that is returned by self.stats.run
         return self.stats.run(maskedImage)
  

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:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-172-gfb10e10a+18fedfabac/python/lsst/pipe/tasks/exampleCmdLineTask.py

Public Member Functions

Static Public Attributes