diff --git a/src/ctapipe/instrument/camera/description.py b/src/ctapipe/instrument/camera/description.py index b88bc1fa48d..6c4f2c466db 100644 --- a/src/ctapipe/instrument/camera/description.py +++ b/src/ctapipe/instrument/camera/description.py @@ -60,14 +60,26 @@ def get_known_camera_names(cls): @classmethod def from_name(cls, name): - """ - Construct a CameraDescription from a camera name + """Construct a CameraDescription from a camera name Parameters ---------- name: str Camera name (e.g. NectarCam, LSTCam, ...) + + Notes + ----- + + Warning: This method loads a pre-generated ``CameraDescription`` and is + thus not guranteed to be the same pixel ordering or even positions that + correspond with event data! Therefore if you are analysing data, you + should not rely on this method, but rather open the data with an + ``EventSource`` and use the ``CameraDescription`` that is provided by + ``source.subarray.tel[i].camera`` or by + ``source.subarray.camera_types[type_name]``. This will guarantee that + the pixels in the event data correspond with the ``CameraDescription`` + Returns ------- CameraDescription diff --git a/src/ctapipe/instrument/telescope.py b/src/ctapipe/instrument/telescope.py index edab4e24490..f7cd58120b0 100644 --- a/src/ctapipe/instrument/telescope.py +++ b/src/ctapipe/instrument/telescope.py @@ -84,6 +84,19 @@ def from_name(cls, optics_name, camera_name): optics name (e.g. LST, or SST-ASTRI), also called telescope_description + Notes + ----- + + Warning: This method loads a pre-generated ``TelescopeDescription`` and is + thus not guranteed to be the same pixel ordering or even positions that + correspond with event data! Therefore if you are analysing data, you + should not rely on this method, but rather open the data with an + ``EventSource`` and use the ``TelescopeDescription`` that is provided by + ``source.subarray.tel[i]`` or by + ``source.subarray.telescope_types[type_name]``. This will guarantee that + the pixels in the event data correspond with the ``TelescopeDescription`` + + Returns ------- TelescopeDescription