Dicom Image

DicomImage is a class representing a dicom file/slice within the OsiriX database. It contains information including patient details, modality, and file location.

Type

All types only contain a single parameter, the UUID of the underlying OsiriX object.

types.proto (lines 29-31)

message DicomImage{
    string osirixrpc_uid = 1;
}

Methods

By convention, any method defined with syntax

rpc DicomImageXyz (DicomImage) returns (DicomImageXyzResponse) {}

is called in Python (for example) using syntax

response = osirix_stub.DicomImageXyz(request) # (1)

1. response is a DicomImageXyzResponse class, and request a DicomImage class.

osirix.proto (lines 134-143)

rpc DicomImageWidth (DicomImage) returns (DicomImageWidthResponse) {}
rpc DicomImageHeight (DicomImage) returns (DicomImageHeightResponse) {}
rpc DicomImageSOPInstanceUID (DicomImage) returns (DicomImageSOPInstanceUIDResponse) {}
rpc DicomImageCompletePath (DicomImage) returns (DicomImageCompletePathResponse) {}
rpc DicomImageDate (DicomImage) returns (DicomImageDateResponse) {}
rpc DicomImageNumberOfFrames (DicomImage) returns (DicomImageNumberOfFramesResponse) {}
rpc DicomImageModality (DicomImage) returns (DicomImageModalityResponse) {}
rpc DicomImageSeries (DicomImage) returns (DicomImageSeriesResponse) {}
rpc DicomImageSliceLocation (DicomImage) returns (DicomImageSliceLocationResponse) {}
rpc DicomImageInstanceNumber (DicomImage) returns (DicomImageInstanceNumberResponse) {}

Responses

By convention, any response defined with syntax

message DicomImageXyzResponse{
    type_1 arg_1 = 1;
    type_2 arg_2 = 2; // (1)
    ...
}

1. The numbers on the RHS should be ignored. They are necessary only for protobuf file definitions.

has attributes accessed in Python (for example) using syntax

x1 = response.arg1
x2 = response.arg2
...

dicomimage.proto (lines 9-)

 message DicomImageWidthResponse{
    Status status = 1;
    uint32 width = 2;
 }

 message DicomImageHeightResponse{
    Status status = 1;
    uint32 height = 2;
 }

 message DicomImageSOPInstanceUIDResponse{
    Status status = 1;
    string sop_instance_uid = 2;
 }

 message DicomImageCompletePathResponse{
    Status status = 1;
    string complete_path = 2;
 }

 message DicomImageDateResponse{
    Status status = 1;
    int32 year = 2;
    int32 month = 3;
    int32 day = 4;
    int32 hour = 5;
    int32 minute = 6;
    int32 second = 7;
    int32 millisecond = 8;
 }

 message DicomImageNumberOfFramesResponse{
    Status status = 1;
    uint32 number_of_frames = 2;
 }

 message DicomImageModalityResponse{
    Status status = 1;
    string modality = 2;
 }

 message DicomImageSeriesResponse{
    Status status = 1;
    DicomSeries series = 2;
 }

 message DicomImageSliceLocationResponse{
    Status status = 1;
    float slice_location = 2;
 }

 message DicomImageInstanceNumberResponse{
    Status status = 1;
    uint32 instance_number = 2;
 }

Requests

No specialized requests available for this class (class is immutable).