load_survey

zdm.survey.load_survey(survey_name: str, state: State, dmvals: ndarray, zvals: ndarray = None, sdir: str = None, NFRB: int = None, nbins=None, iFRB: int = 0, dummy=False, edir=None, rand_DMG=False, survey_dict=None, verbose=False)[source]

Load a survey

Parameters:

  • survey_name (str) – Name of the survey e.g. CRAFT/FE

  • state (parameters.State) – Parameters for the state

  • dmvals (np.ndarray) – DM values

  • zvals (np.ndarray,optional) – z values

  • sdir (str, optional) – Path to survey files. Defaults to None.

  • nbins (int, optional) – Sets number of bins for Beam analysis [was NBeams]

  • NFRB (int, optional) – Cut the total survey down to a random subset [useful for testing]

  • iFRB (int, optional) – Start grabbing FRBs at this index Mainly used for Monte Carlo analysis Requires that NFRB be set

  • dummy (bool,optional) – Skip many initialisation steps: used only when loading survey parameters for conversion to the new survey format

  • survey_dict (dict, optional) – dictionary of survey metadata to over-ride values in file

  • verbose (bool) – print output

Raises:

IOError – [description]

Returns:

instance of the class

Return type:

Survey