lsst::meas::extensions::astrometryNet::MultiIndex Class Reference

#include <astrometry_net.h>

Public Member Functions
	MultiIndex (std::string const &filepath)
	Construct a MultiIndex from an astrometry.net multi-index file. More...
	~MultiIndex ()
index_t *	operator[] (int i) const
	Get the specified index. More...
void	addIndex (std::string const &filepath, bool metadataOnly)
	Add an index read from a file. More...
int	isWithinRange (double ra, double dec, double radius_deg)
	Is this multi-index in range of the specified cone? More...
void	unload ()
	Unload the indices. More...
std::string	getName () const
int	getLength () const
	Get the number of indices. More...
void	reload ()
	Reload the indices. More...

Detailed Description

Definition at line 51 of file astrometry_net.h.

Constructor & Destructor Documentation

MultiIndex()

lsst::meas::extensions::astrometryNet::MultiIndex::MultiIndex

(

std::string const &

filepath

)

Construct a MultiIndex from an astrometry.net multi-index file.

Definition at line 32 of file astrometry_net.cc.

                                                 : _multiindex(multiindex_new(filepath.c_str())) {
    if (!_multiindex) {
        std::ostringstream os;
        os << "Could not read multi-index star file " << filepath;
        throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, os.str());
    }
}

~MultiIndex()

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

inline

Definition at line 60 of file astrometry_net.h.

{}

Member Function Documentation

addIndex()

void lsst::meas::extensions::astrometryNet::MultiIndex::addIndex	(	std::string const &	filepath,
		bool	metadataOnly
	)

Add an index read from a file.

Definition at line 40 of file astrometry_net.cc.

                                                                       {
    int const flags = metadataOnly ? INDEX_ONLY_LOAD_METADATA : 0;
    if (multiindex_add_index(_multiindex.get(), filepath.c_str(), flags)) {
        std::ostringstream os;
        os << "Failed to read multiindex from \"" << filepath << "\""
            << " with meatadaOnly=" << metadataOnly;
        throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, os.str());
    }
}

getLength()

int lsst::meas::extensions::astrometryNet::MultiIndex::getLength ( ) const

inline

Get the number of indices.

Definition at line 93 of file astrometry_net.h.

                          {
        return multiindex_n(_multiindex.get());
    }

getName()

std::string lsst::meas::extensions::astrometryNet::MultiIndex::getName ( ) const

inline

Definition at line 86 of file astrometry_net.h.

                              {
        return _multiindex->fits->filename;
    }

isWithinRange()

int lsst::meas::extensions::astrometryNet::MultiIndex::isWithinRange	(	double	ra,
		double	dec,
		double	radius_deg
	)

Is this multi-index in range of the specified cone?

Definition at line 50 of file astrometry_net.cc.

                                                                      {
    return index_is_within_range(multiindex_get(_multiindex.get(), 0), ra, dec, radius_deg);
}

operator[]()

index_t* lsst::meas::extensions::astrometryNet::MultiIndex::operator[] ( int  i ) const

inline

Get the specified index.

Definition at line 65 of file astrometry_net.h.

                                      {
        return multiindex_get(_multiindex.get(), i);
    }

reload()

void lsst::meas::extensions::astrometryNet::MultiIndex::reload

(

)

Reload the indices.

Definition at line 54 of file astrometry_net.cc.

                        {
    if (multiindex_reload_starkd(_multiindex.get())) {
        std::ostringstream os;
        os << "Failed to reload multi-index star file " << getName();
        throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, os.str());
    }
}

unload()

void lsst::meas::extensions::astrometryNet::MultiIndex::unload ( )

inline

Unload the indices.

Definition at line 82 of file astrometry_net.h.

                  {
        multiindex_unload(_multiindex.get());
    }

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/meas_extensions_astrometryNet/17.0.1-3-gd08d533+40/include/lsst/meas/extensions/astrometryNet/astrometry_net.h
• /j/snowflake/release/lsstsw/stack/Linux64/meas_extensions_astrometryNet/17.0.1-3-gd08d533+40/src/astrometry_net.cc