Parameterization Class Family - BSPL

BSPL Models

class model.BSPL_PhotParam1(t0, u0_amp, tE, piE_E, piE_N, sep, phi, mag_src_pri, mag_src_sec, b_sff, raL=None, decL=None)

Bases: PSPL_Param

BSPL model for photometry only

A Binary point Source Point Lens model for microlensing.

Note the attributes, RA (raL) and Dec (decL) are required if you are calculating a model with parallax.

Attributes
t0: float

Time of photometric peak, as seen from Earth (MJD.DDD)

u0_amp: float

Angular distance between the lens and source on the plane of the sky at closest approach in units of thetaE. It can be

  • positive (u0_amp > 0 when u0_hat[0] > 0) or

  • negative (u0_amp < 0 when u0_hat[0] < 0).

Note, since this is a binary source, we are expressing the nominal source position as that of the primary star in the source binary system.

tE: float

Einstein crossing time. [MJD]

piE_E: float

The microlensing parallax in the East direction in units of thetaE

piE_N: float

The microlensing parallax in the North direction in units of thetaE

sep: float

Angular separation of the source scondary from the source primary (in units of thetaE).

phi: float

Angle made between the binary axis and the relative proper motion vector, measured in degrees.

mag_src_pri: array or list

Photometric magnitude of the first (primary) source. This must be passed in as a list or array, with one entry for each photometric filter.

mag_src_sec: array or list

Photometric magnitude of the second (secondary) source. This must be passed in as a list or array, with one entry for each photometric filter.

b_sff: array or list

The ratio of the source flux to the total (source + neighbors + lens) \(b_sff = (f_S1 + f_S2) / (f_S1 + f_s2 + f_L + f_N)\). This must be passed in as a list or array, with one entry for each photometric filter.

raL: float, optional

Right ascension of the lens in decimal degrees.

decL: float, optional

Declination of the lens in decimal degrees.

class model.BSPL_PhotAstromParam1(mL, t0, beta, dL, dL_dS, xS0_E, xS0_N, muL_E, muL_N, muS_E, muS_N, sep, alpha, mag_src_pri, mag_src_sec, b_sff, raL=None, decL=None)

Bases: PSPL_Param

BSPL model for astrometry and photometry - physical parameterization.

A Binary point Source Point Lens model for microlensing. This model uses a parameterization that depends on only physical quantities such as the lens mass and positions and proper motions of both the lens and source.

Note the attributes, RA (raL) and Dec (decL) are required if you are calculating a model with parallax.

Attributes
mL: float

Mass of the lens (Msun)

t0: float

Time of photometric peak, as seen from Earth (MJD.DDD)

beta: float

Angular distance between the lens and primary source on the plane of the sky (mas). Can be

  • positive (u0_amp > 0 when u0_hat[0] < 0) or

  • negative (u0_amp < 0 when u0_hat[0] > 0).

Note, since this is a binary source, we are expressing the nominal source position as that of the primary star in the source binary system.

dL: float

Distance from the observer to the lens (pc)

dL_dS: float

Ratio of Distance from the obersver to the lens to Distance from the observer to the source

xS0_E: float

RA Source position on sky at t = t0 (arcsec) in an arbitrary ref. frame. This should be the position of the source primary.

xS0_N: float

Dec source position on sky at t = t0 (arcsec) in an arbitrary ref. frame. This should be the position of the source primary.

muL_E: float

RA Lens proper motion (mas/yr)

muL_N: float

Dec Lens proper motion (mas/yr)

muS_E: float

RA Source proper motion (mas/yr) Identical proper motions are assumed for the source primary and secondary.

muS_N: float

Dec Source proper motion (mas/yr) Identical proper motions are assumed for the source primary and secondary.

sep: float

Angular separation of the source scondary from the source primary (mas).

alpha: float

Angle made between the binary source axis and North; measured in degrees East of North.

mag_src_pri: array or list

Photometric magnitude of the first (primary) source. This must be passed in as a list or array, with one entry for each photometric filter.

mag_src_sec: array or list

Photometric magnitude of the second (secondary) source. This must be passed in as a list or array, with one entry for each photometric filter.

b_sff: array or list

The ratio of the source flux to the total (source + neighbors + lens) \(b_sff = (f_S1 + f_S2) / (f_S1 + f_s2 + f_L + f_N)\). This must be passed in as a list or array, with one entry for each photometric filter.

raL: float, optional

Right ascension of the lens in decimal degrees.

decL: float, optional

Declination of the lens in decimal degrees.

class model.BSPL_PhotAstromParam2(t0, u0_amp, tE, thetaE, piS, piE_E, piE_N, xS0_E, xS0_N, muS_E, muS_N, sep, alpha, fratio_bin, mag_base, b_sff, raL=None, decL=None)

Bases: PSPL_Param

BSPL model for astrometry and photometry - physical parameterization.

A Binary point Source Point Lens model for microlensing. This model uses a parameterization that depends on only physical quantities such as the lens mass and positions and proper motions of both the lens and source.

Note the attributes, RA (raL) and Dec (decL) are required if you are calculating a model with parallax.

Attributes
t0: float

Time of photometric peak, as seen from Earth (MJD.DDD)

u0_ampfloat

Angular distance between the source and the GEOMETRIC center of the lenses on the plane of the sky at closest approach in units of thetaE. Can

  • positive (u0_amp > 0 when u0_hat[0] > 0) or

  • negative (u0_amp < 0 when u0_hat[0] < 0).

Note, since this is a binary source, we are expressing the nominal source position as that of the primary star in the source binary system.

tEfloat

Einstein crossing time (days).

thetaEfloat

The size of the Einstein radius in (mas).

piSfloat

Amplitude of the parallax (1AU/dS) of the source. (mas)

piE_Efloat

The microlensing parallax in the East direction in units of thetaE

piE_Nfloat

The microlensing parallax in the North direction in units of thetaE

xS0_Efloat

R.A. of source position on sky at t = t0 (arcsec) in an arbitrary ref. frame. This should be the position of the source primary.

xS0_Nfloat

Dec. of source position on sky at t = t0 (arcsec) in an arbitrary ref. frame.

muS_Efloat

RA Source proper motion (mas/yr) Identical proper motions are assumed for the source primary and secondary.

muS_Nfloat

Dec Source proper motion (mas/yr) Identical proper motions are assumed for the source primary and secondary.

sep: float

Angular separation of the source scondary from the source primary (mas).

alpha: float

Angle made between the binary source axis and North; measured in degrees East of North.

fratio_bin: float

Flux ratio of secondary flux / primary flux.

mag_basearray or list

Photometric magnitude of the base. This must be passed in as a list or array, with one entry for each photometric filter. Note that

\(flux_{base} = f_{src1} + f_{src2} + f_{blend}\)

such that

\(b_sff = (f_{src1}+ f_{src2}) / ( f_{src1} + f_{src2} + f_{blend} )\)

b_sff: array or list

The ratio of the source flux to the total (source + neighbors + lens) \(b_sff = (f_{S1} + f_{S2}) / (f_{S1} + f_{s2} + f_L + f_N)\). This must be passed in as a list or array, with one entry for each photometric filter.

raL: float, optional

Right ascension of the lens in decimal degrees.

decL: float, optional

Declination of the lens in decimal degrees.

class model.BSPL_PhotAstromParam3(t0, u0_amp, tE, log10_thetaE, piS, piE_E, piE_N, xS0_E, xS0_N, muS_E, muS_N, sep, alpha, fratio_bin, mag_base, b_sff, raL=None, decL=None)

Bases: PSPL_Param

BSPL model for astrometry and photometry - physical parameterization.

A Binary point Source Point Lens model for microlensing. This model uses a parameterization that depends on only physical quantities such as the lens mass and positions and proper motions of both the lens and source.

Note the attributes, RA (raL) and Dec (decL) are required if you are calculating a model with parallax.

Attributes
t0: float

Time of photometric peak, as seen from Earth (MJD.DDD)

u0_ampfloat

Angular distance between the source and the GEOMETRIC center of the lenses on the plane of the sky at closest approach in units of thetaE. Can

  • positive (u0_amp > 0 when u0_hat[0] > 0) or

  • negative (u0_amp < 0 when u0_hat[0] < 0).

Note, since this is a binary source, we are expressing the nominal source position as that of the primary star in the source binary system.

tEfloat

Einstein crossing time (days).

log10_thetaEfloat

The size of the Einstein radius in (mas).

piSfloat

Amplitude of the parallax (1AU/dS) of the source. (mas)

piE_Efloat

The microlensing parallax in the East direction in units of thetaE

piE_Nfloat

The microlensing parallax in the North direction in units of thetaE

xS0_Efloat

R.A. of source position on sky at t = t0 (arcsec) in an arbitrary ref. frame. This should be the position of the source primary.

xS0_Nfloat

Dec. of source position on sky at t = t0 (arcsec) in an arbitrary ref. frame.

muS_Efloat

RA Source proper motion (mas/yr) Identical proper motions are assumed for the source primary and secondary.

muS_Nfloat

Dec Source proper motion (mas/yr) Identical proper motions are assumed for the source primary and secondary.

sep: float

Angular separation of the source scondary from the source primary (mas).

alpha: float

Angle made between the binary source axis and North; measured in degrees East of North.

fratio_bin: float

Flux ratio of secondary flux / primary flux.

mag_basearray or list

Photometric magnitude of the base. This must be passed in as a list or array, with one entry for each photometric filter. Note that

\(flux_base = f_{src1{ + f_{src2{ + f_{blend}\)

such that

\(b_sff = (f_{src1} + f_{src2}) / ( f_{src1} + f_{src2} + f_{blend} )\)

b_sff: array or list

The ratio of the source flux to the total (source + neighbors + lens) \(b_sff = (f_{S1} + f_{S2}) / (f_{S1} + f_{s2} + f_L + f_N)\). This must be passed in as a list or array, with one entry for each photometric filter.

raL: float, optional

Right ascension of the lens in decimal degrees.

decL: float, optional

Declination of the lens in decimal degrees.

GP Models

class model.BSPL_GP_PhotParam1(t0, u0_amp, tE, piE_E, piE_N, sep, phi, mag_src_pri, mag_src_sec, b_sff, gp_log_sigma, gp_rho, gp_log_omega04_S0, gp_log_omega0, raL=None, decL=None)

Bases: BSPL_PhotParam1

BSPL model for photometry only, with GP.

A Binary point Source Point Lens model for microlensing.

Note the attributes, RA (raL) and Dec (decL) are required if you are calculating a model with parallax.

Parameters
t0: float

Time of photometric peak, as seen from Earth (MJD.DDD)

u0_amp: float

Angular distance between the lens and source on the plane of the sky at closest approach in units of thetaE. It can be

  • positive (u0_amp > 0 when u0_hat[0] > 0) or

  • negative (u0_amp < 0 when u0_hat[0] < 0).

Note, since this is a binary source, we are expressing the nominal source position as that of the primary star in the source binary system.

tE: float

Einstein crossing time. [MJD]

piE_E: float

The microlensing parallax in the East direction in units of thetaE

piE_N: float

The microlensing parallax in the North direction in units of thetaE

sep: float

Angular separation of the source scondary from the source primary (in units of thetaE).

phi: float

Angle made between the binary axis and the relative proper motion vector, measured in degrees.

mag_src_pri: array or list

Photometric magnitude of the first (primary) source. This must be passed in as a list or array, with one entry for each photometric filter.

mag_src_sec: array or list

Photometric magnitude of the second (secondary) source. This must be passed in as a list or array, with one entry for each photometric filter.

b_sff: array or list

The ratio of the source flux to the total (source + neighbors + lens) \(b_sff = (f_{S1} + f_{S2}) / (f_{S1} + f_{s2} + f_L + f_N).\) This must be passed in as a list or array, with one entry for each photometric filter.

gp_log_sigma: float

Guassian process \(log(\sigma)\) for the Matern 3/2 kernel.

gp_rho: float

Guassian process \({\rho}\) for the Matern 3/2 kernel.

gp_log_omega04_S0: float

Guassian process \(log(\omega_0^4 * S_0)\) from the SHO kernel.

gp_log_omega0: float

Guassian process \(log(\omega_0)\) from the SHO kernel.

raL: float, optional

Right ascension of the lens in decimal degrees.

decL: float, optional

Declination of the lens in decimal degrees.

class model.BSPL_GP_PhotAstromParam1(mL, t0, beta, dL, dL_dS, xS0_E, xS0_N, muL_E, muL_N, muS_E, muS_N, sep, alpha, mag_src_pri, mag_src_sec, b_sff, gp_log_sigma, gp_rho, gp_log_omega04_S0, gp_log_omega0, raL=None, decL=None)

Bases: BSPL_PhotAstromParam1

BSPL model for astrometry and photometry with GP - physical parameterization.

A Binary point Source Point Lens model for microlensing. This model uses a parameterization that depends on only physical quantities such as the lens mass and positions and proper motions of both the lens and source.

Note the attributes, RA (raL) and Dec (decL) are required if you are calculating a model with parallax.

Attributes
mL: float

Mass of the lens (Msun)

t0: float

Time of photometric peak, as seen from Earth (MJD.DDD)

beta: float

Angular distance between the lens and primary source on the plane of the sky (mas). Can be

  • positive (u0_amp > 0 when u0_hat[0] < 0) or

  • negative (u0_amp < 0 when u0_hat[0] > 0).

Note, since this is a binary source, we are expressing the nominal source position as that of the primary star in the source binary system.

dL: float

Distance from the observer to the lens (pc)

dL_dS: float

Ratio of Distance from the obersver to the lens to Distance from the observer to the source

xS0_E: float

RA Source position on sky at t = t0 (arcsec) in an arbitrary ref. frame. This should be the position of the source primary.

xS0_N: float

Dec source position on sky at t = t0 (arcsec) in an arbitrary ref. frame. This should be the position of the source primary.

muL_E: float

RA Lens proper motion (mas/yr)

muL_N: float

Dec Lens proper motion (mas/yr)

muS_E: float

RA Source proper motion (mas/yr) Identical proper motions are assumed for the source primary and secondary.

muS_N: float

Dec Source proper motion (mas/yr) Identical proper motions are assumed for the source primary and secondary.

sep: float

Angular separation of the source scondary from the source primary (mas).

alpha: float

Angle made between the binary source axis and North; measured in degrees East of North.

mag_src_pri: array or list

Photometric magnitude of the first (primary) source. This must be passed in as a list or array, with one entry for each photometric filter.

mag_src_sec: array or list

Photometric magnitude of the second (secondary) source. This must be passed in as a list or array, with one entry for each photometric filter.

b_sff: array or list

The ratio of the source flux to the total (source + neighbors + lens) \(b_sff = (f_{S1} + f_{S2}) / (f_{S1} + f_{s2} + f_L + f_N)\). This must be passed in as a list or array, with one entry for each photometric filter.

gp_log_sigma: float

Guassian process \(log(\sigma)\) for the Matern 3/2 kernel.

gp_rho: float

Guassian process \({\rho}\) for the Matern 3/2 kernel.

gp_log_omega04_S0: float

Guassian process \(log(\omega_0^4 * S_0)\) from the SHO kernel.

gp_log_omega0: float

Guassian process \(log(\omega_0)\) from the SHO kernel.

raL: float, optional

Right ascension of the lens in decimal degrees.

decL: float, optional

Declination of the lens in decimal degrees.

class model.BSPL_GP_PhotAstromParam2(t0, u0_amp, tE, thetaE, piS, piE_E, piE_N, xS0_E, xS0_N, muS_E, muS_N, sep, alpha, fratio_bin, mag_base, b_sff, gp_log_sigma, gp_rho, gp_log_omega04_S0, gp_log_omega0, raL=None, decL=None)

Bases: BSPL_PhotAstromParam2

BSPL model for astrometry and photometry with GP - physical parameterization.

A Binary point Source Point Lens model for microlensing. This model uses a parameterization that depends on only physical quantities such as the lens mass and positions and proper motions of both the lens and source.

Note the attributes, RA (raL) and Dec (decL) are required if you are calculating a model with parallax.

Attributes
t0: float

Time of photometric peak, as seen from Earth (MJD.DDD)

u0_ampfloat

Angular distance between the source and the GEOMETRIC center of the lenses on the plane of the sky at closest approach in units of thetaE. Can be

  • positive (u0_amp > 0 when u0_hat[0] > 0) or

  • negative (u0_amp < 0 when u0_hat[0] < 0).

Note, since this is a binary source, we are expressing the nominal source position as that of the primary star in the source binary system.

tEfloat

Einstein crossing time (days).

thetaEfloat

The size of the Einstein radius in (mas).

piSfloat

Amplitude of the parallax (1AU/dS) of the source. (mas)

piE_Efloat

The microlensing parallax in the East direction in units of thetaE

piE_Nfloat

The microlensing parallax in the North direction in units of thetaE

xS0_Efloat

R.A. of source position on sky at t = t0 (arcsec) in an arbitrary ref. frame. This should be the position of the source primary.

xS0_Nfloat

Dec. of source position on sky at t = t0 (arcsec) in an arbitrary ref. frame.

muS_Efloat

RA Source proper motion (mas/yr) Identical proper motions are assumed for the source primary and secondary.

muS_Nfloat

Dec Source proper motion (mas/yr) Identical proper motions are assumed for the source primary and secondary.

sep: float

Angular separation of the source scondary from the source primary (mas).

alpha: float

Angle made between the binary source axis and North; measured in degrees East of North.

fratio_bin: float

Flux ratio of secondary flux / primary flux.

mag_basearray or list

Photometric magnitude of the base. This must be passed in as a list or array, with one entry for each photometric filter. Note that

\(flux_{base} = f_{src1} + f_{src2} + f_{blend}\)

such that

\(b_{sff} = (f_{src1} + f_{src2}) / ( f_{src1} + f_{src2} + f_{blend} )\)

b_sff: array or list

The ratio of the source flux to the total (source + neighbors + lens) :math:` b_{sff} = (f_{S1} + f_{S2}) / (f_{S1} + f_{s2} + f_L + f_N)`. This must be passed in as a list or array, with one entry for each photometric filter.

gp_log_sigma: float

Guassian process \(log(\sigma)\) for the Matern 3/2 kernel.

gp_rho: float

Guassian process \({\rho}\) for the Matern 3/2 kernel.

gp_log_omega04_S0: float

Guassian process \(log(\omega_0^4 * S_0)\) from the SHO kernel.

gp_log_omega0: float

Guassian process \(log(\omega_0)\) from the SHO kernel.

raL: float, optional

Right ascension of the lens in decimal degrees.

decL: float, optional

Declination of the lens in decimal degrees.

class model.BSPL_GP_PhotAstromParam3(t0, u0_amp, tE, log10_thetaE, piS, piE_E, piE_N, xS0_E, xS0_N, muS_E, muS_N, sep, alpha, fratio_bin, mag_base, b_sff, gp_log_sigma, gp_rho, gp_log_omega04_S0, gp_log_omega0, raL=None, decL=None)

Bases: BSPL_PhotAstromParam3

Point Source Point Lens with GP model for microlensing. This model includes proper motions of the source and the source position on the sky. It is the same as PSPL_PhotAstromParam4 except it fits for log10(thetaE) instead of thetaE.

Attributes
t0: float

Time of photometric peak, as seen from Earth (MJD.DDD)

u0_amp: float

Angular distance between the lens and source on the plane of the sky at closest approach in units of thetaE. Can be

  • positive (u0_amp > 0 when u0_hat[0] > 0) or

  • negative (u0_amp < 0 when u0_hat[0] < 0).

tE: float

Einstein crossing time (days).

log10_thetaE: float

log10 of the size of the Einstein radius in (mas).

piS: float

Amplitude of the parallax (1AU/dS) of the source. (mas)

piE_E: float

The microlensing parallax in the East direction in units of thetaE

piE_N: float

The microlensing parallax in the North direction in units of thetaE

xS0_E: float

RA Source position on sky at t = t0 (arcsec) in an arbitrary ref. frame.

xS0_N: float

Dec source position on sky at t = t0 (arcsec) in an arbitrary ref. frame.

muS_E: float

RA Source proper motion (mas/yr)

muS_N: float

Dec Source proper motion (mas/yr)

sep: float

Angular separation of the source scondary from the source primary (mas).

alpha: float

Angle made between the binary source axis and North; measured in degrees East of North.

fratio_bin: float

Flux ratio of secondary flux / primary flux.

mag_basearray or list

Photometric magnitude of the base. This must be passed in as a list or array, with one entry for each photometric filter. Note that

\(flux_{base} = f_{src1} + f_{src2} + f_{blend}\)

such that

\(b_{sff} = (f_{src1} + f_{src2}) / ( f_{src1} + f_{src2} + f_{blend})\)

b_sff: array or list

The ratio of the source flux to the total (source + neighbors + lens) :math:` b_{sff} = (f_{S1} + f_{S2}) / (f_{S1} + f_{s2} + f_L + f_N)`. This must be passed in as a list or array, with one entry for each photometric filter.

gp_log_sigma: float

Guassian process \(log(\sigma)\) for the Matern 3/2 kernel.

gp_rho: float

Guassian process \({\rho}\) for the Matern 3/2 kernel.

gp_log_omega04_S0: float

Guassian process \(log(\omega_0^4 * S_0)\) from the SHO kernel.

gp_log_omega0: float

Guassian process \(log(\omega_0)\) from the SHO kernel.