sorcha.modules.PPVignetting

Attributes

deg2rad

rad2deg

sin

cos

Functions

vignettingEffects(df[, raName, decName, fieldName, ...])

Calculates effective limiting magnitude at source, taking vignetting into account.

calcVignettingLosses(ra, dec, fieldra, fielddec)

Calculates magnitude loss due to vignetting for a point with the telescope

haversine(ra1, dec1, ra2, dec2)

Calculates angular distance between two points. Can produce floating point

vignetFunc(x)

Returns the magnitude of dimming caused by the vignetting relative to the

Module Contents

deg2rad[source]
rad2deg[source]
sin[source]
cos[source]
vignettingEffects(df, raName='RA_deg', decName='Dec_deg', fieldName='FieldID', raNameSurvey='fieldRA_deg', decNameSurvey='fieldDec_deg')[source]

Calculates effective limiting magnitude at source, taking vignetting into account. Wrapper for calcVignettingLosses().

Parameters:

  • df (pandas dataframe) -- dataframe of observations.

  • raName (string, default="RA_deg") -- 'df' column name of object RA.

  • decName (string, default="Dec_deg") -- 'df' column name of object declination.

  • fieldName (string, default="FieldID") -- 'df' column name for observation pointing field ID.

  • raNameSurvey (string, default="fieldRA_deg") --

    'df' column name for observation pointing RA.

    decNameSurveystring, default="fieldDec_deg"

    'df' column name for observation pointing declination.

Returns:

Five sigma limiting magnitude at object location adjusted for vignetting for each row in 'df' dataframe.

Return type:

list of floats

calcVignettingLosses(ra, dec, fieldra, fielddec)[source]

Calculates magnitude loss due to vignetting for a point with the telescope centered on fieldra, fielddec.

Parameters:

  • ra (float or aarray of floats) -- RA of object(s).

  • dec (float or array of floats) -- Dec of object(s).

  • fieldra (float or array of floats) -- RA of field(s).

  • fielddec (float or array of floats) -- Dec of field(s).

Returns:

Magnitude loss due to vignetting at object position.

Return type:

floats or array of floats

haversine(ra1, dec1, ra2, dec2)[source]

Calculates angular distance between two points. Can produce floating point errors for antipodal points, which are not intended to be encountered within the scope of this module.

Parameters:

  • ra1 (float or array of floats) -- RA of first point.

  • floats (dec1 or float or array of) -- Dec of first point.

  • ra2 (float or array of floats) -- RA of second point.

  • dec2 (float/array of floats) -- Dec of second point.

Returns:

Angular distance between two points.

Return type:

float or array of floats

vignetFunc(x)[source]

Returns the magnitude of dimming caused by the vignetting relative to the center of the field.

Parameters:

x (float or array of floats) -- Angular separation of point from field centre.

Returns:

Magnitude of dimming due to vignetting at object position.

Return type:

float or array of floats

Notes

Grabbed from sims_selfcal. From VignettingFunc_v3.3.TXT. r is in degrees, frac is fraction of rays which were not vignetted.