Add rotated arg to utils functions

Author: maxnoe

fact/coordinates/utils.py

@@ -19,10 +19,14 @@ def arrays_to_altaz(zenith, azimuth, obstime=None):
     )
 
 
-def arrays_to_camera(x, y, pointing_direction, obstime=None):
+def arrays_to_camera(x, y, pointing_direction, obstime=None, rotated=True):
     if obstime is not None:
         obstime = to_astropy_time(obstime)
-    frame = CameraFrame(pointing_direction=pointing_direction, obstime=obstime)
+    frame = CameraFrame(
+        pointing_direction=pointing_direction,
+        obstime=obstime,
+        rotated=rotated,
+    )
     return SkyCoord(
         x=np.asanyarray(x) * u.mm,
         y=np.asanyarray(y) * u.mm,
@@ -63,7 +67,7 @@ def to_astropy_time(series_or_array):
     return Time(time, scale='utc')
 
 
-def equatorial_to_camera(ra, dec, zd_pointing, az_pointing, obstime):
+def equatorial_to_camera(ra, dec, zd_pointing, az_pointing, obstime, rotated=True):
     '''
     Convert sky coordinates from the equatorial frame to FACT camera
     coordinates.
@@ -80,6 +84,11 @@ def equatorial_to_camera(ra, dec, zd_pointing, az_pointing, obstime):
         Azimuth of the telescope pointing direction in degree
     obstime: datetime or np.datetime64
         Time of the observations
+    rotated: bool
+        True means x points right and y points up when looking on the camera
+        from the dish, which is the efinition of FACT-Tools >= 1.0 and Mars.
+        False means x points up and y points left,
+        which is definition in the original FACTPixelMap file.
 
     Returns
     -------
@@ -93,13 +102,13 @@ def equatorial_to_camera(ra, dec, zd_pointing, az_pointing, obstime):
     eq_coordinates = arrays_to_equatorial(ra, dec, obstime=obstime)
     pointing_direction = arrays_to_altaz(zd_pointing, az_pointing, obstime)
 
-    camera_frame = CameraFrame(pointing_direction=pointing_direction)
+    camera_frame = CameraFrame(pointing_direction=pointing_direction, rotated=rotated)
     cam_coordinates = eq_coordinates.transform_to(camera_frame)
 
     return cam_coordinates.x.to(u.mm).value, cam_coordinates.y.to(u.mm).value
 
 
-def camera_to_equatorial(x, y, zd_pointing, az_pointing, obstime):
+def camera_to_equatorial(x, y, zd_pointing, az_pointing, obstime, rotated=True):
     '''
     Convert FACT camera coordinates to sky coordinates in the equatorial (icrs)
     frame.
@@ -118,6 +127,11 @@ def camera_to_equatorial(x, y, zd_pointing, az_pointing, obstime):
         Azimuth of the telescope pointing direction in degree
     obstime: datetime or np.datetime64
         Time of the observations
+    rotated: bool
+        True means x points right and y points up when looking on the camera
+        from the dish, which is the efinition of FACT-Tools >= 1.0 and Mars.
+        False means x points up and y points left,
+        which is definition in the original FACTPixelMap file.
 
     Returns
     -------
@@ -127,13 +141,15 @@ def camera_to_equatorial(x, y, zd_pointing, az_pointing, obstime):
         Declination in degrees
     '''
     pointing_direction = arrays_to_altaz(zd_pointing, az_pointing, obstime)
-    cam_coordinates = arrays_to_camera(x, y, pointing_direction, obstime=obstime)
+    cam_coordinates = arrays_to_camera(
+        x, y, pointing_direction, obstime=obstime, rotated=True
+    )
     eq_coordinates = cam_coordinates.transform_to(ICRS)
 
     return eq_coordinates.ra.hourangle, eq_coordinates.dec.deg
 
 
-def horizontal_to_camera(zd, az, zd_pointing, az_pointing):
+def horizontal_to_camera(zd, az, zd_pointing, az_pointing, rotated=True):
     '''
     Convert sky coordinates from the equatorial frame to FACT camera
     coordinates.
@@ -148,6 +164,11 @@ def horizontal_to_camera(zd, az, zd_pointing, az_pointing):
         Zenith distance of the telescope pointing direction in degree
     az_pointing: number or array-like
         Azimuth of the telescope pointing direction in degree
+    rotated: bool
+        True means x points right and y points up when looking on the camera
+        from the dish, which is the efinition of FACT-Tools >= 1.0 and Mars.
+        False means x points up and y points left,
+        which is definition in the original FACTPixelMap file.
 
     Returns
     -------
@@ -161,13 +182,15 @@ def horizontal_to_camera(zd, az, zd_pointing, az_pointing):
     altaz = arrays_to_altaz(zd, az)
     pointing_direction = arrays_to_altaz(zd_pointing, az_pointing)
 
-    camera_frame = CameraFrame(pointing_direction=pointing_direction)
+    camera_frame = CameraFrame(
+        pointing_direction=pointing_direction, rotated=rotated
+    )
     cam_coordinates = altaz.transform_to(camera_frame)
 
     return cam_coordinates.x.to(u.mm).value, cam_coordinates.y.to(u.mm).value
 
 
-def camera_to_horizontal(x, y, zd_pointing, az_pointing):
+def camera_to_horizontal(x, y, zd_pointing, az_pointing, rotated=True):
     '''
     Convert FACT camera coordinates to sky coordinates in the equatorial (icrs)
     frame.
@@ -184,6 +207,11 @@ def camera_to_horizontal(x, y, zd_pointing, az_pointing):
         Zenith distance of the telescope pointing direction in degree
     az_pointing: number or array-like
         Azimuth of the telescope pointing direction in degree
+    rotated: bool
+        True means x points right and y points up when looking on the camera
+        from the dish, which is the efinition of FACT-Tools >= 1.0 and Mars.
+        False means x points up and y points left,
+        which is definition in the original FACTPixelMap file.
 
     Returns
     -------
@@ -193,7 +221,9 @@ def camera_to_horizontal(x, y, zd_pointing, az_pointing):
         Declination in degrees
     '''
     pointing_direction = arrays_to_altaz(zd_pointing, az_pointing)
-    cam_coordinates = arrays_to_camera(x, y, pointing_direction)
+    cam_coordinates = arrays_to_camera(
+        x, y, pointing_direction, rotated=rotated
+    )
     altaz = cam_coordinates.transform_to(AltAz(location=LOCATION))
 
     return altaz.zen.deg, altaz.az.deg