ds9_objects_to_string

regions.ds9_objects_to_string(regions, coordsys='fk5', fmt='.6f', radunit='deg')[source]

Converts a list of Region to DS9 region string.

See Reading/writing to DS9 region files

Parameters:
regions : list

List of Region objects

coordsys : str, optional

This overrides the coordinate system frame for all regions. Default is ‘fk5’.

fmt : str, optional

A python string format defining the output precision. Default is .6f, which is accurate to 0.0036 arcseconds.

radunit : str, optional

This denotes the unit of the radius. Default is ‘deg’(degrees)

Returns:
region_string : str

DS9 region string