return_cluster¶
- clustertools.cluster.operations.return_cluster(cluster, units0, origin0, rorder0, rorder_origin0, sortstars=False, centre_method=None)[source]¶
return cluster to a specific combination of units and origin
- Parameters:
- clusterclass
StarCluster
- units0str
units that StarCluster will be changed to
- origin0str
origin that StarCluster will be changed to
- sortstarsbool
sort star by radius after coordinate change (default: False)
- centre_methodstr
method for shifting coordinates to clustercentric coordinates (see to_cluster). (default: None)
- Returns:
- None
- History:
- 2018 - Written - Webb (UofT)