Coretex
Public Member Functions | List of all members
coretex.coretex.annotation.image.classes_format.ImageDatasetClasses Class Reference
Inheritance diagram for coretex.coretex.annotation.image.classes_format.ImageDatasetClasses:
coretex.coretex.annotation.image.classes_format.ImageDatasetClass coretex.codable.codable.Codable

Public Member Functions

Optional[ImageDatasetClass] classById (self, UUID classId)
 
Optional[ImageDatasetClass] classByLabel (self, str label)
 
Optional[int] labelIdForClassId (self, UUID classId)
 
Optional[int] labelIdForClass (self, ImageDatasetClass clazz)
 
None exclude (self, List[str] excludedClasses)
 
- Public Member Functions inherited from coretex.coretex.annotation.image.classes_format.ImageDatasetClass
ImageDatasetClasses generate (cls, Set[str] labels)
 
- Public Member Functions inherited from coretex.codable.codable.Codable
Dict[str, Any] encode (self)
 
None onDecode (self)
 
Self decode (cls, Dict[str, Any] encodedObject)
 

Detailed Description

    List of Image Dataset class metadata

    Properties
    ----------
    labels : List[str]
        list of the classes names

Definition at line 115 of file classes_format.py.

Member Function Documentation

◆ classById()

Optional[ImageDatasetClass] coretex.coretex.annotation.image.classes_format.ImageDatasetClasses.classById (   self,
UUID  classId 
) 
    Retrieves a Image dataset class based on provided ID

    Parameters
    ----------
    classID : UUID
id of class

    Returns
    -------
    Optional[ImageDatasetClasses] -> fetched class if provided ID
    is found in list of class IDs, None otherwise

    Examples
    --------
    >>> from coretex import ImageDataset
    \b
    >>> dataset = ImageDataset.fetchById(1023)
    >>> classObj = dataset.classes.classById(UUID("d710019b-f28f-40ab-aa65-e13df949beff"))
    \b
    >>> if classObj is not None:
    print(classObj.classIds)
    print(classObj.label)
    print(classObj.color)
    UUID("d710019b-f28f-40ab-aa65-e13df949beff")
    "bicycle"
    "#d06df5"

Definition at line 133 of file classes_format.py.

133  def classById(self, classId: UUID) -> Optional[ImageDatasetClass]:
134  """
135  Retrieves a Image dataset class based on provided ID
136 
137  Parameters
138  ----------
139  classID : UUID
140  id of class
141 
142  Returns
143  -------
144  Optional[ImageDatasetClasses] -> fetched class if provided ID
145  is found in list of class IDs, None otherwise
146 
147  Examples
148  --------
149  >>> from coretex import ImageDataset
150  \b
151  >>> dataset = ImageDataset.fetchById(1023)
152  >>> classObj = dataset.classes.classById(UUID("d710019b-f28f-40ab-aa65-e13df949beff"))
153  \b
154  >>> if classObj is not None:
155  print(classObj.classIds)
156  print(classObj.label)
157  print(classObj.color)
158  UUID("d710019b-f28f-40ab-aa65-e13df949beff")
159  "bicycle"
160  "#d06df5"
161  """
162 
163  for element in self:
164  for other in element.classIds:
165  if str(classId) == str(other):
166  return element
167 
168  return None
169 

◆ classByLabel()

Optional[ImageDatasetClass] coretex.coretex.annotation.image.classes_format.ImageDatasetClasses.classByLabel (   self,
str  label 
) 
    Retrieves a Image dataset class based on provided label

    Parameters
    ----------
    label : str
name of class

    Returns
    -------
    Optional[ImageDatasetClasses] -> fetched class if provided label
    is found in list of class labels, None otherwise

Definition at line 170 of file classes_format.py.

170  def classByLabel(self, label: str) -> Optional[ImageDatasetClass]:
171  """
172  Retrieves a Image dataset class based on provided label
173 
174  Parameters
175  ----------
176  label : str
177  name of class
178 
179  Returns
180  -------
181  Optional[ImageDatasetClasses] -> fetched class if provided label
182  is found in list of class labels, None otherwise
183  """
184 
185  for element in self:
186  if element.label == label:
187  return element
188 
189  return None
190 

◆ exclude()

None coretex.coretex.annotation.image.classes_format.ImageDatasetClasses.exclude (   self,
List[str]  excludedClasses 
) 
    Excludes classes that are provided in excludedClasses list

    Parameters
    ----------
    excludedClasses : List[str]
list of classes that will be excluded

Definition at line 251 of file classes_format.py.

251  def exclude(self, excludedClasses: List[str]) -> None:
252  """
253  Excludes classes that are provided in excludedClasses list
254 
255  Parameters
256  ----------
257  excludedClasses : List[str]
258  list of classes that will be excluded
259  """
260 
261  classes = [
262  element for element in self
263  if element.label not in excludedClasses
264  ]
265 
266  self.clear()
267  self.extend(classes)

◆ labelIdForClass()

Optional[int] coretex.coretex.annotation.image.classes_format.ImageDatasetClasses.labelIdForClass (   self,
ImageDatasetClass  clazz 
) 
    Retrieves a label ID based on provided ImageDatasetClass object

    Parameters
    ----------
    clazz : ImageDatasetClass
Image Dataset class metadata object

    Returns
    -------
    Optional[int] -> label ID if provided class exists
    in a list of ImageDataset classes otherwise None

    Example
    -------
    >>> from coretex import ImageDatasetClass
    \b
    >>> dataset = ImageDataset.fetchById(1023)
    >>> labelId = dataset.classes.labelIdForClass(dataset.classes[0])
    >>> print(labelId)
    0

Definition at line 225 of file classes_format.py.

225  def labelIdForClass(self, clazz: ImageDatasetClass) -> Optional[int]:
226  """
227  Retrieves a label ID based on provided ImageDatasetClass object
228 
229  Parameters
230  ----------
231  clazz : ImageDatasetClass
232  Image Dataset class metadata object
233 
234  Returns
235  -------
236  Optional[int] -> label ID if provided class exists
237  in a list of ImageDataset classes otherwise None
238 
239  Example
240  -------
241  >>> from coretex import ImageDatasetClass
242  \b
243  >>> dataset = ImageDataset.fetchById(1023)
244  >>> labelId = dataset.classes.labelIdForClass(dataset.classes[0])
245  >>> print(labelId)
246  0
247  """
248 
249  return self.labelIdForClassId(clazz.classIds[0])
250 

◆ labelIdForClassId()

Optional[int] coretex.coretex.annotation.image.classes_format.ImageDatasetClasses.labelIdForClassId (   self,
UUID  classId 
) 
    Retrieves a label ID based on provided class ID

    Parameters
    ----------
    classId : UUID
id of class

    Returns
    -------
    Optional[int] -> label ID if provided class ID
    is found in list of class IDs, None otherwise

    Example
    -------
    >>> from coretex import ImageDataset
    \b
    >>> dataset = ImageDataset.fetchById(1023)
    >>> labelId = dataset.classes.labelIdForClassId(UUID("d710019b-f28f-40ab-aa65-e13df949beff"))
    >>> print(labelId)
    1

Definition at line 191 of file classes_format.py.

191  def labelIdForClassId(self, classId: UUID) -> Optional[int]:
192  """
193  Retrieves a label ID based on provided class ID
194 
195  Parameters
196  ----------
197  classId : UUID
198  id of class
199 
200  Returns
201  -------
202  Optional[int] -> label ID if provided class ID
203  is found in list of class IDs, None otherwise
204 
205  Example
206  -------
207  >>> from coretex import ImageDataset
208  \b
209  >>> dataset = ImageDataset.fetchById(1023)
210  >>> labelId = dataset.classes.labelIdForClassId(UUID("d710019b-f28f-40ab-aa65-e13df949beff"))
211  >>> print(labelId)
212  1
213 
214  """
215 
216  clazz = self.classById(classId)
217  if clazz is None:
218  return None
219 
220  try:
221  return self.labels.index(clazz.label)
222  except ValueError:
223  return None
224 
The documentation for this class was generated from the following file: