astropy:docs

Beam

class aplpy.Beam(parent)[source]

Bases: object

Methods Summary

hide() Hide the beam
set(**kwargs) Modify the beam properties.
set_alpha(alpha) Set the alpha value (transparency).
set_angle(angle) Set the position angle of the beam on the sky, in degrees.
set_borderpad(borderpad) Set the amount of padding within the beam object, relative to the canvas size.
set_color(color) Set the beam color.
set_corner(corner) Set the beam location.
set_edgecolor(edgecolor) Set the color for the edge of the beam.
set_facecolor(facecolor) Set the color for the interior of the beam.
set_frame(frame) Set whether to display a frame around the beam.
set_hatch(hatch) Set the hatch pattern.
set_linestyle(linestyle) Set the line style for the edge of the beam.
set_linewidth(linewidth) Set the line width for the edge of the beam, in points.
set_major(major) Set the major axis of the beam, in degrees.
set_minor(minor) Set the minor axis of the beam, in degrees.
set_pad(pad) Set the amount of padding between the beam object and the image corner/edge, relative to the canvas size.
show([major, minor, angle, corner, frame, ...]) Display the beam shape and size for the primary image.

Methods Documentation

hide()[source]

Hide the beam

set(**kwargs)[source]

Modify the beam properties. All arguments are passed to the matplotlib Ellipse class. See the matplotlib documentation for more details.

set_alpha(alpha)[source]

Set the alpha value (transparency).

This should be a floating point value between 0 and 1.

set_angle(angle)[source]

Set the position angle of the beam on the sky, in degrees.

set_borderpad(borderpad)[source]

Set the amount of padding within the beam object, relative to the canvas size.

set_color(color)[source]

Set the beam color.

set_corner(corner)[source]

Set the beam location.

Acceptable values are ‘left’, ‘right’, ‘top’, ‘bottom’, ‘top left’, ‘top right’, ‘bottom left’ (default), and ‘bottom right’.

set_edgecolor(edgecolor)[source]

Set the color for the edge of the beam.

set_facecolor(facecolor)[source]

Set the color for the interior of the beam.

set_frame(frame)[source]

Set whether to display a frame around the beam.

set_hatch(hatch)[source]

Set the hatch pattern.

This should be one of ‘/’, ‘’, ‘|’, ‘-‘, ‘+’, ‘x’, ‘o’, ‘O’, ‘.’, or ‘*’.

set_linestyle(linestyle)[source]

Set the line style for the edge of the beam.

This should be one of ‘solid’, ‘dashed’, ‘dashdot’, or ‘dotted’.

set_linewidth(linewidth)[source]

Set the line width for the edge of the beam, in points.

set_major(major)[source]

Set the major axis of the beam, in degrees.

set_minor(minor)[source]

Set the minor axis of the beam, in degrees.

set_pad(pad)[source]

Set the amount of padding between the beam object and the image corner/edge, relative to the canvas size.

show(major='BMAJ', minor='BMIN', angle='BPA', corner='bottom left', frame=False, borderpad=0.4, pad=0.5, **kwargs)[source]

Display the beam shape and size for the primary image.

By default, this method will search for the BMAJ, BMIN, and BPA keywords in the FITS header to set the major and minor axes and the position angle on the sky.

Parameters:

major : float, quantity or unit, optional

Major axis of the beam in degrees or an angular quantity (overrides BMAJ if present)

minor : float, quantity or unit, optional

Minor axis of the beam in degrees or an angular quantity (overrides BMIN if present)

angle : float, quantity or unit, optional

Position angle of the beam on the sky in degrees or an angular quantity (overrides BPA if present) in the anticlockwise direction.

corner : int, optional

The beam location. Acceptable values are ‘left’, ‘right’, ‘top’, ‘bottom’, ‘top left’, ‘top right’, ‘bottom left’ (default), and ‘bottom right’.

frame : str, optional

Whether to display a frame behind the beam (default is False)

kwargs

Additional arguments are passed to the matplotlib Ellipse class. See the matplotlib documentation for more details.

Page Contents