scifysim.sources module

scifysim.sources.ABmag2Jy(ABmag)[source]

scifysim.sources.Jy2ABmag(fnu)[source]

class scifysim.sources._blackbody(modules='numexpr')[source]

Bases: object

Stefan_Boltzmann(T, epsilon=1.0)[source]: Quick utility function giving the Stefan-Boltzmann law

__dict__ = mappingproxy({'__module__': 'scifysim.sources', '__init__': <function _blackbody.__init__>, 'Stefan_Boltzmann': <function _blackbody.Stefan_Boltzmann>, '__dict__': <attribute '__dict__' of '_blackbody' objects>, '__weakref__': <attribute '__weakref__' of '_blackbody' objects>, '__doc__': None, '__annotations__': {}})

__init__(modules='numexpr')[source]

Builds the spectral radiance as a function of $T$ and $\nu$ , $k$ , and $\lambda$

Call self.get_Bxxx to get the function B = f(lambda , T)

GENIEsim	Attribute	Results in
0	B_lamb_Jy	Jy / sr
1	B_lamb_W	W / m^2 / m / sr
2	B_lamb_ph	ph / s / m^2 / m / sr
3	B_nu_ph	ph / s / m^2 / Hz / sr

__module__ = 'scifysim.sources'

__weakref__: list of weak references to the object (if defined)

scifysim.sources.chain(A, B)[source]

This function helps define which occulting / emitting source is in front ro behind which.

Parameters:

A : An upstream transmission_emission object
B : A downstream transmission_emission object.

scifysim.sources.distant_blackbody(lambda_range, T, dist, radius)[source]

Returns the flux density for a distant blackbody lambda_range : Wavelenght [m] T : temperature [K] dist : Distance [pc] radius : Star radius [R_sun]

Returns flux density [ph/s/m^2] arriving to earth (no atmosphere).

class scifysim.sources.enclosure(trans_file='data/hawaii2rg_qe.csv', T=285, name='noname', solid_angle=6.283185307179586)[source]

Bases: transmission_emission

__init__(trans_file='data/hawaii2rg_qe.csv', T=285, name='noname', solid_angle=6.283185307179586)[source]

Reproduces a basic behaviour of an enclosure at a given temperature. Here, self.trans represents the (1-quantum efficiency) as to be analogous to optics in transmission.

Parameters:

qe : The quantum efficiency of the detector, including throughput by intervening glasses/surfaces.
T : Temperature of the medium used for emission
airmass : When True, scales the effect with the airmass provided by the observatory object
observatory : The observatory object used to provided the airmass.
solid_angle : The solid angle for this given part of the enclosure Default: 2pi, the fraction seen by a plane detector.

Warning

Unlike for astrophysical sources, when a transmission_emission object contains an ss attribute, it already takes into account the transmission through the insturment.

__module__ = 'scifysim.sources'

get_total_emission(wl, bandwidth=None, bright=False, n_sub=10)[source]

Similar begaviour as get_trans_emit() but averages the effect over each spectral channel.

Parameters:

wl : The center of each wavelength channel. If bandwidth is not provided (prefered situation) the width of each channel will be set as the spacing between them (through np.gradient())
bandwidth : (deprecated) array of floats providing the width of each spectral channe.
n_sub : The number of sub-channel to compute for the calculation. A minimum of 10 is recommended.
solid_angle : As this is designed to

class scifysim.sources.exozodi_simple(lambda_range, distance, radius, star, z, angular_res=10, radial_res=15, offset=(0.0, 0.0), build_map=True)[source]

Bases: object

__dict__ = mappingproxy({'__module__': 'scifysim.sources', '__init__': <function exozodi_simple.__init__>, 'build_grid': <function exozodi_simple.build_grid>, 'get_spectrum_map': <function exozodi_simple.get_spectrum_map>, 'build_spectrum_map': <function exozodi_simple.build_spectrum_map>, 'exozodiacal_disk': <function exozodi_simple.exozodiacal_disk>, '__dict__': <attribute '__dict__' of 'exozodi_simple' objects>, '__weakref__': <attribute '__weakref__' of 'exozodi_simple' objects>, '__doc__': None, '__annotations__': {}})

__init__(lambda_range, distance, radius, star, z, angular_res=10, radial_res=15, offset=(0.0, 0.0), build_map=True)[source]

Parameters:

distance : Distance of the source [pc]
radius : The radius of the source [R_sun]
star : a star object
z : The amount of zodi [zodi]
L_star : the star luminosity [L_sun]
angular_res : Number of bins in position angle
radial_res : Number of bins in radius
offset : Offset of the source radial ([mas], [deg])
build_map : Whether to precompute a mapped spectrum

After building the map, self.ss (wl, pos_x, pos_y) contains the map of flux density corresponding to positions self.xx, self.yy

__module__ = 'scifysim.sources'

__weakref__: list of weak references to the object (if defined)

build_grid(angular_res, radial_res)[source]

Routine used to construct resolved source: Creates self.xx, self.yy, self.ds, self.theta, self.r

Arguments: * angular_res : Number of angulare elements * radial_res : Number of radial elements

build_spectrum_map()[source]: The map is saved in a flat shape xx_f and yy_f are created to be flat versions of the coordinates. ss is a total flux (ph/s/m^2) at the entrance of earth atmosphere.

exozodiacal_disk()[source]

Computes the emission spectrum of each disk element. Updates:

self.ss the spectral illuminance
self.total_flux density
self.sigma the opacity
self.t_dust the temperature of the dust

get_spectrum_map()[source]

Maps self.total_flux_density

This produces numerical integration over solid angle elements

scifysim.sources.flux_bin2mag(lambda_range, fd)[source]

Arguments: * lambda_range : Wavelength channels [m] * fd : flux density [ph/s/m^2]

arriving to earth (no atmo)

Returns : magnitude (vega) for each wavelength

class scifysim.sources.group[source]

Bases: object

Just a simple object to structure some data.

__dict__ = mappingproxy({'__module__': 'scifysim.sources', '__doc__': '\n Just a simple object to structure some data.\n ', '__init__': <function group.__init__>, '__dict__': <attribute '__dict__' of 'group' objects>, '__weakref__': <attribute '__weakref__' of 'group' objects>, '__annotations__': {}})

__init__()[source]

__module__ = 'scifysim.sources'

__weakref__: list of weak references to the object (if defined)

scifysim.sources.mag2flux_bin(lambda_range, mag)[source]

Arguments: * lambda_range : Wavelength channels [m] * mag : Magnitud [vega]

Returns: Flux density [ph/s/m^2] arriving to earth

scifysim.sources.magT2flux_bin(lambda_range, mag, T)[source]

class scifysim.sources.resolved_source(lambda_range, distance, radius, T, angular_res=10, radial_res=15, offset=(0.0, 0.0), build_map=True, resolved=True)[source]

Bases: object

property L: Computes the luminosity (in solar luminosity) returns the approximate star luminosity based on blackbody and the Stefan-Boltzman law.

__dict__ = mappingproxy({'__module__': 'scifysim.sources', '__init__': <function resolved_source.__init__>, 'build_point': <function resolved_source.build_point>, 'build_grid': <function resolved_source.build_grid>, 'get_spectrum_map': <function resolved_source.get_spectrum_map>, 'build_spectrum_map': <function resolved_source.build_spectrum_map>, 'distant_blackbody': <function resolved_source.distant_blackbody>, 'L': <property object>, '__dict__': <attribute '__dict__' of 'resolved_source' objects>, '__weakref__': <attribute '__weakref__' of 'resolved_source' objects>, '__doc__': None, '__annotations__': {}})

__init__(lambda_range, distance, radius, T, angular_res=10, radial_res=15, offset=(0.0, 0.0), build_map=True, resolved=True)[source]

Parameters:

distance : Distance of the source [pc]
radius : The radius of the source [R_sun]
T : Blackbody temperature [K]
angular_res : Number of bins in position angle
radial_res : Number of bins in radius
offset : Offset of the source radial ([mas], [deg])
build_map : Whether to precompute a mapped spectrum
resolved : If false, computes a single point-source

After building the map, self.ss (wl, pos_x, pos_y) contains the map of flux density corresponding to positions self.xx, self.yy

__module__ = 'scifysim.sources'

__weakref__: list of weak references to the object (if defined)

build_grid(angular_res, radial_res)[source]

Routine used to construct resolved source:

Creates self.xx, self.yy, self.ds, self.theta, self.r

build_point()[source]

Routine used to construct unresolved source:

Creates self.xx, self.yy, self.ds, self.theta [rad], self.r [rad] Shapes of xx, yy are preserved, but they will contain a single element corresponding to the unresolved point source.

build_spectrum_map()[source]: The map is saved in a flat shape xx_f and yy_f are created to be flat versions of the coordinates. ss is a total flux (ph/s/m^2) at the entrance of earth atmosphere.

distant_blackbody()[source]: Returns the flux density for a distant blackbody It is a total in ph/s/m2

get_spectrum_map()[source]

Maps self.total_flux_density

This produces numerical integration over solid angle elements

scifysim.sources.set_sink(A)[source]: Defines A as the last element in the chain.

scifysim.sources.set_source(A)[source]: Defines A as the first element in the chain.

class scifysim.sources.source(xx, yy, ss)[source]

Bases: object

DEPRECATED: use resolved_source for all source modelisation purposes

__add__(other)[source]

__dict__ = mappingproxy({'__module__': 'scifysim.sources', '__doc__': '\n DEPRECATED: use resolved_source for all source modelisation purposes\n ', '__init__': <function source.__init__>, '__add__': <function source.__add__>, 'copy': <function source.copy>, 'sky_bg': <classmethod object>, '__dict__': <attribute '__dict__' of 'source' objects>, '__weakref__': <attribute '__weakref__' of 'source' objects>, '__annotations__': {}})

__init__(xx, yy, ss)[source]: DEPRECATED: use resolved_source for all source modelisation purposes

__module__ = 'scifysim.sources'

__weakref__: list of weak references to the object (if defined)

copy()[source]

classmethod sky_bg(injector, res, T, lamb_range, crop=1.0)[source]: DEPRECATED: a transmission_emission object for the sky background

class scifysim.sources.src_extended(resol, extent, fiber_vigneting=False)[source]

Bases: object

__dict__ = mappingproxy({'__module__': 'scifysim.sources', '__init__': <function src_extended.__init__>, 'uniform_disk': <function src_extended.uniform_disk>, '__dict__': <attribute '__dict__' of 'src_extended' objects>, '__weakref__': <attribute '__weakref__' of 'src_extended' objects>, '__doc__': None, '__annotations__': {}})

__init__(resol, extent, fiber_vigneting=False)[source]: resol : Number of elements across extent : The extent of the source fiber_vigneting : whether to include fiber vigneting in the luminosity distribution

Fiber vigneting should not be included when off-axis injection is simulated

__module__ = 'scifysim.sources'

__weakref__: list of weak references to the object (if defined)

uniform_disk(radius)[source]

class scifysim.sources.star_planet_target(config, director)[source]

Bases: object

__dict__ = mappingproxy({'__module__': 'scifysim.sources', '__init__': <function star_planet_target.__init__>, 'physical_separation': <property object>, '__dict__': <attribute '__dict__' of 'star_planet_target' objects>, '__weakref__': <attribute '__weakref__' of 'star_planet_target' objects>, '__doc__': None, '__annotations__': {}})

__init__(config, director)[source]

__module__ = 'scifysim.sources'

__weakref__: list of weak references to the object (if defined)

property physical_separation: The physical separation between the planet and star (AU)

class scifysim.sources.transmission_emission(trans_file=None, T=285, airmass=False, observatory=None, name='noname')[source]

Bases: object

__dict__ = mappingproxy({'__module__': 'scifysim.sources', '__init__': <function transmission_emission.__init__>, 'get_trans_emit': <function transmission_emission.get_trans_emit>, 'get_mean_trans_emit': <function transmission_emission.get_mean_trans_emit>, 'get_own_brightness': <function transmission_emission.get_own_brightness>, 'get_upstream_brightness': <function transmission_emission.get_upstream_brightness>, 'get_total_brightness': <function transmission_emission.get_total_brightness>, 'get_own_transmission': <function transmission_emission.get_own_transmission>, 'get_downstream_transmission': <function transmission_emission.get_downstream_transmission>, '__dict__': <attribute '__dict__' of 'transmission_emission' objects>, '__weakref__': <attribute '__weakref__' of 'transmission_emission' objects>, '__doc__': None, '__annotations__': {}})

__init__(trans_file=None, T=285, airmass=False, observatory=None, name='noname')[source]

Reproduces a basic behaviour in emission-transmission of a medium in the optical path. Inspired by the geniesim

Parameters:

trans_file : The path to a transmission data file
T : Temperature of the medium used for emission
airmass : When True, scales the effect with the airmass provided by the observatory object
observatory : The observatory object used to provided the airmass.

Warning

Unlike for astrophysical sources, when a transmission_emission object contains an ss attribute, it already takes into account the transmission through the insturment.

__module__ = 'scifysim.sources'

__weakref__: list of weak references to the object (if defined)

get_downstream_transmission(wl, inclusive=True)[source]

Used when chaining different media. Returns the total of the transmission function of the chain downstream of the object.

Parameters:

wl : The wavelengths to be computed
inclusive: Whether to includ the transmission of the object itself

get_mean_trans_emit(wl, bandwidth=None, bright=False, n_sub=10)[source]

Similar begaviour as get_trans_emit() but averages the effect over each spectral channel.

Parameters:

wl : The center of each wavelength channel. If bandwidth is not provided (prefered situation) the width of each channel will be set as the spacing between them (through np.gradient())
bandwidth : (deprecated) array of floats providing the width of each spectral channe.
n_sub : The number of sub-channel to compute for the calculation. A minimum of 10 is recommended.

get_own_brightness(wl)[source]: Used when chaining different media. Returns the flux density per solid angle of the object in each wl channel. [ph/m2/sr]

get_own_transmission(wl)[source]: Used when chaining different media. Returns the transmission function of the object.

get_total_brightness(wl)[source]: Used when chaining different media. Returns the total filtered flux density per solid angle of the object in each wl channel. [ph/s/m2/sr] downstream of the object (inclusively)

get_trans_emit(wl, bright=False, no=False)[source]

Return the transmission or brightness of the object depending on th bright keyword

Parameters:

wl : The wavelength channels to compute [m]
bright : If True: compute the brightness if False: compute the transmission

[ph/s/sr]

get_upstream_brightness(wl)[source]: Used when chaining different media. Returns the flux density per solid angle of the object in each wl channel [ph/m2/sr], upstream of the current object (exclusively), including the transmission by the upstream objects (exclusively)

scifysim.sources.vega_flux_bin(lambda_range, T=9600.0, dist=7.68, radius=2.36)[source]

Returns the flux density for Vega lambda_range : Wavelenght [m] T : temperature default 9600. [K] dist : Distance 7.68 [pc] radius : Star radius 2.36 [R_sun]

Returns flux density [ph/s/m^2] arriving to earth (no atmosphere).