Coretex
Public Member Functions | List of all members
coretex.coretex.dataset.dataset.Dataset Class Reference
Inheritance diagram for coretex.coretex.dataset.dataset.Dataset:
coretex.coretex.dataset.local_dataset.LocalDataset coretex.coretex.dataset.network_dataset.NetworkDataset coretex.coretex.dataset.custom_dataset.local_custom_dataset.LocalCustomDataset coretex.coretex.dataset.image_dataset.local_image_dataset.LocalImageDataset coretex.coretex.dataset.custom_dataset.custom_dataset.CustomDataset coretex.coretex.dataset.image_dataset.image_dataset.ImageDataset coretex.coretex.dataset.image_segmentation_dataset.local_image_segmentation_dataset.LocalImageSegmentationDataset coretex.coretex.dataset.image_segmentation_dataset.image_segmentation_dataset.ImageSegmentationDataset

Public Member Functions

int count (self)
 
bool add (self, SampleType sample)
 
bool rename (self, str name)
 
Optional[SampleType] getSample (self, str name)
 

Detailed Description

    Represents the generic class Dataset
    Includes methods that can be used by any instance of Dataset
    and abstract methods that must be implemented by any subclass

    Properties
    ----------
    name : str
        name of dataset
    samples : List[SampleType]
        list of samples

Definition at line 28 of file dataset.py.

Member Function Documentation

◆ add()

bool coretex.coretex.dataset.dataset.Dataset.add (   self,
SampleType  sample 
) 
    Adds the specified sample into the dataset

    Parameters
    ----------
    sample : SampleType
sample which should be added into the dataset

    Returns
    -------
    bool -> True if sample was added, False if sample was not added

Reimplemented in coretex.coretex.dataset.network_dataset.NetworkDataset.

Definition at line 65 of file dataset.py.

65  def add(self, sample: SampleType) -> bool:
66  """
67  Adds the specified sample into the dataset
68 
69  Parameters
70  ----------
71  sample : SampleType
72  sample which should be added into the dataset
73 
74  Returns
75  -------
76  bool -> True if sample was added, False if sample was not added
77  """
78 
79  self.samples.append(sample)
80  return True
81 

◆ count()

int coretex.coretex.dataset.dataset.Dataset.count (   self) 
    Returns
    -------
    int -> number of samples in this dataset

Definition at line 47 of file dataset.py.

47  def count(self) -> int:
48  """
49  Returns
50  -------
51  int -> number of samples in this dataset
52  """
53 
54  return len(self.samples)
55 

◆ getSample()

Optional[SampleType] coretex.coretex.dataset.dataset.Dataset.getSample (   self,
str  name 
) 
    Retrieves sample which matches the provided name

    Parameters
    ----------
    name : str
name of sample

    Returns
    -------
    Optional[SampleType] -> sample object

Definition at line 103 of file dataset.py.

103  def getSample(self, name: str) -> Optional[SampleType]:
104  """
105  Retrieves sample which matches the provided name
106 
107  Parameters
108  ----------
109  name : str
110  name of sample
111 
112  Returns
113  -------
114  Optional[SampleType] -> sample object
115  """
116 
117  for sample in self.samples:
118  # startswith must be used since if we import sample
119  # with the same name twice, the second one will have
120  # suffix with it's serial number
121  if sample.name.startswith(name):
122  return sample
123 
124  return None
125 

◆ rename()

bool coretex.coretex.dataset.dataset.Dataset.rename (   self,
str  name 
) 
    Renames the dataset, if the provided name is
    different from the current name

    Parameters
    ----------
    name : str
new dataset name

    Returns
    -------
    bool -> True if dataset was renamed, False if dataset was not renamed

Reimplemented in coretex.coretex.dataset.network_dataset.NetworkDataset.

Definition at line 82 of file dataset.py.

82  def rename(self, name: str) -> bool:
83  """
84  Renames the dataset, if the provided name is
85  different from the current name
86 
87  Parameters
88  ----------
89  name : str
90  new dataset name
91 
92  Returns
93  -------
94  bool -> True if dataset was renamed, False if dataset was not renamed
95  """
96 
97  if self.name == name:
98  return False
99 
100  self.name = name
101  return True
102 
The documentation for this class was generated from the following file: