Dicom Series

DicomSeries is a class representing a group of DicomImage objects within the same series. It contains information including patient details, modality, and file location(s).

Type

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

types.proto (lines 33-35)

message DicomSeries{
    string osirixrpc_uid = 1;
}

Methods

By convention, any method defined with syntax

rpc DicomSeriesXyz (DicomSeries) returns (DicomSeriesXyzResponse) {}

is called in Python (for example) using syntax

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

1. response is a DicomSeriesXyzResponse class, and request a DicomSeries class.

osirix.proto (lines 146-158)

rpc DicomSeriesPaths (DicomSeries) returns (DicomSeriesPathsResponse) {}
rpc DicomSeriesPreviousSeries (DicomSeries) returns (DicomSeriesPreviousSeriesResponse) {}
rpc DicomSeriesNextSeries (DicomSeries) returns (DicomSeriesNextSeriesResponse) {}
rpc DicomSeriesSortedImages (DicomSeries) returns (DicomSeriesSortedImagesResponse) {}
rpc DicomSeriesStudy (DicomSeries) returns (DicomSeriesStudyResponse) {}
rpc DicomSeriesImages (DicomSeries) returns (DicomSeriesImagesResponse) {}
rpc DicomSeriesSeriesInstanceUID (DicomSeries) returns (DicomSeriesSeriesInstanceUIDResponse) {}
rpc DicomSeriesSeriesSOPClassUID (DicomSeries) returns (DicomSeriesSeriesSOPClassUIDResponse) {}
rpc DicomSeriesSeriesDescription (DicomSeries) returns (DicomSeriesSeriesDescriptionResponse) {}
rpc DicomSeriesModality (DicomSeries) returns (DicomSeriesModalityResponse) {}
rpc DicomSeriesName (DicomSeries) returns (DicomSeriesNameResponse) {}
rpc DicomSeriesDate (DicomSeries) returns (DicomSeriesDateResponse) {}
rpc DicomSeriesNumberOfImages (DicomSeries) returns (DicomSeriesNumberOfImagesResponse) {}

Responses

By convention, any response defined with syntax

message DicomSeriesXyzResponse{
    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
...

dicomseries.proto (lines 9-)

message DicomSeriesPathsResponse{
    Status status = 1;
    repeated string paths = 2;
}

message DicomSeriesPreviousSeriesResponse{
    Status status = 1;
    DicomSeries previous_series = 2;
}

message DicomSeriesNextSeriesResponse{
    Status status = 1;
    DicomSeries next_series = 2;
}

message DicomSeriesSortedImagesResponse{
    Status status = 1;
    repeated DicomImage sorted_images  = 2;
}

message DicomSeriesStudyResponse{
    Status status = 1;
    DicomStudy study = 2;
}

message DicomSeriesImagesResponse{
    Status status = 1;
    repeated DicomImage images = 2;
}

message DicomSeriesSeriesInstanceUIDResponse{
    Status status = 1;
    string series_instance_uid = 2;
}

message DicomSeriesSeriesSOPClassUIDResponse{
    Status status = 1;
    string series_sop_class_uid = 2;
}

message DicomSeriesSeriesDescriptionResponse{
    Status status = 1;
    string series_description = 2;
}

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

message DicomSeriesNameResponse{
    Status status = 1;
    string name = 2;
}

message DicomSeriesNumberOfImagesResponse{
    Status status = 1;
    int32 number_of_images = 2;
}

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

Requests

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