Laelaps  2.3.5
RoadNarrows Robotics Small Outdoor Mobile Robot Project
Laelaps.Utils.ImageLoader Class Reference

Class to handle image loading. More...

Public Member Functions

def __init__ (self, py_pkg=None, image_paths=[])
 Constructor. More...
 
def loadImage (self, filename)
 Open image from file and convert to PhotoImage. More...
 
def openImage (self, filename)
 Open image from file. More...
 

Public Attributes

 m_pyPkg
 
 m_imagePaths
 

Detailed Description

Class to handle image loading.

Definition at line 76 of file Utils.py.

Constructor & Destructor Documentation

def Laelaps.Utils.ImageLoader.__init__ (   self,
  py_pkg = None,
  image_paths = [] 
)

Constructor.

Parameters
py_pkgPython resource (e.g. "laelaps_control.images").
image_pathsList of directory paths to search for the image.

Definition at line 83 of file Utils.py.

References Laelaps.Utils.ImageLoader.m_imagePaths, and Laelaps.Utils.ImageLoader.m_pyPkg.

83  def __init__(self, py_pkg=None, image_paths=[]):
84  self.m_pyPkg = py_pkg
85  if len(image_paths) > 0:
86  self.m_imagePaths = image_paths
87  else:
88  self.m_imagePaths = ['.']
89 
def __init__(self, py_pkg=None, image_paths=[])
Constructor.
Definition: Utils.py:83

Member Function Documentation

def Laelaps.Utils.ImageLoader.loadImage (   self,
  filename 
)

Open image from file and convert to PhotoImage.

Parameters
filenameImage file name.
Returns
Returns image widget on success, None on failure.

Definition at line 97 of file Utils.py.

References Laelaps.Utils.ImageLoader.openImage().

97  def loadImage(self, filename):
98  img = self.openImage(filename)
99  if img is not None:
100  return ImageTk.PhotoImage(img)
101  else:
102  return None
103 
def openImage(self, filename)
Open image from file.
Definition: Utils.py:141
def loadImage(self, filename)
Open image from file and convert to PhotoImage.
Definition: Utils.py:97
def Laelaps.Utils.ImageLoader.openImage (   self,
  filename 
)

Open image from file.

Parameters
filenameImage file name.
Returns
Returns image widget on success, None on failure.

Definition at line 141 of file Utils.py.

References Laelaps.Utils.ImageLoader.m_imagePaths, and Laelaps.Utils.ImageLoader.m_pyPkg.

Referenced by Laelaps.Utils.ImageLoader.loadImage().

141  def openImage(self, filename):
142  # no file name
143  if filename is None or len(filename) == 0:
144  return None;
145  # relative file name - try python resource(s) first
146  if self.m_pyPkg:
147  try:
148  fqname = resource_filename(self.m_pyPkg, filename)
149  try:
150  return Image.open(fqname)
151  except IOError:
152  pass
153  except ImportError:
154  pass
155  # relative file name - search path for file
156  for path in self.m_imagePaths:
157  fqname = path + os.path.sep + filename
158  try:
159  return Image.open(fqname)
160  except IOError:
161  continue
162  return None
163 
164 
165 
166 # ------------------------------------------------------------------------------
167 # Misc. Utilities
168 # ------------------------------------------------------------------------------
169 
170 #
171 #
def openImage(self, filename)
Open image from file.
Definition: Utils.py:141

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