lsst.meas.extensions.astrometryNet  14.0-2-g519ff97
Classes | Public Member Functions | List of all members
lsst::meas::extensions::astrometryNet::Solver Class Reference

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::afw::coord::Coord const &ctrCoord, lsst::afw::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::PropertyListgetSolveStats () const
 
std::shared_ptr< lsst::afw::geom::SkyWcsgetWcs ()
 
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 119 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.

◆ ~Solver()

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

Definition at line 65 of file astrometry_net.cc.

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.

◆ didSolve()

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

Definition at line 170 of file astrometry_net.h.

◆ getCatalog()

lsst::afw::table::SimpleCatalog lsst::meas::extensions::astrometryNet::Solver::getCatalog ( std::vector< index_t *>  inds,
lsst::afw::coord::Coord const &  ctrCoord,
lsst::afw::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]indslist of star kd-trees from astrometry.net
[in]ctrCoordcenter of search region
[in]radiussearch radius
[in]idColname of ID column in astrometry.net data
[in]filterNameListnames of filters in astrometry.net data
[in]magColListnames of magnitude columns in astrometry.net data
[in]magErrColListnames of magnitude uncertainty (sigma) columns in astrometry.net data
[in]starGalColname of "starGal" column (true if object is a star) in astrometry.net data
[in]varColname of "var" column (true if brightness is variable) in astrometry.net data
[in]uniqueIdsif true then only return unique IDs (the first of each seen)

Returned schema:

  • id
  • coord: sky position (an lsst::afw::coord::IcrsCoord)
  • centroid: centroid on some exposure, if relevant (an lsst::afw::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_fluxSigma: 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.

◆ getQuadSizeRangeArcsec()

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

Definition at line 176 of file astrometry_net.h.

◆ getSolveStats()

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

Definition at line 100 of file astrometry_net.cc.

◆ getWcs()

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

Definition at line 141 of file astrometry_net.cc.

◆ run()

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

Definition at line 159 of file astrometry_net.cc.

◆ setImageSize()

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

Definition at line 212 of file astrometry_net.cc.

◆ setMatchThreshold()

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

Definition at line 197 of file astrometry_net.h.

◆ setMaxStars()

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

Definition at line 212 of file astrometry_net.h.

◆ setParity()

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

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

Definition at line 193 of file astrometry_net.h.

◆ setPixelScaleRange()

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

Definition at line 201 of file astrometry_net.h.

◆ setRaDecRadius()

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

Definition at line 206 of file astrometry_net.h.

◆ 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.


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