You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Doc_BoxAlgorithm_Matrix3DTo2D.dox-part 2.0KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. /**
  2. * \page BoxAlgorithm_Matrix3DTo2D 3D to 2D Matrix conversion
  3. __________________________________________________________________
  4. Detailed description
  5. __________________________________________________________________
  6. * |OVP_DocBegin_BoxAlgorithm_Matrix3DTo2D_Description|
  7. This box extracts a 2D matrix from a 3D matrix by removing a dimension and selecting a 2D matrix at the desired index
  8. of the removed dimension.
  9. * |OVP_DocEnd_BoxAlgorithm_Matrix3DTo2D_Description|
  10. __________________________________________________________________
  11. Inputs description
  12. __________________________________________________________________
  13. * |OVP_DocBegin_BoxAlgorithm_Matrix3DTo2D_Inputs|
  14. * |OVP_DocEnd_BoxAlgorithm_Matrix3DTo2D_Inputs|
  15. * |OVP_DocBegin_BoxAlgorithm_Matrix3DTo2D_Input1|
  16. 3D Matrix from which a 2D matrix ( a "slice") will be extracted.
  17. * |OVP_DocEnd_BoxAlgorithm_Matrix3DTo2D_Input1|
  18. __________________________________________________________________
  19. Outputs description
  20. __________________________________________________________________
  21. * |OVP_DocBegin_BoxAlgorithm_Matrix3DTo2D_Outputs|
  22. * |OVP_DocEnd_BoxAlgorithm_Matrix3DTo2D_Outputs|
  23. * |OVP_DocBegin_BoxAlgorithm_Matrix3DTo2D_Output1|
  24. The 2D matrix extrated from the input Matrix
  25. * |OVP_DocEnd_BoxAlgorithm_Matrix3DTo2D_Output1|
  26. __________________________________________________________________
  27. Settings description
  28. __________________________________________________________________
  29. * |OVP_DocBegin_BoxAlgorithm_Matrix3DTo2D_Settings|
  30. * |OVP_DocEnd_BoxAlgorithm_Matrix3DTo2D_Settings|
  31. * |OVP_DocBegin_BoxAlgorithm_Matrix3DTo2D_Setting1|
  32. The dimension to remove from the 3D Matrix. Possible values are ranging in [ 0 - 2 ].
  33. * |OVP_DocEnd_BoxAlgorithm_Matrix3DTo2D_Setting1|
  34. * |OVP_DocBegin_BoxAlgorithm_Matrix3DTo2D_Setting2|
  35. The index from the removed dimension at which to extract the 2 Matrix (the "slice").
  36. * |OVP_DocEnd_BoxAlgorithm_Matrix3DTo2D_Setting2|
  37. * |OVP_DocBegin_BoxAlgorithm_Matrix3DTo2D_Setting3|
  38. * |OVP_DocEnd_BoxAlgorithm_Matrix3DTo2D_Setting3|