A thin C++ wrapper around astrometry.net's solver_t struct. More...

#include <astrometry_net.h>

Public Member Functions
	Solver ()

	~Solver ()

lsst::afw::table::SimpleCatalog	getCatalog (std::vector< index_t > inds, lsst::geom::SpherePoint const &ctrCoord, lsst::geom::Angle const &radius, const char idCol, std::vector< std::string > const &filterNameList, std::vector< std::string > const &magColList, std::vector< std::string > const &magErrColList, const char starGalCol, const char varCol, bool uniqueIds=true)
	Load reference objects in a region of the sky described by a center coordinate and a radius. More...

std::shared_ptr< lsst::daf::base::PropertyList >	getSolveStats () const

std::shared_ptr< lsst::afw::geom::SkyWcs >	getWcs ()

bool	didSolve () const

void	run (double cpulimit)

std::pair< double, double >	getQuadSizeRangeArcsec () const

void	addIndices (std::vector< index_t *> inds)
	Add indices to the solver. More...

void	setParity (bool flipped)
	Set parity to flipped (if true) or normal (if false) More...

void	setMatchThreshold (double threshold)

void	setPixelScaleRange (double low, double high)

void	setRaDecRadius (double ra, double dec, double radius_deg)

void	setImageSize (int width, int height)

void	setMaxStars (int maxStars)

void	setStars (lsst::afw::table::SourceCatalog const &srcs, int x0, int y0)

Detailed Description

A thin C++ wrapper around astrometry.net's solver_t struct.

This provide memory management and methods used by LSST.

Definition at line 120 of file astrometry_net.h.

Constructor & Destructor Documentation

◆ Solver()

lsst::meas::extensions::astrometryNet::Solver::Solver ( )

explicit

Definition at line 63 of file astrometry_net.cc.

63 : _solver(solver_new()) {}

◆ ~Solver()

lsst::meas::extensions::astrometryNet::Solver::~Solver ( )

Definition at line 65 of file astrometry_net.cc.

                 {
     // Working around a bug in Astrometry.net: doesn't take ownership of the field.
     // unseemly familiarity with the innards... but valgrind-clean.
     starxy_free(_solver->fieldxy);
     _solver->fieldxy = NULL;
 }

Member Function Documentation

◆ addIndices()

void lsst::meas::extensions::astrometryNet::Solver::addIndices ( std::vector< index_t *> inds )

Add indices to the solver.

The indices are bare pointers whose memory is managed by the caller. Typically the indices are owned by a MultiIndex object owned by the caller.

Definition at line 181 of file astrometry_net.cc.

                                                 {
     for (std::vector<index_t*>::iterator pind = inds.begin();
          pind != inds.end(); ++pind) {
         detail::IndexManager man(*pind);
 //            printf("Checking index \"%s\"\n", man.index->indexname);
         if (_solver->use_radec) {
             double ra,dec,radius;
             xyzarr2radecdeg(_solver->centerxyz, &ra, &dec);
             radius = distsq2deg(_solver->r2);
             if (!index_is_within_range(man.index, ra, dec, radius)) {
                                  //printf("Not within RA,Dec range\n");
                 continue;
             }
         }
         // qlo,qhi in arcsec
         double qlo, qhi;
         solver_get_quad_size_range_arcsec(_solver.get(), &qlo, &qhi);
         if (!index_overlaps_scale_range(man.index, qlo, qhi)) {
 //                printf("Not within quad scale range\n");
             continue;
         }
 //            printf("Adding index.\n");
         if (index_reload(man.index)) {
             throw LSST_EXCEPT(lsst::pex::exceptions::IoError,
                               "Failed to index_reload() an astrometry_net_data index file -- out of file descriptors?");
         }
 
         solver_add_index(_solver.get(), man.index);
     }
 }

◆ didSolve()

bool lsst::meas::extensions::astrometryNet::Solver::didSolve ( ) const

inline

Definition at line 171 of file astrometry_net.h.

                           {
         return solver_did_solve(_solver.get());
     }

◆ getCatalog()

lsst::afw::table::SimpleCatalog lsst::meas::extensions::astrometryNet::Solver::getCatalog	(	std::vector< index_t *>	inds,
		lsst::geom::SpherePoint const &	ctrCoord,
		lsst::geom::Angle const &	radius,
		const char *	idCol,
		std::vector< std::string > const &	filterNameList,
		std::vector< std::string > const &	magColList,
		std::vector< std::string > const &	magErrColList,
		const char *	starGalCol,
		const char *	varCol,
		bool	uniqueIds = `true`
	)

Load reference objects in a region of the sky described by a center coordinate and a radius.

Parameters

[in]	inds	list of star kd-trees from astrometry.net
[in]	ctrCoord	center of search region
[in]	radius	search radius
[in]	idCol	name of ID column in astrometry.net data
[in]	filterNameList	names of filters in astrometry.net data
[in]	magColList	names of magnitude columns in astrometry.net data
[in]	magErrColList	names of magnitude uncertainty (sigma) columns in astrometry.net data
[in]	starGalCol	name of "starGal" column (true if object is a star) in astrometry.net data
[in]	varCol	name of "var" column (true if brightness is variable) in astrometry.net data
[in]	uniqueIds	if true then only return unique IDs (the first of each seen)

Returned schema:

id
coord: ICRS sky position (an lsst::geom::SpherePoint)
centroid: centroid on some exposure, if relevant (an lsst::geom::Point2D); returned value is not set
hasCentroid: if true then centroid has been set; returned value is false
filterName_flux: flux in the specified filter (double)
filterName_fluxErr: flux uncertainty in the specified filter (double)
resolved (if starGalCol specified): true if object is not resolved
variable (if varCol specified): true if brightness is variable
photometric: true if not resolved (or starGalCol blank) and not variable (or varCol blank); note that if starGalCol and varCol both blank then all objects are claimed to be photometric

Definition at line 72 of file astrometry_net.cc.

 {
     if ((filterNameList.size() != magColList.size()) || (filterNameList.size() != magErrColList.size())) {
         throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
             "Filter name, mag column, and mag error column vectors must be the same length.");
     }
     std::vector<detail::MagColInfo> magColInfoList;
     for (size_t i=0; i<filterNameList.size(); ++i) {
         astrometryNet::detail::MagColInfo mc;
         mc.filterName = filterNameList[i];
         mc.magCol = magColList[i];
         mc.magErrCol = magErrColList[i];
         magColInfoList.push_back(mc);
     }
     return detail::getCatalogImpl(inds, ctrCoord, radius,
         idCol, magColInfoList, starGalCol, varCol, uniqueIds);
 }

◆ getQuadSizeRangeArcsec()

std::pair<double, double> lsst::meas::extensions::astrometryNet::Solver::getQuadSizeRangeArcsec ( ) const

inline

Definition at line 177 of file astrometry_net.h.

                                                            {
         double qlo,qhi;
         solver_get_quad_size_range_arcsec(_solver.get(), &qlo, &qhi);
         return std::make_pair(qlo, qhi);
     }

◆ getSolveStats()

std::shared_ptr< lsst::daf::base::PropertyList > lsst::meas::extensions::astrometryNet::Solver::getSolveStats ( ) const

Definition at line 100 of file astrometry_net.cc.

                                                                    {
     // Gather solve stats...
     auto qa = std::make_shared<daf::base::PropertyList>();
     // FIXME -- Ticket #1875 prevents dotted-names from working with toString().
     qa->set("meas_astrom*an*n_tried", _solver->numtries);
     qa->set("meas_astrom*an*n_matched", _solver->nummatches);
     qa->set("meas_astrom*an*n_scaleok", _solver->numscaleok);
     qa->set("meas_astrom*an*n_cxdxcut", _solver->num_cxdx_skipped);
     qa->set("meas_astrom*an*n_meanxcut", _solver->num_meanx_skipped);
     qa->set("meas_astrom*an*n_radeccut", _solver->num_radec_skipped);
     qa->set("meas_astrom*an*n_scalecut", _solver->num_abscale_skipped);
     qa->set("meas_astrom*an*n_verified", _solver->num_verified);
     qa->set("meas_astrom*an*time_used", _solver->timeused);
     qa->set("meas_astrom*an*best_logodds", _solver->best_logodds);
     if (_solver->best_index) {
         index_t* ind = _solver->best_index;
         qa->set("meas_astrom*an*best_index*id", ind->indexid);
         qa->set("meas_astrom*an*best_index*hp", ind->healpix);
         qa->set("meas_astrom*an*best_index*nside", ind->hpnside);
         qa->set("meas_astrom*an*best_index*name", std::string(ind->indexname));
     }
     if (_solver->have_best_match) {
         MatchObj* mo = &(_solver->best_match);
         std::string s = boost::str(boost::format("%i") % mo->star[0]);
         for (int i=1; i<mo->dimquads; i++)
             s = s + boost::str(boost::format(", %i") % mo->star[i]);
         qa->set("meas_astrom*an*best_match*starinds", s);
         qa->set("meas_astrom*an*best_match*coderr", std::sqrt(mo->code_err));
         qa->set("meas_astrom*an*best_match*nmatch", mo->nmatch);
         qa->set("meas_astrom*an*best_match*ndistract", mo->ndistractor);
         qa->set("meas_astrom*an*best_match*nconflict", mo->nconflict);
         qa->set("meas_astrom*an*best_match*nfield", mo->nfield);
         qa->set("meas_astrom*an*best_match*nindex", mo->nindex);
         qa->set("meas_astrom*an*best_match*nbest", mo->nbest);
         qa->set("meas_astrom*an*best_match*logodds", mo->logodds);
         qa->set("meas_astrom*an*best_match*parity", mo->parity ? 0 : 1);
         qa->set("meas_astrom*an*best_match*nobjs", mo->objs_tried);
     }
     return qa;
 }

◆ getWcs()

std::shared_ptr< lsst::afw::geom::SkyWcs > lsst::meas::extensions::astrometryNet::Solver::getWcs ( )

Definition at line 141 of file astrometry_net.cc.

                                                 {
     MatchObj* match = solver_get_best_match(_solver.get());
     if (!match)
         return std::shared_ptr<afw::geom::SkyWcs>();
     tan_t* wcs = &(match->wcstan);
 
     geom::Point2D crpix(wcs->crpix[0], wcs->crpix[1]);
     auto const crval = geom::SpherePoint(wcs->crval[0] * geom::degrees,
                                          wcs->crval[1] * geom::degrees);
     Eigen::Matrix2d cdMatrix;
     for (int i = 0; i < 2; ++i) {
         for (int j = 0; j < 2; ++j) {
             cdMatrix(i, j) = wcs->cd[i][j];
         }
     }
     return afw::geom::makeSkyWcs(crpix, crval, cdMatrix);
 }

◆ run()

void lsst::meas::extensions::astrometryNet::Solver::run ( double cpulimit )

Definition at line 159 of file astrometry_net.cc.

                                 {
     solver_log_params(_solver.get());
     struct timer_baton tt;
     if (cpulimit > 0.) {
         tt.s = _solver.get();
         tt.timelimit = cpulimit;
         _solver->userdata = &tt;
         _solver->timer_callback = timer_callback;
     }
     solver_run(_solver.get());
     if (cpulimit > 0.) {
         _solver->timer_callback = NULL;
         _solver->userdata = NULL;
     }
 }

◆ setImageSize()

void lsst::meas::extensions::astrometryNet::Solver::setImageSize	(	int	width,
		int	height
	)

Definition at line 212 of file astrometry_net.cc.

                                                {
     solver_set_field_bounds(_solver.get(), 0, width, 0, height);
     double hi = hypot(width, height);
     double lo = 0.1 * std::min(width, height);
     solver_set_quad_size_range(_solver.get(), lo, hi);
 }

◆ setMatchThreshold()

void lsst::meas::extensions::astrometryNet::Solver::setMatchThreshold ( double threshold )

inline

Definition at line 198 of file astrometry_net.h.

                                              {
         solver_set_keep_logodds(_solver.get(), threshold);
     }

◆ setMaxStars()

void lsst::meas::extensions::astrometryNet::Solver::setMaxStars ( int maxStars )

inline

Definition at line 213 of file astrometry_net.h.

                                    {
         _solver->endobj = maxStars;
     }

◆ setParity()

void lsst::meas::extensions::astrometryNet::Solver::setParity ( bool flipped )

inline

Set parity to flipped (if true) or normal (if false)

Definition at line 194 of file astrometry_net.h.

                                  {
         _solver->parity = flipped ? PARITY_FLIP : PARITY_NORMAL;
     }

◆ setPixelScaleRange()

void lsst::meas::extensions::astrometryNet::Solver::setPixelScaleRange	(	double	low,
		double	high
	)

inline

Definition at line 202 of file astrometry_net.h.

                                                      {
         _solver->funits_lower = low;
         _solver->funits_upper = high;
     }

◆ setRaDecRadius()

void lsst::meas::extensions::astrometryNet::Solver::setRaDecRadius	(	double	ra,
		double	dec,
		double	radius_deg
	)

inline

Definition at line 207 of file astrometry_net.h.

                                                                   {
         solver_set_radec(_solver.get(), ra, dec, radius_deg);
     }

◆ setStars()

void lsst::meas::extensions::astrometryNet::Solver::setStars	(	lsst::afw::table::SourceCatalog const &	srcs,
		int	x0,
		int	y0
	)

Definition at line 219 of file astrometry_net.cc.

                                                                             {
     // convert to Astrometry.net "starxy_t"
     starxy_free(_solver->fieldxy);
     const size_t N = srcs.size();
     starxy_t *starxy = starxy_new(N, true, false);
     for (size_t i=0; i<N; ++i) {
         double const x    = srcs[i].getX();
         double const y    = srcs[i].getY();
         double const flux = srcs[i].getPsfInstFlux();
         starxy_set(starxy, i, x - x0, y - y0);
         starxy_set_flux(starxy, i, flux);
     }
     // Sort the array
     starxy_sort_by_flux(starxy);
 
     starxy_free(solver_get_field(_solver.get()));
     solver_free_field(_solver.get());
     solver_set_field(_solver.get(), starxy);
     solver_reset_field_size(_solver.get());
     // Find field boundaries and precompute kdtree
     solver_preprocess_field(_solver.get());
 }

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

/j/snowflake/release/lsstsw/stack/Linux64/meas_extensions_astrometryNet/18.1.0-3-g9bc06b8+7/include/lsst/meas/extensions/astrometryNet/astrometry_net.h
/j/snowflake/release/lsstsw/stack/Linux64/meas_extensions_astrometryNet/18.1.0-3-g9bc06b8+7/src/astrometry_net.cc

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Solver()

◆ ~Solver()

Member Function Documentation

◆ addIndices()

◆ didSolve()

◆ getCatalog()

◆ getQuadSizeRangeArcsec()

◆ getSolveStats()

◆ getWcs()

◆ run()

◆ setImageSize()

◆ setMatchThreshold()

◆ setMaxStars()

◆ setParity()

◆ setPixelScaleRange()

◆ setRaDecRadius()

◆ setStars()