overlap_cluster¶
- clustertools.cluster.cluster.overlap_cluster(cluster1, cluster2, tol=0.1, projected=False, return_cluster=True)[source]¶
Extract a sub population of stars from cluster1 that spatially overlaps with cluster2
- Parameters:
- cluster1StarCluster
cluster from which stars are to be extracted
- cluster2StarCluster
cluster from which overlap region is defined
- tol: float
tolerance parameter for how much regions need to overlap (default: 0.1)
- projectedbool
use projected values and constraints (default:False)
- return_cluster: bool
returns a sub_cluster if True, otherwise return the boolean array (default:True)
- Returns:
- StarCluster