.. _sweepproperties: Sweep Properties =================== Changes properties such as calibration or registration of ultrasound sweeps. This class is deprecated. Its functionality has been split on TrackedSharedImageSetProperties for TrackedSharedImageSets and FrameGeometryProperties for SharedImageSets with FrameGeometry. Input ----- The algorithm requires at least one ultrasound sweep. Output ------ None. The input sweep(s) are updated. Description ----------- The algorithm will open a dialog with fours tabs. The first three tabs (**Registration**, **Calibration** and **Tracking**) use the functionality of :ref:`Tracking Properties`. Please refer to the documentation there for details on calibration, registration and tracking sequence management. Calibration Tab ################ In addition the spatial and temporal calibration settings, the parameters in ``Image Size (mm)`` allow to change the ultrasound image extent. This setting is used for all frames of the ultrasound sweep. Registration Tab ################ In addition to the registration matrix controls, this tab allows to calculate the registration matrix *R* based on additional assumptions: * With **Align to Main Axis**, the sweep's main direction is estimated, and a registration matrix defined so that this main direction is aligned to the X axis of the world coordinate system. Furthermore, the sweep is centered around the world origin. * The button **Register Correspondances** required frame-based correspondances to be available, a feature currently only available for SDK users. Fan Tab ################ This tab allows to define the geometry of the ultrasound image region within the rectangular images. The Suite refers to this geometry as the :ref:`Frame Geometry` With a defined Frame Geometry, the button **Crop** will crop the image to the circumscribing rectangle of the selected frane geometry. The *calibration* matrix is adjusted accordingly. The drop-down button **Mask** has two options: * **Add/Remove Fan Mask** will add/remove a **mask** to the ultrasound sweep, so that the pixel data outside of the fan are left untouched but most algorithms, e.g. :ref:`Image Registration` or :ref:`Ultrasound Calibration`, do not consider them. * **Set Outside Pixels to Zero** is irreversible and will modify pixels intensities in all areas outside of the fan.