PSCalib::SegGeometry Class Reference
[PSCalib package]

Abstract base class SegGeometry defines the interface to access segment pixel coordinates. More...

#include <SegGeometry.h>

Inheritance diagram for PSCalib::SegGeometry:

List of all members.

Public Types
typedef double	pixel_coord_t
typedef double	pixel_area_t
typedef int	pixel_mask_t
	AXIS_X = 0
	AXIS_Y
	AXIS_Z
enum	AXIS { AXIS_X = 0, AXIS_Y, AXIS_Z }
	Enumerator for X, Y, and Z axes. More...
Public Member Functions
virtual	~SegGeometry ()
virtual void	print_seg_info (const unsigned &pbits=0)=0
	Prints segment info for selected bits.
virtual const size_t	size ()=0
	Returns segment size - total number of pixels in segment.
virtual const size_t	rows ()=0
	Returns number of rows in segment.
virtual const size_t	cols ()=0
	Returns number of cols in segment.
virtual const size_t *	shape ()=0
	Returns shape of the segment {rows, cols}.
virtual const pixel_coord_t	pixel_scale_size ()=0
	Returns pixel size in um for indexing.
virtual const pixel_area_t *	pixel_area_array ()=0
	Returns pointer to the array of pixel areas normalized on minimal pixel area.
virtual const pixel_coord_t *	pixel_size_array (AXIS axis)=0
	Returns pointer to the array of pixel size in um for AXIS.
virtual const pixel_coord_t *	pixel_coord_array (AXIS axis)=0
	Returns pointer to the array of segment pixel coordinates in um for AXIS.
virtual const pixel_coord_t	pixel_coord_min (AXIS axis)=0
	Returns minimal value in the array of segment pixel coordinates in um for AXIS.
virtual const pixel_coord_t	pixel_coord_max (AXIS axis)=0
	Returns maximal value in the array of segment pixel coordinates in um for AXIS.
virtual const pixel_mask_t *	pixel_mask_array (const unsigned &mbits=0377)=0
	Returns pointer to the array of pixel mask.

---

Detailed Description

Abstract base class SegGeometry defines the interface to access segment pixel coordinates.

This software was developed for the LCLS project. If you use all or part of it, please give an appropriate acknowledgment.

See also:

CalibFileFinder

Version:

Id

SegGeometry.h 10053 2015-05-11 22:27:46Z dubrovin@SLAC.STANFORD.EDU

Author:

Mikhail S. Dubrovin

See also:

CalibFileFinder

Definition at line 56 of file SegGeometry.h.

---

Member Typedef Documentation

typedef double PSCalib::SegGeometry::pixel_area_t

Definition at line 67 of file SegGeometry.h.

typedef double PSCalib::SegGeometry::pixel_coord_t

Definition at line 66 of file SegGeometry.h.

typedef int PSCalib::SegGeometry::pixel_mask_t

Definition at line 68 of file SegGeometry.h.

---

Member Enumeration Documentation

enum PSCalib::SegGeometry::AXIS

Enumerator for X, Y, and Z axes.

Enumerator:

AXIS_X
AXIS_Y
AXIS_Z

Definition at line 60 of file SegGeometry.h.

---

Constructor & Destructor Documentation

virtual PSCalib::SegGeometry::~SegGeometry

(

)

[inline, virtual]

Definition at line 72 of file SegGeometry.h.

---

Member Function Documentation

virtual const size_t PSCalib::SegGeometry::cols

(

)

[pure virtual]

Returns number of cols in segment.

Implemented in PSCalib::SegGeometryCspad2x1V1, PSCalib::SegGeometryEpix100V1, and PSCalib::SegGeometryMatrixV1.

virtual const pixel_area_t* PSCalib::SegGeometry::pixel_area_array

(

)

[pure virtual]

Returns pointer to the array of pixel areas normalized on minimal pixel area.

Implemented in PSCalib::SegGeometryCspad2x1V1, PSCalib::SegGeometryEpix100V1, and PSCalib::SegGeometryMatrixV1.

virtual const pixel_coord_t* PSCalib::SegGeometry::pixel_coord_array

(

AXIS

axis

)

[pure virtual]

Returns pointer to the array of segment pixel coordinates in um for AXIS.

virtual const pixel_coord_t PSCalib::SegGeometry::pixel_coord_max

(

AXIS

axis

)

[pure virtual]

Returns maximal value in the array of segment pixel coordinates in um for AXIS.

virtual const pixel_coord_t PSCalib::SegGeometry::pixel_coord_min

(

AXIS

axis

)

[pure virtual]

Returns minimal value in the array of segment pixel coordinates in um for AXIS.

virtual const pixel_mask_t* PSCalib::SegGeometry::pixel_mask_array

(

const unsigned &

mbits = 0377

)

[pure virtual]

Returns pointer to the array of pixel mask.

Implemented in PSCalib::SegGeometryCspad2x1V1, PSCalib::SegGeometryEpix100V1, and PSCalib::SegGeometryMatrixV1.

virtual const pixel_coord_t PSCalib::SegGeometry::pixel_scale_size

(

)

[pure virtual]

Returns pixel size in um for indexing.

Implemented in PSCalib::SegGeometryCspad2x1V1, PSCalib::SegGeometryEpix100V1, and PSCalib::SegGeometryMatrixV1.

virtual const pixel_coord_t* PSCalib::SegGeometry::pixel_size_array

(

AXIS

axis

)

[pure virtual]

Returns pointer to the array of pixel size in um for AXIS.

virtual void PSCalib::SegGeometry::print_seg_info

(

const unsigned &

pbits = 0

)

[pure virtual]

Prints segment info for selected bits.

Implemented in PSCalib::SegGeometryCspad2x1V1, PSCalib::SegGeometryEpix100V1, and PSCalib::SegGeometryMatrixV1.

virtual const size_t PSCalib::SegGeometry::rows

(

)

[pure virtual]

Returns number of rows in segment.

Implemented in PSCalib::SegGeometryCspad2x1V1, PSCalib::SegGeometryEpix100V1, and PSCalib::SegGeometryMatrixV1.

virtual const size_t* PSCalib::SegGeometry::shape

(

)

[pure virtual]

Returns shape of the segment {rows, cols}.

Implemented in PSCalib::SegGeometryCspad2x1V1, PSCalib::SegGeometryEpix100V1, and PSCalib::SegGeometryMatrixV1.

virtual const size_t PSCalib::SegGeometry::size

(

)

[pure virtual]

Returns segment size - total number of pixels in segment.

Implemented in PSCalib::SegGeometryCspad2x1V1, PSCalib::SegGeometryEpix100V1, and PSCalib::SegGeometryMatrixV1.

---

The documentation for this class was generated from the following file:

• PSCalib/include/SegGeometry.h

---