LegacySourceCatalog

class photutils.segmentation.LegacySourceCatalog(properties_list, wcs=None)[source]

Bases: object

Deprecated since version 1.1: The LegacySourceCatalog class is deprecated and may be removed in a future version. Use SourceCatalog instead.

Class to hold source catalogs (deprecated).

Deprecated since version 1.1: The LegacySourceCatalog class is deprecated and may be removed in a future version. Use SourceCatalog instead.

Attributes Summary

background_at_centroid

sky_bbox_ll

sky_bbox_lr

sky_bbox_ul

sky_bbox_ur

sky_centroid

sky_centroid_icrs

Methods Summary

to_table([columns, exclude_columns])

Construct a QTable of source properties from a LegacySourceCatalog object.

Attributes Documentation

background_at_centroid
sky_bbox_ll
sky_bbox_lr
sky_bbox_ul
sky_bbox_ur
sky_centroid
sky_centroid_icrs

Methods Documentation

to_table(columns=None, exclude_columns=None)[source]

Construct a QTable of source properties from a LegacySourceCatalog object.

If columns or exclude_columns are not input, then the QTable will include a default list of scalar-valued properties.

Multi-dimensional properties, e.g., data_cutout, can be included in the columns input, but they will not be preserved when writing the table to a file. This is a limitation of multi-dimensional columns in astropy tables.

Parameters
columnsstr or list of str, optional

Names of columns, in order, to include in the output QTable. The allowed column names are any of the attributes of SourceProperties.

exclude_columnsstr or list of str, optional

Names of columns to exclude from the default columns in the output QTable. The default columns are defined in the photutils.segmentation.properties.DEFAULT_COLUMNS variable.

Returns
tableQTable

A table of source properties with one row per source.