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

Public Member Functions
def	__init__ (self, andConfig)
	Constructor. More...
def	writeCache (self)
def	__getitem__ (self, ii)
def	__iter__ (self)
def	__len__ (self)

Public Attributes
	config

Detailed Description

An interface to an astrometry.net catalog

Behaves like a list of MultiIndexCache (or multiindex_t).

These should usually be constructed using the 'fromEnvironment'
class method, which wraps the 'fromIndexFiles' and 'fromCache'
alternative class methods.

Definition at line 165 of file multiindex.py.

Constructor & Destructor Documentation

__init__()

def lsst.meas.extensions.astrometryNet.multiindex.AstrometryNetCatalog.__init__	(		self,
			andConfig
	)

Constructor.

Parameters

andConfig

Configuration (an AstrometryNetDataConfig)

Definition at line 176 of file multiindex.py.

    def __init__(self, andConfig):
        """!Constructor

        @param andConfig   Configuration (an AstrometryNetDataConfig)
        """
        self.config = andConfig
        cacheName = getIndexPath(self._cacheFilename)
        if self.config.allowCache and os.path.exists(cacheName):
            self._initFromCache(cacheName)
        else:
            self._initFromIndexFiles(self.config)

Member Function Documentation

__getitem__()

def lsst.meas.extensions.astrometryNet.multiindex.AstrometryNetCatalog.__getitem__	(		self,
			ii
	)

Definition at line 253 of file multiindex.py.

    def __getitem__(self, ii):
        return self._multiInds[ii]

__iter__()

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

(

self

)

Definition at line 256 of file multiindex.py.

    def __iter__(self):
        return iter(self._multiInds)

__len__()

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

(

self

)

Definition at line 259 of file multiindex.py.

    def __len__(self):
        return len(self._multiInds)

writeCache()

def lsst.meas.extensions.astrometryNet.multiindex.AstrometryNetCatalog.writeCache

(

self

)

Write a cache file

The cache file is a FITS file with all the required information to
build the AstrometryNetCatalog quickly.  The first table extension
contains a row for each multiindex, storing the healpix and nside
values.  The second table extension contains a row for each filename
in all the multiindexes.  The two may be JOINed through the 'id'
column.

Definition at line 193 of file multiindex.py.

    def writeCache(self):
        """Write a cache file

        The cache file is a FITS file with all the required information to
        build the AstrometryNetCatalog quickly.  The first table extension
        contains a row for each multiindex, storing the healpix and nside
        values.  The second table extension contains a row for each filename
        in all the multiindexes.  The two may be JOINed through the 'id'
        column.
        """
        outName = getIndexPath(self._cacheFilename)
        numFilenames = sum(len(ind._filenameList) for ind in self._multiInds)
        maxLength = max(len(fn) for ind in self._multiInds for fn in ind._filenameList) + 1

        # First table
        first = fits.BinTableHDU.from_columns([fits.Column(name="id", format="K"),
                                               fits.Column(name="healpix", format="K"),
                                               fits.Column(name="nside", format="K"),
                                               ], nrows=len(self._multiInds))
        first.data.field("id")[:] = np.arange(len(self._multiInds), dtype=int)
        first.data.field("healpix")[:] = np.array([ind._healpix for ind in self._multiInds])
        first.data.field("nside")[:] = np.array([ind._nside for ind in self._multiInds])

        # Second table
        second = fits.BinTableHDU.from_columns([fits.Column(name="id", format="K"),
                                                fits.Column(name="filename", format="%dA" % (maxLength)),
                                                ], nrows=numFilenames)
        ident = second.data.field("id")
        filenames = second.data.field("filename")
        i = 0
        for j, ind in enumerate(self._multiInds):
            for fn in ind._filenameList:
                ident[i] = j
                filenames[i] = fn
                i += 1

        fits.HDUList([fits.PrimaryHDU(), first, second]).writeto(outName, overwrite=True)

Member Data Documentation

config

lsst.meas.extensions.astrometryNet.multiindex.AstrometryNetCatalog.config

Definition at line 181 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