SegGeometry::SegGeometry Class Reference

List of all members.

Public Member Functions
def	__init__
def	print_seg_info
def	size
def	rows
def	cols
def	shape
def	pixel_scale_size
def	pixel_area_array
def	pixel_size_array
def	pixel_coord_array
def	pixel_coord_min
def	pixel_coord_max
def	pixel_mask_array
def	return_switch
Static Public Attributes
list	AXIS = ['X', 'Y', 'Z']
dictionary	DIC_AXIS = {'X':0, 'Y':1, 'Z':2}
string	wmsg = 'WARNING! %s - interface method from the base class \nneeds to be re-implemented in the derived class'

---

Detailed Description

Definition at line 66 of file SegGeometry.py.

---

Member Function Documentation

def SegGeometry::SegGeometry::__init__

(

self

)

Definition at line 71 of file SegGeometry.py.

def SegGeometry::SegGeometry::cols

(

self

)

Returns number of cols in segment

Definition at line 90 of file SegGeometry.py.

def SegGeometry::SegGeometry::pixel_area_array

(

self

)

Returns array of pixel relative areas of shape=[rows, cols]

Definition at line 105 of file SegGeometry.py.

def SegGeometry::SegGeometry::pixel_coord_array	(		self,
			axis
	)

Returns array of segment pixel coordinates in um for AXIS

Definition at line 115 of file SegGeometry.py.

def SegGeometry::SegGeometry::pixel_coord_max	(		self,
			axis
	)

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

Definition at line 125 of file SegGeometry.py.

def SegGeometry::SegGeometry::pixel_coord_min	(		self,
			axis
	)

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

Definition at line 120 of file SegGeometry.py.

def SegGeometry::SegGeometry::pixel_mask_array	(		self,
			mbits
	)

Returns array of masked pixels which content depends on bontrol bitword mbits

Definition at line 130 of file SegGeometry.py.

def SegGeometry::SegGeometry::pixel_scale_size

(

self

)

Returns pixel size in um for indexing

Definition at line 100 of file SegGeometry.py.

def SegGeometry::SegGeometry::pixel_size_array	(		self,
			axis
	)

Returns array of pixel size in um for AXIS

Definition at line 110 of file SegGeometry.py.

def SegGeometry::SegGeometry::print_seg_info	(		self,
			pbits = 0
	)

Definition at line 76 of file SegGeometry.py.

def SegGeometry::SegGeometry::return_switch	(		sp,
			meth,
			axis = None
	)

Returns three x,y,z arrays if axis=None, or single array for specified axis 

Definition at line 135 of file SegGeometry.py.

def SegGeometry::SegGeometry::rows

(

self

)

Returns number of rows in segment

Definition at line 85 of file SegGeometry.py.

def SegGeometry::SegGeometry::shape

(

self

)

Returns shape of the segment [rows, cols]

Definition at line 95 of file SegGeometry.py.

def SegGeometry::SegGeometry::size

(

self

)

Returns segment size - total number of pixels in segment

Definition at line 80 of file SegGeometry.py.

---

Member Data Documentation

list SegGeometry::SegGeometry::AXIS = ['X', 'Y', 'Z'] [static]

Definition at line 67 of file SegGeometry.py.

dictionary SegGeometry::SegGeometry::DIC_AXIS = {'X':0, 'Y':1, 'Z':2} [static]

Definition at line 68 of file SegGeometry.py.

string SegGeometry::SegGeometry::wmsg = 'WARNING! %s - interface method from the base class \nneeds to be re-implemented in the derived class' [static]

Definition at line 69 of file SegGeometry.py.

---

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

• PSCalib/src/SegGeometry.py

---