ShapeList

class regions.ShapeList[source]

Bases: list

List of Shape

Methods Summary

to_crtf(self[, coordsys, fmt, radunit]) Converts a list of regions.Shape objects to crtf region strings.
to_ds9(self[, coordsys, fmt, radunit]) Converts a list of regions.Shape objects to ds9 region strings.
to_fits(self) Converts a ShapeList to a Table object.
to_regions(self)

Methods Documentation

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

Converts a list of regions.Shape objects to crtf region strings.

Parameters:
coordsys : str

This overrides the coordinate system frame for all regions.

fmt : str

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

radunit : str

This denotes the unit of the radius.

Returns:
region_string : str

crtf region string

Examples

TODO

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

Converts a list of regions.Shape objects to ds9 region strings.

Parameters:
coordsys : str

This overrides the coordinate system frame for all regions.

fmt : str

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

radunit : str

This denotes the unit of the radius.

Returns:
region_string : str

ds9 region string

Examples

TODO

to_fits(self)[source]

Converts a ShapeList to a Table object.

to_regions(self)[source]