lsst::ap::cluster::SourceProcessingControl Struct Reference

Parameters for source processing. More...

#include <SourceProcessingControl.h>

Public Member Functions
	SourceProcessingControl ()
	~SourceProcessingControl ()

Public Attributes
std::string	exposurePrefix
	"Prefix for exposure related fields in the output source schema.\n" "May be empty.\n" ; More...
std::string	clusterPrefix
	"Prefix for cluster related fields in the output source schema.\n" "May be empty.\n" ; More...
bool	multiBand
	"If true, sources have been detected/measured on multi-band\n" "exposures (e.g. chi-squared coadds) and are not filter\n" "specific.\n" ; More...
bool	coadd
	"If true, sources have been detected/measured on coadd exposures,\n" "and have no associated time-stamp/epoch.\n" ; More...
std::vector< std::string >	badFlagFields
	"A list of flag field names. If an input source has any of the\n" "corresponding flag bits set, then the source is considered \"bad", " "and does not participate in spatial clustering. " ; More...
double	fluxScale
	"Scaling factor applied to F/F_0 prior to averaging, where F is\n" "an uncalibrated source flux and F_0 is the flux of a 0-magnitude\n" "object for the corresponding exposure.\n" ; More...
std::string	fluxUnit
	"Unit of calibrated flux.\n" ; More...
std::vector< std::string >	fluxFields
	"A list of flux field names which should be carried over from input\n" "source tables to output source cluster tables. Input source tables\n" "are expected to contain fields '<flux>', '<flux>.err' and\n" "'<flux>.flags' for each list entry ('<flux>').\n" ; More...
std::vector< std::string >	shapeFields
	"A list of shape field names which should be carried over from input\n" "source tables to output source cluster tables. Input source tables\n" "are expected to contain fields '<shape>', '<shape>.err' and\n" "'<shape>.flags' for each list entry ('<shape>').\n" ; More...

Detailed Description

Parameters for source processing.

Definition at line 41 of file SourceProcessingControl.h.

Constructor & Destructor Documentation

lsst::ap::cluster::SourceProcessingControl::SourceProcessingControl

(

)

Definition at line 33 of file SourceProcessingControl.cc.

                                                 :
    exposurePrefix("exposure"),
    clusterPrefix("cluster"),
    multiBand(false),
    coadd(false),
    badFlagFields(),
    // The default flux scale S is chosen such that the AB magnitude
    // -2.5*log10(S*F/F_0) - 48.6 = 0 when F = F_0, where F is an
    // uncalibrated flux and F_0 is the flux of a 0-magnitude source.
    fluxScale(3.63078054770101342467371212362e-20),
    fluxUnit("erg/s/cm^2/Hz"),
    fluxFields(),
    shapeFields()
{
    fluxFields.push_back("flux.gaussian");
    fluxFields.push_back("flux.naive");
    fluxFields.push_back("flux.psf");
    fluxFields.push_back("flux.sinc");
    fluxFields.push_back("flux.kron");
    fluxFields.push_back("multishapelet.exp.flux");
    fluxFields.push_back("multishapelet.dev.flux");
    fluxFields.push_back("multishapelet.combo.flux");
    shapeFields.push_back("shape.sdss");
}

lsst::ap::cluster::SourceProcessingControl::~SourceProcessingControl

(

)

Definition at line 58 of file SourceProcessingControl.cc.

{ }

Member Data Documentation

std::vector<std::string> lsst::ap::cluster::SourceProcessingControl::badFlagFields

"A list of flag field names. If an input source has any of the\n" "corresponding flag bits set, then the source is considered \"bad",
" "and does not participate in spatial clustering.
" ;

Definition at line 65 of file SourceProcessingControl.h.

std::string lsst::ap::cluster::SourceProcessingControl::clusterPrefix

"Prefix for cluster related fields in the output source schema.\n" "May be empty.\n" ;

Definition at line 51 of file SourceProcessingControl.h.

bool lsst::ap::cluster::SourceProcessingControl::coadd

"If true, sources have been detected/measured on coadd exposures,\n" "and have no associated time-stamp/epoch.\n" ;

Definition at line 60 of file SourceProcessingControl.h.

std::string lsst::ap::cluster::SourceProcessingControl::exposurePrefix

"Prefix for exposure related fields in the output source schema.\n" "May be empty.\n" ;

Definition at line 47 of file SourceProcessingControl.h.

std::vector<std::string> lsst::ap::cluster::SourceProcessingControl::fluxFields

"A list of flux field names which should be carried over from input\n" "source tables to output source cluster tables. Input source tables\n" "are expected to contain fields '<flux>', '<flux>.err' and\n" "'<flux>.flags' for each list entry ('<flux>').\n" ;

Definition at line 79 of file SourceProcessingControl.h.

double lsst::ap::cluster::SourceProcessingControl::fluxScale

"Scaling factor applied to F/F_0 prior to averaging, where F is\n" "an uncalibrated source flux and F_0 is the flux of a 0-magnitude\n" "object for the corresponding exposure.\n" ;

Definition at line 70 of file SourceProcessingControl.h.

std::string lsst::ap::cluster::SourceProcessingControl::fluxUnit

"Unit of calibrated flux.\n" ;

Definition at line 73 of file SourceProcessingControl.h.

bool lsst::ap::cluster::SourceProcessingControl::multiBand

"If true, sources have been detected/measured on multi-band\n" "exposures (e.g. chi-squared coadds) and are not filter\n" "specific.\n" ;

Definition at line 56 of file SourceProcessingControl.h.

std::vector<std::string> lsst::ap::cluster::SourceProcessingControl::shapeFields

"A list of shape field names which should be carried over from input\n" "source tables to output source cluster tables. Input source tables\n" "are expected to contain fields '<shape>', '<shape>.err' and\n" "'<shape>.flags' for each list entry ('<shape>').\n" ;

Definition at line 85 of file SourceProcessingControl.h.

---

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

• /lsst/home/lsstsw/stack/Linux64/ap/master-g60f1e072bb+1/include/lsst/ap/cluster/SourceProcessingControl.h
• /lsst/home/lsstsw/stack/Linux64/ap/master-g60f1e072bb+1/src/cluster/SourceProcessingControl.cc