TRestDetectorExperimentalReadoutModule.h

/**
 * @file TRestDetectorExperimentalReadoutModule.h
 * @brief Defines the TRestDetectorExperimentalReadoutModule class.
 */

#ifndef REST_TRESTDETECTOREXPERIMENTALREADOUTMODULE_H
#define REST_TRESTDETECTOREXPERIMENTALREADOUTMODULE_H

#include <map>

#include "TRestDetectorExperimentalReadoutPixel.h"

class KDTree;

/**
 * @class TRestDetectorExperimentalReadoutModule
 * @brief Represents a module in an experimental readout detector.
 * @author Luis Obis
 */
class TRestDetectorExperimentalReadoutModule {
   private:
    std::vector<TRestDetectorExperimentalReadoutPixel> fPixels; /**< The pixels of the module. */

    TVector3 fPosition = {0, 0, 0}; /**< The position of the module in 3D space. */
    TVector3 fNormal = {0, 0, 1};   /**< The normal vector to the module. */
    double fHeight = 1.0;           /**< The height of the module (drift distance). */
    std::pair<TVector3, TVector3> fCoordinateAxes = {{1, 0, 0},
                                                     {0, 1, 0}}; /**< The coordinate axes of the module. */
    double fRotation =
        0; /**< The rotation angle of the module with respect to the normal vector in degrees. */
    // auxiliary data structures
    KDTree* fKDTree = nullptr;         /**< The KDTree used for spatial queries. */
    double fSearchRadius = 0;          /**< The search radius for spatial queries. */
    std::vector<TVector2> fConvexHull; /**< The convex hull of the module. */
    std::map<unsigned short, std::vector<TRestDetectorExperimentalReadoutPixel*>>
        fChannelToPixels; /**< A map from channel to pixels. */
    /**
     * @brief Builds the KDTree for the module.
     */
    void BuildKDTree();

    /**
     * @brief Computes the convex hull of the module.
     * @return The convex hull of the module.
     */
    std::vector<TVector2> ComputeConvexHull();

    void UpdateAxes();

   public:
    // needed for root
    TRestDetectorExperimentalReadoutModule() = default;
    virtual ~TRestDetectorExperimentalReadoutModule() {
        // delete fKDTree;
    }

    void SetPosition(const TVector3& position) { fPosition = position; }
    void SetNormal(const TVector3& normal);
    void SetHeight(double height);
    void SetRotation(double rotationInDegrees);

    TVector3 GetPosition() const { return fPosition; }
    TVector3 GetNormal() const { return fNormal; }
    double GetHeight() const { return fHeight; }
    std::pair<TVector3, TVector3> GetCoordinateAxes() const { return fCoordinateAxes; }
    double GetRotation() const { return fRotation; }
    /**
     * @brief Returns the number of pixels in the module.
     * @return The number of pixels.
     */
    size_t GetNumberOfPixels() const { return fPixels.size(); }

    /**
     * @brief Returns the pixels of the module.
     * @return The pixels.
     */
    std::vector<TRestDetectorExperimentalReadoutPixel> GetPixels() const { return fPixels; }

    /**
     * @brief Sets the pixels of the module.
     * @param pixels The pixels to set.
     */
    void SetPixels(const std::vector<TRestDetectorExperimentalReadoutPixel>& pixels);

    /**
     * @brief Returns the convex hull of the module.
     * @return The convex hull.
     */
    std::vector<TVector2> GetConvexHull() const { return fConvexHull; }

    /**
     * @brief Returns the pixels that contain a given point.
     * @param point The point to check.
     * @return The pixels containing the point.
     */
    std::vector<const TRestDetectorExperimentalReadoutPixel*> GetPixelsForPoint(const TVector2& point) const;
    std::vector<const TRestDetectorExperimentalReadoutPixel*> GetPixelsForPoint(const TVector3& point) const;
    std::vector<const TRestDetectorExperimentalReadoutPixel*> GetPixelsForChannel(
        unsigned short channel) const;

    /**
     * @brief Returns the Z coordinate of a given point inside the module.
     * @param point The point to check.
     * @return The Z coordinate of the point.
     */
    double GetZ(const TVector3& point) const;

    /**
     * @brief Checks if a given point is inside the module in the module's local XY plane.
     * @param point The point to check.
     * @return True if the point is inside the module, false otherwise.
     */
    bool IsInside(const TVector2& point) const;

    /**
     * @brief Checks if a given point is inside the module in 3D space.
     * @param point The point to check.
     * @return True if the point is inside the module, false otherwise.
     */
    bool IsInside(const TVector3& point) const;

    /**
     * @brief Transforms a point from 3D space to the module's local XY plane coordinates.
     * @param point The point to transform.
     * @return The transformed point in the local XY plane.
     */
    TVector2 TransformToModuleCoordinates(const TVector3& point) const;

    /**
     * @brief Transforms a point from the module's local XY plane coordinates to 3D space.
     * @param point The point to transform.
     * @return The transformed point in 3D space.
     */
    TVector3 TransformToAbsoluteCoordinates(const TVector2& point) const;

    ClassDef(TRestDetectorExperimentalReadoutModule, 1);
};

#endif  // REST_TRESTDETECTOREXPERIMENTALREADOUTMODULE_H