Package uk.ac.gda.vmxi.match.api

Interface ImageMatchService

All Superinterfaces:

Findable

All Known Implementing Classes:

ImageMatchServiceBase, ImageMatchServiceVmxi, ImageMatchServiceWrapper

public interface ImageMatchService
extends Findable

Interface for access to crystal image matching service.

Method Summary

Modifier and Type	Method	Description
void	clearAllTasks()	Clear all pending requests and ignore any asynchronously returned result
void	clearTask(String requestId)	Clear specified request and ignore any asynchronously returned result
ImageMatchRequest	createRequest()	Factory to create empty request, to be configured before submitting
ImageMatchResult	executeMatch(ImageMatchRequest request)	Synchronous call to match service
Optional<ImageMatchRequest>	getRequest(String requestId)	Check for pending request
int	getRequestCount()	Count the pending requests
List<ImageMatchRequest>	getRequestList()	Check list of pending requests
Optional<ImageMatchResult>	getResult(String requestId)	Check for specified result
int	getResultCount()	Count the available completed results
Boolean	isComplete(String requestId)	Check for presence of specified result
String	requestMatch(ImageMatchRequest request)	Asynchronous call to match service, returning id for request made
ServiceStatusCode	stackImages(URL target, List<URL> inputs)	Combine images for an extended focus image

Methods inherited from interface gda.factory.Findable

getName, setName

Method Details

clearAllTasks

void clearAllTasks()

Clear all pending requests and ignore any asynchronously returned result

clearTask

void clearTask(String requestId)

Clear specified request and ignore any asynchronously returned result

createRequest

ImageMatchRequest createRequest()

Factory to create empty request, to be configured before submitting

executeMatch

ImageMatchResult executeMatch(ImageMatchRequest request)
                       throws MatchException

Synchronous call to match service

Throws:

MatchException

getRequest

Optional<ImageMatchRequest> getRequest(String requestId)

Check for pending request

getRequestCount

int getRequestCount()

Count the pending requests

getRequestList

List<ImageMatchRequest> getRequestList()

Check list of pending requests

getResult

Optional<ImageMatchResult> getResult(String requestId)

Check for specified result

getResultCount

int getResultCount()

Count the available completed results

isComplete

Boolean isComplete(String requestId)

Check for presence of specified result

requestMatch

String requestMatch(ImageMatchRequest request)
             throws MatchException

Asynchronous call to match service, returning id for request made

Throws:

MatchException

stackImages

ServiceStatusCode stackImages(URL target,
 List<URL> inputs)
                       throws MatchException

Combine images for an extended focus image

Throws:

MatchException