allpix::Cluster

#include <Cluster.hpp>

Public Functions

Public Functions Documentation

function Cluster

explicit Cluster(
    const PixelHit * seed_pixel_hit
)

Construct a cluster.

Parameters:

• seed_pixel_hit PixelHit to start the cluster with

function getCharge

inline double getCharge() const

Get the total accumulated signal of the cluster.

Return: Total cluster charge

function addPixelHit

bool addPixelHit(
    const PixelHit * pixel_hit
)

Add a PixelHit to the cluster.

Parameters:

• pixel_hit PixelHit to be added

function getSize

inline unsigned long int getSize() const

Get the cluster size.

Return: cluster size

function getSizeXY

std::pair< unsigned int, unsigned int > getSizeXY() const

Get the cluster sizes in x and y.

Return: pair of cluster size x and y

function getPosition

ROOT::Math::XYZPoint getPosition() const

Get the charge-weighted mean cluster position in local coordinates.

Return: weighted mean cluster position

function getSeedPixelHit

inline const PixelHit * getSeedPixelHit() const

Get the seed PixelHit, i.e. the PixelHit with the largest charge.

Return: Pointer to PixelHit

function getPixelHit

const PixelHit * getPixelHit(
    int x,
    int y
) const

Get the PixelHit at coordinates x and y.

Parameters:

• x Coordinate of the pixel in x direction
• y Coordinate of the pixel in y direction

Return: Pointer to matching PixelHit if available or a nullptr if not part of the cluster

function getPixelHits

inline const std::set< const PixelHit * > & getPixelHits() const

Get the PixelHits contained in this cluster.

Return: List of all contained PixelHits

function getMCParticles

inline const std::set< const MCParticle * > & getMCParticles() const

Get all MCParticles related to the cluster.

Return: Vector of all related MCParticles

Note: MCParticles can only be fetched if the full history of objects are in scope and stored

Updated on 2025-02-27 at 14:14:46 +0000