coretex.coretex.dataset.local_dataset.LocalDataset Class Reference

Inheritance diagram for coretex.coretex.dataset.local_dataset.LocalDataset:

Public Member Functions
Path	path (self)
Public Member Functions inherited from coretex.coretex.dataset.dataset.Dataset
int	count (self)
bool	add (self, SampleType sample)
bool	rename (self, str name)
Optional[SampleType]	getSample (self, str name)

Static Public Member Functions
LocalDataset	default (Path path)
LocalDataset	custom (Path path, SampleGenerator generator)

Detailed Description

    Represents the generic Local Dataset class for all
    LocalDataset classes \n
    Used for working with local datasets

    Properties
    ----------
    path : Path
        local path of dataset
    sampleClass : Type[SampleType]
        class of sample
    generator : Optional[SampleGenerator]
        sample generator

Definition at line 42 of file local_dataset.py.

Member Function Documentation

custom()

LocalDataset coretex.coretex.dataset.local_dataset.LocalDataset.custom ( Path  path, SampleGenerator  generator  )

static

    Creates Custom Local Dataset object

    Parameters
    ----------
    path : Path
Local Dataset path
    generator : SampleGenerator
sample generator

    Returns
    -------
    LocalDataset -> Local Dataset object

Definition at line 86 of file local_dataset.py.

    def custom(path: Path, generator: SampleGenerator) -> LocalDataset:
        """
            Creates Custom Local Dataset object
 
            Parameters
            ----------
            path : Path
                Local Dataset path
            generator : SampleGenerator
                sample generator
 
            Returns
            -------
            LocalDataset -> Local Dataset object
        """
 
        return LocalDataset(path, AnyLocalSample, generator)
 

default()

LocalDataset coretex.coretex.dataset.local_dataset.LocalDataset.default ( Path  path )

static

    Creates Local Dataset object

    Parameters
    ----------
    path : Path
Local Dataset path

    Returns
    -------
    LocalDataset -> Local Dataset object

Definition at line 69 of file local_dataset.py.

    def default(path: Path) -> LocalDataset:
        """
            Creates Local Dataset object
 
            Parameters
            ----------
            path : Path
                Local Dataset path
 
            Returns
            -------
            LocalDataset -> Local Dataset object
        """
 
        return LocalDataset(path, LocalSample)
 

path()

Path coretex.coretex.dataset.local_dataset.LocalDataset.path

(

self

)

    Returns
    -------
    Path -> Local Dataset path

Reimplemented from coretex.coretex.dataset.dataset.Dataset.

Definition at line 105 of file local_dataset.py.

    def path(self) -> Path:
        """
            Returns
            -------
            Path -> Local Dataset path
        """
 
        return self.__path
 

---

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

• src/coretex/coretex/dataset/local_dataset.py