HMpTy.htm.htm.Matcher (class)

class HMpTy.htm.htm.Matcher(ra, dec, depth=16, log=False, convertToArray=True)[source]

A matcher-array object to match other arrays of ra,dec against

The Matcher object is initialized with a set of ra,dec coordinates and can then be used and reused to match against other sets of coordinates

Key Arguments:
  • log – logger
  • depth – the depth of the mesh generate the Matcher object at. Default 16
  • ra – list, numpy array or single ra value
  • dec – –list, numpy array or single dec value (must match ra array length)
  • convertToArray – convert the coordinates into an array. Default True. Can bypass the conversion check if you are sure coordinates in numpy array
Return:
  • None

Usage:

If we have a set of coordinates such that:

raList1 = [200.0, 200.0, 200.0, 175.23, 21.36]
decList1 = [24.3,  24.3,  24.3,  -28.25, -15.32]

We can initialise a matcher object like so:

from HMpTy import Matcher
coordinateSet = Matcher(
    log=log,
    ra=raList1,
    dec=decList1,
    depth=16
)
__init__(ra, dec, depth=16, log=False, convertToArray=True)[source]

x.__init__(…) initializes x; see help(type(x)) for signature

Methods

__init__(ra, dec[, depth, log, convertToArray]) x.__init__(…) initializes x; see help(type(x)) for signature
get_depth()
match(ra, dec, radius[, maxmatch]) match a corrdinate set against this Matcher object’s coordinate set

Attributes

depth the depth of the Matcher object