📄 dvpstat.h
字号:
*/ DVPSTextObject *addTextObject(size_t layer, DVPSObjectApplicability applicability=DVPSB_allImages); /** deletes the text object with the given index * on the given layer. * Only the objects that are applicable to the current (attached) image * and the selected frame number are used by this method. * @param layer index of the graphic layer, must be < getNumberOfGraphicLayers() * @param idx index of the text object, must be < getNumberOfTextObjects(layer) * @return EC_Normal upon success, an error code otherwise */ OFCondition removeTextObject(size_t layer, size_t idx); /** moves the text object with the given index on the given * layer to a different layer. * Only the objects that are applicable to the current (attached) image * and the selected frame number are used by this method. * @param old_layer index of the graphic layer on which the text object is, * must be < getNumberOfGraphicLayers() * @param idx index of the text object, must be < getNumberOfTextObjects(layer) * @param new_layer index of the graphic layer to which the text object is moved, * must be < getNumberOfGraphicLayers() * @param applicability defines to which images/frames the new object applies from now on. * Default: all images referenced by the presentation state. * @return EC_Normal upon success, an error code otherwise */ OFCondition moveTextObject(size_t old_layer, size_t idx, size_t new_layer, DVPSObjectApplicability applicability=DVPSB_allImages); /** returns the number of graphic objects for the given * graphic layer. * Only the objects that are applicable to the current (attached) image * and the selected frame number are used by this method. * @param idx index of the graphic layer, must be < getNumberOfGraphicLayers() * @return number of graphic objects */ size_t getNumberOfGraphicObjects(size_t layer); /** gets the graphic object with the given index * on the given layer. If the graphic object or the graphic layer does * not exist, NULL is returned. * Only the objects that are applicable to the current (attached) image * and the selected frame number are used by this method. * @param layer index of the graphic layer, must be < getNumberOfGraphicLayers() * @param idx index of the graphic object, must be < getNumberOfGraphicObjects(layer) * @return a pointer to the graphic object */ DVPSGraphicObject *getGraphicObject(size_t layer, size_t idx); /** creates a new graphic object on the given layer. * Returns a pointer to the new graphic object. * If the creation of the graphic object fails or if the graphic layer * does not exist, NULL is returned. * @param layer index of the graphic layer, must be < getNumberOfGraphicLayers() * @param applicability defines to which images/frames the new object applies. * Default: all images referenced by the presentation state. * @return a pointer to the new graphic object */ DVPSGraphicObject *addGraphicObject(size_t layer, DVPSObjectApplicability applicability=DVPSB_allImages); /** deletes the graphic object with the given index * on the given layer. * Only the objects that are applicable to the current (attached) image * and the selected frame number are used by this method. * @param layer index of the graphic layer, must be < getNumberOfGraphicLayers() * @param idx index of the graphic object, must be < getNumberOfGraphicObjects(layer) * @return EC_Normal upon success, an error code otherwise */ OFCondition removeGraphicObject(size_t layer, size_t idx); /** moves the graphic object with the given index on the given * layer to a different layer. * Only the objects that are applicable to the current (attached) image * and the selected frame number are used by this method. * @param old_layer index of the graphic layer on which the graphic object is, * must be < getNumberOfGraphicLayers() * @param idx index of the graphic object, must be < getNumberOfGraphicObjects(layer) * @param new_layer index of the graphic layer to which the graphic object is moved, * must be < getNumberOfGraphicLayers() * @param applicability defines to which images/frames the new object applies from now on. * Default: all images referenced by the presentation state. * @return EC_Normal upon success, an error code otherwise */ OFCondition moveGraphicObject(size_t old_layer, size_t idx, size_t new_layer, DVPSObjectApplicability applicability=DVPSB_allImages); /** gets the curve with the given index * on the given layer. If the curve or the graphic layer does * not exist, NULL is returned. * @param layer index of the graphic layer, must be < getNumberOfGraphicLayers() * @param idx index of the curve, must be < getNumberOfCurves(layer) * @return a pointer to the curve */ DVPSCurve *getCurve(size_t layer, size_t idx); /** returns the number of curves in the attached image * that could be activated in the presentation state. * @return number of available curves */ size_t getNumberOfCurvesInImage(); /** gets the curve with the given index * from the attached image. If the curve does * not exist, NULL is returned. * @param idx index of the curve, must be < getNumberOfCurvesInImage() * @return a pointer to the curve */ DVPSCurve *getCurveInImage(size_t idx); /** activates curve in presentation state. * This method adds an activation for the given curve from the * attached image to the given graphic layer in the presentation state. * @param layer index of the graphic layer, must be < getNumberOfGraphicLayers() * @param curveidxinimage index of the curve in the attached image, * must be < getNumberOfCurvesInImage() * @return EC_Normal upon success, an error code otherwise */ OFCondition addCurve(size_t layer, size_t curveidxinimage); /** gets the overlay label of the given activated overlay. * @param layer index of the graphic layer, must be < getNumberOfGraphicLayers() * @param idx index of the overlay, must be < getNumberOfActiveOverlays(). * @return label string if it exists, NULL otherwise. */ const char *getActiveOverlayLabel(size_t layer, size_t idx); /** gets the overlay description of the given activated overlay. * @param layer index of the graphic layer, must be < getNumberOfGraphicLayers() * @param idx index of the overlay, must be < getNumberOfActiveOverlays(). * @return description string if it exists, NULL otherwise. */ const char *getActiveOverlayDescription(size_t layer, size_t idx); /** checks whether the given activated overlay is a ROI * (region of interest) overlay. * @param layer index of the graphic layer, must be < getNumberOfGraphicLayers() * @param idx index of the overlay, must be < getNumberOfActiveOverlays(). * @return OFTrue if overlay exists and is ROI, OFFalse otherwise. */ OFBool activeOverlayIsROI(size_t layer, size_t idx); /** gets one overlay bitmap. * @param layer index of the graphic layer on which this overlay is * activated, must be < getNumberOfGraphicLayers(). * @param idx index of the overlay activation on the given layer, * must be < getNumberOfActiveOverlays(layer). * @param overlayData upon success a pointer to the overlay plane is passed back * in this parameter. The overlay plane is organized as one byte or one word per pixel. * The byte/word values are already transformed from pvalues to DDLs. * @param width upon success the width of the overlay bitmap in pixels is returned in this parameter. * @param height upon success the height of the overlay bitmap in pixels is returned in this parameter. * @param left_pos upon success the horizontal position of the overlay relative to the image * is returned. 0 means that the overlay is left aligned with the image. * Since the overlay is cropped at the borders of the image, values < 0 are impossible. * @param top_pos upon success the vertical position of the overlay relative to the image * is returned. * @param isROI returns OFTrue if the overlay is ROI, OFFalse if the overlay is Graphic. * @param fore returns value of foreground color (pvalue), all other values are transparent * @param bits number of bits used for overlayData (valid: 8 or 12, default: 8). If bits is less than or * equal to 8 the resulting overlayData is an array of 8 bit values, an array 16 bit values otherwise. * @return EC_Normal upon success, an error code otherwise. */ OFCondition getOverlayData( size_t layer, size_t idx, const void *&overlayData, unsigned int &width, unsigned int &height, unsigned int &left_pos, unsigned int &top_pos, OFBool &isROI, Uint16 &fore, unsigned int bits = 8); /** gets the number of overlays which are embedded in the * image currently attached to the presentation state. Overlays in the image are counted only * if they are not shadowed by overlays that are embedded in the presentation state * and use the same repeating group number. * @return number of overlays in attached image */ size_t getNumberOfOverlaysInImage(); /** gets the repeating group number of the given overlay in the attached image. * @param idx index of the overlay, must be < getNumberOfOverlaysInImage(). * @return repeating group number if found, 0 otherwise. */ Uint16 getOverlayInImageGroup(size_t idx); /** gets the overlay label of the given overlay in the attached image. * @param idx index of the overlay, must be < getNumberOfOverlaysInImage(). * @return label string if it exists, NULL otherwise. */ const char *getOverlayInImageLabel(size_t idx); /** gets the overlay description of the given overlay in the attached image. * @param idx index of the overlay, must be < getNumberOfOverlaysInImage(). * @return description string if it exists, NULL otherwise. */ const char *getOverlayInImageDescription(size_t idx); /** gets the index of the activation layer on which the given * overlay from the attached image is activated. * @param idx index of the overlay, must be < getNumberOfOverlaysInImage(). * @return layer index (which is < getNumberOfGraphicLayers()) if overlay exists * and is activated, DVPS_IDX_NONE otherwise. */ size_t getOverlayInImageActivationLayer(size_t idx); /** checks whether the given overlay in the attached image is a ROI * (region of interest) overlay. * @param idx index of the overlay, must be < getNumberOfOverlaysInImage(). * @return OFTrue if overlay exists and is ROI, OFFalse otherwise. */ OFBool overlayInImageIsROI(size_t idx); /** removes an overlay from the presentation state. * If the overlay is activated, the activation is also removed. * Since overlays in the presentation state can shadow overlays in the attached image, * execution of this method may change the number of overlays reported in the attached image. * @param idx index of the overlay, must be < getNumberOfOverlaysInPresentationState(). * @return EC_Normal upon success, an error code otherwise. */ OFCondition removeOverlayFromPresentationState(size_t idx); /** changes the repeating group used for an overlay in the presentation state. * Since overlays in the presentation state can shadow overlays in the attached image, * execution of this method may change the number of overlays reported in the attached image. * @param idx index of the overlay, must be < getNumberOfOverlaysInPresentationState(). * @param newGroup new repeating group number 0x6000-0x601F (even). If this optional parameter is omitted, * the method attemps to automatically determine a new group number so that no overlay in the * attached image is shadowed any more. If this is impossible, the method fails and leaves * the overlay repeating group unchanged. * @return EC_Normal upon success, an error code otherwise. */ OFCondition changeOverlayGroupInPresentationState(size_t idx, Uint16 newGroup=0); /** adds a new overlay bitmap to the presentation state. * The overlay is read from a DICOM dataset which must contain the * attributes required for a graphic or ROI overlay, see class DVPSOverlay. * The dataset can be an image or standalone overlay IOD. * The overlay data is copied into the presentation state, i.e. the DICOM dataset * can be deleted after execution of this method. * @param overlayIOD the DICOM dataset from which the overlay is to be read * @groupInItem the repeating group 0x6000..0x61F (even) of the overlay to be read * @param newGroup repeating group number 0x6000-0x601F (even) to be used for * the overlay in the presentation state. If this optional parameter is omitted, * the method attemps to automatically determine a new group number so that no overlay in the * attached image is shadowed any more. If this is impossible, a group number so far unused * in the presentation state is taken. * @return EC_Normal upon success, an error code otherwise. */ OFCondition addOverlayToPresentationState(DcmItem& overlayIOD, Uint16 groupInItem, Uint16 newGroup=0);
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -