A measurement algorithm that gets mask bits from the exposure and sets flag bits to summarize which bits are set within a source's footprint. More...

#include <PixelFlags.h>

Inheritance diagram for lsst::meas::base::PixelFlagsAlgorithm:

Public Types
enum	{ FAILURE =FlagHandler::FAILURE, EDGE, INTERPOLATED, INTERPOLATED_CENTER, SATURATED, SATURATED_CENTER, CR, CR_CENTER, BAD, N_FLAGS }
	Flag bits to be used with the 'flags' data member of the Result object. More...

typedef PixelFlagsControl	Control

Public Member Functions
	PixelFlagsAlgorithm (Control const &ctrl, std::string const &name, afw::table::Schema &schema)

virtual void	measure (afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const

virtual void	fail (afw::table::SourceRecord &measRecord, MeasurementError *error=NULL) const

Public Member Functions inherited from lsst::meas::base::SimpleAlgorithm
virtual void	measureForced (afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure, afw::table::SourceRecord const &refRecord, afw::image::Wcs const &refWcs) const

virtual void	measureNForced (afw::table::SourceCatalog const &measCat, afw::image::Exposure< float > const &exposure, afw::table::SourceCatalog const &refRecord, afw::image::Wcs const &refWcs) const

Public Member Functions inherited from lsst::meas::base::SingleFrameAlgorithm
virtual void	measureN (afw::table::SourceCatalog const &measCat, afw::image::Exposure< float > const &exposure) const

Public Member Functions inherited from lsst::meas::base::BaseAlgorithm
virtual	~BaseAlgorithm ()

Private Attributes
Control	_ctrl

FlagHandler	_flagHandler

SafeCentroidExtractor	_centroidExtractor

Detailed Description

A measurement algorithm that gets mask bits from the exposure and sets flag bits to summarize which bits are set within a source's footprint.

Definition at line 59 of file PixelFlags.h.

Member Typedef Documentation

typedef PixelFlagsControl lsst::meas::base::PixelFlagsAlgorithm::Control

A typedef to the Control object for this algorithm, defined above. The control object contains the configuration parameters for this algorithm.

Definition at line 82 of file PixelFlags.h.

Member Enumeration Documentation

anonymous enum

Flag bits to be used with the 'flags' data member of the Result object.

Inspect getFlagDefinitions() for more detailed explanations of each flag.

Enumerator
FAILURE
EDGE
INTERPOLATED
INTERPOLATED_CENTER
SATURATED
SATURATED_CENTER
CR
CR_CENTER
BAD
N_FLAGS

Definition at line 67 of file PixelFlags.h.

          {
         FAILURE=FlagHandler::FAILURE,
         EDGE,
         INTERPOLATED,
         INTERPOLATED_CENTER,
         SATURATED,
         SATURATED_CENTER,
         CR,
         CR_CENTER,
         BAD,
         N_FLAGS
     };

Constructor & Destructor Documentation

lsst::meas::base::PixelFlagsAlgorithm::PixelFlagsAlgorithm	(	Control const &	ctrl,
		std::string const &	name,
		afw::table::Schema &	schema
	)

Definition at line 61 of file PixelFlags.cc.

   : _ctrl(ctrl),
     _centroidExtractor(schema, name)
 {
     static boost::array<FlagDefinition,N_FLAGS> const flagDefs = {{
         {"flag", "general failure flag, set if anything went wrong"},
         {"flag_edge", "Source is outside usable exposure region (masked EDGE or NO_DATA)"},
         {"flag_interpolated", "Interpolated pixel in the source footprint"},
         {"flag_interpolatedCenter", "Interpolated pixel in the source center"},
         {"flag_saturated", "Saturated pixel in the source footprint"},
         {"flag_saturatedCenter", "Saturated pixel in the source center"},
         {"flag_cr", "Cosmic ray in the source footprint"},
         {"flag_crCenter", "Cosmic ray in the source center"},
         {"flag_bad", "Bad pixel in the source footprint"}
     }};
     _flagHandler = FlagHandler::addFields(schema, name, flagDefs.begin(), flagDefs.end());
 }

Member Function Documentation

void lsst::meas::base::PixelFlagsAlgorithm::fail	(	afw::table::SourceRecord &	measRecord,
		MeasurementError *	error = `NULL`
	)		const

virtual

Handle an exception thrown by the current algorithm by setting flags in the given record.

fail() is called by the measurement framework when an exception is allowed to propagate out of one the algorithm's measure() methods. It should generally set both a general failure flag for the algorithm as well as a specific flag indicating the error condition, if possible. To aid in this, if the exception was an instance of MeasurementError, it will be passed in, carrying information about what flag to set.

An algorithm can also to chose to set flags within its own measure() methods, and then just return, rather than throw an exception. However, fail() should be implemented even when all known failure modes do not throw exceptions, to ensure that unexpected exceptions thrown in lower-level code are properly handled.

Implements lsst::meas::base::BaseAlgorithm.

Definition at line 139 of file PixelFlags.cc.

                                                                                                 {
     _flagHandler.handleFailure(measRecord, error);
 }

void lsst::meas::base::PixelFlagsAlgorithm::measure	(	afw::table::SourceRecord &	measRecord,
		afw::image::Exposure< float > const &	exposure
	)		const

virtual

Called to measure a single child source in an image.

Before this method is called, all neighbors will be replaced with noise, using the outputs of the deblender. Outputs should be saved in the given SourceRecord, which can also be used to obtain centroid (see SafeCentroidExtractor) and shape (see SafeShapeExtractor) information.

Implements lsst::meas::base::SingleFrameAlgorithm.

Definition at line 82 of file PixelFlags.cc.

         {
 
     afw::geom::Point2D center = _centroidExtractor(measRecord, _flagHandler);
     typedef afw::image::MaskedImage<float> MaskedImageT;
     MaskedImageT mimage = exposure.getMaskedImage();
 
     FootprintBits<MaskedImageT> func(mimage);
 
 //  Catch NAN in centroid estimate
     if (lsst::utils::isnan(center.getX()) || lsst::utils::isnan(center.getY())) {
         throw LSST_EXCEPT(pex::exceptions::InvalidParameterError,
                           "Center point passed to PixelFlagsALgorithm is NaN");
     }
 //  Catch centroids off the image
     if (!mimage.getBBox().contains(afw::geom::Point2I(center))) {
        _flagHandler.setValue(measRecord, EDGE, true);
     }
     // Check for bits set in the source's Footprint
     afw::detection::Footprint const & footprint(*measRecord.getFootprint());
     func.apply(footprint);
     if (func.getBits() & (MaskedImageT::Mask::getPlaneBitMask("EDGE") |
                           MaskedImageT::Mask::getPlaneBitMask("NO_DATA"))) {
         _flagHandler.setValue(measRecord, EDGE, true);
     }
     if (func.getBits() & MaskedImageT::Mask::getPlaneBitMask("BAD")) {
         _flagHandler.setValue(measRecord, BAD, true);
     }
     if (func.getBits() & MaskedImageT::Mask::getPlaneBitMask("INTRP")) {
         _flagHandler.setValue(measRecord, INTERPOLATED, true);
     }
     if (func.getBits() & MaskedImageT::Mask::getPlaneBitMask("SAT")) {
         _flagHandler.setValue(measRecord, SATURATED, true);
     }
     if (func.getBits() & MaskedImageT::Mask::getPlaneBitMask("CR")) {
         _flagHandler.setValue(measRecord, CR, true);
     }
 
     // Check for bits set in the 3x3 box around the center
     afw::geom::Point2I llc(afw::image::positionToIndex(center.getX())-1, afw::image::positionToIndex(center.getY()) - 1);
 
     afw::detection::Footprint const middle(afw::geom::BoxI(llc, afw::geom::ExtentI(3))); // central 3x3
     func.apply(middle);
     if (func.getBits() & MaskedImageT::Mask::getPlaneBitMask("INTRP")) {
         _flagHandler.setValue(measRecord, INTERPOLATED_CENTER, true);
     }
     if (func.getBits() & MaskedImageT::Mask::getPlaneBitMask("SAT")) {
         _flagHandler.setValue(measRecord, SATURATED_CENTER, true);
     }
     if (func.getBits() & MaskedImageT::Mask::getPlaneBitMask("CR")) {
         _flagHandler.setValue(measRecord, CR_CENTER, true);
     }
     _flagHandler.setValue(measRecord, FAILURE, false);
 }

Member Data Documentation

SafeCentroidExtractor lsst::meas::base::PixelFlagsAlgorithm::_centroidExtractor

private

Definition at line 100 of file PixelFlags.h.

Control lsst::meas::base::PixelFlagsAlgorithm::_ctrl

private

Definition at line 98 of file PixelFlags.h.

FlagHandler lsst::meas::base::PixelFlagsAlgorithm::_flagHandler

private

Definition at line 99 of file PixelFlags.h.

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

/home/lsstsw/stack/Linux64/meas_base/11.0+1/include/lsst/meas/base/PixelFlags.h
/home/lsstsw/stack/Linux64/meas_base/11.0+1/src/PixelFlags.cc

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation