ENLIGHTEN
Cross-platform desktop GUI for Wasatch Photonics spectrometers
Loading...
Searching...
No Matches
wasatch.ROI.ROI Class Reference

This class encapsulates a Region Of Interest, which may be either horizontal (pixels) or vertical (rows/lines). More...

Public Member Functions

 __init__ (self, start, end)
 
 __repr__ (self)
 
 contains (self, value)
 
 crop (self, spectrum)
 
 valid (self)
 

Public Attributes

 end = int(end)
 
int len = end - start + 1
 
self.end+1] start = int(start)
 

Detailed Description

This class encapsulates a Region Of Interest, which may be either horizontal (pixels) or vertical (rows/lines).

Note that self.end is the LAST valid index, not LAST+1; (start, end) is an open interval, not half-open.

Constructor & Destructor Documentation

◆ __init__()

wasatch.ROI.ROI.__init__ ( self,
start,
end )

Member Function Documentation

◆ __repr__()

wasatch.ROI.ROI.__repr__ ( self)

◆ contains()

wasatch.ROI.ROI.contains ( self,
value )

◆ crop()

wasatch.ROI.ROI.crop ( self,
spectrum )

◆ valid()

wasatch.ROI.ROI.valid ( self)

Member Data Documentation

◆ end

wasatch.ROI.ROI.end = int(end)

◆ len

int wasatch.ROI.ROI.len = end - start + 1

◆ start

self.end+1] wasatch.ROI.ROI.start = int(start)

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