velociraptor.observations package¶
Sub-module for adding observational data to plots.
Includes the ObservationalData object and helper functions to convert data to this new format.
-
velociraptor.observations.load_observation(filename: str)[source]¶ Load an observation from file filename. This should be in the standard velociraptor format.
Deprecated in favour of
load_observations()Parameters: filename (str) – Filename of the observational dataset that you wish to load. Should probably end in .hdf5. See the documentation for velociraptor.observations.objects.ObservationalDatafor more information.Returns: Observational data instance read from file. Return type: velociraptor.observations.objects.ObservationalData
-
velociraptor.observations.load_observations(filenames: Union[str, Iterable[str]], redshift_bracket: List[float] = [0.0, 1000.0])[source]¶ Parameters: - filename (str, Iterable[str]) – Filename(s) of the observational dataset that you wish to load.
Should probably end in .hdf5. See the documentation for
velociraptor.observations.objects.ObservationalDataandvelociraptor.observations.objects.MultiRedshiftObservationalDatafor more information. - redshift_bracket (str) – Redshift bracket to overlap with. If any of the observations in the file overlap with this bracket, they are returned. By default, this bracket is 0.0 to 1000.0, so will encompass all reasonable observations present in the file.
Returns: Observational data instances read from file that overlap with your specified redshift bracket.
Return type: - filename (str, Iterable[str]) – Filename(s) of the observational dataset that you wish to load.
Should probably end in .hdf5. See the documentation for