coretex.entities.sample.image_sample.image_sample.ImageSample Class Reference

Inheritance diagram for coretex.entities.sample.image_sample.image_sample.ImageSample:

Public Member Functions
bool	saveAnnotation (self, CoretexImageAnnotation coretexAnnotation)
None	saveMetadata (self, Dict[str, Any] metadata)
Public Member Functions inherited from coretex.entities.sample.network_sample.NetworkSample
Path	path (self)
Path	zipPath (self)
Path	downloadPath (self)
bool	modifiedSinceLastDownload (self)
None	decrypt (self, bool ignoreCache=False)
None	download (self, bool decrypt=True, bool ignoreCache=False)
None	unzip (self, bool ignoreCache=False)
Public Member Functions inherited from coretex.entities.sample.sample.Sample
Path	joinPath (self, Union[Path, str] other)
Public Member Functions inherited from coretex.entities.sample.image_sample.image_sample_data.AnnotatedImageSampleData
np.ndarray	extractSegmentationMask (self, ImageDatasetClasses classes)
Public Member Functions inherited from coretex.entities.sample.image_sample.local_image_sample.LocalImageSample
AnnotatedImageSampleData	load (self)
Dict[str, Any]	loadMetadata (self)
Public Member Functions inherited from coretex.entities.sample.local_sample.LocalSample
Path	path (self)
Path	zipPath (self)
None	download (self, bool decrypt=True, bool ignoreCache=False)

Detailed Description

    Represents the generic image sample\n
    Contains basic properties and functionality for all image sample classes\n
    The class has several methods that allow users to access and
    manipulate image data and annotations, as well as to create new image samples

Definition at line 27 of file image_sample.py.

Member Function Documentation

saveAnnotation()

bool coretex.entities.sample.image_sample.image_sample.ImageSample.saveAnnotation	(		self,
		CoretexImageAnnotation	coretexAnnotation
	)

    Updates annotation for the image

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

Reimplemented from coretex.entities.sample.image_sample.local_image_sample.LocalImageSample.

Definition at line 39 of file image_sample.py.

    def saveAnnotation(self, coretexAnnotation: CoretexImageAnnotation) -> bool:
        # Encrypted sample must be downloaded for annotation to be updated
        if self.isEncrypted:
            self.download(decrypt = True)
 
        # Only save annotation locally if it is downloaded
        if self.zipPath.exists():
            self.unzip()
 
            super().saveAnnotation(coretexAnnotation)
 
        if self.isEncrypted:
            try:
                self._overwriteSample(self.zipPath)
                return True
            except NetworkRequestError:
                return False
        else:
            parameters = {
                "id": self.id,
                "data": coretexAnnotation.encode()
            }
 
            response = networkManager.post("session/save-annotations", parameters)
            return not response.hasFailed()
 

saveMetadata()

None coretex.entities.sample.image_sample.image_sample.ImageSample.saveMetadata	(		self,
		Dict[str, Any]	metadata
	)

    Saves a json object as metadata for the sample

    Parameters
    ----------
    metadata : dict[str, Any]
        Json object containing sample metadata

Reimplemented from coretex.entities.sample.image_sample.local_image_sample.LocalImageSample.

Definition at line 65 of file image_sample.py.

    def saveMetadata(self, metadata: Dict[str, Any]) -> None:
        # Encrypted sample must be downloaded for metadata to be updated
        if self.isEncrypted:
            self.download(decrypt = True)
 
        # Only save metadata locally if it is downloaded
        if self.zipPath.exists():
            self.unzip()
 
            super().saveMetadata(metadata)
 
        if self.isEncrypted:
            self._overwriteSample(self.zipPath)
        else:
            parameters = {
                "id": self.id,
                "data": metadata
            }
 
            response = networkManager.post("session/save-metadata", parameters)
            if response.hasFailed():
                raise NetworkRequestError(response, f"Failed to upload metadata for sample \"{self.name}\"")

---

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

• coretex/entities/sample/image_sample/image_sample.py