hpmcm.classify module
- hpmcm.classify.classifyClusters(matcher, **kwargs)[source]
Sort clusters by their properties
This will return a dict of lists of clusters of various types
- Return type:
dict[str,list]- Parameters:
matcher (Match)
kwargs (Any)
- hpmcm.classify.classifyObjects(matcher, **kwargs)[source]
Sort objects by their properties
This will return a dict of lists of objects
- Return type:
dict[str,list]- Parameters:
matcher (Match)
kwargs (Any)
- hpmcm.classify.clusterStats(cluster_dict)[source]
Helper function to get stats about the clusters
- Return type:
ndarray- Parameters:
cluster_dict (OrderedDict[int, ClusterData]) – Dict from clusterId to ClusterData object
- Return type:
Cluster Statistics (nClusters, n_orphan, n_mixed, n_confused)
Notes
Return array contains
nClusters: Total number of clusters
n_orphan: Number of single source clusters (i.e., single detections)
n_mixed: Number of clusters with more than one source from each input catalog
n_confused: Number of souces with more than four cases of duplication
- hpmcm.classify.matchObjectsAgainstRef(matcher, **kwargs)[source]
Match objects against the reference catalog
- Return type:
dict[str,list]- Parameters:
matcher (Match)
kwargs (Any)
- hpmcm.classify.printClusterTypes(cluster_types)[source]
Print numbers of different types of clusters
- Return type:
None- Parameters:
cluster_types (dict[str, list])
- hpmcm.classify.printObjectMatchTypes(o_dict)[source]
Print numbers of different types of object matches
- Return type:
None- Parameters:
o_dict (dict)