mitknnInteractiveBoundingBoxHelpers.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitknnInteractiveBoundingBoxHelpers_h
#define mitknnInteractiveBoundingBoxHelpers_h
 
#include <mitkImage.h>
#include <mitkPlaneGeometry.h>
#include <mitknnInteractiveBoundingBox.h>
 
namespace mitk::nnInteractive
{
  // Computes a tight axis-aligned bounding box in MITK index space around
  // the non-zero footprint of the 2D painting slice, by mapping the slice's
  // non-zero 2D bounds through its own geometry into the reference image's
  // index space. Pads by a couple of voxels to absorb VTK reslicing
  // boundary effects on axes the stroke spans non-trivially. Works for any
  // slice orientation (axial / coronal / sagittal / oblique).
  //
  // Returns false if the slice has no non-zero pixels or no usable geometry.
  // On success, outBoundingBox is in nnInteractive's (Z, Y, X) order.
  //
  // \pre paintingSlice2D must be a 2D uint8 slice extracted from
  //      referenceImage (i.e. its geometry is related to the reference's
  //      via SegTool2D::GetAffectedImageSliceAs2DImage or equivalent), so
  //      that mapping its 2D index corners through its own IndexToWorld
  //      and back through the reference's WorldToIndex is meaningful.
  bool ComputeStrokeBoundingBox(const Image* paintingSlice2D,
                                const Image* referenceImage,
                                InteractionBoundingBox& outBoundingBox);
 
  // Builds a small 3D uint8 mitk::Image sized exactly to the given bounding
  // box and transfers the 2D painting slice into it using MITK's plane-aware
  // VTK reslicing (SegTool2D::WriteSliceToVolume). The returned image's
  // geometry is derived from the reference image: its origin sits at the
  // box's first voxel and its spacing/direction match the reference, so
  // numpy sees it with shape matching the box sizes in nnInteractive's
  // (Z, Y, X) order.
  //
  // The source's non-zero pixels become 1; zero pixels stay 0. Designed for
  // forwarding to nnInteractive's add_*_interaction(..., interaction_bbox=).
  //
  // \pre paintingSlice2D must be a 2D uint8 slice taken at slicingPlane
  //      from referenceImage (typically via SegTool2D), and boundingBox
  //      must be the result of ComputeStrokeBoundingBox on the same
  //      slice/reference pair.
  Image::Pointer BuildBoundingBoxMaskImage(const Image* paintingSlice2D,
                                           const PlaneGeometry* slicingPlane,
                                           const Image* referenceImage,
                                           const InteractionBoundingBox& boundingBox);
}
 
#endif