View source for Documentation/4.6/Extensions/BlendVectorVolumes

<noinclude>{{documentation/versioncheck}}</noinclude>
<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-header}}
<!-- ---------------------------- -->

<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}}}
{{documentation/{{documentation/version}}/module-introduction-row}}
Extension: [[Documentation/{{documentation/version}}/Extensions/OpenCVExample|OpenCVExample]]<br>
Acknowledgments:
This work was supported by a supplement to the Quantitative Image Informatics project via the NIH-National Cancer Institute Grant U24 CA180918-03 as well as U24 CA180924 Tools to Analyze Morphology and Spatially Mapped Molecular Data with Stony Brook University.<br>
Author: Nicole Aucoin ({{collaborator|name|spl}})<br>
Contact: Nicole Aucoin, <email>nicole@bwh.harvard.edu</email><br>
{{documentation/{{documentation/version}}/module-introduction-row}}
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
|{{collaborator|logo|qiicr}}|{{collaborator|longname|qiicr}}
|{{collaborator|logo|spl}}|{{collaborator|longname|spl}}
}}

{{documentation/{{documentation/version}}/module-introduction-end}}

<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-section|Module Description}}

This is a CLI module that depends on the [[Documentation/{{documentation/version}}/Extensions/SlicerOpenCV|SlicerOpenCV extension]], providing a way to blend two vector volumes together. It uses the OpenCV function [http://docs.opencv.org/3.1.0/d2/de8/group__core__array.html#gafafb2513349db3bcff51f54ee5592a19 addWeighted].

<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-section|Use Cases}}

When loading in RGB files, they are loaded as vector volumes in Slicer. Use this module to blend them together if they have the same dimensions.

<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-section|Tutorials}}

<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-section|Panels and their use}}

{|
| [[Image:BlendVectorVolumes-GUI.png|thumb|200px|Blend Vector Volumes GUI]]
|
'''IO:'''
* Alpha: A double value between 0.0 and 1.0 that gives the weight of the first input image in the resulting blend.
* Gamma: A double value that is added to the weighted blend, used to increase or decrease intensity.
* First Input Volume: First input vector volume
* Second Input Volume: Second input vector volume, must have the same dimensions as the first input volume.
* Output Volume: Output vector volume, holding the blending of the two input volumes, Can be a newly created vector volume.
|}

<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-section|Similar Modules}}

* The [https://github.com/SBU-BMI/SlicerPathology Slicer Pathology] extension also uses the [[Documentation/{{documentation/version}}/Extensions/SlicerOpenCV|SlicerOpenCV extension]]. 

<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-section|References}}
* [http://qiicr.org Quantitative Image Informatics for Cancer Research (QIICR)]
* [http://opencv.org Open Source Computer Vision]
** [http://docs.opencv.org/3.1.0/d2/de8/group__core__array.html#gafafb2513349db3bcff51f54ee5592a19 addWeighted] documentation for version 3.1

<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
{{documentation/{{documentation/version}}/module-developerinfo}}

To depend on the OpenCV provided by the [[Documentation/{{documentation/version}}/Extensions/SlicerOpenCV|SlicerOpenCV]] extension, in the CLI's CMakeLists.txt file define OpenCV_DIR by finding the package that SlicerOpenCV provided:
  find_package(OpenCV 3.1 REQUIRED)
* The header include path is defined as:
  get_filename_component(OpenCV_INCLUDE_DIR ${OpenCV_DIR}/../../include ABSOLUTE)
* Add ${OpenCV_INCLUDE_DIR} to the MODULE_INCLUDE_DIRECTORIES list
* Link against the OpenCV libraries by adding ${OpenCV_LIBS} to the MODULE_TARGET_LIBRARIES

[[Documentation/{{documentation/version}}/Extensions/OpenCVExample|OpenCVExample]] provides some more information about writing an extension that includes modules that depend on OpenCV

The images are read in using the opencv imread method. The blending is done by the opencv addWeighted function, and the output is written using imwrite.

<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-footer}}
[[Category:Documentation/{{documentation/version}}/Modules/Filtering]]
<!-- ---------------------------- -->