Skip to content

Commit 72ac01b

Browse files
committed
Update an out of date reference to _centre and _vcentre in narrative docs.
1 parent 0f9759a commit 72ac01b

File tree

1 file changed

+3
-3
lines changed
  • docs/source/coordinate_transformations

1 file changed

+3
-3
lines changed

docs/source/coordinate_transformations/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,15 @@ Automatic recentering
4343

4444
By default, a :class:`~swiftgalaxy.reader.SWIFTGalaxy` is recentered on the centre of the galaxy (as defined by the halo catalogue), and its velocity is shifted to follow the bulk velocity of the galaxy (again as defined by the halo catalogue). This behaviour can be disabled by setting ``SWIFTGalaxy(..., auto_recentre=False)``. Note that this recentering only applies to particles -- no coordinate transformations of any kind are every applied to entries in the halo catalogues, so for instance querying the position of the galaxy in the halo catalogue will always give this in the simulation box frame.
4545

46-
Some halo catalogues define more than one centre and/or bulk velocity. The one used is the one returned by :meth:`swiftgalaxy.halo_catalogues._HaloCatalogue._centre` (for the centre) and :meth:`swiftgalaxy.halo_catalogues._HaloCatalogue._vcentre` (for the bulk velocity). In the case of the :class:`~swiftgalaxy.halo_catalogues.Velociraptor` halo catalogue, the centre used can be manipulated by the ``centre_type`` argument. By default it uses the potential minimum (``minpot``), but this could be exchanged for the most bound particle, for instance:
46+
Some halo catalogues define more than one centre and/or bulk velocity. The one used is the one returned by :attr:`swiftgalaxy.halo_catalogues._HaloCatalogue.centre` (for the centre) and :attr:`swiftgalaxy.halo_catalogues._HaloCatalogue.velocity_centre` (for the bulk velocity). The centre to be used is configurable if the halo catalogue defines multiple centres. In the case of a :class:`~swiftgalaxy.halo_catalogues.SOAP` halo catalogue, for example, the centre and bulk velocity used can be manipulated by the ``centre_type`` and ``velocity_centre_type`` arguments. By default :class:`~swiftgalaxy.halo_catalogues.SOAP` uses the ``input_halos.halo_centre`` for the position and ``bound_subhalo.centre_of_mass_velocity`` for the bulk velocity. The centre in position could be changed to also use the centre of mass like this:
4747

4848
.. code-block:: python
4949
5050
SWIFTGalaxy(
5151
...,
52-
Velociraptor(
52+
SOAP(
5353
...,
54-
centre_type='mpb',
54+
centre_type='bound_subhalo.centre_of_mass',
5555
),
5656
)
5757

0 commit comments

Comments
 (0)