Namespace Nvidia.Clara.DicomAdapter.API

Classes

BaseApplicationEntity

DICOM Application Entity or AE.

ClaraApplicationEntity

Clara Application Entity Clara's SCP AE Title which is used to map to a user-defined pipeline.

DestinationApplicationEntity

Destination Application Entity

InferenceJob

InferenceJob is used to track status a of job that is to be submitted to the Clara Platform service. It is used internally by the JobSubmissionService.

InstanceNotSupportedException

InstanceNotSupportedException is thrown if a Job Processor cannot handle the specified DICOM instance.

InstanceStorageInfo

Provides basic information for a DICOM instance and storage hierarchy/path.

Job

JobMetadataBuilder

JobMetadataBuilderFactory

JobProcessorBase

JobProcessorBase is an abstraction layer to simplify the job submission process to Clara Platform API. This allows one to customize the grouping of received DICOM instances based on their workflow requirements.

Name, AeTitle and HandleInstance(InstanceStorageInfo) are the required properties and method to be implemented. SubmitPipelineJob(String, String, JobPriority, String, IList<InstanceStorageInfo>) may be used to submit a new job to the Clara Platform API. RemoveInstances(List<InstanceStorageInfo>) shall be called once job is submitted and can be removed from the temporary storage.

JobStoreException

Job storage exception

MissingRequiredTagException

MissingRequiredTagException is thrown when the required DICOM tag is not found, null or blank.

PayloadFile

PayloadUploadException

InstanceNotSupportedException is thrown if a Job Processor cannot handle the specified DICOM instance.

ProcessorValidationAttribute

An attribute that is attached to a derived class of JobProcessorBase. This attribute is used when the Create Clara AE Title (RESTful) API is called. The API looks up the passed in value of Job Processor and reads the associated attribute to determine and instantiate IJobProcessorValidator for validating process settings.

SourceApplicationEntity

Source (SCP) Application Entity

Interfaces

IClaraService

IInstanceCleanupQueue

Interface of Instance Cleanup Queue

IInstanceStoredNotificationService

Interface of the Instance Stored Notification Service

IJobMetadataBuilderFactory

IJobProcessorValidator

Interface for providing a validator for JobProcessor. See ProcessorValidationAttribute.

IJobRepository

Interface for queuing jobs to be submitted to Clara Platform. The actual implementation stores all queued jobs in a database and deletes the job once the associated job is successfully submitted.

IJobs

Interface wrapper for the Platform Jobs API

IPayloads

Interface wrapper for the Platform Payloads API

IResultsService

Interface of the Results Service RESTful API

Enums

InferenceJobState

State of a inference job submission.

InferenceJobStatus

Status of an inference job submission.