 |
ImFusion C++ SDK 4.5.0
|
|
ImFusion C++ SDK 4.5.0
|
Namespace of the ImFusionUS and ImFusionLiveUS plugins. More...
Namespace of the ImFusionUS and ImFusionLiveUS plugins.
Namespaces | |
| namespace | FrameGeometryUtils |
| Utilities to generate different instances of FrameGeometry. | |
| namespace | Signal |
| Signal processing functions. | |
Classes | |
| class | AcousticParametersDataComponent |
| The AcousticParametersDataComponent class enables defining the acoustic properties, i.e. More... | |
| class | CalibrationMatrixWidget |
| Specialization of TransformationMatrixWidget that allows the user to read and modify the calibration matrix of image sets that use a FrameGeometry to identify where in the image the tip of the ultrasound probe is, and allowing to express the calibration matrix independent of the imaging depth. More... | |
| class | ConvertToSweep |
| Algorithm wrapping multiple ways to create an UltrasoundSweep from one or multiple images. More... | |
| class | DicomGeVividE9IOD |
| Extra IOD specialization for basic support of loading multiple ultrasound volumes created by GE Vivid E9 devices. More... | |
| class | ExportCalibrationAlgorithm |
| Exports the calibration of an UltrasoundSweep to a calibration file. More... | |
| class | ExportCalibrationController |
| Controller for ExportCalibrationAlgorithm. More... | |
| class | ExtractDoppler |
| Extract color doppler information from an ultrasound sweep. More... | |
| class | FanAnnotationManipulator |
| Manipulator for fan geometries. More... | |
| class | FanMask |
| Mask for images, that shows only those pixels which are inside the configured FrameGeometry. More... | |
| class | FrameGeometry |
| Represents the (fan) geometry of an ultrasound frame acquired through scanline-based imaging. More... | |
| class | ScanlineConfiguration3D |
| Dimensions of a 3D scanline dataset. More... | |
| class | FrameGeometryConvex3D |
| Describes the specific convex acquisition parameters of a 3D ultrasound frame. More... | |
| class | FrameGeometry3D |
| Describes the geometry of a 3D ultrasound frame. More... | |
| class | FrameGeometryCircular |
| Specialization for circular frame geometries. More... | |
| class | FrameGeometryConvex |
| Specialization for convex frame geometries. More... | |
| class | FrameGeometryConvexSteered |
| Specialization for convex frame geometries including steering. More... | |
| class | FrameGeometryLinear |
| Specialization for linear frame geometries. More... | |
| class | FrameGeometryMetadata |
| Metadata for the frame geometry of an ultrasound sweep. More... | |
| class | FrameGeometryPropertiesAlgorithm |
| Algorithm to change properties of a FrameGeometry of a Shared Image Set. More... | |
| class | FrameGeometryPropertiesController |
| Dialog for adjusting the frame geometry properties of a Shared Image Set. More... | |
| class | FrameGeometrySector |
| Specialization for sector frame geometries. More... | |
| class | FrameGrabbingConfigComponent |
| Data component that stores the configuration of FrameGrabbingPresets. More... | |
| class | FrameGrabbingConfigEditorAlgorithm |
| class | FrameGrabbingConfigEditorController |
| class | FrameGrabbingPresets |
| Named ultrasound frame-grabbing presets: image templates, frame geometries, and imaging depths. More... | |
| class | Geometry3DDetectionAlgorithm |
| Algorithm that tries to automatically detect the 3D frame geometry of an ultrasound volume. More... | |
| class | GeometryDetection |
| Actual implementation for automatically detecting the ultrasound image geometry from screen recordings. More... | |
| class | BaseGeometryDetectionAlgorithm |
| Shared implementation for algorithms that estimate ultrasound frame geometry from one or more 2D frames. More... | |
| class | GeometryDetectionAlgorithm |
| Algorithm that detects the actual image region of interest (ROI) in an ultrasound video and returns a matching US::FrameGeometry. More... | |
| class | GeometryDetectionController |
| GUI controller for BaseGeometryDetectionAlgorithm used for real-time ultrasound video content detection, and its derived algorithms (GeometryDetectionAlgorithm, LiveGeometryDetectionAlgorithm). More... | |
| class | GlFanGeometry |
| Ultrasound fan illustration on 2D slice view. More... | |
| class | GlFanWireframe |
| Ultrasound fan wireframe enclosing a 3D sweep Fan wireframes can be created from an existing UltrasoundSweep, and can be added to image views: More... | |
| class | GlGeometricTransform |
| Base interface for implementing polymorphic geometric transforms from and to image coordinates using OpenGL. More... | |
| class | GlProbeDeformation |
| Deformation model simulating radial compression from an ultrasound probe. More... | |
| class | GlScanConversionConvexGeometricTransform |
| A geometric transform shader include that converts image coordinates to pre-scanconverted coordinates of convex frame geometries and vice versa. More... | |
| class | GlScanConversionLinearGeometricTransform |
| A geometric transform shader include that converts image coordinates to pre-scanconverted coordinates of linear frame geometries and vice versa. More... | |
| class | GlScanConversionSectorGeometricTransform |
| A geometric transform shader include that converts image coordinates to pre-scanconverted coordinates of sector frame geometries and vice versa. More... | |
| class | GlSliceRendererSweep |
| Enables GlSlice to render freehand Ultrasound Sweeps. More... | |
| class | GlSweep3D |
| GlObject to render an UltrasoundSweep in 3D Views. More... | |
| class | GlSweepCompounding |
| Algorithm to reconstruct a voxel-based 3D volume from an UltrasoundSweep. More... | |
| class | GlSweepReconstruction |
| Reconstruction of pixel data of one or multiple UltrasoundSweep image sets into an arbitrary 2D frame in 3D space. More... | |
| class | GlSweepStretchDeformation |
| Deformation model to undo probe pressure deformation on an ultrasound sweep. More... | |
| class | GlUltrasoundRuler |
| OpenGL object that renders a ruler-like scale overlay on Ultrasound images. More... | |
| class | ImportCalibrationAlgorithm |
| Imports the calibrations from a file and applies them to a number of UltrasoundSweep instances using a SweepCalibrator. More... | |
| class | ImportCalibrationController |
| Controller for ImportCalibrationAlgorithm. More... | |
| class | InteractiveFanAnnotation |
| An interactive fan annotation that manages an internal FrameGeometry. More... | |
| class | LabelCompoundingAlgorithm |
| Compounding of label maps belonging to an ultrasound sweep. More... | |
| class | MergeSweepsAlgorithm |
| Merges multiple TrackedSharedImageSet into a single one. More... | |
| class | MotionTrajectoryModel |
| Base class for helper classes modeling arbitrary motion trajectories using various parameterization methods. More... | |
| class | ComposedMotionModel |
| Motion model that composes multiple motion models into a single unified model. More... | |
| class | SimpleMotionModel |
| Model representing simple motion defined either by a shift and rotation or a rigid pose between the first and last frames. More... | |
| class | ParametricMotionModel |
| A motion model that extends rigid motion with possible waypoint parametrization. More... | |
| class | KeyframeMotionModel |
| This model allows users to define a set of keyframes—each associated with a specific frame index. More... | |
| class | EveryFrameModel |
| Motion model with independent poses for each frame, exposing only one frame at a time for optimization. More... | |
| class | PiecewiseMotionModel |
| Motion model enabling piecewise segment-based registration using frame selection. More... | |
| class | GatingMotionModel |
| Specialized motion model that incorporates gating metadata for respiratory-aware motion. More... | |
| class | NeedleSweepCalibrationAlgorithm |
| This algorithm allows to perform ultrasound calibration using a tracked needle or pointer. More... | |
| class | NeedleSweepCalibrationController |
| Controller for defining needle points in ultrasound sweeps for calibration. More... | |
| class | PointsOnSweepManipulator |
| Class that handles creation and manipulation of points on ultrasound sweeps. More... | |
| class | ProbeRenderer |
| Visualizes the probe corresponding to an Ultrasound sweep in a volumetric view. More... | |
| struct | ProcessUltrasoundParameters |
| Parameters controlling how ProcessUltrasound transforms each ultrasound frame. More... | |
| struct | ProcessedFrame |
| Result of ProcessUltrasound::processFrame(). More... | |
| class | ProcessUltrasound |
| Processes single ultrasound frames according to a FrameGeometry and ProcessUltrasoundParameters. More... | |
| class | ProcessUltrasoundClip |
| Processes a 2D ultrasound clip frame by frame using ProcessUltrasound. More... | |
| class | ProcessUltrasoundController |
| Controller for editing ProcessUltrasound parameters and frame geometry. More... | |
| class | RawDataComponent |
| This data component holds SharedImageSets that relate to the one they are attached to, holding their associated raw ultrasound data. More... | |
| class | RemoveDuplicateFrames |
| Algorithm for detecting and removing duplicate or nearly identical successive frames from an image set. More... | |
| class | ScanConversion |
| Algorithm that performs scan-conversion on a given UltrasoundSweep, using its FrameGeometry to fully determine the result. More... | |
| struct | ConversionParameters |
| class | ScanConversion3D |
| Ultrasound scan-conversion for 3D probe data into a volumetric image and vice versa. More... | |
| class | SetAcousticParametersAlgorithm |
| The SetAcousticParametersAlgorithm class creates and configures an AcousticParametersDataComponent and adds it to the SharedImageSet. More... | |
| class | ProbeTrackerPair |
| Class uniquely identifying a probe-tracker pair via probe-name and tracker-ID. More... | |
| class | SweepCalibrationData |
| This class maintains a database of calibration matrices between the image FrameGeometry offset and the (possibly multiple) TrackingInstrument frames. More... | |
| class | SweepCalibrationDataIO |
| Loads and saves SweepCalibrationData instances from XML files. More... | |
| class | SweepCalibrator |
| Calibrates UltrasoundSweep instances given a SweepCalibrationData. More... | |
| class | SweepCompoundingController |
| GUI controller for configuring and running freehand ultrasound sweep compounding. More... | |
| class | SweepCroppingAlgorithm |
| Algorithm for cropping, binning (downsampling), and vertical flipping of ultrasound image data, with full correction of associated tracking and geometry metadata. More... | |
| class | SweepDisplayDataController |
| GUI DataController for adjusting ultrasound sweep visualization in the display views. More... | |
| class | SweepDisplayHandler |
| A DataDisplayHandler for UltrasoundSweep. More... | |
| class | SweepDisplayOptions |
| DataComponent to store UltrasoundSweep-specific rendering options. More... | |
| class | SweepMotion |
| Analyse and edit motion of a freehand ultrasound sweep. More... | |
| class | SweepOptimization |
| Class that factors out the parametrization of an UltrasoundSweep as needed for registration, motion estimation and calibration. More... | |
| class | SweepProcessingAlgorithm |
| High-level algorithm for post-processing 3D freehand ultrasound sweeps. More... | |
| class | SweepPropertiesAlgorithm |
| Algorithm to change properties of one or two ultrasound sweeps. More... | |
| class | SweepToMeshAlgorithm |
| Algorithm to generate a 3D surface mesh from a 2D ultrasound sweep. More... | |
| class | SweepTrackingProperties |
| Dialog for adjusting FrameGeometry related properties of a tracked shared image set. More... | |
| class | SyntheticUltrasoundSweepAlgorithm |
| Algorithm to create an ultrasound sweep without image content from two splines. More... | |
| class | SyntheticUltrasoundSweepController |
| Controller for SyntheticUltrasoundSweepAlgorithm. More... | |
| class | UltrasoundCalibrationInit |
| Helper class for the geometric computations needed in the UltrasoundCalibrationWizardAlgorithm. More... | |
| struct | AcousticTissueParameters |
| The AcousticTissueParameters struct stores relevant tissue parameters. More... | |
| struct | SimulationParameters |
| Struct for medium properties used in ultrasound simulation. More... | |
| struct | SimulationMedium |
| for convenience More... | |
| class | UltrasoundMetadata |
| Metadata for a medical ultrasound image. More... | |
| class | UltrasoundSweep |
| Set of 2D ultrasound images constituting a 3D (freehand) ultrasound sweep, so a clip of 2D ultrasound images with arbitrarily sampled tracking data and additional ultrasound-specific metadata. More... | |
| class | UltrasoundSweepRingBuffer |
| Class for ring buffer version of freehand ultrasound sweep. More... | |
| class | USAlgorithmControllerFactory |
| Factory for controllers around ultrasound imaging. More... | |
| class | USAlgorithmFactory |
| Factory for algorithms around ultrasound imaging. More... | |
| class | USPlugin |
| Plugin for algorithms from US module. More... | |
| class | USPluginSettings |
| class | VolumeReslicingAlgorithm |
| Reslices a volume at the frame positions of an ultrasound sweep. More... | |
| class | ClProbeDeformation |
| Differentiable OpenCL implementation of GlProbeDeformation. More... | |
| class | ProbeDeformationAlgorithm |
| Setup ultrasound probe-skin deformation on another volume. More... | |
| class | RawDataAlgorithm |
| Handles pairing of B-mode ultrasound images with raw data and an optional label map. More... | |
| class | RawDataController |
| Controller for ultrasound B-mode and raw data handling. More... | |
| class | SliceToVolumeRegistrationAlgorithm |
| Intensity-based registration of an ultrasound sweep to a volume. More... | |
| class | SweepGlobalInitAlgorithm |
| Algorithm for initializing the 3D pose of an ultrasound sweep relative to a reference volume. More... | |
| class | SweepGlobalInitController |
| Provides a user interface for initializing the global pose of an ultrasound sweep relative to a reference volume. More... | |
| class | SweepPointCorrAlgorithm |
| Handles point correspondences between an ultrasound sweep and a 3D volume for registration. More... | |
| class | SweepPointCorrController |
| GUI controller for sweep to volume point correspondences. More... | |
| class | UltrasoundCalibration |
| Freehand ultrasound calibration with overlapping sweeps. More... | |
| class | UltrasoundCalibrationController |
| GUI controller for freehand ultrasound calibration. More... | |
| class | UltrasoundRegistrationAlgorithm |
| Registration of an ultrasound sweep or volume to a tomographic scan (CT or MRI). More... | |
| class | UltrasoundRegistrationController |
| GUI controller for 3D ultrasound registration. More... | |
| class | UltrasoundSimulation |
| Ultrasound simulation from CT. More... | |
| class | UltrasoundSimulationHybrid |
| Hybrid ultrasound simulation method. More... | |
| class | BoneSegmentationAlgorithm |
| Algorithm which segments bone in an ultrasound sweep. More... | |
| class | BoneSegmentationBaseAlgorithm |
| Performs bone segmentation on ultrasound images using a machine learning model. More... | |
| class | BoneSegmentationController |
| Controller for ultrasound bone segmentation algorithm. More... | |
| class | FrameFromVolumeOperation |
| Extracts 2D frames from a 3D volume by sampling while rotating around the specified axis. More... | |
| class | RandomFrameFromVolumeOperation |
| Randomized version of the FrameFromVolumeOperation. More... | |
| class | UltrasoundConeCalibrationAlgorithm |
| Algorithm that automatically computes ultrasound calibration using two or more ultrasound sweeps covering a cone phantom. More... | |
| class | UltrasoundDISARegistrationAlgorithm |
| Algorithm for registering an ultrasound sweep to a volume using DISA. More... | |
| class | UltrasoundDISARegistrationController |
| Controller for the UltrasoundDISARegistrationAlgorithm. More... | |
| class | FrameGrabbingAlgorithm |
| class | RoiAnnotationsWidget |
| class | RecordingWidget |
| class | PresetsTable |
| class | FrameGrabbingController |
| class | InstrumentButtonListener |
| Utility class for managing button events from hardware. More... | |
| class | LiveGeometryDetectionAlgorithm |
| Detects ultrasound frame geometry continuously from a live ImageStream. More... | |
| class | LiveSweepRecordingVisualizationAlgorithm |
| Handles live ultrasound sweep visualization using an ImageStream and a TrackingStream. More... | |
| class | LiveSweepRecordingVisualizationController |
| Controller for visualizing live ring buffer sweeps. More... | |
| class | LiveUSAlgorithmControllerFactory |
| Factory for built-in algorithms. More... | |
| class | LiveUSAlgorithmFactory |
| Factory for built-in Live US algorithms. More... | |
| class | LiveUSPlugin |
| Plugin for algorithms from Live US module. More... | |
| class | ProbeTrackerAssigner |
| Assigns the main tracker to a tracking instrument whose name matches a predefined list associated with a probe name. More... | |
| class | ProcessedUltrasoundStream |
| ImageStream that preprocesses live ultrasound frames and attaches frame geometry metadata. More... | |
| class | ScreenTint |
| Utility class for applying a red tint to an UltrasoundSweep by modifying its transfer function. More... | |
| class | StreamDisplayDataController |
| GUI DataController for adjusting ultrasound stream visualizations in the display views. More... | |
| class | SweepPlaybackAlgorithm |
| An algorithm to playback an UltrasoundSweep as separate ImageStream and TrackingStream. More... | |
| class | SweepRecorderAlgorithm |
| Algorithm for recording an ImageStream with modality ULTRASOUND and zero, one, or multiple TrackingStreams into an UltrasoundSweep. More... | |
| class | SweepRecorderController |
| Controller for recording and visualizing multiple ultrasound sweeps. More... | |
| class | CalibrationProgress |
| Progress implementation as an integrated QProgressBar. More... | |
| class | WizardPage |
| Base WizardPage class. More... | |
| class | IntroPage |
| Introduction page. The user can select which tracking instruments to calibrate for. More... | |
| class | TrackRecordPage |
| Tracking recording page. Allows the user to record tracking sequences for each direction in the wizard. More... | |
| class | SymmetryPage |
| Symmetry disambiguation page. Guides the user to indicate which probe orientation they're holding. More... | |
| class | GuidedExpert |
| Guided or Expert selection page. Allows the user to end the wizard early with an initial calibration. More... | |
| class | SweepRecordPage |
| Sweep recording page in the UltrasoundCalibrationWizard. Allows the user to record calibration sweeps. More... | |
| class | CalibrationPage |
| Calibration page in the UltrasoundCalibrationWizard. Displays the calibration progress and controls to explore the calibration sweeps. More... | |
| class | UltrasoundCalibrationWizard |
| Wizard dialog as fronted for the UltrasoundCalibrationWizardAlorithm. More... | |
| class | UltrasoundCalibrationWizardAlgorithm |
| Back-end algorithm for the UltrasoundCalibrationWizard. More... | |
| class | VirtualImagingAlgorithm |
| Virtual imaging in 2D or 3D through ultrasound simulation or volume slicing. More... | |
| class | VirtualImagingStream |
| Virtual TEE imaging in 2D or 3D through ultrasound simulation This class is a wrapper over the VirtualImagingAlgorithm, taking a TrackingStream and a volume to generate a simulated ultrasound image stream. More... | |
| class | VirtualImagingStreamAlgorithm |
| class | VirtualImagingStreamController |
| Controller for streaming the output of virtual imagining a volume. More... | |
| class | AcquisitionSequence |
| Collection of frame acquisition parametrizations that form a sequence. More... | |
| class | AcquisitionSequenceWidget |
| Widget to configure a AcquisitionSequence, intended to be used in other controllers. More... | |
| class | BeamformingAlgorithm |
| Algorithm to perform beamforming (and optionally coherent compounding) on RF or IQ ultrasound channel data. More... | |
| class | BeamformingRois |
| DataComponent that describes the spatial regions of interest (ROIs) for beamforming for each pulse-echo event. More... | |
| class | ChannelDataFilterAlgorithm |
| Algorithm to filter RF channel data in the fast time domain. More... | |
| class | ChannelDataLayout |
| Layout of ultrasound channel data in a 3D image. More... | |
| class | ChannelDataRemappingAlgorithm |
| Algorithm to remap the order of channels in channel data to simple muxed order (channel# = element % num channels). More... | |
| class | EnvelopeDetectionAlgorithm |
| Algorithm that performs envelope detection and (optionally) log compression on an ultrasound image given in pre-scan form. More... | |
| struct | FrameParameters |
| Properties for high-level parametrization of a frame acquisition. More... | |
| class | FrameAcquisition |
| Metadata and programming for the sequence of pulse echo events of one frame, e.g. More... | |
| class | FrameAcquisitionWidget |
| Widget to configure a FrameAcquisition, intended to be used mainly through the AcquisitionSequenceWidget. More... | |
| class | IqDemodulation |
| Perform IQ demodulation on an image. More... | |
| class | IqDemodulationAlgorithm |
| Algorithm that performs IQ demodulation in the fast-time axis of ultrasound channel data or y-axis of general RF data. More... | |
| class | LogCompressionAlgorithm |
| Algorithm that applies ultrasound-style log compression to scalar amplitude or complex IQ images. More... | |
| class | PulseEchoEvent |
| Describes one ultrasound pulse echo event. More... | |
| class | ScanConversionUltrafastImaging |
| Algorithm that performs scan-conversion ultrafast ultrasound images, using its FrameGeometry to fully determine the result. More... | |
| class | SimulatedChannelDataStream |
| Testing / debugging algorithm, that creates a stream of channel data, containing the echo of one or more point scatterers. More... | |
| struct | SingleImageStreamAlgorithmExecutorPayload |
| Work item for the StreamAlgorithmExecutor. More... | |
| class | SingleImageStreamAlgorithmExecutor |
| Generic algorithm that allows the execution of arbitrary algorithms on each image coming in through an image stream. More... | |
| class | SingleImageAlgorithmExecutorStream |
| Image stream helper class used as output of the StreamAlgorithmExecutor class. More... | |
| class | SingleImageStreamAlgorithmExecutorController |
| class | StreamScanConversionAlgorithm |
| Shortcut Algorithm to instantiate a SequentialImageProcessor for US::ScanConversion2 on an image stream. More... | |
| class | Transducer |
| Low level transducer information, used for programming US firings and channel data processing. More... | |
Enumerations | |
| enum class | CoordinateSystem { Pixels , Image } |
| Coordinate system the geometry is defined in. | |
| enum | Medium { UNDEFINED_MEDIUM = 0 , BACKGROUND = 1 , LUNG = 2 , FAT = 3 , WATER = 4 , CSF = 5 , KIDNEY = 6 , BLOOD = 7 , MUSCLE = 8 , GREY_MATTER = 9 , WHITE_MATTER = 10 , LIVER = 11 , SOFT_TISSUE = 12 , BONE = 13 , SKULL = 14 , VESSELS = 15 , TUMOR_BRAIN = 16 , AIR = 17 , LAST = AIR } |
| enum class | Stage { Intro , Front , Side , Roll , Pitch , Yaw , Flip , GuidedExpert , FrontSweep , SideSweep , Calibrate , None } |
| Stages in the UltrasoundCalibrationWizard. | |
| enum class | WavefrontShape { Focused = 0 , PlaneWave = 1 , DivergingWave = 2 } |
| Shape of an emitted wavefront. More... | |
Functions | |
| bool | hasFrameGeometryMetadata (const SharedImageSet &imageSet) |
| returns true if image set has a valid FrameGeometryMetadata, i.e. | |
| const FrameGeometryMetadata & | getFrameGeometryMetadata (const SharedImageSet &imageSet) |
| Shortcut to get FrameGeometryMetadata from a SharedImageSet. | |
| bool | isChannelData (const SharedImageSet &imageSet, int which=-1) |
| returns true if image set is a valid representation of the concept ChannelData, i.e. | |
| bool | isChannelData (const DataComponentList &components) |
| returns true if data component list is a valid representation of the concept ChannelData, i.e. | |
| const FrameAcquisition & | getFrameAcquisition (const SharedImageSet &imageSet, int which=-1) |
| Shortcut to get FrameAcquisition from a SharedImageSet. | |
| const FrameAcquisition & | getFrameAcquisition (const DataComponentList &components) |
| Shortcut to get FrameAcquisition from a DataComponentList. | |
| std::unique_ptr< MemImage > | permuteChannelData (const MemImage &inImage, const ChannelDataLayout &inputLayout, const ChannelDataLayout &outputLayout) |
| Utility function to permute the channel data layout of a MemImage. | |
| bool ImFusion::US::hasFrameGeometryMetadata | ( | const SharedImageSet & | imageSet | ) |
returns true if image set has a valid FrameGeometryMetadata, i.e.
has FrameGeometryMetadata as elementwise DataComponent
| const FrameGeometryMetadata & ImFusion::US::getFrameGeometryMetadata | ( | const SharedImageSet & | imageSet | ) |
Shortcut to get FrameGeometryMetadata from a SharedImageSet.
This method requires that the DataComponent exists in sis.components() If this is not certain, use hasFrameGeometry() to check first. Throws if FrameGeometryMetadata is not present