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

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

Public Member Functions
bool	saveAnnotation (self, CoretexImageAnnotation coretexAnnotation)
Optional[Self]	createImageSample (cls, int datasetId, Union[Path, str] imagePath)
Public Member Functions inherited from coretex.coretex.sample.network_sample.NetworkSample
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)
Public Member Functions inherited from coretex.coretex.sample.image_sample.local_image_sample.LocalImageSample
AnnotatedImageSampleData	load (self)
Public Member Functions inherited from coretex.coretex.sample.local_sample.LocalSample
str	path (self)
str	zipPath (self)
bool	download (self, 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 30 of file image_sample.py.

Member Function Documentation

createImageSample()

Optional[Self] coretex.coretex.sample.image_sample.image_sample.ImageSample.createImageSample	(		cls,
		int	datasetId,
		Union[Path, str]	imagePath
	)

    Creates a new image sample with specified properties\n
    For creating custom sample, sample must be an image of supported format

    Parameters
    ----------
    datasetId : int
id of dataset in which image sample will be created
    imagePath : Union[Path, str]
path to the image sample

    Returns
    -------
    The created image sample object

    Example
    -------
    >>> from coretex import ImageSample
    \b
    >>> sample = ImageSample.createImageSample(1023, "path/to/file.jpeg")
    >>> if sample is None:
    print("Failed to create image sample")

Definition at line 76 of file image_sample.py.

    def createImageSample(cls, datasetId: int, imagePath: Union[Path, str]) -> Optional[Self]:
        """
            Creates a new image sample with specified properties\n
            For creating custom sample, sample must be an image of supported format
 
            Parameters
            ----------
            datasetId : int
                id of dataset in which image sample will be created
            imagePath : Union[Path, str]
                path to the image sample
 
            Returns
            -------
            The created image sample object
 
            Example
            -------
            >>> from coretex import ImageSample
            \b
            >>> sample = ImageSample.createImageSample(1023, "path/to/file.jpeg")
            >>> if sample is None:
                    print("Failed to create image sample")
        """
 
        parameters = {
            "dataset_id": datasetId
        }
 
        return cls._createSample(parameters, imagePath)

saveAnnotation()

bool coretex.coretex.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.coretex.sample.image_sample.local_image_sample.LocalImageSample.

Definition at line 59 of file image_sample.py.

    def saveAnnotation(self, coretexAnnotation: CoretexImageAnnotation) -> bool:
        super().saveAnnotation(coretexAnnotation)
 
        parameters = {
            "id": self.id,
            "data": coretexAnnotation.encode()
        }
 
        response = networkManager.genericJSONRequest(
            endpoint = "session/save-annotations",
            requestType = RequestType.post,
            parameters = parameters
        )
 
        return not response.hasFailed()
 

---

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

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