Personal tools
  • We're Hiring!

You are here: Home Documentation Previous versions OME Server Developer Remote Framework Reference Image Import

Image Import

Importing proprietary and OME-XML image files into the data server

Image import methods

These import methods facilitate using OME's file import mechanism from a remote client.

Additional documentation may be available from the OME::Remote::Facades::ImportFacade class that implements these methods

 getDefaultRepository

Retrieve the server's default repository.

Returns a hash containing the repository's URL and ID

No parameters

Return value:

Repository [Hash] Repository information. Represented as a hash with two keys: id, ImageServerURL. The id should be used as the Repository ID in subsequent calls to the import methods. The ImageServerURL can be used to upload files to OMEIS as sepcified in the OMEIS Documentation for the UploadFile method.

Dispatched; since 2.6.0


 startImport

Starts a non-blocking import process, returning a Task ID

Given an array of OMEIS File IDs, a Repository ID (identifying the OMEIS server) And an optional Dataset ID, this method begins an import process for the specified files, and returns the OME::Task ID for the task. As this method is non-blocking it returns as soon as it can start the task. Subsequent calls need to be made by the client to determine the Task's status

Parameters:

RepositoryID [Integer] The Repository ID returned by getDefaultRepository()

FileIDs [Array] An array of integers. Each integer is a FileID as returned by OMEIS's UploadFile call

DatasetID [Integer] An optional Dataset ID to add imported images to.

Return value:

TaskID [Integer] The ID of the OME::Task object that was started to do the requested import

Dispatched; since 2.2.1


 importFiles

Starts a blocking import process, returning an array of Image IDs

Given an array of OMEIS File IDs, a Repository ID (identifying the OMEIS server) And an optional Dataset ID, this method imports the specified files, and returns an array of the resulting Image IDs.

Parameters:

RepositoryID [Integer] The Repository ID returned by getDefaultRepository()

FileIDs [Array] An array of integers. Each integer is a FileID as returned by OMEIS's UploadFile call

DatasetID [Integer] An optional Dataset ID to add imported images to.

Return value:

ImageIDs [Array] An array of integers. Each integer is an OME::Image ID resulting from the file import

Dispatched; since 2.2.1

Document Actions