lsst.meas.extensions.astrometryNet  18.1.0-2-g31c43f9+14
Public Member Functions | Public Attributes | List of all members
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
filenameListList of filenames; first is the multiindex, then follows the individual index files
healpixHealpix number
nsideHealpix nside

Definition at line 66 of file multiindex.py.

Member Function Documentation

◆ __getitem__()

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

Definition at line 153 of file multiindex.py.

◆ __iter__()

def lsst.meas.extensions.astrometryNet.multiindex.MultiIndexCache.__iter__ (   self)

Definition at line 160 of file multiindex.py.

◆ __len__()

def lsst.meas.extensions.astrometryNet.multiindex.MultiIndexCache.__len__ (   self)

Definition at line 157 of file multiindex.py.

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

◆ isWithinRange()

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

Is the index within range of the provided coordinates?

Parameters
coordICRS coordinate to check (lsst.geom.SpherPoint)
distanceAngular distance (lsst.geom.Angle)

Definition at line 145 of file multiindex.py.

◆ read()

def lsst.meas.extensions.astrometryNet.multiindex.MultiIndexCache.read (   self)
Read the indices

Definition at line 102 of file multiindex.py.

◆ reload()

def lsst.meas.extensions.astrometryNet.multiindex.MultiIndexCache.reload (   self)
Reload the indices.

Definition at line 128 of file multiindex.py.

◆ unload()

def lsst.meas.extensions.astrometryNet.multiindex.MultiIndexCache.unload (   self)
Unload the indices

Definition at line 138 of file multiindex.py.

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: