lsst::meas::algorithms::ClassificationControl Class Reference

Control/factory for the algorithm that does star/galaxy classification. More...

#include <Classification.h>

Inheritance diagram for lsst::meas::algorithms::ClassificationControl:

Public Member Functions
	ClassificationControl ()
boost::shared_ptr < ClassificationControl >	clone () const
Public Member Functions inherited from lsst::meas::algorithms::AlgorithmControl
boost::shared_ptr < AlgorithmControl >	clone () const
boost::shared_ptr< Algorithm >	makeAlgorithm (afw::table::Schema &schema, boost::shared_ptr< daf::base::PropertyList > const &metadata=boost::shared_ptr< daf::base::PropertyList >(), AlgorithmMap const &others=AlgorithmMap()) const
	Construct a new algorithm configured with *this. More...
virtual	~AlgorithmControl ()

Public Attributes
double	fluxRatio
	"critical ratio of model to psf flux" ; More...
double	modelErrFactor
	"correction factor for modelFlux error" ; More...
double	psfErrFactor
	"correction factor for psfFlux error" ; More...
Public Attributes inherited from lsst::meas::algorithms::AlgorithmControl
std::string	name
	Name of the algorithm. More...
double	priority
	"Parameter that sets the sort order for algorithms; lower numbers go first. " "Typically, priority=0 for centroids, 1 for shapes, and 2 for fluxes." ; More...

Private Member Functions
virtual boost::shared_ptr < AlgorithmControl >	_clone () const
virtual boost::shared_ptr < Algorithm >	_makeAlgorithm (afw::table::Schema &schema, boost::shared_ptr< daf::base::PropertyList > const &metadata) const

Additional Inherited Members
Protected Member Functions inherited from lsst::meas::algorithms::AlgorithmControl
virtual boost::shared_ptr < Algorithm >	_makeAlgorithm (afw::table::Schema &schema, boost::shared_ptr< daf::base::PropertyList > const &metadata, AlgorithmMap const &others) const
	AlgorithmControl (std::string const &name_, double priority_)

Detailed Description

Control/factory for the algorithm that does star/galaxy classification.

The algorithm class itself adds nothing to the public interface of its base class, so it is declared only in the source file.

This algorithm is based entirely on the ratio of Model to PSF fluxes; it never fails unless one of these fails, so it does not have its own failure flag.

Todo:

this class needs a more specific name, especially now that classifiers are pluggable

Definition at line 43 of file Classification.h.

Constructor & Destructor Documentation

lsst::meas::algorithms::ClassificationControl::ClassificationControl ( )

inline

Definition at line 50 of file Classification.h.

                            :
        AlgorithmControl("classification.extendedness", 5.0),
        fluxRatio(0.925), modelErrFactor(0.0), psfErrFactor(0.0)
    {}

Member Function Documentation

boost::shared_ptr< AlgorithmControl > lsst::meas::algorithms::ClassificationControl::_clone ( ) const

privatevirtual

Implements lsst::meas::algorithms::AlgorithmControl.

Definition at line 53 of file Classification.cc.

                                                          {
    return boost::make_shared<ClassificationControl>(*this);
}

boost::shared_ptr< Algorithm > lsst::meas::algorithms::ClassificationControl::_makeAlgorithm ( afw::table::Schema &  schema, boost::shared_ptr< daf::base::PropertyList > const &  metadata  ) const

privatevirtual

Reimplemented from lsst::meas::algorithms::AlgorithmControl.

Definition at line 57 of file Classification.cc.

        {
    return boost::make_shared<ClassificationAlgorithm>(*this, boost::ref(schema));
}

boost::shared_ptr< ClassificationControl > lsst::meas::algorithms::ClassificationControl::clone ( void  ) const

inline

Definition at line 55 of file Classification.h.

                                             {
        return boost::static_pointer_cast<ClassificationControl>(_clone());
    }

Member Data Documentation

double lsst::meas::algorithms::ClassificationControl::fluxRatio

"critical ratio of model to psf flux" ;

Definition at line 46 of file Classification.h.

double lsst::meas::algorithms::ClassificationControl::modelErrFactor

"correction factor for modelFlux error" ;

Definition at line 47 of file Classification.h.

double lsst::meas::algorithms::ClassificationControl::psfErrFactor

"correction factor for psfFlux error" ;

Definition at line 48 of file Classification.h.

---

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

• /lsst/home/lsstsw/stack/Linux64/meas_algorithms/master-g7bce1f4e06+57/include/lsst/meas/algorithms/Classification.h
• /lsst/home/lsstsw/stack/Linux64/meas_algorithms/master-g7bce1f4e06+57/src/Classification.cc