Orthanc Client
Documentation of the client library of Orthanc
 All Classes Files Functions Enumerations Enumerator Groups
Public Member Functions | List of all members
OrthancClient::Series Class Reference

Connection to a series stored in Orthanc. More...

#include <OrthancCppClient.h>

Public Member Functions

 Series (const Series &other)
 Construct a new reference to this object. More...
 
 Series (::OrthancClient::OrthancConnection &connection, const ::std::string &id)
 Create a connection to some series. More...
 
 ~Series ()
 Destructs the object. More...
 
void Reload ()
 Reload the instances of this series. More...
 
LAAW_UINT32 GetInstanceCount ()
 Return the number of instances for this series. More...
 
inline::OrthancClient::Instance GetInstance (LAAW_UINT32 index)
 Get some instance of this series. More...
 
inline::std::string GetId () const
 Get the Orthanc identifier of this series. More...
 
inline::std::string GetUrl () const
 Returns the URL to this series. More...
 
inline::std::string GetMainDicomTag (const ::std::string &tag, const ::std::string &defaultValue) const
 Get the value of one of the main DICOM tags for this series. More...
 
bool Is3DImage ()
 Test whether this series encodes a 3D image that can be downloaded from Orthanc. More...
 
LAAW_UINT32 GetWidth ()
 Get the width of the 3D image. More...
 
LAAW_UINT32 GetHeight ()
 Get the height of the 3D image. More...
 
float GetVoxelSizeX ()
 Get the physical size of a voxel along the X-axis. More...
 
float GetVoxelSizeY ()
 Get the physical size of a voxel along the Y-axis. More...
 
float GetVoxelSizeZ ()
 Get the physical size of a voxel along the Z-axis. More...
 
void Load3DImage (void *target,::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride)
 Load the 3D image into a memory buffer. More...
 
void Load3DImage (void *target,::Orthanc::PixelFormat format, LAAW_INT64 lineStride, LAAW_INT64 stackStride, float progress[])
 Load the 3D image into a memory buffer. More...
 

Detailed Description

This class encapsulates a connection to a series from a remote instance of Orthanc.

Constructor & Destructor Documentation

OrthancClient::Series::Series ( const Series other)
inline

Construct a new reference to this object. Pay attention to the fact that when the referenced object is deleted, the content of this object will be invalid.

Parameters
otherThe original object.
OrthancClient::Series::Series ( ::OrthancClient::OrthancConnection connection,
const ::std::string &  id 
)
inline

Create a connection to some series.

Parameters
connectionThe remote instance of Orthanc.
idThe Orthanc identifier of the series.
OrthancClient::Series::~Series ( )
inline

Destructs the object.

Member Function Documentation

LAAW_UINT32 OrthancClient::Series::GetHeight ( )
inline

Get the height of the 3D image (i.e. along the Y-axis). This call is only valid if this series corresponds to a 3D image.

Returns
The height.
std::string OrthancClient::Series::GetId ( ) const
inline

Get the Orthanc identifier of this series.

Returns
The identifier.
OrthancClient::Instance OrthancClient::Series::GetInstance ( LAAW_UINT32  index)
inline

This method will return an object that contains information about some instance. The instances are indexed by a number between 0 (inclusive) and the result of GetInstanceCount() (exclusive).

Parameters
indexThe index of the instance of interest.
Returns
The instance.
LAAW_UINT32 OrthancClient::Series::GetInstanceCount ( )
inline

Return the number of instances for this series.

Returns
The number of instances.
std::string OrthancClient::Series::GetMainDicomTag ( const ::std::string &  tag,
const ::std::string &  defaultValue 
) const
inline

Get the value of one of the main DICOM tags for this series.

Parameters
tagThe name of the tag of interest ("Modality", "Manufacturer", "SeriesDate", "SeriesDescription", "SeriesInstanceUID"...).
defaultValueThe default value to be returned if this tag does not exist.
Returns
The value of the tag.
std::string OrthancClient::Series::GetUrl ( ) const
inline

Returns the URL to this series.

Returns
The URL.
float OrthancClient::Series::GetVoxelSizeX ( )
inline

Get the physical size of a voxel along the X-axis. This call is only valid if this series corresponds to a 3D image.

Returns
The voxel size.
float OrthancClient::Series::GetVoxelSizeY ( )
inline

Get the physical size of a voxel along the Y-axis. This call is only valid if this series corresponds to a 3D image.

Returns
The voxel size.
float OrthancClient::Series::GetVoxelSizeZ ( )
inline

Get the physical size of a voxel along the Z-axis. This call is only valid if this series corresponds to a 3D image.

Returns
The voxel size.
LAAW_UINT32 OrthancClient::Series::GetWidth ( )
inline

Get the width of the 3D image (i.e. along the X-axis). This call is only valid if this series corresponds to a 3D image.

Returns
The width.
bool OrthancClient::Series::Is3DImage ( )
inline

Test whether this series encodes a 3D image that can be downloaded from Orthanc.

Returns
"true" if and only if this is a 3D image.
void OrthancClient::Series::Load3DImage ( void *  target,
::Orthanc::PixelFormat  format,
LAAW_INT64  lineStride,
LAAW_INT64  stackStride 
)
inline

Load the 3D image into a memory buffer. This call is only valid if this series corresponds to a 3D image. The "target" buffer must be wide enough to store all the voxels of the image.

Parameters
targetThe target memory buffer.
formatThe memory layout of the voxels.
lineStrideThe number of bytes between two lines in the target memory buffer.
stackStrideThe number of bytes between two 2D slices in the target memory buffer.
void OrthancClient::Series::Load3DImage ( void *  target,
::Orthanc::PixelFormat  format,
LAAW_INT64  lineStride,
LAAW_INT64  stackStride,
float  progress[] 
)
inline

Load the 3D image into a memory buffer. This call is only valid if this series corresponds to a 3D image. The "target" buffer must be wide enough to store all the voxels of the image. This method will also update a progress indicator to monitor the loading of the image.

Parameters
targetThe target memory buffer.
formatThe memory layout of the voxels.
lineStrideThe number of bytes between two lines in the target memory buffer.
stackStrideThe number of bytes between two 2D slices in the target memory buffer.
progressA pointer to a floating-point number that is continuously updated by the download threads to reflect the percentage of completion (between 0 and 1). This value can be read from a separate thread.
void OrthancClient::Series::Reload ( )
inline

This method will reload the list of the instances of this series. Pay attention to the fact that the instances that have been previously returned by GetInstance() will be invalidated.


The documentation for this class was generated from the following file: