CircleAperture

class marxs.optics.CircleAperture(**kwargs)

Bases: FlatAperture

Select the position where a parallel ray from an astrophysical source starts the simulation.

Photons are placed in a circle. The radius of the circle is the lengths of its v_y vector. At this point, the aperture must have the same zoom in y and z direction; it cannot be used to simulate an entrance ellipse.

Parameters

philist of 2 floats

Bounding angles for a segment covered by the GSA. \(\phi=0\) is on the positive y axis. The segment fills the space from phi1 to phi2 in the usual mathematical way (counterclockwise). Angles are given in radian. Use phi[1] < 0 if the segment crosses the y axis. (Default is the full circle.)

r_innerfloat

Inner radius for ring-like apertures. Default is 0 (full circle). If r_inner is non-zero, plotting the aperture will fill in the inner region. If this is not desired because several CircleApertures are stacked into each other, self.display['inner_factor'] can be used to restrict the radius range where the inner disk is displayed in a plot.

Define a new MARXS element.

Attributes Summary

area	Area covered by the aperture

Methods Summary

generate_local_xy(n)

Generate x, y in the local coordinate system

Attributes Documentation

area

Area covered by the aperture

Methods Documentation

generate_local_xy(n)

Generate x, y in the local coordinate system

Parameters

nint

number of x, y coordinate pairs requested

Returns

x, yarrays of floats

(x, y) coordinates of the photons in the local frame