lsst.meas.extensions.astrometryNet.multiindex.MultiIndexCache Class Reference

Public Member Functions
def	__init__ (self, filenameList, healpix, nside)
	Constructor. More...
def	fromFilenameList (cls, filenameList)
def	read (self)
def	reload (self)
def	unload (self)
def	isWithinRange (self, coord, distance)
	Is the index within range of the provided coordinates? More...
def	__getitem__ (self, i)
def	__len__ (self)
def	__iter__ (self)

Public Attributes
	log

Detailed Description

A wrapper for the multiindex_t, which only reads the data when it
needs to

The MultiIndexCache may be instantiated directly, or via the
'fromFilenameList' class method, which loads it from a list of filenames.

Definition at line 58 of file multiindex.py.

Constructor & Destructor Documentation

__init__()

def lsst.meas.extensions.astrometryNet.multiindex.MultiIndexCache.__init__	(		self,
			filenameList,
			healpix,
			nside
	)

Constructor.

Parameters

filenameList	List of filenames; first is the multiindex, then follows the individual index files
healpix	Healpix number
nside	Healpix nside

Definition at line 66 of file multiindex.py.

    def __init__(self, filenameList, healpix, nside):
        """!Constructor

        @param filenameList  List of filenames; first is the multiindex, then
                             follows the individual index files
        @param healpix       Healpix number
        @param nside         Healpix nside
        """
        if len(filenameList) < 2:
            raise RuntimeError("Insufficient filenames provided for multiindex (%s): expected >= 2" %
                               (filenameList,))
        self._filenameList = filenameList
        self._healpix = int(healpix)
        self._nside = int(nside)
        self._mi = None
        self._loaded = False
        self.log = Log.getDefaultLogger()

Member Function Documentation

__getitem__()

def lsst.meas.extensions.astrometryNet.multiindex.MultiIndexCache.__getitem__	(		self,
			i
	)

Definition at line 153 of file multiindex.py.

    def __getitem__(self, i):
        self.reload()
        return self._mi[i]

__iter__()

def lsst.meas.extensions.astrometryNet.multiindex.MultiIndexCache.__iter__

(

self

)

Definition at line 160 of file multiindex.py.

    def __iter__(self):
        self.reload()
        return iter(self._mi)

__len__()

def lsst.meas.extensions.astrometryNet.multiindex.MultiIndexCache.__len__

(

self

)

Definition at line 157 of file multiindex.py.

    def __len__(self):
        return len(self._filenameList) - 1  # The first is the multiindex; the rest are the indices

fromFilenameList()

def lsst.meas.extensions.astrometryNet.multiindex.MultiIndexCache.fromFilenameList	(		cls,
			filenameList
	)

Construct from a list of filenames

The list of filenames should contain the multiindex filename first,
then the individual index filenames.  The healpix and nside are
determined by reading the indices, so this is not very efficient.

Definition at line 85 of file multiindex.py.

    def fromFilenameList(cls, filenameList):
        """Construct from a list of filenames

        The list of filenames should contain the multiindex filename first,
        then the individual index filenames.  The healpix and nside are
        determined by reading the indices, so this is not very efficient.
        """
        self = cls(filenameList, 0, 0)
        self.reload()
        healpixes = set(self[i].healpix for i in range(len(self)))
        nsides = set(self[i].hpnside for i in range(len(self)))
        assert len(healpixes) == 1
        assert len(nsides) == 1
        self._healpix = healpixes.pop()
        self._nside = nsides.pop()
        return self

isWithinRange()

def lsst.meas.extensions.astrometryNet.multiindex.MultiIndexCache.isWithinRange	(		self,
			coord,
			distance
	)

Is the index within range of the provided coordinates?

Parameters

coord	ICRS coordinate to check (lsst.geom.SpherPoint)
distance	Angular distance (lsst.geom.Angle)

Definition at line 145 of file multiindex.py.

    def isWithinRange(self, coord, distance):
        """!Is the index within range of the provided coordinates?

        @param coord   ICRS coordinate to check (lsst.geom.SpherPoint)
        @param distance   Angular distance (lsst.geom.Angle)
        """
        return (self._healpix == -1 or healpixDistance(self._healpix, self._nside, coord) <= distance)

read()

def lsst.meas.extensions.astrometryNet.multiindex.MultiIndexCache.read

(

self

)

Read the indices

Definition at line 102 of file multiindex.py.

    def read(self):
        """Read the indices"""
        if self._mi is not None:
            return
        fn = getIndexPath(self._filenameList[0])
        if not os.path.exists(fn):
            raise RuntimeError(
                "Unable to get filename for astrometry star file %s" % (self._filenameList[0],))
        self._mi = MultiIndex(fn)
        if self._mi is None:
            # Can't proceed at all without stars
            raise RuntimeError('Failed to read stars from astrometry multiindex filename "%s"' % fn)
        for i, fn in enumerate(self._filenameList[1:]):
            if fn is None:
                self.log.debug('Unable to find index part of multiindex %s', fn)
                continue
            fn = getIndexPath(fn)
            if not os.path.exists(fn):
                self.log.warn("Unable to get filename for astrometry index %s", fn)
                continue
            self.log.debug('Reading index from multiindex file "%s"', fn)
            self._mi.addIndex(fn, False)
            ind = self._mi[i]
            self.log.debug('  index %i, hp %i (nside %i), nstars %i, nquads %i',
                           ind.indexid, ind.healpix, ind.hpnside, ind.nstars, ind.nquads)

reload()

def lsst.meas.extensions.astrometryNet.multiindex.MultiIndexCache.reload

(

self

)

Reload the indices.

Definition at line 128 of file multiindex.py.

    def reload(self):
        """Reload the indices."""
        if self._loaded:
            return
        if self._mi is None:
            self.read()
        else:
            self._mi.reload()
        self._loaded = True

unload()

def lsst.meas.extensions.astrometryNet.multiindex.MultiIndexCache.unload

(

self

)

Unload the indices

Definition at line 138 of file multiindex.py.

    def unload(self):
        """Unload the indices"""
        if not self._loaded:
            return
        self._mi.unload()
        self._loaded = False

Member Data Documentation

log

lsst.meas.extensions.astrometryNet.multiindex.MultiIndexCache.log

Definition at line 82 of file multiindex.py.

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/meas_extensions_astrometryNet/18.1.0-3-g9bc06b8+7/python/lsst/meas/extensions/astrometryNet/multiindex.py