LabPointSourceCone¶
- class marxs.source.LabPointSourceCone(position=[0, 0, 0], half_opening=3.141592653589793, direction=[1.0, 0.0, 0.0], **kwargs)[source] [edit on github]¶
Bases:
Source
In-lab point source
Photons are uniformly distributed in all directions in cone (from the point). Cone is meant to refer to the volume swept out by a solid angle in a unit sphere centered at the point source.
Photon start position is source position (tip of cone)
- Parameters:
- position: array-like of shape(3,)
Eukledian coordinates of photon source. Default is at the origin of the coordinate system.
- half_opening: float
This is half the openning angle of the cone. It is given in steradians. The default is pi, which distributes the photons evenly over the entire sphere.
- direction: array-like of shape (3,)
This is the direction of the center of the cone. Default is the positive x-axis.
- kwargssee
Source
Other keyword arguments include
flux
,energy
andpolarization
. SeeSource
for details.
Define a new MARXS element.
Methods Summary
generate_photons
(exposuretime)Central function to generate photons.
Methods Documentation
- generate_photons(exposuretime: Unit('s'))[source] [edit on github]¶
Central function to generate photons.
Calling this function generates a photon table according to the
flux
,energy
, andpolarization
of this source. The number of photons depends on the total exposure time, which is a parameter of this function. Depending on the setting forflux
the photons could be distributed equally over the interval 0..exposuretime or follow some other distribution.- Parameters:
- exposuretime
astropy.quantity.Quantity
Total exposure time.
- exposuretime
- Returns:
- photons
astropy.table.Table
Table with photon properties.
- photons