`phitter.calc.model_obs_calc`#

Module Contents#

Classes#

`binary_star_model_obs`	Class to compute the observables for a modeled binary system, given stellar parameters and binary parameters.
`single_star_model_obs`	Class to compute the observables for a modeled binary system, given stellar parameters and binary parameters.

Data#

`kp_filt`
`h_filt`

API#

phitter.calc.model_obs_calc.kp_filt = 'nirc2_kp_filt(...)'#

phitter.calc.model_obs_calc.h_filt = 'nirc2_h_filt(...)'#

class phitter.calc.model_obs_calc.binary_star_model_obs(bin_observables, use_blackbody_atm=False, use_compact_object=False, print_diagnostics=False, par_compute=False, num_par_processes=8, *args, **kwargs)#

Bases: object

Class to compute the observables for a modeled binary system, given stellar parameters and binary parameters.

bin_observablesobservables: observables object, with obs_times, obs_filts, and obs_types specified.
use_blackbody_atmbool, default=False: Use blackbody atmosphere instead of default Castelli & Kurucz atmosphere. Default: False (i.e.: using a C&K atm by default)
use_compact_objectbool, default=False: If true, sets eclipse_method to ‘only_horizon’ in PHOEBE, which is necessary for compact companions without eclipses. Default: False
print_diagnosticsbool, default=False: Print diagnostic messages, helpful for debugging.
par_computebool, default=False: Uses parallelization when computing with PHOEBE.
num_par_processesint, default=8: Number of processes to use when parallel computing with PHOEBE.

Initialization

compute_obs(star1_params, star2_params, binary_params, irrad_frac_refl=1.0, num_triangles=1500, make_mesh_plots=False, mesh_plot_phases=np.array([0.25]), animate=False, mesh_plot_fig=None, mesh_plot_subplot_grid=None, mesh_plot_subplot_grid_indexes=None, mesh_temp=False, mesh_temp_cmap=None, plot_name=None, mesh_plot_kwargs={}, mesh_quants_output=False)#

Function to compute observables with the specified star and binary system parameters.

star1_paramsstar_params: star_params object, with parameters for the primary star.
star2_paramsstar_params: star_params object, with parameters for the secondary star.
binary_paramsbinary_params: binary_params object, with parameters for the binary system configuration.
irrad_frac_reflfloat, default=1.0: Fraction reflectivity for irradiation
num_trianglesint, default=1500: Number of triangles to use for PHOEBE’s mesh model of each stellar atmosphere. For contact system, num_triangles*2 are used for contact envelope.
make_mesh_plotsbool, default=False: Make a mesh plot of the binary system. Default: False
plot_namestr, default=None: Name for the output plots, if making a mesh plot

observables: observables object returned. Deep copy of input observables object, with obs also defined, with modeled values.

class phitter.calc.model_obs_calc.single_star_model_obs(sing_star_observables, use_blackbody_atm=False, use_compact_object=False, print_diagnostics=False, par_compute=False, num_par_processes=8, *args, **kwargs)#