velociraptor package¶
The velociraptor module.
More information is available in the documentation.
-
velociraptor.load(filename: str, disregard_units: bool = False, registration_file_path: Union[List[str], str, None] = None, mask: slice = Ellipsis) → velociraptor.catalogue.catalogue.Catalogue[source]¶ Loads a velociraptor catalogue, producing a Catalogue object.
Parameters: - filename (str) – The filename of your VELOCIraptor catalogue file (i.e. the path to the .properties file).
- disregard_units (bool, optional) – If
True, then disregard any additional units in the VELOCIraptor catalogues, and instead base everything on the ‘base’ units of velocity, length, and mass. In this case metallicities are left dimensionless. If you are using EAGLE data, you should set this to False, as the star formation rate units are presented in non-internal units. - registration_file_path (Union[List[str], str], optional) – The filename of the derived quantities script(s) to register additional properties with the catalogue. This is an advanced feature. See the documentation for more details.
- mask (Union[None, NDArray[bool], int], optional) – If a boolean array is provided, it is used to mask all catalogue arrays. If an int is provided, catalogue arrays are masked to the single corresponding element.
Returns: The Catalogue object that describes your .properties file.
Return type: