allpix::Pixel

Module: Objects

Pixel in the model with indices, location and size. More…

#include <Pixel.hpp>

Public Types

	Name
enum class	Type { RECTANGLE = 0, HEXAGON_FLAT, HEXAGON_POINTY} Type of pixels.
using ROOT::Math::DisplacementVector2D< ROOT::Math::Cartesian2D< int > >	Index

Public Functions

	Name
	Pixel(Pixel::Index index, Pixel::Type type, ROOT::Math::XYZPoint local_center, ROOT::Math::XYZPoint global_center, ROOT::Math::XYVector size) Construct a new pixel.
Pixel::Index	getIndex() const Return index pair of pixel.
Pixel::Type	getType() const Return type of pixel.
ROOT::Math::XYZPoint	getLocalCenter() const Get center position in local coordinates.
ROOT::Math::XYZPoint	getGlobalCenter() const Get center position in global coordinates.
ROOT::Math::XYVector	getSize() const Get size of pixel.
	Pixel() =default ROOT class definition.
	ClassDef(Pixel , 2 ) Default constructor for ROOT I/O.

Detailed Description

class allpix::Pixel;

Pixel in the model with indices, location and size.

Warning: This object is special and is not meant to be written directly to a tree (not inheriting from Object)

Public Types Documentation

enum Type

Enumerator	Value	Description
RECTANGLE	0	Rectangular pixel shape.
HEXAGON_FLAT		Hexagonal pixel shape, flat side up.
HEXAGON_POINTY		Hexagonal pixel shape, corner up.

Type of pixels.

using Index

using allpix::Pixel::Index =  ROOT::Math::DisplacementVector2D<ROOT::Math::Cartesian2D<int> >;

Public Functions Documentation

function Pixel

Pixel(
    Pixel::Index index,
    Pixel::Type type,
    ROOT::Math::XYZPoint local_center,
    ROOT::Math::XYZPoint global_center,
    ROOT::Math::XYVector size
)

Construct a new pixel.

function getIndex

Pixel::Index getIndex() const

Return index pair of pixel.

Return: Index in x,y-plane

function getType

Pixel::Type getType() const

Return type of pixel.

Return: Type of the pixel describing its shape and orientation

function getLocalCenter

ROOT::Math::XYZPoint getLocalCenter() const

Get center position in local coordinates.

Return: Local center position

function getGlobalCenter

ROOT::Math::XYZPoint getGlobalCenter() const

Get center position in global coordinates.

Return: Global center position

function getSize

ROOT::Math::XYVector getSize() const

Get size of pixel.

Return: Pixel size

function Pixel

Pixel() =default

ROOT class definition.

function ClassDef

ClassDef(
    Pixel ,
    2 
)

Default constructor for ROOT I/O.

Updated on 2024-05-17 at 13:58:18 +0000