Parallax Class Family

class model.PSPL_noParallax

Bases: ParallaxClassABC

Methods

calc_piE_ecliptic()	Not supported on this object.
get_amplification(t)	Get an array of the photometric amplifications at the input times.
get_astrometry(t[, ast_filt_idx])	Get the astrometry of the unresolved (observed) position of the lensed source at the input times.
get_astrometry_unlensed(t)	Get the astrometry of the source if the lens didn't exist.
get_centroid_shift(t)	Get the centroid shift (in mas) at the input times.
get_lens_astrometry(t)	Get the astrometry for the foreground lens at the input times.
get_resolved_amplification(t)	Get the photometric amplification term at a set of times, t for both the plus and minus images.
get_resolved_astrometry(t)	Get the relative RA and Dec astrometry for each of the two source images, which we label plus and minus.

calc_piE_ecliptic()

Not supported on this object.

get_amplification(t)

Get an array of the photometric amplifications at the input times. No parallax is included.

Parameters:

tarray_like

Array of times in MJD.DDD

get_astrometry(t, ast_filt_idx=0)

Get the astrometry of the unresolved (observed) position of the lensed source at the input times. No parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

ast_filt_idxint, optional

Index of the astrometric filter or data set.

get_astrometry_unlensed(t)

Get the astrometry of the source if the lens didn’t exist. No parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

Returns:

xS_unlensednumpy array, dtype=float, shape = [len(t), 2]

The unlensed positions of the source in arcseconds.

get_centroid_shift(t)

Get the centroid shift (in mas) at the input times. The centroid shift is the difference between the lensed, unresolved position and the intrinsic position of the source. No parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

get_lens_astrometry(t)

Get the astrometry for the foreground lens at the input times. No parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

get_resolved_amplification(t)

Get the photometric amplification term at a set of times, t for both the plus and minus images. No parallax is included. The returned tuple has two entries: (A_plus, A_minus), each with len(t) arrays.

Parameters:

tarray_like

Array of times in MJD.DDD

get_resolved_astrometry(t)

Get the relative RA and Dec astrometry for each of the two source images, which we label plus and minus. No parallax is included. The returned tuple has two entries: (xS_plus, xS_minus), each with [len(t), 2] arrays where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

Returns:

(xS_plus, xS_minus)tuple of numpy arrays

• xS_plus is the vector position of the plus image in arcsec with shape = [len(t), 2]

• xS_minus is the vector position of the plus image in arcsec with shape = [len(t), 2]

class model.PSPL_Parallax

Bases: ParallaxClassABC

Methods

calc_piE_ecliptic()	Get piE_ecliptic, the microlensing parallax vector in the ecliptic coorindate system.
get_amplification(t)	Get an array of the photometric amplifications at the input times.
get_astrometry(t_obs[, ast_filt_idx])	Get the astrometry of the unresolved (observed) position of the lensed source at the input times.
get_astrometry_unlensed(t_obs)	Get the astrometry of the source if the lens didn't exist.
get_centroid_shift(t[, ast_filt_idx])	Get the centroid shift (in mas) at the input times.
get_geoproj_ast_params(t0par[, plot])	Get the astrometric microlensing model parameters in the geocentric-projected coordinate system, which just applies a rectalinear position and velocity offset into the geocentric frame at time t0par.
get_geoproj_params(t0par[, plot])	Get the photometric microlensing model parameters in the geocentric-projected coordinate system, which just applies a rectalinear position and velocity offset into the geocentric frame at time t0par.
get_lens_astrometry(t_obs)	Get the astrometry for the foreground lens at the input times.
get_resolved_amplification(t)	Get the photometric amplification term at a set of times, t for both the plus and minus images.
get_resolved_astrometry(t_obs)	Get the relative RA and Dec astrometry for each of the two source images, which we label plus and minus.

set_observer_location
start

calc_piE_ecliptic()

Get piE_ecliptic, the microlensing parallax vector in the ecliptic coorindate system.

get_amplification(t)

Get an array of the photometric amplifications at the input times. Parallax is included.

Parameters:

tarray_like

Array of times in MJD.DDD

get_astrometry(t_obs, ast_filt_idx=0)

Get the astrometry of the unresolved (observed) position of the lensed source at the input times. Parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

ast_filt_idxint, optional

Index of the astrometric filter or data set.

get_astrometry_unlensed(t_obs)

Get the astrometry of the source if the lens didn’t exist. Parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

Returns:

xS_unlensednumpy array, dtype=float, shape = [len(t), 2]

The unlensed positions of the source in arcseconds.

get_centroid_shift(t, ast_filt_idx=0)

Get the centroid shift (in mas) at the input times. The centroid shift is the difference between the lensed, unresolved position and the intrinsic position of the source. Parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

get_geoproj_ast_params(t0par, plot=False)

Get the astrometric microlensing model parameters in the geocentric-projected coordinate system, which just applies a rectalinear position and velocity offset into the geocentric frame at time t0par. Note, this is not a true geocentric frame. It is only geocentric at time t0par. However, this is a common convention for photometry-only microlens models in the literature. The benefits of the geocentric-projected frame is that the t0_{geoProj} can more closely match the observed peak in the light curve.

Parameters:

t0parfloat

Time in MJD at which to convert into the geocentric frame.

Returns:

xS0E_gfloat

The East-component of source position vector on the sky, in the geocentric-projected frame.

xS0N_gfloat

The North-component of source position vector on the sky, in the geocentric-projected frame.

muSE_gfloat

The East-component of source proper motion vector, in the geocentric-projected frame.

muSN_gfloat

The North-component of source proper motion vector, in the geocentric-projected frame.

get_geoproj_params(t0par, plot=False)

Get the photometric microlensing model parameters in the geocentric-projected coordinate system, which just applies a rectalinear position and velocity offset into the geocentric frame at time t0par. Note, this is not a true geocentric frame. It is only geocentric at time t0par. However, this is a common convention for photometry-only microlens models in the literature. The benefits of the geocentric-projected frame is that the t0_{geoProj} can more closely match the observed peak in the light curve.

Parameters:

t0parfloat

Time in MJD at which to convert into the geocentric frame.

Returns:

t0_gfloat

The time (in MJD) of closest approach between the lens and source in the geocentric-projected frame.

u0_gfloat

The distance (in thetaE) at closest approach in the geocentric-projected frame.

tE_gfloat

The Einsten crossing time (in MJD) in the geocentric-projected frame.

piEE_gfloat

The East-component of the microlensing parallax vector, in the geocentric-projected frame. This also indicates the East-component of the relative proper motion vector between the source and lens

piEN_gfloat

The North-component of the microlensing parallax vector, in the geocentric-projected frame. This also indicates the North-component of the relative proper motion vector between the source and lens

get_lens_astrometry(t_obs)

Get the astrometry for the foreground lens at the input times. Parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

get_resolved_amplification(t)

Get the photometric amplification term at a set of times, t for both the plus and minus images. Parallax is included. The returned tuple has two entries: (A_plus, A_minus), each with len(t) arrays.

Parameters:

tarray_like

Array of times in MJD.DDD

get_resolved_astrometry(t_obs)

Get the relative RA and Dec astrometry for each of the two source images, which we label plus and minus. Parallax is included. The returned tuple has two entries: (xS_plus, xS_minus), each with [len(t), 2] arrays where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

Returns:

(xS_plus, xS_minus)tuple of numpy arrays

• xS_plus is the vector position of the plus image in arcsec with shape = [len(t), 2]

• xS_minus is the vector position of the plus image in arcsec with shape = [len(t), 2]

class model.PSPL_Parallax

Bases: ParallaxClassABC

Methods

calc_piE_ecliptic()	Get piE_ecliptic, the microlensing parallax vector in the ecliptic coorindate system.
get_amplification(t)	Get an array of the photometric amplifications at the input times.
get_astrometry(t_obs[, ast_filt_idx])	Get the astrometry of the unresolved (observed) position of the lensed source at the input times.
get_astrometry_unlensed(t_obs)	Get the astrometry of the source if the lens didn't exist.
get_centroid_shift(t[, ast_filt_idx])	Get the centroid shift (in mas) at the input times.
get_geoproj_ast_params(t0par[, plot])	Get the astrometric microlensing model parameters in the geocentric-projected coordinate system, which just applies a rectalinear position and velocity offset into the geocentric frame at time t0par.
get_geoproj_params(t0par[, plot])	Get the photometric microlensing model parameters in the geocentric-projected coordinate system, which just applies a rectalinear position and velocity offset into the geocentric frame at time t0par.
get_lens_astrometry(t_obs)	Get the astrometry for the foreground lens at the input times.
get_resolved_amplification(t)	Get the photometric amplification term at a set of times, t for both the plus and minus images.
get_resolved_astrometry(t_obs)	Get the relative RA and Dec astrometry for each of the two source images, which we label plus and minus.

set_observer_location
start

calc_piE_ecliptic()

Get piE_ecliptic, the microlensing parallax vector in the ecliptic coorindate system.

get_amplification(t)

Get an array of the photometric amplifications at the input times. Parallax is included.

Parameters:

tarray_like

Array of times in MJD.DDD

get_astrometry(t_obs, ast_filt_idx=0)

Get the astrometry of the unresolved (observed) position of the lensed source at the input times. Parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

ast_filt_idxint, optional

Index of the astrometric filter or data set.

get_astrometry_unlensed(t_obs)

Get the astrometry of the source if the lens didn’t exist. Parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

Returns:

xS_unlensednumpy array, dtype=float, shape = [len(t), 2]

The unlensed positions of the source in arcseconds.

get_centroid_shift(t, ast_filt_idx=0)

Get the centroid shift (in mas) at the input times. The centroid shift is the difference between the lensed, unresolved position and the intrinsic position of the source. Parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

get_geoproj_ast_params(t0par, plot=False)

Get the astrometric microlensing model parameters in the geocentric-projected coordinate system, which just applies a rectalinear position and velocity offset into the geocentric frame at time t0par. Note, this is not a true geocentric frame. It is only geocentric at time t0par. However, this is a common convention for photometry-only microlens models in the literature. The benefits of the geocentric-projected frame is that the t0_{geoProj} can more closely match the observed peak in the light curve.

Parameters:

t0parfloat

Time in MJD at which to convert into the geocentric frame.

Returns:

xS0E_gfloat

The East-component of source position vector on the sky, in the geocentric-projected frame.

xS0N_gfloat

The North-component of source position vector on the sky, in the geocentric-projected frame.

muSE_gfloat

The East-component of source proper motion vector, in the geocentric-projected frame.

muSN_gfloat

The North-component of source proper motion vector, in the geocentric-projected frame.

get_geoproj_params(t0par, plot=False)

Get the photometric microlensing model parameters in the geocentric-projected coordinate system, which just applies a rectalinear position and velocity offset into the geocentric frame at time t0par. Note, this is not a true geocentric frame. It is only geocentric at time t0par. However, this is a common convention for photometry-only microlens models in the literature. The benefits of the geocentric-projected frame is that the t0_{geoProj} can more closely match the observed peak in the light curve.

Parameters:

t0parfloat

Time in MJD at which to convert into the geocentric frame.

Returns:

t0_gfloat

The time (in MJD) of closest approach between the lens and source in the geocentric-projected frame.

u0_gfloat

The distance (in thetaE) at closest approach in the geocentric-projected frame.

tE_gfloat

The Einsten crossing time (in MJD) in the geocentric-projected frame.

piEE_gfloat

The East-component of the microlensing parallax vector, in the geocentric-projected frame. This also indicates the East-component of the relative proper motion vector between the source and lens

piEN_gfloat

The North-component of the microlensing parallax vector, in the geocentric-projected frame. This also indicates the North-component of the relative proper motion vector between the source and lens

get_lens_astrometry(t_obs)

Get the astrometry for the foreground lens at the input times. Parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

get_resolved_amplification(t)

Get the photometric amplification term at a set of times, t for both the plus and minus images. Parallax is included. The returned tuple has two entries: (A_plus, A_minus), each with len(t) arrays.

Parameters:

tarray_like

Array of times in MJD.DDD

get_resolved_astrometry(t_obs)

Get the relative RA and Dec astrometry for each of the two source images, which we label plus and minus. Parallax is included. The returned tuple has two entries: (xS_plus, xS_minus), each with [len(t), 2] arrays where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

Returns:

(xS_plus, xS_minus)tuple of numpy arrays

• xS_plus is the vector position of the plus image in arcsec with shape = [len(t), 2]

• xS_minus is the vector position of the plus image in arcsec with shape = [len(t), 2]

class model.PSPL_noParallax_LumLens

Bases: PSPL_noParallax

Methods

calc_piE_ecliptic()	Not supported on this object.
get_amplification(t)	Get an array of the photometric amplifications at the input times.
get_astrometry(t[, ast_filt_idx])	Get the astrometry of the unresolved (observed) position of the lensed source at the input times.
get_astrometry_unlensed(t)	Get the astrometry of the source if the lens didn't exist.
get_centroid_shift(t[, ast_filt_idx])	Get the centroid shift (in mas) at the input times.
get_lens_astrometry(t)	Get the astrometry for the foreground lens at the input times.
get_resolved_amplification(t)	Get the photometric amplification term at a set of times, t for both the plus and minus images.
get_resolved_astrometry(t)	Get the relative RA and Dec astrometry for each of the two source images, which we label plus and minus.

calc_piE_ecliptic()

Not supported on this object.

get_amplification(t)

Get an array of the photometric amplifications at the input times. No parallax is included.

Parameters:

tarray_like

Array of times in MJD.DDD

get_astrometry(t, ast_filt_idx=0)

Get the astrometry of the unresolved (observed) position of the lensed source at the input times. No parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

ast_filt_idxint, optional

Index of the astrometric filter or data set.

get_astrometry_unlensed(t)

Get the astrometry of the source if the lens didn’t exist. No parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

Returns:

xS_unlensednumpy array, dtype=float, shape = [len(t), 2]

The unlensed positions of the source in arcseconds.

get_centroid_shift(t, ast_filt_idx=0)

Get the centroid shift (in mas) at the input times. The centroid shift is the difference between the lensed, unresolved position and the intrinsic position of the source. No parallax is included and the lens is assumed to be luminous. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

ast_filt_idxint, optional

Index of the astrometric filter or data set.

get_lens_astrometry(t)

Get the astrometry for the foreground lens at the input times. No parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

get_resolved_amplification(t)

Get the photometric amplification term at a set of times, t for both the plus and minus images. No parallax is included. The returned tuple has two entries: (A_plus, A_minus), each with len(t) arrays.

Parameters:

tarray_like

Array of times in MJD.DDD

get_resolved_astrometry(t)

Get the relative RA and Dec astrometry for each of the two source images, which we label plus and minus. No parallax is included. The returned tuple has two entries: (xS_plus, xS_minus), each with [len(t), 2] arrays where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

Returns:

(xS_plus, xS_minus)tuple of numpy arrays

• xS_plus is the vector position of the plus image in arcsec with shape = [len(t), 2]

• xS_minus is the vector position of the plus image in arcsec with shape = [len(t), 2]

class model.PSPL_Parallax_LumLens

Bases: PSPL_Parallax

Methods

calc_piE_ecliptic()	Get piE_ecliptic, the microlensing parallax vector in the ecliptic coorindate system.
get_amplification(t)	Get an array of the photometric amplifications at the input times.
get_astrometry(t_obs[, ast_filt_idx])	Get the centroid shift (in mas) at the input times.
get_astrometry_unlensed(t_obs)	Get the astrometry of the source if the lens didn't exist.
get_centroid_shift(t[, ast_filt_idx])	Get the centroid shift (in mas) at the input times.
get_geoproj_ast_params(t0par[, plot])	Get the astrometric microlensing model parameters in the geocentric-projected coordinate system, which just applies a rectalinear position and velocity offset into the geocentric frame at time t0par.
get_geoproj_params(t0par[, plot])	Get the photometric microlensing model parameters in the geocentric-projected coordinate system, which just applies a rectalinear position and velocity offset into the geocentric frame at time t0par.
get_lens_astrometry(t_obs)	Get the astrometry for the foreground lens at the input times.
get_resolved_amplification(t)	Get the photometric amplification term at a set of times, t for both the plus and minus images.
get_resolved_astrometry(t_obs)	Get the relative RA and Dec astrometry for each of the two source images, which we label plus and minus.

set_observer_location
start

calc_piE_ecliptic()

Get piE_ecliptic, the microlensing parallax vector in the ecliptic coorindate system.

get_amplification(t)

Get an array of the photometric amplifications at the input times. Parallax is included.

Parameters:

tarray_like

Array of times in MJD.DDD

get_astrometry(t_obs, ast_filt_idx=0)

Get the centroid shift (in mas) at the input times. The centroid shift is the difference between the lensed, unresolved position and the intrinsic position of the source. Parallax is included and the lens is assumed to be luminous. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

ast_filt_idxint, optional

Index of the astrometric filter or data set.

get_astrometry_unlensed(t_obs)

Get the astrometry of the source if the lens didn’t exist. Parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

Returns:

xS_unlensednumpy array, dtype=float, shape = [len(t), 2]

The unlensed positions of the source in arcseconds.

get_centroid_shift(t, ast_filt_idx=0)

Get the centroid shift (in mas) at the input times. The centroid shift is the difference between the lensed, unresolved position and the intrinsic position of the source. Parallax is included and the lens is luminous. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

get_geoproj_ast_params(t0par, plot=False)

Get the astrometric microlensing model parameters in the geocentric-projected coordinate system, which just applies a rectalinear position and velocity offset into the geocentric frame at time t0par. Note, this is not a true geocentric frame. It is only geocentric at time t0par. However, this is a common convention for photometry-only microlens models in the literature. The benefits of the geocentric-projected frame is that the t0_{geoProj} can more closely match the observed peak in the light curve.

Parameters:

t0parfloat

Time in MJD at which to convert into the geocentric frame.

Returns:

xS0E_gfloat

The East-component of source position vector on the sky, in the geocentric-projected frame.

xS0N_gfloat

The North-component of source position vector on the sky, in the geocentric-projected frame.

muSE_gfloat

The East-component of source proper motion vector, in the geocentric-projected frame.

muSN_gfloat

The North-component of source proper motion vector, in the geocentric-projected frame.

get_geoproj_params(t0par, plot=False)

Get the photometric microlensing model parameters in the geocentric-projected coordinate system, which just applies a rectalinear position and velocity offset into the geocentric frame at time t0par. Note, this is not a true geocentric frame. It is only geocentric at time t0par. However, this is a common convention for photometry-only microlens models in the literature. The benefits of the geocentric-projected frame is that the t0_{geoProj} can more closely match the observed peak in the light curve.

Parameters:

t0parfloat

Time in MJD at which to convert into the geocentric frame.

Returns:

t0_gfloat

The time (in MJD) of closest approach between the lens and source in the geocentric-projected frame.

u0_gfloat

The distance (in thetaE) at closest approach in the geocentric-projected frame.

tE_gfloat

The Einsten crossing time (in MJD) in the geocentric-projected frame.

piEE_gfloat

The East-component of the microlensing parallax vector, in the geocentric-projected frame. This also indicates the East-component of the relative proper motion vector between the source and lens

piEN_gfloat

The North-component of the microlensing parallax vector, in the geocentric-projected frame. This also indicates the North-component of the relative proper motion vector between the source and lens

get_lens_astrometry(t_obs)

Get the astrometry for the foreground lens at the input times. Parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

get_resolved_amplification(t)

Get the photometric amplification term at a set of times, t for both the plus and minus images. Parallax is included. The returned tuple has two entries: (A_plus, A_minus), each with len(t) arrays.

Parameters:

tarray_like

Array of times in MJD.DDD

get_resolved_astrometry(t_obs)

Get the relative RA and Dec astrometry for each of the two source images, which we label plus and minus. Parallax is included. The returned tuple has two entries: (xS_plus, xS_minus), each with [len(t), 2] arrays where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

Returns:

(xS_plus, xS_minus)tuple of numpy arrays

• xS_plus is the vector position of the plus image in arcsec with shape = [len(t), 2]

• xS_minus is the vector position of the plus image in arcsec with shape = [len(t), 2]

class model.PSPL_Parallax

Bases: ParallaxClassABC

Methods

calc_piE_ecliptic()	Get piE_ecliptic, the microlensing parallax vector in the ecliptic coorindate system.
get_amplification(t)	Get an array of the photometric amplifications at the input times.
get_astrometry(t_obs[, ast_filt_idx])	Get the astrometry of the unresolved (observed) position of the lensed source at the input times.
get_astrometry_unlensed(t_obs)	Get the astrometry of the source if the lens didn't exist.
get_centroid_shift(t[, ast_filt_idx])	Get the centroid shift (in mas) at the input times.
get_geoproj_ast_params(t0par[, plot])	Get the astrometric microlensing model parameters in the geocentric-projected coordinate system, which just applies a rectalinear position and velocity offset into the geocentric frame at time t0par.
get_geoproj_params(t0par[, plot])	Get the photometric microlensing model parameters in the geocentric-projected coordinate system, which just applies a rectalinear position and velocity offset into the geocentric frame at time t0par.
get_lens_astrometry(t_obs)	Get the astrometry for the foreground lens at the input times.
get_resolved_amplification(t)	Get the photometric amplification term at a set of times, t for both the plus and minus images.
get_resolved_astrometry(t_obs)	Get the relative RA and Dec astrometry for each of the two source images, which we label plus and minus.

set_observer_location
start

calc_piE_ecliptic()

Get piE_ecliptic, the microlensing parallax vector in the ecliptic coorindate system.

get_amplification(t)

Get an array of the photometric amplifications at the input times. Parallax is included.

Parameters:

tarray_like

Array of times in MJD.DDD

get_astrometry(t_obs, ast_filt_idx=0)

Get the astrometry of the unresolved (observed) position of the lensed source at the input times. Parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

ast_filt_idxint, optional

Index of the astrometric filter or data set.

get_astrometry_unlensed(t_obs)

Get the astrometry of the source if the lens didn’t exist. Parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

Returns:

xS_unlensednumpy array, dtype=float, shape = [len(t), 2]

The unlensed positions of the source in arcseconds.

get_centroid_shift(t, ast_filt_idx=0)

Get the centroid shift (in mas) at the input times. The centroid shift is the difference between the lensed, unresolved position and the intrinsic position of the source. Parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

get_geoproj_ast_params(t0par, plot=False)

Get the astrometric microlensing model parameters in the geocentric-projected coordinate system, which just applies a rectalinear position and velocity offset into the geocentric frame at time t0par. Note, this is not a true geocentric frame. It is only geocentric at time t0par. However, this is a common convention for photometry-only microlens models in the literature. The benefits of the geocentric-projected frame is that the t0_{geoProj} can more closely match the observed peak in the light curve.

Parameters:

t0parfloat

Time in MJD at which to convert into the geocentric frame.

Returns:

xS0E_gfloat

The East-component of source position vector on the sky, in the geocentric-projected frame.

xS0N_gfloat

The North-component of source position vector on the sky, in the geocentric-projected frame.

muSE_gfloat

The East-component of source proper motion vector, in the geocentric-projected frame.

muSN_gfloat

The North-component of source proper motion vector, in the geocentric-projected frame.

get_geoproj_params(t0par, plot=False)

Get the photometric microlensing model parameters in the geocentric-projected coordinate system, which just applies a rectalinear position and velocity offset into the geocentric frame at time t0par. Note, this is not a true geocentric frame. It is only geocentric at time t0par. However, this is a common convention for photometry-only microlens models in the literature. The benefits of the geocentric-projected frame is that the t0_{geoProj} can more closely match the observed peak in the light curve.

Parameters:

t0parfloat

Time in MJD at which to convert into the geocentric frame.

Returns:

t0_gfloat

The time (in MJD) of closest approach between the lens and source in the geocentric-projected frame.

u0_gfloat

The distance (in thetaE) at closest approach in the geocentric-projected frame.

tE_gfloat

The Einsten crossing time (in MJD) in the geocentric-projected frame.

piEE_gfloat

The East-component of the microlensing parallax vector, in the geocentric-projected frame. This also indicates the East-component of the relative proper motion vector between the source and lens

piEN_gfloat

The North-component of the microlensing parallax vector, in the geocentric-projected frame. This also indicates the North-component of the relative proper motion vector between the source and lens

get_lens_astrometry(t_obs)

Get the astrometry for the foreground lens at the input times. Parallax is included. The returned array is in arcsec and has a shape of [len(t), 2] where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

get_resolved_amplification(t)

Get the photometric amplification term at a set of times, t for both the plus and minus images. Parallax is included. The returned tuple has two entries: (A_plus, A_minus), each with len(t) arrays.

Parameters:

tarray_like

Array of times in MJD.DDD

get_resolved_astrometry(t_obs)

Get the relative RA and Dec astrometry for each of the two source images, which we label plus and minus. Parallax is included. The returned tuple has two entries: (xS_plus, xS_minus), each with [len(t), 2] arrays where the second dimension includes [RA, Dec] positions in arcsec.

Parameters:

tarray_like

Time (in MJD).

Returns:

(xS_plus, xS_minus)tuple of numpy arrays

• xS_plus is the vector position of the plus image in arcsec with shape = [len(t), 2]

• xS_minus is the vector position of the plus image in arcsec with shape = [len(t), 2]