vsdclient

Type Members

1. case class FileUploadResponse(file: VSDURL, relatedObject: VSDURL) extends Product with Serializable

   

   Result class of a File upload operation as returned by the VSD

   Result class of a File upload operation as returned by the VSD

   file

   url of the successfully uploaded file

   relatedObject

   url of the created object associated to this file. For example,several upload Dicom files will have the same related VSD object

2. class VSDClient extends AnyRef

   

   Class representing an authenticated session with the VSD.

   Class representing an authenticated session with the VSD. Once successfully created, all operations on the VSD can be performed by accessing methods of this class

3. case class VSDCommonObjectInfo(id: Int, createdDate: String, name: String, description: Option[String], ontologyCount: Option[Int], type: VSDObjectType, downloadUrl: String, license: Option[VSDURL], files: VSDPaginatedList[VSDURL], linkedObjects: Option[VSDPaginatedList[VSDURL]], linkedObjectRelations: Option[VSDPaginatedList[VSDURL]], ontologyItems: Option[VSDPaginatedList[VSDURL]], ontologyItemRelations: Option[VSDPaginatedList[VSDURL]], objectPreviews: Option[Seq[VSDURL]], objectGroupRights: Option[Seq[VSDURL]], objectUserRights: Option[Seq[VSDURL]], selfUrl: String) extends VSDObjectInfo with Product with Serializable

   

   Common VSD Object information that is present for all supported object types The sub-fields names should be self-explanatory.

   Common VSD Object information that is present for all supported object types The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

4. case class VSDFolder(id: Int, name: String, level: Int, parentFolder: Option[VSDURL], childFolders: Option[Seq[VSDURL]], containedObjects: Option[Seq[VSDURL]], folderGroupRights: Option[Seq[VSDURL]], folderUserRights: Option[Seq[VSDURL]], selfUrl: String) extends Product with Serializable

   

   Class of Folders on the VSD The sub-fields names should be self-explanatory.

   Class of Folders on the VSD The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

5. case class VSDGroup(id: Int, name: String, chief: Option[VSDURL], selfUrl: String) extends Product with Serializable

   

   Class of groups (user groups) on the VSD The sub-fields names should be self-explanatory.

   Class of groups (user groups) on the VSD The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

6. case class VSDLink(id: Int, description: String, object1: VSDURL, object2: VSDURL, selfUrl: String) extends Product with Serializable

   

   Class of Links on the VSD.

   Class of Links on the VSD. a link indicates a relation between 2 objects eg. object 2 is the segmentation of the raw object 1 The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

7. case class VSDModality(id: Int, name: String, description: String, selfUrl: String) extends Product with Serializable

   

   Class of Image modalities supported by the VSD (CT, OT,).

   Class of Image modalities supported by the VSD (CT, OT,). A detailed list of modality names (not necessarily all supported by the VSD) can be found here The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

8. case class VSDObjectGroupRight(id: Int, relatedObject: VSDURL, relatedGroup: VSDURL, relatedRights: Seq[VSDURL], selfUrl: String) extends Product with Serializable

   

   Class indicating rights attributed to a group on a VSD object The sub-fields names should be self-explanatory.

   Class indicating rights attributed to a group on a VSD object The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

9. trait VSDObjectInfo extends AnyRef

   

10. case class VSDObjectOntologyItem(id: Int, position: Int, type: Int, object: VSDURL, ontologyItem: VSDURL, selfUrl: String) extends Product with Serializable

    

    Relation between an ontology item and a VSD object.

    Relation between an ontology item and a VSD object. This is used to say that the VSD object is a depiction of a particular organ The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

11. sealed case class VSDObjectRight(id: Int, name: String, rightValue: Int, selfUrl: String) extends Product with Serializable

    

    Class of rights than can be attributed to VSD objects and Folders The sub-fields names should be self-explanatory.

    Class of rights than can be attributed to VSD objects and Folders The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

12. sealed case class VSDObjectType(name: String, displayName: String, displayNameShort: String, selfUrl: String) extends Product with Serializable

    

    Class identifying an object type on the VSD The sub-fields names should be self-explanatory.

    Class identifying an object type on the VSD The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

13. case class VSDObjectUserRight(id: Int, relatedObject: VSDURL, relatedUser: VSDURL, relatedRights: Seq[VSDURL], selfUrl: String) extends Product with Serializable

    

    Class indicating rights attributed to a users on a VSD object The sub-fields names should be self-explanatory.

    Class indicating rights attributed to a users on a VSD object The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

14. case class VSDOntologies(types: Array[VSDOntology]) extends Product with Serializable

    

    Class of lists of VSDOntology returned upon request

15. case class VSDOntology(key: Int, value: String) extends Product with Serializable

    

    Class of VSD Ontologies.

    Class of VSD Ontologies. An ontology on the VSD, is a set of statndardized denomination of anatomical organs. An example of such an ontology is the Foundational Model of Anatomy (FMA) The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

16. case class VSDOntologyItem(id: Int, term: String, type: Int, selfUrl: String) extends Product with Serializable

    

    Class of an item belonging to an ontology supported by the VSD.

    Class of an item belonging to an ontology supported by the VSD. This is typically the denomination of a particular organ of interest in the given ontology. The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

17. case class VSDPaginatedList[A](totalCount: Int, pagination: VSDPagination, items: Array[A], nextPageUrl: Option[String]) extends Product with Serializable

    

    Internal class to handle paginated responses.

    Internal class to handle paginated responses.

    (required to be public due to Marshalling implicits)

18. case class VSDPagination(rpp: Int, page: Int) extends Product with Serializable

    

    Internal class to handle paginated responses.

    Internal class to handle paginated responses.

    (required to be public due to Marshalling implicits)

19. case class VSDRawImage(sliceThickness: Option[Float], spaceBetweenSlices: Option[Float], kilovoltPeak: Option[Float], modality: Option[VSDURL]) extends Product with Serializable

    

    Information about RawImage such as slice thickness, inter-spacing, signal strength, modality, ..

    Information about RawImage such as slice thickness, inter-spacing, signal strength, modality, .. The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

20. case class VSDRawImageObjectInfo(rawImage: VSDRawImage, id: Int, createdDate: String, name: String, description: Option[String], ontologyCount: Option[Int], type: VSDObjectType, downloadUrl: String, license: Option[VSDURL], files: VSDPaginatedList[VSDURL], linkedObjects: Option[VSDPaginatedList[VSDURL]], linkedObjectRelations: Option[VSDPaginatedList[VSDURL]], ontologyItems: Option[VSDPaginatedList[VSDURL]], ontologyItemRelations: Option[VSDPaginatedList[VSDURL]], objectPreviews: Option[Seq[VSDURL]], objectGroupRights: Option[Seq[VSDURL]], objectUserRights: Option[Seq[VSDURL]], selfUrl: String) extends VSDObjectInfo with Product with Serializable

    

    Information for VSD Objects of type RawImage (i.e.

    Information for VSD Objects of type RawImage (i.e. raw intensity images). Additionally to the common object information, this adds optional fields such as slice thickness, inter-spacing, signal strength, modality, .. The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

21. case class VSDSegmentationImage(methodDescription: Option[String], segmentationMethod: Option[VSDURL]) extends Product with Serializable

    

    Information about SegmentationImage such as segmentation method, and a description ..

    Information about SegmentationImage such as segmentation method, and a description .. The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

22. case class VSDSegmentationMethod(id: Int, name: String, selfUrl: String) extends Product with Serializable

    

    Class of Segmentation methods supported by the VSD.

    Class of Segmentation methods supported by the VSD. These are for example: Manual, Automatic. Semi-Automatic The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

23. case class VSDSegmentationObjectInfo(segmentationImage: VSDSegmentationImage, id: Int, createdDate: String, name: String, description: Option[String], ontologyCount: Option[Int], type: VSDObjectType, downloadUrl: String, license: Option[VSDURL], files: VSDPaginatedList[VSDURL], linkedObjects: Option[VSDPaginatedList[VSDURL]], linkedObjectRelations: Option[VSDPaginatedList[VSDURL]], ontologyItems: Option[VSDPaginatedList[VSDURL]], ontologyItemRelations: Option[VSDPaginatedList[VSDURL]], objectPreviews: Option[Seq[VSDURL]], objectGroupRights: Option[Seq[VSDURL]], objectUserRights: Option[Seq[VSDURL]], selfUrl: String) extends VSDObjectInfo with Product with Serializable

    

    Information for VSD Objects of type Segmentation (i.e.

    Information for VSD Objects of type Segmentation (i.e. binary images). Additionally to the common object information, this adds optional fields such as segmentation method, and a description .. The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

24. case class VSDStatisticalModelObjectInfo(id: Int, createdDate: String, name: String, description: Option[String], ontologyCount: Option[Int], type: VSDObjectType, downloadUrl: String, license: Option[VSDURL], files: VSDPaginatedList[VSDURL], linkedObjects: Option[VSDPaginatedList[VSDURL]], linkedObjectRelations: Option[VSDPaginatedList[VSDURL]], ontologyItems: Option[VSDPaginatedList[VSDURL]], ontologyItemRelations: Option[VSDPaginatedList[VSDURL]], objectPreviews: Option[Seq[VSDURL]], objectGroupRights: Option[Seq[VSDURL]], objectUserRights: Option[Seq[VSDURL]], selfUrl: String) extends VSDObjectInfo with Product with Serializable

    

    Information for VSD Objects of type Statistical Model (i.e.

    Information for VSD Objects of type Statistical Model (i.e. h5 files) The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc

25. case class VSDURL(selfUrl: String) extends Product with Serializable

    

    VSDURL is the first clsss pointer to objects on the VSD.

    VSDURL is the first clsss pointer to objects on the VSD. It can point to Files, Objects, Folders, Links, Ontologies, etc ... Most of the client's API requests rely on a VSDURL to identify the objects to manipulate.

    selfUrl

    actual URL of the resource

26. case class VSDUser(id: Int, username: String, selfUrl: String) extends Product with Serializable

    

    Class identifying a user on the VSD The sub-fields names should be self-explanatory.

    Class identifying a user on the VSD The sub-fields names should be self-explanatory. In case of doubt, please check the VSD's API doc