lsst::jointcal::MeasuredStar Class Reference

Sources measured on images. More...

#include <MeasuredStar.h>

Inheritance diagram for lsst::jointcal::MeasuredStar:

Public Member Functions
	MeasuredStar ()
	MeasuredStar (BaseStar const &baseStar)
	MeasuredStar (MeasuredStar const &)=default
	No move, allow copy constructor: we may copy the fitted StarLists when associating and matching catalogs, otherwise Stars should be managed by shared_ptr only.
	MeasuredStar (MeasuredStar &&)=delete
MeasuredStar &	operator= (MeasuredStar const &)=delete
MeasuredStar &	operator= (MeasuredStar &&)=delete
void	setFittedStar (std::shared_ptr< FittedStar > fittedStar)
void	print (std::ostream &out) const
void	setInstFluxAndErr (double instFlux, double instFluxErr)
double	getInstFlux () const
double	getInstFluxErr () const
double	getInstMag () const
double	getInstMagErr () const
void	setId (afw::table::RecordId id)
afw::table::RecordId	getId () const
double	getMagWeight () const
	the inverse of the mag variance
double	getXFocal () const
void	setXFocal (double xFocal)
double	getYFocal () const
void	setYFocal (double yFocal)
std::shared_ptr< FittedStar >	getFittedStar () const
CcdImage const &	getCcdImage () const
void	setCcdImage (const CcdImage *ccdImage)
bool	isValid () const
	Fits may use that to discard outliers.
void	setValid (bool v)
	Fits may use that to discard outliers.
double	getX () const
	access stuff.
double	getY () const
double	getFlux () const
double &	getFlux ()
void	setFlux (double flux)
double	getFluxErr () const
void	setFluxErr (double fluxErr)
double	getMag () const
double &	getMag ()
double	getMagErr () const
void	setMagErr (double magErr)
double	Distance (const Point &other) const
double	computeDist2 (const Point &other) const
	distance squared to other
Point	operator+ (const Point &Right) const
	Sum.
Point	operator- (const Point &Right) const
	Difference.

Static Public Member Functions
static const char *	typeName ()

Public Attributes
double	vx
double	vy
double	vxy
double	x
	coordinate
double	y

Protected Attributes
double	_flux
double	_fluxErr {}
double	_mag {}
double	_magErr {}

Detailed Description

Sources measured on images.

x/y positions and uncertainties (from BaseStar) are in pixels in the image frame. instFlux[Err] are in counts. flux[Err] (from BaseStar) are nJy.

Definition at line 51 of file MeasuredStar.h.

Constructor & Destructor Documentation

MeasuredStar() [1/4]

lsst::jointcal::MeasuredStar::MeasuredStar ( )

inline

Definition at line 53 of file MeasuredStar.h.

            : BaseStar(),
              _id(0),
              _instFlux(0.),
              _instFluxErr(0.),
              _ccdImage(nullptr),
              _valid(true),
              _xFocal(0.0),
              _yFocal(0.0),
              _instMag(0.),
              _instMagErr(0.) {}

MeasuredStar() [2/4]

lsst::jointcal::MeasuredStar::MeasuredStar ( BaseStar const & baseStar )

inline

Definition at line 65 of file MeasuredStar.h.

            : BaseStar(baseStar),
              _id(0),
              _instFlux(0.),
              _instFluxErr(0.),
              _ccdImage(nullptr),
              _valid(true),
              _xFocal(0.0),
              _yFocal(0.0),
              _instMag(0.),
              _instMagErr(0.) {}

MeasuredStar() [3/4]

lsst::jointcal::MeasuredStar::MeasuredStar ( MeasuredStar const & )

default

No move, allow copy constructor: we may copy the fitted StarLists when associating and matching catalogs, otherwise Stars should be managed by shared_ptr only.

MeasuredStar() [4/4]

lsst::jointcal::MeasuredStar::MeasuredStar ( MeasuredStar && )

delete

Member Function Documentation

computeDist2()

double lsst::jointcal::Point::computeDist2 ( const Point & other ) const

inlineinherited

distance squared to other

Definition at line 56 of file Point.h.

                                                  {
        return ((x - other.x) * (x - other.x) + (y - other.y) * (y - other.y));
    };

Distance()

double lsst::jointcal::Point::Distance ( const Point & other ) const

inlineinherited

Definition at line 51 of file Point.h.

                                              {
        return sqrt((x - other.x) * (x - other.x) + (y - other.y) * (y - other.y));
    };

getCcdImage()

CcdImage const & lsst::jointcal::MeasuredStar::getCcdImage ( ) const

inline

Definition at line 120 of file MeasuredStar.h.

{ return *_ccdImage; };

getFittedStar()

std::shared_ptr< FittedStar > lsst::jointcal::MeasuredStar::getFittedStar ( ) const

inline

Definition at line 118 of file MeasuredStar.h.

{ return _fittedStar; };

getFlux() [1/2]

double & lsst::jointcal::BaseStar::getFlux ( )

inlineinherited

Definition at line 99 of file BaseStar.h.

{ return _flux; }

getFlux() [2/2]

double lsst::jointcal::BaseStar::getFlux ( ) const

inlineinherited

Definition at line 98 of file BaseStar.h.

{ return _flux; }

getFluxErr()

double lsst::jointcal::BaseStar::getFluxErr ( ) const

inlineinherited

Definition at line 102 of file BaseStar.h.

{ return _fluxErr; }

getId()

afw::table::RecordId lsst::jointcal::MeasuredStar::getId ( ) const

inline

Definition at line 108 of file MeasuredStar.h.

{ return _id; }

getInstFlux()

double lsst::jointcal::MeasuredStar::getInstFlux ( ) const

inline

Definition at line 102 of file MeasuredStar.h.

{ return _instFlux; }

getInstFluxErr()

double lsst::jointcal::MeasuredStar::getInstFluxErr ( ) const

inline

Definition at line 103 of file MeasuredStar.h.

{ return _instFluxErr; }

getInstMag()

double lsst::jointcal::MeasuredStar::getInstMag ( ) const

inline

Definition at line 104 of file MeasuredStar.h.

{ return _instMag; }

getInstMagErr()

double lsst::jointcal::MeasuredStar::getInstMagErr ( ) const

inline

Definition at line 105 of file MeasuredStar.h.

{ return _instMagErr; }

getMag() [1/2]

double & lsst::jointcal::BaseStar::getMag ( )

inlineinherited

Definition at line 106 of file BaseStar.h.

{ return _mag; }

getMag() [2/2]

double lsst::jointcal::BaseStar::getMag ( ) const

inlineinherited

Definition at line 105 of file BaseStar.h.

{ return _mag; }

getMagErr()

double lsst::jointcal::BaseStar::getMagErr ( ) const

inlineinherited

Definition at line 108 of file BaseStar.h.

{ return _magErr; }

getMagWeight()

double lsst::jointcal::MeasuredStar::getMagWeight ( ) const

inline

the inverse of the mag variance

Definition at line 111 of file MeasuredStar.h.

{ return (_instFlux * _instFlux / (_instFluxErr * _instFluxErr)); }

getX()

double lsst::jointcal::BaseStar::getX ( ) const

inlineinherited

access stuff.

Definition at line 73 of file BaseStar.h.

{ return x; }

getXFocal()

double lsst::jointcal::MeasuredStar::getXFocal ( ) const

inline

Definition at line 113 of file MeasuredStar.h.

{ return _xFocal; }

getY()

double lsst::jointcal::BaseStar::getY ( ) const

inlineinherited

Definition at line 75 of file BaseStar.h.

{ return y; }

getYFocal()

double lsst::jointcal::MeasuredStar::getYFocal ( ) const

inline

Definition at line 115 of file MeasuredStar.h.

{ return _yFocal; }

isValid()

bool lsst::jointcal::MeasuredStar::isValid ( ) const

inline

Fits may use that to discard outliers.

Definition at line 125 of file MeasuredStar.h.

{ return _valid; }

operator+()

Point lsst::jointcal::Point::operator+ ( const Point & Right ) const

inlineinherited

Sum.

Definition at line 61 of file Point.h.

{ return Point(x + Right.x, y + Right.y); }

operator-()

Point lsst::jointcal::Point::operator- ( const Point & Right ) const

inlineinherited

Difference.

Definition at line 64 of file Point.h.

{ return Point(x - Right.x, y - Right.y); }

operator=() [1/2]

MeasuredStar & lsst::jointcal::MeasuredStar::operator= ( MeasuredStar && )

delete

operator=() [2/2]

MeasuredStar & lsst::jointcal::MeasuredStar::operator= ( MeasuredStar const & )

delete

print()

void lsst::jointcal::MeasuredStar::print ( std::ostream & out ) const

inlinevirtual

Reimplemented from lsst::jointcal::BaseStar.

Definition at line 89 of file MeasuredStar.h.

                                      {
        BaseStar::print(out);
        out << " instFlux: " << _instFlux << " instFluxErr: " << _instFluxErr << " id: " << _id
            << " valid: " << _valid;
    }

setCcdImage()

void lsst::jointcal::MeasuredStar::setCcdImage ( const CcdImage * ccdImage )

inline

Definition at line 122 of file MeasuredStar.h.

{ _ccdImage = ccdImage; };

setFittedStar()

void lsst::jointcal::MeasuredStar::setFittedStar ( std::shared_ptr< FittedStar > fittedStar )

inline

Definition at line 84 of file MeasuredStar.h.

                                                             {
        if (fittedStar) fittedStar->getMeasurementCount()++;
        _fittedStar = std::move(fittedStar);
    }

setFlux()

void lsst::jointcal::BaseStar::setFlux ( double flux )

inlineinherited

Definition at line 100 of file BaseStar.h.

{ _flux = flux; }

setFluxErr()

void lsst::jointcal::BaseStar::setFluxErr ( double fluxErr )

inlineinherited

Definition at line 103 of file BaseStar.h.

{ _fluxErr = fluxErr; }

setId()

void lsst::jointcal::MeasuredStar::setId ( afw::table::RecordId id )

inline

Definition at line 107 of file MeasuredStar.h.

{ _id = id; }

setInstFluxAndErr()

void lsst::jointcal::MeasuredStar::setInstFluxAndErr ( double instFlux, double instFluxErr )

inline

Definition at line 95 of file MeasuredStar.h.

                                                                {
        _instFlux = instFlux;
        _instMag = instMagFromInstFlux(instFlux);
        _instFluxErr = instFluxErr;
        _instMagErr = magErrFromFluxErr(instFlux, instFluxErr);
    }

setMagErr()

void lsst::jointcal::BaseStar::setMagErr ( double magErr )

inlineinherited

Definition at line 109 of file BaseStar.h.

{ _magErr = magErr; }

setValid()

void lsst::jointcal::MeasuredStar::setValid ( bool v )

inline

Fits may use that to discard outliers.

Definition at line 127 of file MeasuredStar.h.

{ _valid = v; }

setXFocal()

void lsst::jointcal::MeasuredStar::setXFocal ( double xFocal )

inline

Definition at line 114 of file MeasuredStar.h.

{ _xFocal = xFocal; }

setYFocal()

void lsst::jointcal::MeasuredStar::setYFocal ( double yFocal )

inline

Definition at line 116 of file MeasuredStar.h.

{ _yFocal = yFocal; }

typeName()

static const char * lsst::jointcal::BaseStar::typeName ( )

inlinestaticinherited

Definition at line 94 of file BaseStar.h.

{ return "BaseStar"; }

Member Data Documentation

_flux

double lsst::jointcal::BaseStar::_flux

protectedinherited

Definition at line 113 of file BaseStar.h.

_fluxErr

double lsst::jointcal::BaseStar::_fluxErr {}

protectedinherited

Definition at line 114 of file BaseStar.h.

{};

_mag

double lsst::jointcal::BaseStar::_mag {}

protectedinherited

Definition at line 117 of file BaseStar.h.

{};

_magErr

double lsst::jointcal::BaseStar::_magErr {}

protectedinherited

Definition at line 118 of file BaseStar.h.

{};

vx

double lsst::jointcal::FatPoint::vx

inherited

Definition at line 36 of file FatPoint.h.

vxy

double lsst::jointcal::FatPoint::vxy

inherited

Definition at line 36 of file FatPoint.h.

vy

double lsst::jointcal::FatPoint::vy

inherited

Definition at line 36 of file FatPoint.h.

x

double lsst::jointcal::Point::x

inherited

coordinate

Definition at line 42 of file Point.h.

y

double lsst::jointcal::Point::y

inherited

Definition at line 42 of file Point.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/jointcal/g82479be7b0+f568feb641/include/lsst/jointcal/MeasuredStar.h