The class that implements the relations between MeasuredStar and FittedStar. More...

#include <Associations.h>

Public Member Functions
size_t	refStarListSize ()

size_t	fittedStarListSize ()

	Associations ()
	Source selection is performed in python, so Associations' constructor only initializes a couple of variables. More...

	Associations (CcdImageList const &imageList)
	Create an Associations object from a pre-built list of ccdImages. More...

	Associations (Associations const &)=delete
	No moves or copies: jointcal only ever needs one Associations object. More...

	Associations (Associations &&)=delete

Associations &	operator= (Associations const &)=delete

Associations &	operator= (Associations &&)=delete

void	computeCommonTangentPoint ()
	Sets a shared tangent point for all ccdImages, using the mean of the centers of all ccdImages. More...

void	setCommonTangentPoint (lsst::afw::geom::Point2D const &commonTangentPoint)
	Sets a shared tangent point for all ccdImages. More...

Point	getCommonTangentPoint () const
	can be used to project sidereal coordinates related to the image set on a plane. More...

void	createCcdImage (afw::table::SourceCatalog &catalog, std::shared_ptr< lsst::afw::geom::SkyWcs > wcs, std::shared_ptr< lsst::afw::image::VisitInfo > visitInfo, lsst::afw::geom::Box2I const &bbox, std::string const &filter, std::shared_ptr< afw::image::PhotoCalib > photoCalib, std::shared_ptr< afw::cameraGeom::Detector > detector, int visit, int ccd, lsst::jointcal::JointcalControl const &control)
	Create a ccdImage from an exposure catalog and metadata, and add it to the list. More...

void	associateCatalogs (const double matchCutInArcsec=0, const bool useFittedList=false, const bool enlargeFittedList=true)
	incrementaly builds a merged catalog of all image catalogs More...

void	collectRefStars (afw::table::SimpleCatalog &refCat, afw::geom::Angle matchCut, std::string const &fluxField, RefFluxMapType const &refFluxMap=RefFluxMapType(), RefFluxMapType const &refFluxErrMap=RefFluxMapType(), bool rejectBadFluxes=false)
	Collect stars from an external reference catalog and associate them with fittedStars. More...

void	deprojectFittedStars ()
	Sends back the fitted stars coordinates on the sky FittedStarsList::inTangentPlaneCoordinates keeps track of that. More...

void	prepareFittedStars (int minMeasurements)
	Set the color field of FittedStar 's from a colored catalog. More...

CcdImageList const &	getCcdImageList () const

unsigned	getNFilters () const
	Number of different bands in the input image list. Not implemented so far. More...

const lsst::afw::geom::Box2D	getRaDecBBox ()

int	nCcdImagesValidForFit () const
	return the number of CcdImages with non-empty catalogs to-be-fit. More...

size_t	nFittedStarsWithAssociatedRefStar () const
	Return the number of fittedStars that have an associated refStar. More...

Public Attributes
CcdImageList	ccdImageList

RefStarList	refStarList

FittedStarList	fittedStarList

Detailed Description

The class that implements the relations between MeasuredStar and FittedStar.

Definition at line 30 of file Associations.h.

Constructor & Destructor Documentation

◆ Associations() [1/4]

lsst::jointcal::Associations::Associations ( )

inline

Source selection is performed in python, so Associations' constructor only initializes a couple of variables.

Definition at line 45 of file Associations.h.

◆ Associations() [2/4]

lsst::jointcal::Associations::Associations ( CcdImageList const & imageList )

inline

Create an Associations object from a pre-built list of ccdImages.

This is primarily useful for tests that build their own ccdImageList, but it could be used to help parallelize the creation of the ccdImages.

Parameters

imageList A pre-built ccdImage list.

Definition at line 57 of file Associations.h.

◆ Associations() [3/4]

lsst::jointcal::Associations::Associations ( Associations const & )

delete

No moves or copies: jointcal only ever needs one Associations object.

◆ Associations() [4/4]

lsst::jointcal::Associations::Associations ( Associations && )

delete

Member Function Documentation

◆ associateCatalogs()

void lsst::jointcal::Associations::associateCatalogs	(	const double	matchCutInArcsec = `0`,
		const bool	useFittedList = `false`,
		const bool	enlargeFittedList = `true`
	)

incrementaly builds a merged catalog of all image catalogs

Definition at line 66 of file Associations.cc.

◆ collectRefStars()

void lsst::jointcal::Associations::collectRefStars	(	afw::table::SimpleCatalog &	refCat,
		afw::geom::Angle	matchCut,
		std::string const &	fluxField,
		RefFluxMapType const &	refFluxMap = `RefFluxMapType()`,
		RefFluxMapType const &	refFluxErrMap = `RefFluxMapType()`,
		bool	rejectBadFluxes = `false`
	)

Collect stars from an external reference catalog and associate them with fittedStars.

Parameters

	refCat	The catalog of reference sources
[in]	matchCut	Separation radius to match fitted and reference stars.
	fluxField	The field name in refCat to get the flux from.
	refFluxMap	fluxes per filter of corresponding refCat objects (can be empty)
	refFluxErrMap	flux errors per filter of corresponding refCat objects (can be empty)
	rejectBadFluxes	Reject reference sources with flux=NaN or 0 and/or fluxErr=NaN or 0. Typically false for astrometry and true for photometry.

Definition at line 145 of file Associations.cc.

◆ computeCommonTangentPoint()

void lsst::jointcal::Associations::computeCommonTangentPoint ( )

Sets a shared tangent point for all ccdImages, using the mean of the centers of all ccdImages.

Definition at line 50 of file Associations.cc.

◆ createCcdImage()

void lsst::jointcal::Associations::createCcdImage	(	afw::table::SourceCatalog &	catalog,
		std::shared_ptr< lsst::afw::geom::SkyWcs >	wcs,
		std::shared_ptr< lsst::afw::image::VisitInfo >	visitInfo,
		lsst::afw::geom::Box2I const &	bbox,
		std::string const &	filter,
		std::shared_ptr< afw::image::PhotoCalib >	photoCalib,
		std::shared_ptr< afw::cameraGeom::Detector >	detector,
		int	visit,
		int	ccd,
		lsst::jointcal::JointcalControl const &	control
	)

Create a ccdImage from an exposure catalog and metadata, and add it to the list.

Parameters

[in]	catalog	The extracted source catalog, selected for good astrometric sources.
[in]	wcs	The exposure's original wcs
[in]	visitInfo	The exposure's visitInfo object
[in]	bbox	The bounding box of the exposure
[in]	filter	The exposure's filter
[in]	photoCalib	The exposure's photometric calibration
[in]	detector	The exposure's detector
[in]	visit	The visit identifier
[in]	ccd	The ccd identifier
[in]	control	The JointcalControl object

Definition at line 36 of file Associations.cc.

◆ deprojectFittedStars()

void lsst::jointcal::Associations::deprojectFittedStars ( )

Sends back the fitted stars coordinates on the sky FittedStarsList::inTangentPlaneCoordinates keeps track of that.

Definition at line 357 of file Associations.cc.

◆ fittedStarListSize()

size_t lsst::jointcal::Associations::fittedStarListSize ( )

inline

Definition at line 39 of file Associations.h.

◆ getCcdImageList()

CcdImageList const& lsst::jointcal::Associations::getCcdImageList ( ) const

inline

Definition at line 143 of file Associations.h.

◆ getCommonTangentPoint()

Point lsst::jointcal::Associations::getCommonTangentPoint ( ) const

inline

can be used to project sidereal coordinates related to the image set on a plane.

Definition at line 81 of file Associations.h.

◆ getNFilters()

unsigned lsst::jointcal::Associations::getNFilters ( ) const

inline

Number of different bands in the input image list. Not implemented so far.

Definition at line 146 of file Associations.h.

◆ getRaDecBBox()

const lsst::afw::geom::Box2D lsst::jointcal::Associations::getRaDecBBox ( )

Definition at line 218 of file Associations.cc.

◆ nCcdImagesValidForFit()

int lsst::jointcal::Associations::nCcdImagesValidForFit ( ) const

return the number of CcdImages with non-empty catalogs to-be-fit.

Definition at line 371 of file Associations.cc.

◆ nFittedStarsWithAssociatedRefStar()

size_t lsst::jointcal::Associations::nFittedStarsWithAssociatedRefStar ( ) const

Return the number of fittedStars that have an associated refStar.

Definition at line 377 of file Associations.cc.

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

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

delete

◆ prepareFittedStars()

void lsst::jointcal::Associations::prepareFittedStars ( int minMeasurements )

Set the color field of FittedStar 's from a colored catalog.

Prepare the fittedStar list by making quality cuts and normalizing measurements.

Parameters

[in] minMeasurements The minimum number of measuredStars for a FittedStar to be included.

Definition at line 268 of file Associations.cc.

◆ refStarListSize()

size_t lsst::jointcal::Associations::refStarListSize ( )

inline

Definition at line 38 of file Associations.h.

◆ setCommonTangentPoint()

void lsst::jointcal::Associations::setCommonTangentPoint ( lsst::afw::geom::Point2D const & commonTangentPoint )

Sets a shared tangent point for all ccdImages.

Parameters

commonTangentPoint The common tangent point of all input images (decimal degrees).

Definition at line 61 of file Associations.cc.

Member Data Documentation

◆ ccdImageList

CcdImageList lsst::jointcal::Associations::ccdImageList

Definition at line 32 of file Associations.h.

◆ fittedStarList

FittedStarList lsst::jointcal::Associations::fittedStarList

Definition at line 34 of file Associations.h.

◆ refStarList

RefStarList lsst::jointcal::Associations::refStarList

Definition at line 33 of file Associations.h.

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

include/lsst/jointcal/Associations.h
src/Associations.cc

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Associations() [1/4]

◆ Associations() [2/4]

◆ Associations() [3/4]

◆ Associations() [4/4]

Member Function Documentation

◆ associateCatalogs()

◆ collectRefStars()

◆ computeCommonTangentPoint()

◆ createCcdImage()

◆ deprojectFittedStars()

◆ fittedStarListSize()

◆ getCcdImageList()

◆ getCommonTangentPoint()

◆ getNFilters()

◆ getRaDecBBox()

◆ nCcdImagesValidForFit()

◆ nFittedStarsWithAssociatedRefStar()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ prepareFittedStars()

◆ refStarListSize()

◆ setCommonTangentPoint()

Member Data Documentation

◆ ccdImageList

◆ fittedStarList

◆ refStarList