ComparisonViewer#

class stellarphot.gui_tools.ComparisonViewer(file='', directory='.', target_mag=10, bright_mag_limit=8, dim_mag_limit=15, targets_from_file=None, object_coordinate=None, photom_apertures_file=None, overwrite_outputs=True, observatory=None)[source]#

Bases: object

A class to store an instance of the comparison viewer.

Parameters:

filestr, optional: File to open. Defaults to “”.
directorystr, optional: Directory to open file from. Defaults to ‘.’.
target_magfloat, optional: Magnitude of the target. Defaults to 10.
bright_mag_limitfloat, optional: Bright magnitude limit for APASS stars. Defaults to 8.
dim_mag_limitfloat, optional: Dim magnitude limit for APASS stars. Defaults to 17.
targets_from_filestr, optional: File with target information. Defaults to None.
object_coordinateastropy.coordinates.SkyCoord, optional: Coordinates of the target. Defaults to None.
photom_apertures_filestr, optional: File to save photometry aperture information to. Defaults to None.
overwrite_outputs: bool, optional: Whether to overwrite existing output files. Defaults to True.
observatorystellarphot.settings.Observatory, optional: Observatory information.

Attributes:

photom_apertures_filestr: File to save photometry aperture information to.
boxipywidgets.Box: Box containing the widgets.
bright_mag_limitfloat: Bright magnitude limit for APASS stars.
dim_mag_limitfloat: Dim magnitude limit for APASS stars.
iwginga.util.grc.RemoteClient: Ginga widget.
overwrite_outputs: bool: Whether to overwrite existing output files. Defaults to True.
target_coordastropy.coordinates.SkyCoord: Coordinates of the target.
targets_from_filestr: File with target information.
target_magfloat: Magnitude of the target.
variablesastropy.table.Table: An astropy.table.Table of the variables in the class.

Attributes Summary

`fits_file`
`photom_apertures_file`
`variables`	An `astropy.table.Table` of the variables in the class.

Methods Summary

`generate_table`()	Generate the table of stars to use for the aperture file.
`remove_circle`()	Remove the circle around the target.
`remove_labels`()	Remove the labels for the stars.
`save`()	Save all of the settings we have to a partial settings file.
`show_circle`([radius, pixel_scale])	Show a circle around the target.
`show_labels`()	Show the labels for the stars.
`tess_field_view`()	Show the whole TESS field of view including circle around target, but hide labels.
`tess_field_zoom_view`([width])	Zoom in on the TESS field of view.

Attributes Documentation

fits_file#

photom_apertures_file#

variables#: An astropy.table.Table of the variables in the class.

Methods Documentation

generate_table()[source]#

Generate the table of stars to use for the aperture file.

Returns:

comp_tableastropy.table.Table: Table of stars to use for the aperture file.

remove_circle()[source]#

Remove the circle around the target.

Returns:

None: Circle is removed from the image.

remove_labels()[source]#

Remove the labels for the stars.

Returns:

None: Labels for the stars are removed.

save()[source]#: Save all of the settings we have to a partial settings file.

show_circle(radius=<Quantity 2.5 arcmin>, pixel_scale=<Quantity 0.56 arcsec / pix>)[source]#

Show a circle around the target.

Parameters:

radiusastropy.units.Quantity, optional: Radius of circle. The default is 2.5*u.arcmin.
pixel_scaleastropy.units.Quantity, optional: Pixel scale of image. The default is 0.56*u.arcsec/u.pixel.

Returns:

None: Circle is shown around the target.

show_labels()[source]#

Show the labels for the stars.

Returns:

None: Labels for the stars are shown.

tess_field_view()[source]#

Show the whole TESS field of view including circle around target, but hide labels.

Returns:

None: Shows image as described above.

tess_field_zoom_view(width=<Quantity 6. arcmin>)[source]#

Zoom in on the TESS field of view.

Parameters:

widthastropy.units.Quantity, optional: Width of field of view. The default is 6*u.arcmin.

Returns:

None: Zooms in on the image as described above.