coretex.coretex.sample.image_sample.local_image_sample.LocalImageSample Class Reference

Inheritance diagram for coretex.coretex.sample.image_sample.local_image_sample.LocalImageSample:

Public Member Functions
AnnotatedImageSampleData	load (self)
bool	saveAnnotation (self, CoretexImageAnnotation coretexAnnotation)
Public Member Functions inherited from coretex.coretex.sample.local_sample.LocalSample
str	path (self)
str	zipPath (self)
bool	download (self, bool ignoreCache=False)
Public Member Functions inherited from coretex.coretex.sample.sample.Sample
None	unzip (self, bool ignoreCache=False)
Path	joinPath (self, Union[Path, str] other)
Public Member Functions inherited from coretex.coretex.sample.image_sample.image_sample_data.AnnotatedImageSampleData
np.ndarray	extractSegmentationMask (self, ImageDatasetClasses classes)

Detailed Description

    Represents the local Image Sample object\n
    Contains basic properties and functionality for local image Sample classes\n
    The class has several methods that allow users to access and
    manipulate local image data and annotations

Definition at line 29 of file local_image_sample.py.

Member Function Documentation

load()

AnnotatedImageSampleData coretex.coretex.sample.image_sample.local_image_sample.LocalImageSample.load

(

self

)

    Loads image and its annotation if it exists

    Returns
    -------
    AnnotatedImageSampleData -> image data and annotation in Coretex.ai format

Reimplemented from coretex.coretex.sample.local_sample.LocalSample.

Definition at line 38 of file local_image_sample.py.

    def load(self) -> AnnotatedImageSampleData:
        """
            Loads image and its annotation if it exists
 
            Returns
            -------
            AnnotatedImageSampleData -> image data and annotation in Coretex.ai format
        """
 
        return AnnotatedImageSampleData(Path(self.path))
 

saveAnnotation()

bool coretex.coretex.sample.image_sample.local_image_sample.LocalImageSample.saveAnnotation	(		self,
		CoretexImageAnnotation	coretexAnnotation
	)

    Updates annotation for the image

    Returns
    -------
    bool -> returns True if successful, False otherwise

Reimplemented in coretex.coretex.sample.image_sample.image_sample.ImageSample.

Definition at line 49 of file local_image_sample.py.

    def saveAnnotation(self, coretexAnnotation: CoretexImageAnnotation) -> bool:
        """
            Updates annotation for the image
 
            Returns
            -------
            bool -> returns True if successful, False otherwise
        """
 
        with open(Path(self.path) / "annotations.json", "w") as file:
            json.dump(coretexAnnotation.encode(), file)
 
        zipPath = Path(self.zipPath)
 
        oldZipPath = zipPath.parent / f"{zipPath.stem}-old.zip"
        zipPath.rename(oldZipPath)
 
        with ZipFile(zipPath, "w") as zipFile:
            path = Path(self.path)
            for element in os.listdir(path):
                zipFile.write(path / element, arcname = element)
 
        oldZipPath.unlink()
        return True

---

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

• src/coretex/coretex/sample/image_sample/local_image_sample.py