From c5e8a35b13a0e697c258645c6ed1bac5eb8d3fe8 Mon Sep 17 00:00:00 2001 From: Stefan Dinkelacker Date: Sun, 1 Nov 2020 22:25:18 +0100 Subject: [PATCH] Reduce Doxygen warnings --- Modules/AppUtil/include/mitkBaseApplication.h | 10 +- .../include/mitkAbstractGlobalImageFeature.h | 2 +- .../include/mitkGeneralizedLinearModel.h | 4 +- .../CLUtilities/include/mitkCLUtil.h | 56 ++- .../DataHolder/mitkDataCollection.h | 7 +- .../Algorithms/mitkContourModelUtils.h | 5 + .../DataManagement/mitkContourModel.h | 1 + .../DataManagement/mitkContourModelSet.h | 2 +- .../ContourModel/IO/mitkContourModelWriter.h | 4 +- Modules/Core/include/mitkAbstractFileIO.h | 1 + Modules/Core/include/mitkAbstractFileReader.h | 4 +- Modules/Core/include/mitkAnnotation.h | 8 +- .../mitkApplyTransformMatrixOperation.h | 14 +- Modules/Core/include/mitkArray.h | 2 +- Modules/Core/include/mitkColorProperty.h | 2 +- Modules/Core/include/mitkCoreServices.h | 1 + Modules/Core/include/mitkDataNode.h | 4 +- Modules/Core/include/mitkDataStorage.h | 1 - Modules/Core/include/mitkEqual.h | 2 +- Modules/Core/include/mitkEventRecorder.h | 28 +- Modules/Core/include/mitkException.h | 4 +- Modules/Core/include/mitkFileReaderRegistry.h | 2 +- Modules/Core/include/mitkGeometry3D.h | 44 +- Modules/Core/include/mitkImage.h | 389 +++++++++--------- Modules/Core/include/mitkImagePixelAccessor.h | 5 +- .../Core/include/mitkImagePixelReadAccessor.h | 4 +- .../include/mitkImagePixelWriteAccessor.h | 4 +- Modules/Core/include/mitkImageReadAccessor.h | 4 +- .../Core/include/mitkImageToSurfaceFilter.h | 4 +- Modules/Core/include/mitkImageVtkMapper2D.h | 2 - .../Core/include/mitkImageVtkReadAccessor.h | 4 +- .../Core/include/mitkImageVtkWriteAccessor.h | 4 +- Modules/Core/include/mitkImageWriteAccessor.h | 4 +- Modules/DICOM/doc/images/tilt-correction.jpg | Bin 22967 -> 0 bytes .../include/mitkDICOMITKSeriesGDCMReader.h | 26 +- .../include/mitkDICOMReaderConfigurator.h | 6 +- .../DICOM/src/legacy/mitkDicomSeriesReader.h | 20 +- Modules/DICOMweb/include/mitkDICOMweb.h | 2 +- .../include/mitkApplyDiffImageOperation.h | 4 + .../DataTypesExt/include/mitkCellOperation.h | 7 +- .../itkMultiGaussianImageSource.h | 2 +- .../mitkImageStatisticsContainerManager.h | 3 + .../ImageStatistics/mitkIntensityProfile.h | 2 + .../include/mitkEnhancedPointSetVtkMapper3D.h | 2 +- Modules/ModelFit/include/mitkFormulaParser.h | 2 +- .../include/mitkModelFitCmdAppsHelper.h | 4 +- .../mitkModelFitParameterValueExtraction.h | 6 + Modules/ModelFit/include/mitkTimeGridHelper.h | 1 + .../Commands/mitkGrabCutOpenCVImageFilter.h | 2 +- Modules/OpenIGTLink/mitkIGTLMeasurements.h | 44 +- Modules/RT/include/mitkDoseImageVtkMapper2D.h | 6 - .../Algorithms/mitkContourUtils.h | 3 + .../mitkImageLiveWireContourModelFilter.h | 4 +- .../Interactions/mitkFeedbackContourTool.h | 5 + .../include/mitkControlPointManager.h | 2 +- .../mitkIGTLMessageToUSImageFilter.h | 2 +- .../src/berryISchedulingRule.h | 2 +- .../org.mitk.core.ext/src/mitkIInputDevice.h | 2 +- .../src/mitkIInputDeviceRegistry.h | 2 +- Utilities/mbilog/mbilogBackendCout.h | 2 +- Utilities/mbilog/mbilogTextBackendBase.h | 6 + 61 files changed, 404 insertions(+), 397 deletions(-) delete mode 100644 Modules/DICOM/doc/images/tilt-correction.jpg diff --git a/Modules/AppUtil/include/mitkBaseApplication.h b/Modules/AppUtil/include/mitkBaseApplication.h index 03219562529..78cd66de278 100644 --- a/Modules/AppUtil/include/mitkBaseApplication.h +++ b/Modules/AppUtil/include/mitkBaseApplication.h @@ -37,10 +37,10 @@ namespace mitk * org.blueberry.osgi.applications extension point. * * This class contains many convenience methods to: - * - Put the application in \emph{safe mode} which catches unhandled + * - Put the application in safe mode which catches unhandled * exceptions thrown in the Qt event loop and displays an error * message. - * - Put the application in \emph{single mode} which by default + * - Put the application in single mode which by default * sends the command line arguments to an already running instance * of the same application instead of creating a second instance. * - Add a list of library names which should be pre-loaded at @@ -58,7 +58,7 @@ namespace mitk * - getQApplication() to provide a custom QCoreApplication instance * * A simple but complete example: - * + * \code * #include * * int main(int argc, char* argv[]) @@ -70,7 +70,7 @@ namespace mitk * // Run the workbench * return app.run(); * } - * + * \endcode */ class MITKAPPUTIL_EXPORT BaseApplication : public Poco::Util::Application { @@ -275,7 +275,7 @@ namespace mitk * then the command line arguments used in starting the platform, and not consumed * by the platform code, are passed to the application as a QStringList. *

- * @param argument the argument passed to the application. May be invalid + * @param args the argument passed to the application. May be invalid * @return the result of running the application * @throws std::exception if anything goes wrong */ diff --git a/Modules/Classification/CLCore/include/mitkAbstractGlobalImageFeature.h b/Modules/Classification/CLCore/include/mitkAbstractGlobalImageFeature.h index af235b78254..b72e15a9f5a 100644 --- a/Modules/Classification/CLCore/include/mitkAbstractGlobalImageFeature.h +++ b/Modules/Classification/CLCore/include/mitkAbstractGlobalImageFeature.h @@ -181,7 +181,7 @@ class MITKCLCORE_EXPORT AbstractGlobalImageFeature : public BaseData * @param checkParameterActivation Indicates if the features should only be calculated and added if the FeatureClass is activated in the parameters. * True: only append if activated in the parametes. False: always and append it. */ - void CalculateAndAppendFeatures(const Image* image, const Image* mask, const Image* maskNoNAN, FeatureListType &featureList, bool checkParameterActivation = true); + void CalculateAndAppendFeatures(const Image* image, const Image* mask, const Image* maskNoNaN, FeatureListType &featureList, bool checkParameterActivation = true); itkSetMacro(Prefix, std::string); itkSetMacro(ShortName, std::string); diff --git a/Modules/Classification/CLImportanceWeighting/include/mitkGeneralizedLinearModel.h b/Modules/Classification/CLImportanceWeighting/include/mitkGeneralizedLinearModel.h index 10c4b59fc56..629595486aa 100644 --- a/Modules/Classification/CLImportanceWeighting/include/mitkGeneralizedLinearModel.h +++ b/Modules/Classification/CLImportanceWeighting/include/mitkGeneralizedLinearModel.h @@ -51,7 +51,7 @@ namespace mitk * * No input validation is done. The data and the learned model might not match! * - * @paaram c Column for which the data is guessed. + * @param c Column for which the data is guessed. */ double Predict(const vnl_vector &c); @@ -64,7 +64,7 @@ namespace mitk * * No input validation is done. The data and the learned model might not match! * - * @paaram x Matrix for which the data is guessed. + * @param x Matrix for which the data is guessed. */ vnl_vector Predict(const vnl_matrix &x); diff --git a/Modules/Classification/CLUtilities/include/mitkCLUtil.h b/Modules/Classification/CLUtilities/include/mitkCLUtil.h index 46cd3714e4f..6202e9197b7 100644 --- a/Modules/Classification/CLUtilities/include/mitkCLUtil.h +++ b/Modules/Classification/CLUtilities/include/mitkCLUtil.h @@ -46,7 +46,8 @@ class MITKCLUTILITIES_EXPORT CLUtil /// /// \brief InterpolateCreateCheckerboardPrediction - /// \param image + /// \param checkerboard_prediction + /// \param checkerboard_mask /// \param outimage /// static void InterpolateCheckerboardPrediction(mitk::Image::Pointer checkerboard_prediction, mitk::Image::Pointer & checkerboard_mask, mitk::Image::Pointer & outimage); @@ -95,6 +96,7 @@ class MITKCLUTILITIES_EXPORT CLUtil /// \brief LogicalAndImages /// \param image1 /// \param image2 + /// \param outimage /// static void LogicalAndImages(const Image::Pointer &image1, const Image::Pointer &image2, Image::Pointer &outimage); @@ -121,25 +123,23 @@ class MITKCLUTILITIES_EXPORT CLUtil /// \param image /// \param smoothed (Result is sigma1-sigma2) /// \param sigma1 - /// \param sigma2 /// static void LaplacianOfGaussianFilter(mitk::Image::Pointer image, mitk::Image::Pointer & smoothed, double sigma1); /// /// \brief SubtractGaussianFilter /// \param image - /// \param smoothed (Result is sigma1-sigma2) - /// \param sigma1 - /// \param sigma2 + /// \param out + /// \param sigma /// static void HessianOfGaussianFilter(mitk::Image::Pointer image, std::vector &out, double sigma); /// /// \brief Local Histogram /// \param image - /// \param smoothed (Result is sigma1-sigma2) - /// \param sigma1 - /// \param sigma2 + /// \param out + /// \param Bins + /// \param NeighbourhoodSize /// static void LocalHistogram(mitk::Image::Pointer image, std::vector &out, int Bins, int NeighbourhoodSize); @@ -147,7 +147,6 @@ class MITKCLUTILITIES_EXPORT CLUtil /// \brief transform /// \param matrix /// \param mask - /// \param outimage /// template static mitk::Image::Pointer Transform(const Eigen::Matrix & matrix, const mitk::Image::Pointer & mask) @@ -189,9 +188,8 @@ class MITKCLUTILITIES_EXPORT CLUtil } /// /// \brief TransformImageToMatrix - /// \param in_img + /// \param img /// \param mask - /// \param out_matrix /// template static Eigen::Matrix Transform(const mitk::Image::Pointer & img, const mitk::Image::Pointer & mask) @@ -222,51 +220,51 @@ class MITKCLUTILITIES_EXPORT CLUtil /// /// \brief DilateBinary - /// \param BinaryImage - /// \param BinaryImage - /// \param Size of the StructuringElement - /// \param Dimension + /// \param sourceImage + /// \param resultImage + /// \param radius Size of the StructuringElement + /// \param d /// static void DilateBinary(mitk::Image::Pointer & sourceImage, mitk::Image::Pointer& resultImage, int radius , MorphologicalDimensions d); /// /// \brief ErodeBinary - /// \param BinaryImage - /// \param BinaryImage - /// \param Size of the StructuringElement - /// \param Dimension + /// \param sourceImage + /// \param resultImage + /// \param radius Size of the StructuringElement + /// \param d /// static void ErodeBinary(mitk::Image::Pointer & sourceImage, mitk::Image::Pointer& resultImage, int radius, MorphologicalDimensions d); /// /// \brief ClosingBinary - /// \param BinaryImage - /// \param BinaryImage - /// \param Size of the StructuringElement - /// \param Dimension + /// \param sourceImage + /// \param resultImage + /// \param radius Size of the StructuringElement + /// \param d /// static void ClosingBinary(mitk::Image::Pointer & sourceImage, mitk::Image::Pointer& resultImage, int radius, MorphologicalDimensions d); /// /// \brief MergeLabels - /// \param MultilabelImage + /// \param img /// \param map merge instruction where each map entry defines a mapping instruction. Key \c \ - Value \c \ /// static void MergeLabels(mitk::Image::Pointer & img, const std::map & map); /// /// \brief ConnectedComponentsImage - /// \param BinaryImage - /// \param BinaryImage - /// \param MultilabelImage - /// \param Number of components found in the image + /// \param image + /// \param mask + /// \param outimage + /// \param num_components Number of components found in the image /// static void ConnectedComponentsImage(mitk::Image::Pointer & image, mitk::Image::Pointer& mask, mitk::Image::Pointer &outimage, unsigned int& num_components); /// /// \brief GrabLabel - /// \param MultiLabelImage + /// \param image /// \param outimage /// \param label /// diff --git a/Modules/Classification/DataCollection/DataHolder/mitkDataCollection.h b/Modules/Classification/DataCollection/DataHolder/mitkDataCollection.h index 19620e97a93..ec35e2b844c 100644 --- a/Modules/Classification/DataCollection/DataHolder/mitkDataCollection.h +++ b/Modules/Classification/DataCollection/DataHolder/mitkDataCollection.h @@ -73,10 +73,9 @@ namespace mitk * @brief AddData Add a data item * @param data Images/Fibers/DataCollections * @param name name that allows identifying this data (e.g. a category T2, Segmentation , etc ...) - * @param description + * @param filePath * @return */ - size_t AddData(DataObject::Pointer data, std::string name, std::string filePath = ""); /** @@ -144,7 +143,7 @@ namespace mitk /** * @brief GetData Get original data by index * - * To ensure a mitk::Image is returned use \ref mitk::GetMitkImage + * To ensure a mitk::Image is returned use GetMitkImage * * @param index * @return @@ -154,7 +153,7 @@ namespace mitk /** * @brief GetData Get original data by name * - * To ensure a mitk::Image is returned use \ref mitk::GetMitkImage + * To ensure a mitk::Image is returned use GetMitkImage * * @param name * @return diff --git a/Modules/ContourModel/Algorithms/mitkContourModelUtils.h b/Modules/ContourModel/Algorithms/mitkContourModelUtils.h index 2c06664812f..42c91c021e6 100644 --- a/Modules/ContourModel/Algorithms/mitkContourModelUtils.h +++ b/Modules/ContourModel/Algorithms/mitkContourModelUtils.h @@ -34,8 +34,11 @@ namespace mitk /** \brief Projects a contour onto an image point by point. Converts from world to index coordinates. + \param slice + \param contourIn3D \param correctionForIpSegmentation adds 0.5 to x and y index coordinates (difference between ipSegmentation and MITK contours) + \param constrainToInside */ static ContourModel::Pointer ProjectContourTo2DSlice(Image *slice, ContourModel *contourIn3D, @@ -45,6 +48,8 @@ namespace mitk /** \brief Projects a slice index coordinates of a contour back into world coordinates. + \param sliceGeometry + \param contourIn2D \param correctionForIpSegmentation subtracts 0.5 to x and y index coordinates (difference between ipSegmentation and MITK contours) */ diff --git a/Modules/ContourModel/DataManagement/mitkContourModel.h b/Modules/ContourModel/DataManagement/mitkContourModel.h index 7cded5022db..45aae9bcda4 100644 --- a/Modules/ContourModel/DataManagement/mitkContourModel.h +++ b/Modules/ContourModel/DataManagement/mitkContourModel.h @@ -199,6 +199,7 @@ namespace mitk /** \brief Concatenate two contours. The starting control point of the other will be added at the end of the contour. + \param other \param timestep - the timestep at which the vertex will be add ( default 0) \param check - check for intersections ( default false) */ diff --git a/Modules/ContourModel/DataManagement/mitkContourModelSet.h b/Modules/ContourModel/DataManagement/mitkContourModelSet.h index d23664374e9..e98b8ccdf25 100644 --- a/Modules/ContourModel/DataManagement/mitkContourModelSet.h +++ b/Modules/ContourModel/DataManagement/mitkContourModelSet.h @@ -70,7 +70,7 @@ namespace mitk bool IsEmpty() const override; /** \brief Remove the given ContourModel from the container if exists. - \param ContourModel - the ContourModel to be removed. + \param contourModel - the ContourModel to be removed. */ virtual bool RemoveContourModel(mitk::ContourModel *contourModel); diff --git a/Modules/ContourModel/IO/mitkContourModelWriter.h b/Modules/ContourModel/IO/mitkContourModelWriter.h index aa0190b3956..e338c4eee81 100644 --- a/Modules/ContourModel/IO/mitkContourModelWriter.h +++ b/Modules/ContourModel/IO/mitkContourModelWriter.h @@ -89,7 +89,7 @@ namespace mitk * Writes the geometry information of the TimeGeometry to an outstream. * The root tag is not included. * @param geometry the TimeGeometry of the contour. - * @param the stream to write to. + * @param out the stream to write to. */ void WriteGeometryInformation(const mitk::TimeGeometry *geometry, std::ostream &out); @@ -97,7 +97,7 @@ namespace mitk * Writes the geometry information of the TimeGeometry to an outstream. * The root tag is not included. * @param geometry the TimeGeometry of the contour. - * @param the stream to write to. + * @param out the stream to write to. * * \deprecatedSince{2013_09} Please use TimeGeometry instead of TimeSlicedGeometry. For more information see * http://www.mitk.org/Development/Refactoring%20of%20the%20Geometry%20Classes%20-%20Part%201 diff --git a/Modules/Core/include/mitkAbstractFileIO.h b/Modules/Core/include/mitkAbstractFileIO.h index b7885996221..445d3ec0ba7 100644 --- a/Modules/Core/include/mitkAbstractFileIO.h +++ b/Modules/Core/include/mitkAbstractFileIO.h @@ -99,6 +99,7 @@ namespace mitk * If the given MIME type has nothing but its name set, the according MIME type * is looked up in the service registry. * + * @param baseDataType * @param mimeType The MIME type this reader can read. * @param description A human readable description of this reader. * diff --git a/Modules/Core/include/mitkAbstractFileReader.h b/Modules/Core/include/mitkAbstractFileReader.h index 83ab25d7f34..ee51b225f87 100644 --- a/Modules/Core/include/mitkAbstractFileReader.h +++ b/Modules/Core/include/mitkAbstractFileReader.h @@ -85,9 +85,7 @@ namespace mitk * type id can be set via SetMimeType() or it will be auto-generated using \c extension, * having the form "application/vnd.mitk.". * - * @param extension The file extension (without a leading period) for which a registered - * mime-type object is looked up and associated with this reader instance. - * @param description A human readable description of this reader. + * @param context */ us::ServiceRegistration RegisterService(us::ModuleContext *context = us::GetModuleContext()); void UnregisterService(); diff --git a/Modules/Core/include/mitkAnnotation.h b/Modules/Core/include/mitkAnnotation.h index 2dffee3c913..91b86cf65f7 100644 --- a/Modules/Core/include/mitkAnnotation.h +++ b/Modules/Core/include/mitkAnnotation.h @@ -96,9 +96,10 @@ namespace mitk * * Overwrites values in m_PropertyList only when possible (i.e. when types are compatible). * If you want to allow for object type changes (replacing a "visible":BoolProperty with "visible":IntProperty, - * set the @param replace. + * set \c replace. * - * @param replace true: if @param pList contains a property "visible" of type ColorProperty and our m_PropertyList + * @param pList + * @param replace true: if \c pList contains a property "visible" of type ColorProperty and our m_PropertyList * also has a "visible" property of a different type (e.g. BoolProperty), change the type, i.e. replace the objects * behind the pointer. * @@ -345,8 +346,7 @@ namespace mitk * @brief Convenience method for setting visibility properties (instances * of BoolProperty) * @param visible If set to true, the data will be rendered. If false, the render will skip this data. - * @param renderer Specify a renderer if the visibility shall be specific to a renderer - * @param propertykey Can be used to specify a user defined name of the visibility propery. + * @param propertyKey Can be used to specify a user defined name of the visibility propery. */ void SetVisibility(bool visible, const std::string &propertyKey = "visible"); diff --git a/Modules/Core/include/mitkApplyTransformMatrixOperation.h b/Modules/Core/include/mitkApplyTransformMatrixOperation.h index 472e147166a..649b2dd3f72 100644 --- a/Modules/Core/include/mitkApplyTransformMatrixOperation.h +++ b/Modules/Core/include/mitkApplyTransformMatrixOperation.h @@ -24,14 +24,12 @@ namespace mitk class MITKCORE_EXPORT ApplyTransformMatrixOperation : public Operation { public: - //##Documentation - //##@brief Operation that applies a new vtk transform matrix. - //## - //## @param operationType is the type of the operation (see mitkOperation.h; e.g. move or add; Information for - // StateMachine::ExecuteOperation()); - //## @param matrix is the vtk 4x4 vtk matrix of the transformation - //## @param refPoint is the reference point for realigning the plane stack - + /** @brief Operation that applies a new vtk transform matrix. + * + * @param operationType is the type of the operation (see mitkOperation.h; e.g. move or add; Information for StateMachine::ExecuteOperation()); + * @param matrix is the vtk 4x4 vtk matrix of the transformation + * @param refPoint is the reference point for realigning the plane stack + */ ApplyTransformMatrixOperation(OperationType operationType, vtkSmartPointer matrix, mitk::Point3D refPoint); diff --git a/Modules/Core/include/mitkArray.h b/Modules/Core/include/mitkArray.h index 73d6b34d26d..77097186929 100644 --- a/Modules/Core/include/mitkArray.h +++ b/Modules/Core/include/mitkArray.h @@ -49,7 +49,7 @@ namespace mitk * @brief Copies elements of an array to this Vector * @param[in] array the array whose values will be copied into the Vector. Must be of a type which overrides the [] * operator - * @param return the FixedArrray (e.g., mitk::Vector or mitk::Point) which should hold the elements of array. + * @return the FixedArray (e.g., mitk::Vector or mitk::Point) which should hold the elements of array. * @attention array must be of dimension NVectorDimension! * @attention this method implicitly converts between data types. */ diff --git a/Modules/Core/include/mitkColorProperty.h b/Modules/Core/include/mitkColorProperty.h index 2de38d55e94..70de0bc4875 100644 --- a/Modules/Core/include/mitkColorProperty.h +++ b/Modules/Core/include/mitkColorProperty.h @@ -42,7 +42,7 @@ namespace mitk * make sure to set the mitk::RenderingModeProperty to a mode which * supports color (e.g. LEVELWINDOW_COLOR). For an example how to use * the mitk::ColorProperty see mitkImageVtkMapper2DColorTest.cpp in - * Core\Code\Rendering. + * Core/Code/Rendering. */ class MITKCORE_EXPORT ColorProperty : public BaseProperty { diff --git a/Modules/Core/include/mitkCoreServices.h b/Modules/Core/include/mitkCoreServices.h index 1e3f179acd9..833cc313c83 100644 --- a/Modules/Core/include/mitkCoreServices.h +++ b/Modules/Core/include/mitkCoreServices.h @@ -109,6 +109,7 @@ namespace mitk /** * @brief Unget a previously acquired service instance. * @param service The service instance to be released. + * @param context * @return \c true if ungetting the service was successful, \c false otherwise. */ template diff --git a/Modules/Core/include/mitkDataNode.h b/Modules/Core/include/mitkDataNode.h index 13f64e52b63..24f5890c5b7 100644 --- a/Modules/Core/include/mitkDataNode.h +++ b/Modules/Core/include/mitkDataNode.h @@ -202,7 +202,7 @@ namespace mitk * * Overwrites values in m_PropertyList only when possible (i.e. when types are compatible). * If you want to allow for object type changes (replacing a "visible":BoolProperty with "visible":IntProperty, - * set the \param replace. + * set \c replace . * * \param replace true: if \param pList contains a property "visible" of type ColorProperty and our m_PropertyList * also has a "visible" property of a different type (e.g. BoolProperty), change the type, i.e. replace the objects @@ -494,7 +494,7 @@ namespace mitk * of BoolProperty) * \param visible If set to true, the data will be rendered. If false, the render will skip this data. * \param renderer Specify a renderer if the visibility shall be specific to a renderer - * \param propertykey Can be used to specify a user defined name of the visibility propery. + * \param propertyKey Can be used to specify a user defined name of the visibility propery. */ void SetVisibility(bool visible, const mitk::BaseRenderer *renderer = nullptr, const char *propertyKey = "visible"); diff --git a/Modules/Core/include/mitkDataStorage.h b/Modules/Core/include/mitkDataStorage.h index 8e6771b65fd..a8609593171 100644 --- a/Modules/Core/include/mitkDataStorage.h +++ b/Modules/Core/include/mitkDataStorage.h @@ -351,7 +351,6 @@ namespace mitk //## The methods returns only [-infinity, +infinity], if all data-objects have an infinite live-span. Otherwise, //## all data-objects with infinite live-span are ignored. //## Simply calls ComputeTimeBounds(it, "visible", renderer, boolPropertyKey). - //## @param it an iterator to a data tree structure //## @param boolPropertyKey if a BoolProperty with this boolPropertyKey exists for a node (for @a renderer) //## and is set to @a false, the node is ignored for the time-bounds calculation. //## @param renderer see @a boolPropertyKey diff --git a/Modules/Core/include/mitkEqual.h b/Modules/Core/include/mitkEqual.h index 89539d640fc..ad6d0b9745a 100644 --- a/Modules/Core/include/mitkEqual.h +++ b/Modules/Core/include/mitkEqual.h @@ -31,7 +31,7 @@ namespace mitk * Helper method to check if the difference is bigger or equal to a given epsilon * * @param diff the difference to be checked against the epsilon - * @param the epsilon. The absolute difference needs to be smaller than this. + * @param epsilon The absolute difference needs to be smaller than this. * @return true if abs(diff) >= eps */ template diff --git a/Modules/Core/include/mitkEventRecorder.h b/Modules/Core/include/mitkEventRecorder.h index 2af1e6958fc..a99f54fb562 100644 --- a/Modules/Core/include/mitkEventRecorder.h +++ b/Modules/Core/include/mitkEventRecorder.h @@ -22,27 +22,29 @@ namespace mitk /** *\class EventRecorder *@brief Observer that enables recoding of all user interaction with the render windows and storing it in an XML - *file. + *file. * * @ingroup Interaction * - * XML file will look like + * XML file will look like: * - * - * + * \code{.unparsed} + * + * * - * - * - * + * + * + * * * - * - * - * - * - * + * + * + * + * + * * - * + * + * \endcode **/ class MITKCORE_EXPORT EventRecorder : public InteractionEventObserver { diff --git a/Modules/Core/include/mitkException.h b/Modules/Core/include/mitkException.h index 0465afc949b..c632970caf0 100644 --- a/Modules/Core/include/mitkException.h +++ b/Modules/Core/include/mitkException.h @@ -64,8 +64,8 @@ namespace mitk * exist. * @param rethrowNumber The internal number of the rethrow. * @param file (returnvalue) This varaiable will be filled with the file of the specified rethrow. - * @param file (returnvalue) This varaiable will be filled with the line of the specified rethrow. - * @param file (returnvalue) This varaiable will be filled with the message of the specified rethrow. + * @param line (returnvalue) This varaiable will be filled with the line of the specified rethrow. + * @param message (returnvalue) This varaiable will be filled with the message of the specified rethrow. */ void GetRethrowData(int rethrowNumber, std::string &file, int &line, std::string &message); diff --git a/Modules/Core/include/mitkFileReaderRegistry.h b/Modules/Core/include/mitkFileReaderRegistry.h index 9e55cc156d6..5ee1fc44c07 100644 --- a/Modules/Core/include/mitkFileReaderRegistry.h +++ b/Modules/Core/include/mitkFileReaderRegistry.h @@ -46,7 +46,7 @@ namespace mitk /** * @brief Get the highest ranked mime-type for the given file name. - * @param extension A file name extension without a leading dot. + * @param path * @param context * @return The highest ranked mime-type containing \c extension in * its extension list. diff --git a/Modules/Core/include/mitkGeometry3D.h b/Modules/Core/include/mitkGeometry3D.h index b342f6aa250..8b5645750ea 100644 --- a/Modules/Core/include/mitkGeometry3D.h +++ b/Modules/Core/include/mitkGeometry3D.h @@ -26,10 +26,9 @@ class vtkLinearTransform; namespace mitk { - //##Documentation - //## @brief Standard implementation of BaseGeometry. - //## - //## @ingroup Geometry + /** @brief Standard implementation of BaseGeometry. + * @ingroup Geometry + */ class MITKCORE_EXPORT Geometry3D : public BaseGeometry { public: @@ -43,33 +42,32 @@ namespace mitk mitkNewMacro1Param(Self, const Self&); itkCloneMacro(Self); - // itkGetConstReferenceMacro(TimeBounds, TimeBounds); - - // virtual void SetTimeBounds(const TimeBounds& timebounds); protected : Geometry3D(); Geometry3D(const Geometry3D &); - //##Documentation - //## @brief clones the geometry - //## - //## Overwrite in all sub-classes. - //## Normally looks like: - //## \code - //## Self::Pointer newGeometry = new Self(*this); - //## newGeometry->UnRegister(); - //## return newGeometry.GetPointer(); - //## \endcode + /** + * @brief clones the geometry + * + * Overwrite in all sub-classes. + * Normally looks like: + * \code + * Self::Pointer newGeometry = new Self(*this); + * newGeometry->UnRegister(); + * return newGeometry.GetPointer(); + * \endcode + */ itk::LightObject::Pointer InternalClone() const override; ~Geometry3D() override; - //##Documentation - //## @brief PreSetSpacing - //## - //## These virtual function allows a different beahiour in subclasses. - //## Do implement them in every subclass of BaseGeometry. If not needed, use - //## {Superclass::PreSetSpacing();}; + /** + * @brief PreSetSpacing + * + * These virtual function allows a different beahiour in subclasses. + * Do implement them in every subclass of BaseGeometry. If not needed, use + * \c Superclass::PreSetSpacing(). + */ void PreSetSpacing(const mitk::Vector3D &aSpacing) override { Superclass::PreSetSpacing(aSpacing); }; }; } // namespace mitk diff --git a/Modules/Core/include/mitkImage.h b/Modules/Core/include/mitkImage.h index cdbbe2b5a7b..fe8e646ebc2 100644 --- a/Modules/Core/include/mitkImage.h +++ b/Modules/Core/include/mitkImage.h @@ -46,29 +46,30 @@ namespace mitk class ImageStatisticsHolder; - //##Documentation - //## @brief Image class for storing images - //## - //## Can be asked for header information, the data vector, - //## the mitkIpPicDescriptor struct or vtkImageData objects. If not the complete - //## data is required, the appropriate SubImageSelector class should be used - //## for access. - //## Image organizes sets of slices (s x 2D), volumes (t x 3D) and channels (n - //## x ND). Channels are for different kind of data, e.g., morphology in - //## channel 0, velocities in channel 1. All channels must have the same Geometry! In - //## particular, the dimensions of all channels are the same, only the pixel-type - //## may differ between channels. - //## - //## For importing ITK images use of mitk::ITKImageImport is recommended, see - //## \ref Adaptor. - //## - //## For ITK v3.8 and older: Converting coordinates from the ITK physical - //## coordinate system (which does not support rotated images) to the MITK world - //## coordinate system should be performed via the BaseGeometry of the Image, see - //## BaseGeometry::WorldToItkPhysicalPoint. - //## - //## For more information, see \ref MitkImagePage . - //## @ingroup Data + /** + * @brief Image class for storing images + * + * Can be asked for header information, the data vector, + * the mitkIpPicDescriptor struct or vtkImageData objects. If not the complete + * data is required, the appropriate SubImageSelector class should be used + * for access. + * Image organizes sets of slices (s x 2D), volumes (t x 3D) and channels (n + * x ND). Channels are for different kind of data, e.g., morphology in + * channel 0, velocities in channel 1. All channels must have the same Geometry! In + * particular, the dimensions of all channels are the same, only the pixel-type + * may differ between channels. + * + * For importing ITK images use of mitk::ITKImageImport is recommended, see + * \ref Adaptor. + * + * For ITK v3.8 and older: Converting coordinates from the ITK physical + * coordinate system (which does not support rotated images) to the MITK world + * coordinate system should be performed via the BaseGeometry of the Image, see + * BaseGeometry::WorldToItkPhysicalPoint. + * + * For more information, see \ref MitkImagePage . + * @ingroup Data + */ class MITKCORE_EXPORT Image : public SlicedData { friend class SubImageSelector; @@ -87,48 +88,44 @@ namespace mitk itkCloneMacro(Self); - /** Smart Pointer type to a ImageDataItem. */ - typedef itk::SmartPointer ImageDataItemPointer; + /** Smart Pointer type to a ImageDataItem. */ + typedef itk::SmartPointer ImageDataItemPointer; typedef itk::Statistics::Histogram HistogramType; typedef mitk::ImageStatisticsHolder *StatisticsHolderPointer; - //## @param ImportMemoryManagementType This parameter is evaluated when setting new data to an image. - //## The different options are: - //## CopyMemory: Data to be set is copied and assigned to a new memory block. Data memory block will be freed on - // deletion of mitk::Image. - //## MamageMemory: Data to be set will be referenced, and Data memory block will be freed on deletion of - //mitk::Image. - //## Reference Memory: Data to be set will be referenced, but Data memory block will not be freed on deletion of - // mitk::Image. - //## DontManageMemory = ReferenceMemory. + /** This enum is evaluated when setting new data to an image. + */ enum ImportMemoryManagementType { - CopyMemory, - ManageMemory, - ReferenceMemory, + CopyMemory, /**< Data to be set is copied and assigned to a new memory block. Data memory block will be freed on deletion of mitk::Image. */ + ManageMemory, /**< Data to be set will be referenced, and Data memory block will be freed on deletion of mitk::Image. */ + ReferenceMemory, /**< Data to be set will be referenced, but Data memory block will not be freed on deletion of mitk::Image. */ DontManageMemory = ReferenceMemory }; - //##Documentation - //## @brief Vector container of SmartPointers to ImageDataItems; - //## Class is only for internal usage to allow convenient access to all slices over iterators; - //## See documentation of ImageDataItem for details. + /** + * @brief Vector container of SmartPointers to ImageDataItems; + * Class is only for internal usage to allow convenient access to all slices over iterators; + * See documentation of ImageDataItem for details. + */ typedef std::vector ImageDataItemPointerArray; public: - //##Documentation - //## @brief Returns the PixelType of channel @a n. + /** + * @brief Returns the PixelType of channel @a n. + */ const mitk::PixelType GetPixelType(int n = 0) const; - //##Documentation - //## @brief Get dimension of the image - //## + /** + * @brief Get dimension of the image + */ unsigned int GetDimension() const; - //##Documentation - //## @brief Get the size of dimension @a i (e.g., i=0 results in the number of pixels in x-direction). - //## - //## @sa GetDimensions() + /** + * @brief Get the size of dimension @a i (e.g., i=0 results in the number of pixels in x-direction). + * + * @sa GetDimensions() + */ unsigned int GetDimension(int i) const; /** @brief Get the data vector of the complete image, i.e., of all channels linked together. @@ -158,88 +155,90 @@ namespace mitk unsigned int timestep = 0, unsigned int component = 0); - //##Documentation - //## @brief Get a volume at a specific time @a t of channel @a n as a vtkImageData. + /** + * @brief Get a volume at a specific time @a t of channel @a n as a vtkImageData. + */ virtual vtkImageData *GetVtkImageData(int t = 0, int n = 0); virtual const vtkImageData *GetVtkImageData(int t = 0, int n = 0) const; - //##Documentation - //## @brief Get the complete image, i.e., all channels linked together, as a @a mitkIpPicDescriptor. - //## - //## If you only want to access a slice, volume at a specific time or single channel - //## use one of the SubImageSelector classes. - // virtual mitkIpPicDescriptor* GetPic(); - - //##Documentation - //## @brief Check whether slice @a s at time @a t in channel @a n is set + /** + * @brief Check whether slice @a s at time @a t in channel @a n is set + */ bool IsSliceSet(int s = 0, int t = 0, int n = 0) const override; - //##Documentation - //## @brief Check whether volume at time @a t in channel @a n is set + /** + * @brief Check whether volume at time @a t in channel @a n is set + */ bool IsVolumeSet(int t = 0, int n = 0) const override; - //##Documentation - //## @brief Check whether the channel @a n is set + /** + * @brief Check whether the channel @a n is set + */ bool IsChannelSet(int n = 0) const override; - //##Documentation - //## @brief Set @a data as slice @a s at time @a t in channel @a n. It is in - //## the responsibility of the caller to ensure that the data vector @a data - //## is really a slice (at least is not smaller than a slice), since there is - //## no chance to check this. - //## - //## The data is copied to an array managed by the image. If the image shall - //## reference the data, use SetImportSlice with ImportMemoryManagementType - //## set to ReferenceMemory. For importing ITK images use of mitk:: - //## ITKImageImport is recommended. - //## @sa SetPicSlice, SetImportSlice, SetImportVolume + /** + * @brief Set @a data as slice @a s at time @a t in channel @a n. It is in + * the responsibility of the caller to ensure that the data vector @a data + * is really a slice (at least is not smaller than a slice), since there is + * no chance to check this. + * + * The data is copied to an array managed by the image. If the image shall + * reference the data, use SetImportSlice with ImportMemoryManagementType + * set to ReferenceMemory. For importing ITK images use of mitk:: + * ITKImageImport is recommended. + * @sa SetPicSlice, SetImportSlice, SetImportVolume + */ virtual bool SetSlice(const void *data, int s = 0, int t = 0, int n = 0); - //##Documentation - //## @brief Set @a data as volume at time @a t in channel @a n. It is in - //## the responsibility of the caller to ensure that the data vector @a data - //## is really a volume (at least is not smaller than a volume), since there is - //## no chance to check this. - //## - //## The data is copied to an array managed by the image. If the image shall - //## reference the data, use SetImportVolume with ImportMemoryManagementType - //## set to ReferenceMemory. For importing ITK images use of mitk:: - //## ITKImageImport is recommended. - //## @sa SetPicVolume, SetImportVolume + /** + * @brief Set @a data as volume at time @a t in channel @a n. It is in + * the responsibility of the caller to ensure that the data vector @a data + * is really a volume (at least is not smaller than a volume), since there is + * no chance to check this. + * + * The data is copied to an array managed by the image. If the image shall + * reference the data, use SetImportVolume with ImportMemoryManagementType + * set to ReferenceMemory. For importing ITK images use of mitk:: + * ITKImageImport is recommended. + * @sa SetPicVolume, SetImportVolume + */ virtual bool SetVolume(const void *data, int t = 0, int n = 0); - //##Documentation - //## @brief Set @a data in channel @a n. It is in - //## the responsibility of the caller to ensure that the data vector @a data - //## is really a channel (at least is not smaller than a channel), since there is - //## no chance to check this. - //## - //## The data is copied to an array managed by the image. If the image shall - //## reference the data, use SetImportChannel with ImportMemoryManagementType - //## set to ReferenceMemory. For importing ITK images use of mitk:: - //## ITKImageImport is recommended. - //## @sa SetPicChannel, SetImportChannel + /** + * @brief Set @a data in channel @a n. It is in + * the responsibility of the caller to ensure that the data vector @a data + * is really a channel (at least is not smaller than a channel), since there is + * no chance to check this. + * + * The data is copied to an array managed by the image. If the image shall + * reference the data, use SetImportChannel with ImportMemoryManagementType + * set to ReferenceMemory. For importing ITK images use of mitk:: + * ITKImageImport is recommended. + * @sa SetPicChannel, SetImportChannel + */ virtual bool SetChannel(const void *data, int n = 0); - //##Documentation - //## @brief Set @a data as slice @a s at time @a t in channel @a n. It is in - //## the responsibility of the caller to ensure that the data vector @a data - //## is really a slice (at least is not smaller than a slice), since there is - //## no chance to check this. - //## - //## The data is managed according to the parameter \a importMemoryManagement. - //## @sa SetPicSlice + /** + * @brief Set @a data as slice @a s at time @a t in channel @a n. It is in + * the responsibility of the caller to ensure that the data vector @a data + * is really a slice (at least is not smaller than a slice), since there is + * no chance to check this. + * + * The data is managed according to the parameter \a importMemoryManagement. + * @sa SetPicSlice + */ virtual bool SetImportSlice( void *data, int s = 0, int t = 0, int n = 0, ImportMemoryManagementType importMemoryManagement = CopyMemory); - //##Documentation - //## @brief Set @a data as volume at time @a t in channel @a n. It is in - //## the responsibility of the caller to ensure that the data vector @a data - //## is really a volume (at least is not smaller than a volume), since there is - //## no chance to check this. - //## - //## The data is managed according to the parameter \a importMemoryManagement. - //## @sa SetPicVolume + /** + * @brief Set @a data as volume at time @a t in channel @a n. It is in + * the responsibility of the caller to ensure that the data vector @a data + * is really a volume (at least is not smaller than a volume), since there is + * no chance to check this. + * + * The data is managed according to the parameter \a importMemoryManagement. + * @sa SetPicVolume + */ virtual bool SetImportVolume(void *data, int t = 0, int n = 0, @@ -247,30 +246,36 @@ namespace mitk virtual bool SetImportVolume(const void *const_data, int t = 0, int n = 0); - //##Documentation - //## @brief Set @a data in channel @a n. It is in - //## the responsibility of the caller to ensure that the data vector @a data - //## is really a channel (at least is not smaller than a channel), since there is - //## no chance to check this. - //## - //## The data is managed according to the parameter \a importMemoryManagement. - //## @sa SetPicChannel + /** + * @brief Set @a data in channel @a n. It is in + * the responsibility of the caller to ensure that the data vector @a data + * is really a channel (at least is not smaller than a channel), since there is + * no chance to check this. + * + * The data is managed according to the parameter \a importMemoryManagement. + * @sa SetPicChannel + */ virtual bool SetImportChannel(void *data, int n = 0, ImportMemoryManagementType importMemoryManagement = CopyMemory); - //##Documentation - //## initialize new (or re-initialize) image information - //## @warning Initialize() by pic assumes a plane, evenly spaced geometry starting at (0,0,0). + /** + * initialize new (or re-initialize) image information + * @warning Initialize() by pic assumes a plane, evenly spaced geometry starting at (0,0,0). + */ virtual void Initialize(const mitk::PixelType &type, unsigned int dimension, const unsigned int *dimensions, unsigned int channels = 1); - //##Documentation - //## initialize new (or re-initialize) image information by a BaseGeometry - //## - //## @param tDim defines the number of time steps for which the Image should be initialized + /** + * initialize new (or re-initialize) image information by a BaseGeometry + * + * \param type + * \param geometry + * \param channels + * @param tDim defines the number of time steps for which the Image should be initialized + */ virtual void Initialize(const mitk::PixelType &type, const mitk::BaseGeometry &geometry, unsigned int channels = 1, @@ -279,7 +284,6 @@ namespace mitk /** * initialize new (or re-initialize) image information by a TimeGeometry * - * @param tDim defines the number of time steps for which the Image should be initialized * \deprecatedSince{2013_09} Please use TimeGeometry instead of TimeSlicedGeometry. For more information see * http://www.mitk.org/Development/Refactoring%20of%20the%20Geometry%20Classes%20-%20Part%201 */ @@ -293,6 +297,9 @@ namespace mitk /** * \brief Initialize new (or re-initialize) image information by a TimeGeometry * + * \param type + * \param geometry + * \param channels * \param tDim override time dimension if the value is bigger than 0 (Default -1) */ virtual void Initialize(const mitk::PixelType &type, @@ -300,15 +307,16 @@ namespace mitk unsigned int channels = 1, int tDim = -1); - //##Documentation - //## initialize new (or re-initialize) image information by a PlaneGeometry and number of slices - //## - //## Initializes the bounding box according to the width/height of the - //## PlaneGeometry and @a sDim via SlicedGeometry3D::InitializeEvenlySpaced. - //## The spacing is calculated from the PlaneGeometry. - //## \sa SlicedGeometry3D::InitializeEvenlySpaced - //## \deprecatedSince{2016_11} Use a left-handed or right-handed PlaneGeometry to define the - //## direction of the image stack instead of the flipped parameter + /** + * initialize new (or re-initialize) image information by a PlaneGeometry and number of slices + * + * Initializes the bounding box according to the width/height of the + * PlaneGeometry and @a sDim via SlicedGeometry3D::InitializeEvenlySpaced. + * The spacing is calculated from the PlaneGeometry. + * \sa SlicedGeometry3D::InitializeEvenlySpaced + * \deprecatedSince{2016_11} Use a left-handed or right-handed PlaneGeometry to define the + * direction of the image stack instead of the flipped parameter + */ DEPRECATED(virtual void Initialize(const mitk::PixelType &type, int sDim, const mitk::PlaneGeometry &geometry2d, @@ -322,46 +330,40 @@ namespace mitk unsigned int channels = 1, int tDim = 1); - //##Documentation - //## initialize new (or re-initialize) image information by another - //## mitk-image. - //## Only the header is used, not the data vector! - //## + /** + * initialize new (or re-initialize) image information by another + * mitk-image. + * Only the header is used, not the data vector! + */ virtual void Initialize(const mitk::Image *image); virtual void Initialize(const mitk::ImageDescriptor::Pointer inDesc); - //##Documentation - //## initialize new (or re-initialize) image information by @a pic. - //## Dimensions and @a Geometry3D /@a PlaneGeometry are set according - //## to the tags in @a pic. - //## Only the header is used, not the data vector! Use SetPicVolume(pic) - //## to set the data vector. - //## - //## @param tDim override time dimension (@a n[3]) in @a pic (if >0) - //## @param sDim override z-space dimension (@a n[2]) in @a pic (if >0) - //## @warning Initialize() by pic assumes a plane, evenly spaced geometry starting at (0,0,0). - // virtual void Initialize(const mitkIpPicDescriptor* pic, int channels = 1, int tDim = -1, int sDim = -1); - - //##Documentation - //## initialize new (or re-initialize) image information by @a vtkimagedata, - //## a vtk-image. - //## Only the header is used, not the data vector! Use - //## SetVolume(vtkimage->GetScalarPointer()) to set the data vector. - //## - //## @param tDim override time dimension in @a vtkimagedata (if >0 and <) - //## @param sDim override z-space dimension in @a vtkimagedata (if >0 and <) - //## @param pDim override y-space dimension in @a vtkimagedata (if >0 and <) + /** + * initialize new (or re-initialize) image information by @a vtkimagedata, + * a vtk-image. + * Only the header is used, not the data vector! Use + * SetVolume(vtkimage->GetScalarPointer()) to set the data vector. + * + * @param vtkimagedata + * @param channels + * @param tDim override time dimension in @a vtkimagedata (if >0 and <) + * @param sDim override z-space dimension in @a vtkimagedata (if >0 and <) + * @param pDim override y-space dimension in @a vtkimagedata (if >0 and <) + */ virtual void Initialize(vtkImageData *vtkimagedata, int channels = 1, int tDim = -1, int sDim = -1, int pDim = -1); - //##Documentation - //## initialize new (or re-initialize) image information by @a itkimage, - //## a templated itk-image. - //## Only the header is used, not the data vector! Use - //## SetVolume(itkimage->GetBufferPointer()) to set the data vector. - //## - //## @param tDim override time dimension in @a itkimage (if >0 and <) - //## @param sDim override z-space dimension in @a itkimage (if >0 and <) + /** + * initialize new (or re-initialize) image information by @a itkimage, + * a templated itk-image. + * Only the header is used, not the data vector! Use + * SetVolume(itkimage->GetBufferPointer()) to set the data vector. + * + * @param itkimage + * @param channels + * @param tDim override time dimension in @a itkimage (if >0 and <) + * @param sDim override z-space dimension in @a itkimage (if >0 and <) + */ template void InitializeByItk(const itkImageType *itkimage, int channels = 1, int tDim = -1, int sDim = -1) { @@ -498,31 +500,36 @@ namespace mitk this->Initialize(); } - //##Documentation - //## @brief Check whether slice @a s at time @a t in channel @a n is valid, i.e., - //## is (or can be) inside of the image + /** + * @brief Check whether slice @a s at time @a t in channel @a n is valid, i.e., + * is (or can be) inside of the image + */ virtual bool IsValidSlice(int s = 0, int t = 0, int n = 0) const; - //##Documentation - //## @brief Check whether volume at time @a t in channel @a n is valid, i.e., - //## is (or can be) inside of the image + /** + * @brief Check whether volume at time @a t in channel @a n is valid, i.e., + * is (or can be) inside of the image + */ virtual bool IsValidVolume(int t = 0, int n = 0) const; - //##Documentation - //## @brief Check whether the channel @a n is valid, i.e., - //## is (or can be) inside of the image + /** + * @brief Check whether the channel @a n is valid, i.e., + * is (or can be) inside of the image + */ virtual bool IsValidChannel(int n = 0) const; - //##Documentation - //## @brief Returns true if an image is rotated, i.e. its geometry's - //## transformation matrix has nonzero elements besides the diagonal. - //## Non-diagonal elements are checked if larger then 1/1000 of the matrix' trace. + /** + * @brief Returns true if an image is rotated, i.e. its geometry's + * transformation matrix has nonzero elements besides the diagonal. + * Non-diagonal elements are checked if larger then 1/1000 of the matrix' trace. + */ bool IsRotated() const; - //##Documentation - //## @brief Get the sizes of all dimensions as an integer-array. - //## - //## @sa GetDimension(int i); + /** + * @brief Get the sizes of all dimensions as an integer-array. + * + * @sa GetDimension(int i); + */ unsigned int *GetDimensions() const; ImageDescriptor::Pointer GetImageDescriptor() const { return m_ImageDescriptor; } @@ -680,7 +687,7 @@ namespace mitk void Clear() override; - //## @warning Has to be called by every Initialize method! + /** @warning Has to be called by every Initialize method! */ void Initialize() override; void PrintSelf(std::ostream &os, itk::Indent indent) const override; diff --git a/Modules/Core/include/mitkImagePixelAccessor.h b/Modules/Core/include/mitkImagePixelAccessor.h index 37565d4cc17..f15c77037fe 100644 --- a/Modules/Core/include/mitkImagePixelAccessor.h +++ b/Modules/Core/include/mitkImagePixelAccessor.h @@ -41,7 +41,10 @@ namespace mitk friend class Image; protected: - /** \param ImageDataItem* specifies the allocated image part */ + /** + * \param iP + * \param iDI specifies the allocated image part + */ ImagePixelAccessor(ImageConstPointer iP, const mitk::ImageDataItem *iDI) : m_ImageDataItem(iDI) { if (iDI == nullptr) diff --git a/Modules/Core/include/mitkImagePixelReadAccessor.h b/Modules/Core/include/mitkImagePixelReadAccessor.h index 5eb0a5ec6c5..a4e4d1ad67b 100644 --- a/Modules/Core/include/mitkImagePixelReadAccessor.h +++ b/Modules/Core/include/mitkImagePixelReadAccessor.h @@ -39,8 +39,8 @@ namespace mitk typedef itk::SmartPointer ImageConstPointer; /** \brief Instantiates a mitk::ImageReadAccessor (see its doxygen page for more details) - * \param Image::Pointer specifies the associated Image - * \param ImageDataItem* specifies the allocated image part + * \param iP specifies the associated Image + * \param iDI specifies the allocated image part * \param OptionFlags properties from mitk::ImageAccessorBase::Options can be chosen and assembled with bitwise * unification. * \throws mitk::Exception if the Constructor was created inappropriately diff --git a/Modules/Core/include/mitkImagePixelWriteAccessor.h b/Modules/Core/include/mitkImagePixelWriteAccessor.h index 40b0e50cd21..25b3b20943d 100644 --- a/Modules/Core/include/mitkImagePixelWriteAccessor.h +++ b/Modules/Core/include/mitkImagePixelWriteAccessor.h @@ -36,8 +36,8 @@ namespace mitk typedef itk::SmartPointer ImagePointer; /** \brief Instantiates a mitk::ImageWriteAccessor (see its doxygen page for more details) - * \param Image::Pointer specifies the associated Image - * \param ImageDataItem* specifies the allocated image part + * \param iP specifies the associated Image + * \param iDI specifies the allocated image part * \param OptionFlags properties from mitk::ImageAccessorBase::Options can be chosen and assembled with bitwise * unification. * \throws mitk::Exception if the Constructor was created inappropriately diff --git a/Modules/Core/include/mitkImageReadAccessor.h b/Modules/Core/include/mitkImageReadAccessor.h index db2409d4169..4cd1f303370 100644 --- a/Modules/Core/include/mitkImageReadAccessor.h +++ b/Modules/Core/include/mitkImageReadAccessor.h @@ -35,8 +35,8 @@ namespace mitk typedef itk::SmartPointer ImagePointer; /** \brief Orders read access for a slice, volume or 4D-Image - * \param Image::Pointer specifies the associated Image - * \param ImageDataItem* specifies the allocated image part + * \param image specifies the associated Image + * \param iDI specifies the allocated image part * \param OptionFlags properties from mitk::ImageAccessorBase::Options can be chosen and assembled with bitwise * unification. * \throws mitk::Exception if the Constructor was created inappropriately diff --git a/Modules/Core/include/mitkImageToSurfaceFilter.h b/Modules/Core/include/mitkImageToSurfaceFilter.h index 3a0b8eeab6d..01c0d93c22d 100644 --- a/Modules/Core/include/mitkImageToSurfaceFilter.h +++ b/Modules/Core/include/mitkImageToSurfaceFilter.h @@ -162,9 +162,7 @@ namespace mitk * Set desired TargetReduction of triangles in the range from 0.0 to 1.0. * The destroyed triangles are in relation with the size of data. For example 0.9 * will reduce the data set to 10%. - * - * @param Set a TargetReduction float-value from 0.0 to 1.0 - * */ + */ itkSetMacro(TargetReduction, float); /** diff --git a/Modules/Core/include/mitkImageVtkMapper2D.h b/Modules/Core/include/mitkImageVtkMapper2D.h index 537b81c12a0..2128a21b7c6 100644 --- a/Modules/Core/include/mitkImageVtkMapper2D.h +++ b/Modules/Core/include/mitkImageVtkMapper2D.h @@ -227,8 +227,6 @@ namespace mitk void TransformActor(mitk::BaseRenderer *renderer); /** \brief Generates a plane according to the size of the resliced image in milimeters. - * - * \image html texturedPlane.png * * In VTK a vtkPlaneSource is defined through three points. The origin and two * points defining the axes of the plane (see VTK documentation). The origin is diff --git a/Modules/Core/include/mitkImageVtkReadAccessor.h b/Modules/Core/include/mitkImageVtkReadAccessor.h index be0bd201a64..bf3207c890f 100644 --- a/Modules/Core/include/mitkImageVtkReadAccessor.h +++ b/Modules/Core/include/mitkImageVtkReadAccessor.h @@ -30,7 +30,9 @@ namespace mitk { public: /** \brief Creates an ImageVtkWriteAccessor for a whole Image - * \param Image::Pointer specifies the associated Image + * \param iP specifies the associated Image + * \param iDI + * \param imageDataVtk */ ImageVtkReadAccessor(ImageConstPointer iP, const ImageDataItem *iDI, const vtkImageData *imageDataVtk); diff --git a/Modules/Core/include/mitkImageVtkWriteAccessor.h b/Modules/Core/include/mitkImageVtkWriteAccessor.h index 80493b7231a..c71cfb220fa 100644 --- a/Modules/Core/include/mitkImageVtkWriteAccessor.h +++ b/Modules/Core/include/mitkImageVtkWriteAccessor.h @@ -32,7 +32,9 @@ namespace mitk typedef itk::SmartPointer ImagePointer; /** \brief Creates an ImageVtkWriteAccessor for a whole Image - * \param Image::Pointer specifies the associated Image + * \param iP specifies the associated Image + * \param iDI + * \param imageDataVtk */ ImageVtkWriteAccessor(ImagePointer iP, const ImageDataItem *iDI, vtkImageData *imageDataVtk); diff --git a/Modules/Core/include/mitkImageWriteAccessor.h b/Modules/Core/include/mitkImageWriteAccessor.h index b48e3f9d521..14eb2d0a2bd 100644 --- a/Modules/Core/include/mitkImageWriteAccessor.h +++ b/Modules/Core/include/mitkImageWriteAccessor.h @@ -31,8 +31,8 @@ namespace mitk typedef Image::Pointer ImagePointer; /** \brief Orders write access for a slice, volume or 4D-Image - * \param Image::Pointer specifies the associated Image - * \param ImageDataItem* specifies the allocated image part + * \param image specifies the associated Image + * \param iDI specifies the allocated image part * \param OptionFlags properties from mitk::ImageAccessorBase::Options can be chosen and assembled with bitwise * unification. * \throws mitk::Exception if the Constructor was created inappropriately diff --git a/Modules/DICOM/doc/images/tilt-correction.jpg b/Modules/DICOM/doc/images/tilt-correction.jpg deleted file mode 100644 index 46712f6c866502267b0f523dfcc88be7931872ff..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 22967 zcmbTd1z4NgvM`(qb;F7lcG2QR0>vw6v5h3b0vm?}DZ#x;u|R?1wu_UHPyz%eZSi15 z0)!CQxV!tuzUMpV?0fI|zkAQW@;-UzT{g4U%#xWk>umV!55T>bYMN?*3l}Z`Y|npy zGYa4Z;L^p5e?I5o^7%t^jfUp(WttmTuU@%!>&C5HH*eg$dHW9Cz1w$a@7%n3@BTen zdIm;D##?upnC~+%(=jkI{8`C`OXp=S(_E*axz2F==52<5JDhz3&|bTkapB<71unov z+6$LxFPt?29sn)?&Ph8b_aA}g%H^vUE?&BJ{XALi9^k^|3l}e6qM^BR@!FM3=h@Da zF4J70y-N2`oc@_UgVmeZQbsNb_b=DDpBsGdy)VhcBV}l9gYe*eVe~Ezr}{SA_Pidp za|Gu|{)*;r^;|tqRHQwRKSy$o0C0)s`k#cHC(>R%$M8&_oLTqWT7WX(#PA=j_$TmwkU7PJS@uh$xD5@lfg3w$ zq%K}mQvzDf8pcc5*;ZOf+l;r7ng`98gqy*aja1_ta#$nkz6rY3@Z&ahm)mt)!U|AgCLg7+TgmE3T4U6G_9T+bm?#DptLR` zcWX7M-!65V|9d^~_uP;6s(j+=gPT7L$|l<+EY5zv71q*n&Qj|M8*Xqe(stMC!|F1b zM-6q%&?ePrC?ek=P(_w0RY`llVQwuwnAXnv{S;GP-};jT`O8&qJ2Fe2UH;++of zmmXQ%9eNn0No$O)0QIgAbWdJpie4}3an-qt>3=kDisy`~IrZK=*jqVBT6qyYaIl0I zdch%@C>s&Zu*)*lwoO4T7nQx-QM%X{y`5M*Q(V0z&LROqRvh&Af*RC=GXteFnXr`o z0E1(Hody&+!R(1oaX-{4c~k3ZnRc8KOO7hFaJR$)wDr9EH><~7w_mFT9*majVjF2p_kJInr;Z_a!0D2~!D_xr@r-RXK!RW5ALZ7^?4TEl60 z|Cj9+xdPe^M(dd7CR;jbZqs(wVlu6wzLrR+o+zP+5WXC1lj|SCABF=e1-KeVLlv(V zB${aXH@B z@g(E84A^D)#Wj(6&Vi@c8F>oHpI4*wRlz&KJ&{FRVnGwGX8^@evR^*zm27~ipI)fJ z$yA<>&D%QaL`PppZ7WQy-6;O;=>2$K`)DJ*C!^7aj9Tg3eLixvw{N+gI#$AB`(LT+ zEjM(DEV^wP7mJQ_Da*tKab8Gr(JtMe5*xu^12zS6Rp<~G-W1#5g`Fp7fGhA+ z1FiwmN(Ry*9Km5{+36M-V>Ge3`y_lTMQ;-S6j*Zx$Q{w@b(g(TfbxaqdjCFD_x#6% zEBOp?{h3th^SKIm8&<_gXOC=zmq}fY+z&Q$3(aQ8Fh4hN_wzD{A?Sj>(6bNy|cHihz!2?>QL4p(US<3Fm9nxdI( zYZO<4!_Y7JMpIYfE6)HkW;YIBw#pnb>bz(p7qH1E?Wnf_936k@uOI`_7`3Bl|&>8K%mO3D{IOrjp{Z_V4Grq(}&{J4dqBU{F ze9)xt^~J*frQrTYwhLx`ep-IopTZKCw1|2C)GbK(3v#QQfsG<%cA)G#>OQ$Ty^9rYmQ!29@ z(8kL&c9T2LS}3!@)gpuR(vA5^@rvZ-;brr>#MJN=@Nn3gJv_-)tsrfvT_K#~jsv3l znq+ckMZtI)ixZb!k>Of>w3~!Sz|UQ;HKvkA?VYl5mJy3nGql7^J^e`S&6f%flAaYT zO&8bNw_bV(bDdeJLGc~&pD&c?lZ?`Yub&(g!$s#%x*d`d4CDu_!Hg;&Rm1mUP3V?*Y{1d1*`_k=9rOUFKTC*^`ac%u9Vgb zX4idIG(CrK+Z-l8&9w9nSz*UzWog|!H92-3jKp}&0M7s>y&K)(R2UJxx%lc-d?a_( z>`+SpYM4`P)`L5~M}CbMzma7=f!p18+N{=_tr#`;?8j1CBDwVg#9}~(ZUZTe8|pgt zE6rfMW@f)oY;4mmN|xB5VLaOk`ijC0hN@aD?)PdtZtse+iIj54q4{B}L-_mI*@p$X z@7q7GnJmIynb`PAZMK{NR+ILl_UcPZdjeuHFjp+-e7e&8Ivmjt5JYxws2a5PM52-=BIq)jvrLq*QM-$5))<-Dp?DDG&? z-&$k3rv_u!iRxA+FHRRUYjs9%EUk3m{Jb_FZ_nNp`B*Aw(bb-SDkdXS`6^btPxhW0 zCEL83on4w4Is-KAi{nJgiIO$(+;Jm7u(UP`i8vJeVpLQFbn)4omg+?C#}}EZ9)7}S zMw{YBofqb8kFc+o*b+7>x?!cnFcb+&V*0tPmHs~rjthNHQkZ18S-TyCGKgue4d^xb z*Z(N8Sx&YD+ke}R_Oi}(L%1Tnsf@w=g?yfz3hv6!bPBc`Qi?=E$2)9+G=8GPKBpel zdt{kS72TFU`uwe1Zps$9YR?ZUB;dQ~#Qk&h!!m;T@RN8`YPa00H9#Hu8Sn0nD>YCJ zU2`0J`w#zPaDKiVtB25vR!DG`9naEJ-)H_6Dfyvnv|7S9kO@)#LOG!2XqA->#hwSR z{z2jY3J4uExi0Q+$!pJq=Cc)yLinhQsZhoTQXWetJ9_Ms9fv*03=t7%*5!Ierb8OU zSV!47JDDX0MK+%!#sWF!d_ZIw&|V7Qa`$Th&;P}EAs2Ytd-@Cj!$>!S5C%;h5|zEd zoBWG~##LzhS&kpJDVWo5*tXt=#y=_+cg8ndr~zUI^&it##74>_cEuzGCQ?|}rcp(N zMLk$1n?#Ua;f~j=^i~Se*pXxdA`Wpg`3U;2^-l&}@wo+*s^?vJoJqI0k6WrBBO7(@ zrsowGkUSimY&XcJ;oTKE;NtFi3?iSxm1c`sAE)QL`~0^B?I8(cRAox^D#-#BdEjbt zS15v1Q-dGB6W^G-T(=Ckqx$-P)q8)-bSXDp{VsplZdpd#;Fc%_wX3q1L2US4;?s0Vx`1jw2x@|CA z!ZM4Uk;n1C;0XKdoOn-YKj{_}(Lrwe2S5Ko@Ba%B=W7O)#$x<6Vh5Khx*~LjymM*< z68}pFRYTkNBP;bkRGm4MM zD}pe)iV&x6Jt6&y`9g0ms0#!wI)z;!bJCTC#JXR0_Gfn}b3Q0qN+s=>MrU0D|L{8k zW)gViLt^-gQAy>yFKhTW)S6@UCh` z1D8;_9dMvjOSjp`-Zc}8jBSY4`T4CZzZ9a}-3ksl9pV4!B~8kdz*)8Tmz{#Dc+UXY zDwf$Py!OHDP76mil$(T9CLze8-x(lh{};U-;ry3r^(Iyzr58nAX!$9zE*OoDCmwWAD;PTiJW2Yyfmxum;HZ^EZMn6}w6{w5a!fGNz z-TZIXC2GL1a2)@vai@Z-Af8V)#Z>urnfAf>P|(;6)kw$=5B?1x{P*&gZe&_i91X#q zp86G4W71sPusXdmlFxa^zXJY4L;rg|0KhBIB>^>5!9iL*@9poUuUjbAcvHsA$R#>D z09SiJGs1#nVL>im`U&;8x4O%+SKDra^aKPoIDMXWoG5>zFze#*wGoLLIiKxjXsV5* zzCL_WOO&$jtTJ?p@>ovA(NHT(cl8x=KXic(?!S^&WXQlAl61&WGZRL;#{P_=(@8H? z%eNVv7(_xU+D3~CBW-Un}fRLU{9E!jBR-1230UueZ zKUyY480i60ax@-osYeX~*(0Zmsw1UYKfE_eOz@)(*is>#zC+d3^zUeGo&g|87tM&O z0b>Nnb{xmkH9k|F#a^6J*IQrWhK6_w4f=W&h`4n{e85^x+Rx|T+y{l~3|!@S@pt3=0MqW?b}Gs`%W#Z zX32pVb^f3wp;)CycF&rTk`l{DOVA*`@UGMMYj=&$^-8~2G(o9n09}o4+s^)(J!1F{ zzg4O{t+Yla*#_Y{RO+Luhlm@oi-w}B{wWH7vicHwY?xA;j?_KZ5551vdtVEDXOO@$ zu`u>Wt0J)>EG={PjvFI~2a_U;#r#wXE&HqwnUTpYnsOPsJOA+~^N`_p-lEtJw};%A z&N&}yN3W9EeVfn<)&aOaEv>YQ9(NqS>Z{gxmMFkw>_3qFOJJf)y+Xe&T6NRt@v@cp zZfX%waFc6qOlq|2f>~7kWKrCNYf^`}nay3O&nm{1Xe{na+;RrN7;b!IfOQ0DOO)%xb^wXXMo3188?B;3q~AvmF+EOLUI0B_0HbJf zlaa}%n%+xA@Bqu250~fD9Qg;-er^z(0Md8TQorFb=rsN<(Y${`j{Rq*HDMOIT8DJ8{7wuC%Iwtx{er=T8a~VWeik*)ezQ36# z^}4pYC7-j7c5| zw1sIX)V9i#2*+hLGFN~tvb{zzvPNvWKoI)vFP-|o1MkYy^ZIWRi#nrVwYFPi8AX70 zAWJjHFN;(gGI`|MD@W?9wV4K8C~O7V&mYHH9~JW}ijT>%1sxkx`4~xgV6IX`tqx~h8ArZ>D8*|)AKJWODZJ5t)@@e-M z%0hUb2h};YzBr|Zbr@LgqtNlQp*mVD+Dm3x{VB#`pib=#{nP22vxVY$&U zU27qblFFFdRd&M18UN0WL(2t+w<`gb(>)ASnG;GcRq1Lq*5MD`^l6{chL!6~WfNal zvo7WMYJSSk+7HHcfXL@cXm$LKeuIVPPVh}J2aBF)nf(eM;)K97TsQ95B6|mMzo2X> zBZy1C7sbP9$`{ZX8jRHw{X9SP;Z%$~j7J;qxz%u!0+x+=`VY6RgZ;8ejH|6|jEfXt zb$VfjURHSl(~~qG<2<5IPB#zv>Y%xHG#JRzzs9Zn;jYcQj<6a(s!(}6ItlXrhh+yk z+R|h%b{kt5l%by)qf1Ko4b4UuuvtoxH6f_+&zda`MrSzw{voU_8zzp_laSPq~64e76K9@mUjfx|V6| z_TU4P5GS*H3>r_!xzh+~IIbUb1{nCZ8}b~^*(3t|3`N^7)PrQmeL2Ck^pY*R`30An zodWz#^b(ApA+P9Wlx(_umpQ4X9aojmdQx1LcWz<-x5AC+^vq_AM^WYi=kf;6y^08e z7b7ji^B{2u$U%a~vXgWYm~fel?mG)w_QqV!2;-1&q4-)Vj&EsQMdDh-l&CoUo4)-M zsU?C#(^vdxheFi&Y7Tx=kIVR?>0G91iid*_iX*QZ7WBZ|{N02-{BjAk_dBOBiM)QS ziq?a%%H=TKf59oCW1*Y23oc0&^b_=_Q@byDTm3piXO5{{aiVIf3Q}5KF`#5#9ZHp5 zT!1-gyRtbbIKUORdd69PfBOR-bw9gSQ6X4O=>8XwdLyo)y)rl=yjo5xOHpCFL^NO8 zGUO>TFTd1ysm~l8jj5SAd|0T`ypn1 zNZUen<5dO7o8oETad`hXwcg&3w3vcr2ZtY|i>}w4oH)DK@54%tBk#DjrunKIx`A3@ zf%Och44Qtsdb;_IG>ROGyIws_Roz1d<1v;EE54~RrazPX{l5!~%kz%Rubcst<{UGc z{O=lhh_k32VmAc7K2xaWAY@vMF^_My?~-3YLB)mjMevvER`RHRT;$I6W`0tLsFwEZ zqx|vkha2?UVy`nwQX9(7ErK~p5P>~>Fj3pws$Ul&?X+z8rw|PVc%NK{{kZ^JAf(y5 zfQSP*Bex-IShL*j?#3U{E;Yd$VQWQ9KB~VV*pAe=a`w&upToB~lV|_Hoyh8?6Ph%^ zZKT@M9($HUx1%E3@fW}3_xw;4<6B~+DMZg%KqL>7&j9l%R#aqk_sqOth)9CZfLoxo zBIos_vLc68&c$)u_KoL`Cwf{KMN294aivhjJR)Idg#p4_tfr})uu%g%k!CxJU97US zF=N}w@~yoXR+D7fhv3Z+v*`1~XjzVXlvTxg=XV6Ww1Z1_b;2~lH@Rl`JrAQRcD)I= z3U=$>#xgNWZDn=HQS*jemO%mfN*cKzg87`_x@xUy=&t!aq2R&~l@S&U}cui?YYGFoSROR+O*#bXk~ z+BRERvocNVN;UaoJ;$lC2!d-evhBsIsIG<;5q1=RJUy?9Ap_EQ!vwv9sG4yVlC%J~ zC0gmk&PS54Dy!!F)fVVU+x}Mi86O^(fL_#|Ki|o~u29XKW+VD*G%OdFQcy zTSme)ifeZ@+G~~7|6t6dKln&*fj5g-cKt)G-^uUc7U7Exnp?x)f9|+|`#}%9)!SV? zO=e6UG;|}@Z~?W95%*?xR+F0={gB0rdwvqPgXeKPK?%yh;o-2b0TmT8J?^2XqK?AX z!4CF1Ia$Ev*XM-)H7LxMFote+(DSr+ zO^Of2=_t6Dbp#X4o?dWZ{%h<03PYZJFx9G2+i^_BX)5#Rz)jHv$zBD5M9al$T_+o2 zh4%o4;np#2DKqtiR$B4t&HpG%OCFtZQGDhy0zqtXv$pW91|;FQ{NJ1Lj5W9qu+&3S zYd;eq4b3hr({D(8vAt-E=%czcF^e=dw(A(Lom(K~^70zUy@MRvEa=ezVIJV zVrya&3mtTR1|qXxyIMp+1m?E%Fl7`p!fag4SNu5d=Y`W#qy}FSP!)9xhY#cLvUo0K zbVyJN*A8|_H+y45m5Pt{6TZX;A9t$q!)NEG2eV2-;^<25ZO=5RMv6gwRytARD7y7o zM-!EG>`;8jOal5uW66~5lDl*g6LjoUH&-W`&Z&BO&c);xpQLwOl~x1e7QR|L=CN(l zR7OU{U#EX3y!V>&$7pxIO!b!l>7QO6@Epx-MPp>ckEKmIb$68F4SX8+EZ?ZaMK=@@ zYTIo}fb!g5ra{L&z#e$b_40kzBx&898R!7A*Ec*S(5*Lw=H>~HZP9YlcEvn&wzNbd z=&nXpeW-5Y@AaC7gh;6OLA0YT|I7W7Uy27ObyM+S#U0N{D`mZ=MO)8J8-8ywQ!z#` z=8pG)&j1J?q&um<18=za=_**G-K>^447S9br8@WslM{zMPf5_*J*aTQ8C zV31~Yq4EfQ;A{eb2-_RN02jag-#RYLi8vOV0VMb|&sAo9y{EMJd9**|uAg)k3uxgC z;6y*Krq`$lln~?-eUx;N4T7C$J>_=nUT_-QZ|2iwu%?`LxSptPt}lzWvHgxn2q6P4 zo=d6Bx6^Wb7^dxDIc!J@`kcHzG7`_o-ECNvwwrl7X*SG#H?*cOD})JIGhnftVmi5c zRjh8C&70VhwVTU_?;%;&jD0S{`F$6Zy@QuWBCAQehT$~45?koHX3z|*PT@fX9nnm=w`IU3ReL8nV~i%KWc zMKf^~0~OM`WvLP2dk3G8Yq33O`3XW-&=rCXKSm&bXGhE7ToqSsI0Mk5Z6`%|p;IlE z*8Dm{u_4b0)s}h=6(5f9_kdf##IKl|k-lIq8A4gd_~z)OuHbO)so97dx8-S~$H`SG zz2b%Lqn-rkU-V5{po$Isyd&5xO*G0`6FljiRC#J)-*6gDB^dGh)(!P_;Po9Zd%3)b ztQzo?WyNuw0ff6wXFWYyCEVDN{{9vEnsAAv3LgN?>wh6E7x`(^wXs@aCd^?YlF}S* zK#;ZI+J=EK+R^wyPgeOhxTeLxHFBPsn)Ngv+?gAx0TBJOme)NF%Z8oS8=f}NX5OPE zv9{xmlWvnfdU5pAyb3%>lI*SGBQYuM5~vJSKP;^}h*CSR^Fe$(z!7lsUs3Tl!o+7< zNogT;mBz1o)>lx)+b^y)tZU4k0Sp9= z8Cn{}6xs7%##G0n8}gfJ{M+$wgRBV}Z<-eu)Nembm zCthhA(xC(PSc`$P*YM|?HR9EO>qzXMNC4NM(5&FpM!Drzxoes>Nah*JhU~pm!NbGK zN`q!2sy=`FQxc_@(VUQ@_3YM6-B25V?kC^^X-#8zPSzW4=mpw*Uik&yE^<@WWY3I6 zHbWVDs6HZnOuuLnU2J1xV|>1w93ZoXpRWTn&SS)7z~5GizYy?0f_*HfLQ5+$XbBLL z2H|0pGxp`CxHQQAM6MwC{c70MgB8s}t`^(vnRJ|uvrIQG=LCggBXT94n z^;gQuYjrua6VnSl!hho4GFfExPBm*caWP$-wpN@+?fv z#=B2?zVA0&)w>Nf_qUrFf-8t6xIBeL9*YMQ^HeFS#{Q6WNk}LFxt`V=HA5wvgbmXV z{i%3;`c>Qtm@w#h01lkVqBMfi3Iw%=b3329hG?+81j;${3E{rlX%%EotY6hBOVtxyaKrO?JVwI@e* zB4Z1uRd*IWZaboZX1BD%(IkDO$|1*V{s4R%Qaw++237a#^luvm{6aYhS<_k69$9x^ zMA1yIKge_~)7ZRr#Tpdvn&zB#K=)c|yL!`K3EnY%5cBK$b8Lt_I_TpFPv~c4nHe3{ zlE&T$GJjG&#MA-Pjqj zzN~53cxcC#ET%wwVADse(WI1&A8=mG`f%ij@*W@anE8V2$y7>vfA0R^i#b27yd8+O zfV6}RWqIA_xNS2ND$iUut6MC=rOAr(G9vpIxbxozG8*}m!j|qDow5nT&j4Q>2mEEp zksz!=yGipXw#gQLli-a}9k+9^w(nNU2kuN(*gxX=I^!I;h}?L9U#hGdvEg?}OX6%Y zk?zR~xfxX(u)*69|?#r={$qhn)OLH ztoeWwO7z}7h!5ZS4S`$b7tmRlUL>x4@w`emmZWxMYN_Qg?xlN2z^NMIB!&TPm(r)~ zJh#Y4HCn>t8VqvNc2!bpk1Izzv)By!P+edaP{3A8^kJ;Gr_#mAHBmlv(r8!12jo6{ z;`6zQMTR{pA#7K+1h(q|@iZ(o2)X%HaAh*Wzt(%5-@{uD`=%61TVBBdE_PXNPHIv) z_~fs6lVa!=b&4_ju77mNXuwUxMe{-E8Q`=A2|D;f?HL3yhs92ol%PCX&|AnX_18p-W^DQQWE_)fgy*>nnt8yt@b)u)0jQsF4Y4u15iikVB^S-o&>FT-8aQe z+@vIM;KS0kqC<{1J@(XZfT#cC1o@W?s*57BT82|u2Fs4SC16Em`Ui`V)49Ljv`I9! zlW1A7F%r9nUEi_!W@}~MMO-ntZ%>RGxqW`_wCCOOy`MET8q+w`_A@?}C5<3>%2$#q zfO=B5S3!Tk3 zm=mRV`W?XCWtZj>8uJKOs8=c@LsLI;)))-Rn2z(L$o8oI*tqd_<%(;<;2EI%qn$`s zVA3|Zdmr3HbDb;_^c?7!T<5hypc2pRZFe_z{o{S=b1__gHP>m|^d!czSXQ)@wB{d` zZrI1u2ly6eSa#P`(@)!hCc9H`sOUBkAO6o9)r6lJlMb|bAqIb3gQfP+1h`!l(We{| zk%w{m78s>5#<1M+b5A@?xMZs+ZgmepGiC@1Z9Vwf%75ab%Du9ntvEdr=;Ck&Sji5$ z{wu3ZQ6@)MDL5%K)sJeOvy453ZOTUO$d%m9euMg4#$u{_1_yaJV8KI|ULNEI>bU0qSNbIrOE|mRfx`w@ zehLO+=40Hyvn;N>J=n__eB-0?RKTxXHM42Nr%kK#!(^oh({Jke{SAZZ2WH9%`svy~ z*2>3*K!L~pB{~fn`9V7FuWM>mlhA~q+*oG98NiGlHh>Tm7sh&8;vgQm7VPAz?FAgwoaW0mVpneG`fiC|Fqn-k)@BN-=|#8QxATWzM{#$Enrw5|)n z@3qHW9W%+wU&mAnXwXTecKde96@M_;OiZkf? ztarAG8_vG>(37&b6cHbynmB%=^5Xr(@^7~K;0F88X?{E_st1Dcw*qW!ELyo!r>X2D zD&tLAkNzIrl}zbC=<5r~e;Gsn3G^MQreW^WqQl)6iVd5?wxQ6ths$8#F~?9$%X!0s z;;=nu0L;)lL-(jVUic3{m0yp%&@-MsF=6)#iU~Uxl5AG%ohn=jbo|s9;YMCJTEA}Ac-U-85lQk+t25cUCjxgg zx>cUf`e~Z7B>8dK44v|2$5w3Vw1T}mmhL@vzpHDE0H*lQqo;SkC%-0qltq3`YyO1h z3i&PxIn4AfpA}s4b7%#}DsFIzbw-pn>d43m1|>1T8r)G8!8t{zQkw)&oUDnUYiq^A zB58Ehfb)m;3u)6tF++stQL7atFq$yG#tS+hWw>7p;yDUuPjdpMwRiXfL%gOLeAijK zE<@RYdYzL{#ktJC7Hi3z$d?{AJ#2LJV+us?bh6|3W^m`9EZZReV zvCp`Xu8)Z=Y!k*JnIFUF#0M!|G>85CXudzskHur0k?O#<*%CWdDnlZ!gWMD=VZYhd zQvc_H`H!-KQXgha)&sDSMV9~ll5HM#7kNiOGWBU@%fGbwVUeTw*I=rAZHNE-x_-9!H z)y6M1;8HNv*ti2v%Vm>1psu7kPbJB(RC5=Ub~jlG7zU&taD~&ZB34nWONXo4W^8uT z_0Afv|E?FYbFCu&OGDNZkxplT&Ju>Kol*v5WzJV05ZD<6L2X-7&u8sVYD9DKjyglT z36A9Wti+G+y2gL_SI%20zuV>x0B7nw)L|pDNR$i^-pbktH7?loO%C;~&&i&9!CCr6 zE=X{F>GXZz_gqHUZ_&p*BTedMS{mSX?2~g9ukN65xowG9tjEL{Rf+R5&IeZq!+f=x zZk=2W!7d0rqV7Uo2nvc#TYi`4h!mj6A3btvM)f-5zmnzJXVDjH-C~pO-uE1hhH1LK zq?`c=AG#>pqI@DzcJcxHJ61`-=YDJ&i-^S@5}}>mGK>|`!M*>}43^z) zW09i6`C6pmHAc_pl+nVcw!R+uh+a8)V;HWK3X+vRq#M@e6_Jm6#~Fg)f~k^k|@c)}Z778mT)UvJ57!eaF?gb&EpKUW2&7Ka5UF_*8( zJdFLlOp}-Bat08=EJ&UKVk2j3mp?ReIt@93zs_e|$`8j0>#jB%sgi>hhO_OT2)wW4 zUirE4Xu8kMF`8Iy*>GMd9@!Ig!{jBh~xvKtL^rfqoDnXD(d_@+|A3d^%{S3p6(;>9!~G0AmPgS z3cz*Wi3jf*C9j)0rg0G$3gUbe4PCL`=N>T5Sr=6j~!2b^~eIfq>^S(aW zThM@?ou9_ye`ty5Oofk`kEhHu5eFQ4_juYZ%A#{F;+-4{S2DvQ@#Ar;PE@h%uYsD? za8AZLlG>21ck&UP2M==g2&-bKuvwP7x>t4Qs=Aq;D0djKQ+%!b)Mu~fYA>`~Pwr

|YYd-i@jc>pv;n-pQ5*v3cCM*Zo5iebDY}Uh5 zvOKV3STFy{RJ0t>>q9|Ykw3689hQ75w)Taa-c0%Egma%F-@O8J;mWj)r z;W(hOXcpafhYuWw1zM`?u}8wMMvM1y{Q7NGPn1HzGhM5GGKOK>qm*DvF%Q3V zW`R^xbqOwZaVh+2xsbk$T3HG`>OgeSA+_GgZW(a#>Hj3W|1F*I#3%nju_r10x$&<3 zFgSO?INZP&)e?yHn0cIFwvCcEoZ_-(=aekV3IO3E1Y%u+3dONn{DT9eS3gW0FP{Of>gUhs!c$&;%@#Xp0!f>40sr)=nGemMN=tJS|Gl)W zaIP!GHloJ}=IWB|;J^4|tthMAus7j^@G!Z%y*9(uE0o4)<)+f2%K=KP4gY{E{F68f z8yg#anQ0nV;GLP&sTkqme{FRAZ<6s}BW{`J@wVHz7-?of9m0EaOR?Sd3;20@xv|1) zpsyQ(9Uw!$jVKSpp+r^H!!M4b10{cq1!wBs96oV!=MM!UvACuXDzp-ISfC=}AHY)V zesIk!p7^tEs+Wh&1V%YJCnh^T}kjnUU{^WOJRuqSeKZY8x|l(Z&IYo+xtQWyJ?J@7h{oN|N%p#8gJS*EUB#hcD$ikse(qsP*AKR8|14Ue_t-KgARYDqSA0zhT$XIUgg?8ND z_|TS8yu=R=on^E4Q(ik?s~1iD_uGRvHg)TI{gY_r*BN&*mZ=9RokTHAcSK|_BeYVl z^XscUwT*tw3H>Z5>wKi4@1n5|DSV-3S1I=8*Srr|KOCYlGbVn9X>K|vcMbY=wVW|| z>Bk3FF+`VLi~t9A>b?lmNI6!XFMQ6zPIce=_EdgRt5Cd9Ym4*j8gEvuxnM&Ps;S7N{0Z4k2}o3S%0`^zu&Pja_;N$}vlxY{J5FDT2$%%94ObQ%*|KfhC%Tr67To#{hl%wj2LaNZ zFY6Vr?D}#D+JBAjGhHMMXF8FY zUYK!I-rRQi311H3kODvRc7=XL`DmsVmHw93^gt%oXg81~vqtgLCqTm!EjmSJYAqtK ziT~c-Umo_A^47?L*#4)Rk0x)@fAfm{uQT93zi+5BuJ3x(1S{CdEpe9&M_-?Y@lzv% zMp1+~rdRSsne+;-z>i@~gWsp%y+v%+Z?93<^ouH0bSh77eY@DF*$4Qm*Kbp4c#aFm zA|{d^;y4@lCsu1BZs}yX4_uXopKLb&gi(WEM&-tH0f*bs^49DyBfX>#zio{IWR22rx>{g~-*1grkQR;BESkIDUR|q8 z|NHc2g`3WY-SU~ko(kkcF;-v;kYe$(2f^?426B{HdfNAsq?WIxHN7C;VFA|%hK)j4Kkb7`@*MzMhjp-z}5V5Q?fjl5ivs7g@*~QJ2_>h40PJ0A)1B zIkAsmQ5YFP=kTu1wBz=1F&?Uj(DGtWdf7^?&$~Hi{^b>{XW$@T8eR zU3?VYTc+;_ZsFZ= z{Bij$d})1yUk}W8-bX(%0888uomEw_F|BnCr(l~c*u+G6zgm;pMuZ3t$IK+aK@{iI&0LK(tNoADcpirU1;h?M*u z(S1os$p+-W$QM%DKV95L_+UvgUn}TDtv8z3^0XN@+OxT@f<+<*U7ceB=o=PhHiXlk z6qZgD;L){MlQ`%}+YBt|a&6bh1ZJVyRk04-cvmbghBm6g+w%Km*p41FzSLsUqM$Ud z{LmP+`+_G956qa4h~+AQxXh}-lE{@grQ7G0?GgHE`)H{Q=5w15NM`j&e8>8adjzgh5kMX>1zQsC*TqDIndS$RdJ*G9Ws8;@o1v0&@f@cfb zwP3g1s)&c-O9+p*Ey6`6h(zB`|689O-!O%waKn`|d_dAP+gX8ecE-kH_S~q@;a|DI z72+YOx+Jy{xf!PpvMK_HToC|Kifi3EYyF%H)i%-5c$SrpfZ}f#&HlSU{ofeoy^^7p zLC@Vh=X(|UjH@d(*tR>Jum3-?Uqlx>!8keOeKk$w1NmQwuw)QhT?t60gGhbQK%IKC zlXE?ciE;6O_5n|n4&@RgTj+$=DAL;w?VfxZP_E&)Y_tyrswE_-meNDATq!72$v`Ui zE4hg1JTz~5AX?E|qjW$0{7zg!n$K!RK*nbEXz=aQnv*J&w5kz|xKe2lfQb=((p934 z#7I7$_0G4@psrLH?+;IVw_y;@g+;RtGUR#Ole7tlb%_vj8jul!ZF?gI@#4jklMmaP ztjB$(* zdrzQPgc59_MsN*>T3g!Ue-e<*q-wK_hrjK*r5pMwod2D$r{}i+lsxa7A8wTvb38Rq0f1{dpv)v1FbW(VKU!h+NtKPH z&j|7_`F>F(&du;Qz^ARCu$;sv8Qg5bX`ABaVRJ6ywp;Yw#GmcL(Q0Zf==7OQ6~WZ! z@mr9*flAsy%{@Df(R!{({KDF=c^z;bW7|$rjM#l~3$&}oppiA-JW>y6$yM(VQR5x@ z(jOwCrR$j0hE@<&LmegAuwAta4ALr0sOy3?Jfaem_1PG(H^F5Qv^*kU90r) zUXFsf5z`L*yqHF(J1kbDYt428tbB7j6rQKi^Dgd*<9qLa{#0p)9CPu(&bHe|`B$^f zR-4w!()y5t7)WxL46K3ov!nSIk_E^xIgOR))BZ9^1)xo;;TQXfZQaD(oQAL>8g$3R z+8i-W@R-=OyZGv`+D?wTSBaax(NNko)}L5fc`k$eP3u^7Vnku|v8d`=|Fp@-bbx-B zkq1adRhRf7BVNEI`ssz={ywq_V1x3&qOZQ*`5WS=R4au9Bs4YhpvYakFY0#PQaF83 zUT>}ze`*Djr(Ws@$<|EgHUQ1HzZd>b?~7?gRgh4UiKgqQ*L#!U;bm3!h{2bGrw{r^ z&0nwP``Q%ABGQ`S8uQ8J2qnQJjE+`PqFkALO6ksOX7HpxNpLSYs`Ro)sa%dNOqPB& z;I&QYlc^4V^|W8kr+q%P!KQFxl!^+BKfn2fj?*ML4}De?%}CMN5k_ z5@*yZ=)EkK4q|abTB7hoSs%DCgwgHSmfDqw(%~9>Vx7~?I%!#28N_Ns)=who5SLL@ z>cj056H`Pt&Dll>H_Tz%G8_t*#V8dg(FVWAuWkA!43BgpgpzvOG7fjdUnvNgv5GiO z3v1pQgyF>QCdhoW15w6FA!v8k#67hKLq51xZ6giEvJ9svrm=B2r^bG0#(PzIA@w@2>Uzxqt4T zz1H4q?LT|H``!C}-sgELL;x%YjiJ@CH2>%qj=c;`v}~NQm#$Z$!;@?=!o1uEI$4Ge zLmaRQylGQp9T(R+`lot8^qx7HVBm+MUa^0Z60#8>3Tos-A(pT2<{m0eF^bID>cb17 zW$*PBgiw1k%(f2qg@V*TZOxGGq`d>z`=UR+`QMb2C&D#?f`tGKGlwX! zOIfM6mQ+n}Y=nmwt-ruP-#=2j#usNi8PUKhs$1^xG2CMQ23=K{{(SYdRCp=yXuYx* z(IkfH%2xzp6p`}hdFV^BH17ztIdbB{1+sr2%xqdp8{B?<+AVw|xYlScapvmqhNYKf z;qCpHm%7SjKliR?G1V)29S6Uegv+9vaW(>(=u>UqB~FjT44`yG=M;Ya7X0qWeBE#k zaVM^A_hR!{C|J4~T#~f@K&U+XiOtY9HJ+)zeLD0as z*;=bKFxsfuzG^xeNuj-bp{l&4!8HH*yTqE?jxg8!Ah7)4@6Fk?=3Z}?ZW-gt3gAk* z=9_?q6PH-kOm!H3`;A>+pZ>3W*+I&bn_E(;L344bFq)Cl09&pw(2s~H)H<~r^4Zqx0lSy;kv3}wL-;YpL#R>Rpi z3Hv+$EBX9~iBjope!9u)j@kfD|EIfek-*S*?!bPPJ{dQ&c~ZTG{M8RxD9Z6_KBU-( zO4F=nKV$)J6uB*Yn^-y@%o9z=D2D2{tgO{5M^^7(w@hAL_1scSdRPCk{n+gJ&HQ+NkT}t;-6-cPBB^iRzNgdAK#%ax61itKiRx9h!G#@ys8^JL z^54qzM)Lp6(D|U(ByO`mXiM^m>$7oP{6s+)cyux(Q+Pk|rK4BYZ{?+9Y`%Zqk(SKLJN zXSp~g@`T=ZiKUpgiLwg9=AK~t&}klf|MbRo`az@^5tWfKQ`1U*_WU#V@9rRIYh7_& zXGl8Mf+c_q`yG1U+*yNtD`E6cxJWxtt^=+bcks9m-ri#hPpAVQ_n#&z4n-sNO|m3| zY(`N|B=kvZa3o+1(u|6qEbeO`p>b$lE?W~ZVYX%bVi9e51@E*7&7(y!!Cep}^Jhi+$^_vYP-dK6Co3s>dBTd`K)Bn{DCN2q9qd(23&dC;()(fN2|h zze3K*k+Vgb?#f~R{$1i&v8r?h7rOpSY&@V3Hd3ST)y~kFgMtE6v$phXPCVwFnSiBs z#DcY?^(iuQb0ePKRbf< zs%1+wBqlnqMnlCvxzQABS{hnsc)ng$;JVXb(E*o#)k+E4pKA?On=V;8-}sXF zq&dWc%NXnBXoyJf%z$e=(dh4dWNi;P!s1$jHbJd=wRgyiwDc@L%dmR9N3l3y1eF z{r(RviX*pc*^)^G_XICr>O-go+!Pz({ZM%X3B(n5w#;<$G>h9=@cQJa7Sn@x`E;04D=orE3uR_ z4n|0wO{3NN1z*L(DF|!ec*=0{oWzmiGR4EKaisMtuOu2#(8PZ0pjJ6=tWLLvb8UTM z@25V`!aElTL1di**TvC$*hp^v&7)^>z8XtDD9El01NsD#JFFIlakl0ZK6>1pZ*H5L zo10G{^^O{T?Bw{@@5dNc-q*WK##SDUo&TjfxYvc*CRRMu3g>UdcDbhrLrd;Pv&4*r zp*6pQMv)4!m2$#0hl%}n==Ai3eO$Ea$ajhDn%KXsCcR>~Z{r)PxcvRu*qRZ`f<|{g zqnhgvtNS=~s}fK2AxtE!fp@MUo4P*gNxmFx)kb}M43!elSJnXJhqpj&Z1$uq96>Mg8huW;(ZrR+pytAgp(4Ii zX}+zC9(`Ns7uAf+MZ;C!*bXuB0?h{jjAq2brQ=R$r|ZtJ&eCS23#R00I}e+p>vsRU zgq+Kr3S+}XS~X*LfvpduTpo&GO!mq%6=h**#brWNuF0shxua7LZ_ukjMR9z3Er) zW|M#{y`3+E{Mva5qes8~b4?E075K@V&m@|9Sbk~`oE?5|NewXNK6}*NINGBpWz^&@#ls4#l;VXRlL}~~$g%R>At@JQ_)&b2SocB|1)EhDxl}%8dZ8 z%-DY#GDhyAd|QU7hIm z=VZ@tpUF_VKCtPE%aH|XhKsy3O&;$Nq=&bw=A*RT=R*7_fce)>J4+t~KeP+MD`V%pg)cHhCkYENav4Un((ug*+Nz)Kfy)jSRz*aX2I0wb3t?QY38ZKmyz z^@J*{!4Fx`k7)A{@0Y?NCkB6M;Ra>2o>G}zqykgCtIvjel1#)R5-( z3(vF~$vjNCw@Y+Z4ied^)KRJ*(L*q?NTs2hTgo`U>BNjXEn9C8%A}9AE!kVWg2!Jz zO{STwxC$VvI?smDuqf<_T!TvKhpEygLS@trPjhFdTS-S`e#yGkRz5nmTA+JbWI zUIzIDL?v4|7GB}@T#U%9o*2mmge%PB-wV1SF?%Kh)8(LnW`8eI7R}h7CspI|EqG&E zI10s(;1HRTiyeWcW@rtO79w3>lz?~azUk6;BnVM5*5l!aNIC4eBf`=2!yu-t3e9ob zU-?E$00o+~lMYhMs5dRggT6PDk2i@>&nXxv-_ke}k>*OmJk0(IW zqQJ>ZOp}nX`J829#q7@uf4r0Q=}w9Nprq4N`(v2k8YLO>xh2?bxFccz^FP_|ug)=8W+OC@M`*xz+9ZpeIpE(V3a9-3z&^TF zByaf+{1&aD4?f+$t#;&&K~as%XTg>U*jyt1B?Ph^esl}EH(++V(at=_Y`o<;Zc=WsL0WKBVMB)W?v z5q8_cVGU%Aja-oUA>+z-iKk0%Mq`%_SBiU+IVb)c3jvMn#{Y4ZPZcvP8+7?GZ$Mf{ zfNWJB)AC3+igk$FKR$xLUJ)Cu{EOO4l96r26AvBa&20IG zq%{6id(ax5z|{ubx^{@xHa7U)zylC=|C(yVYvVTuYVt8khG};p^RXCBae7WtTh%uFS!>!tyCWNTol%~?O$ \endverbatim - The root-tag \i names the class to be instantiated, currently this can be one of + The root-tag \c \ names the class to be instantiated, currently this can be one of - DICOMITKSeriesGDCMReader - ThreeDnTDICOMSeriesReader @@ -62,8 +62,8 @@ namespace mitk 

group3DnT="true|false"
Determines whether images at the same spatial position should be interpreted as 3D+t images. - The tags and describe the basic loading strategy of both - reader mentioned above: first images are divided into incompatible groups (), + The tags \c \ and \c \ describe the basic loading strategy of both + reader mentioned above: first images are divided into incompatible groups (\c \), and afterwards the images within each group are sorted by means of DICOMSortCriterion, which most commonly mentions a tag. diff --git a/Modules/DICOM/src/legacy/mitkDicomSeriesReader.h b/Modules/DICOM/src/legacy/mitkDicomSeriesReader.h index 12e83265e88..3a780617e02 100644 --- a/Modules/DICOM/src/legacy/mitkDicomSeriesReader.h +++ b/Modules/DICOM/src/legacy/mitkDicomSeriesReader.h @@ -253,7 +253,7 @@ namespace mitk - red: the output of ITK ImageSeriesReader: wrong, larger spacing, no tilt - blue: how much a shear must correct - \image tilt-correction.jpg + \image html Modules/DICOM/doc/Doxygen/tilt-correction.jpg \section DicomSeriesReader_whatweknowaboutitk The actual image loading process @@ -558,6 +558,9 @@ namespace mitk \param filenames The filenames to load. \param sort Whether files should be sorted spatially (true) or not (false - maybe useful if presorted) \param load4D Whether to load the files as 3D+t (if possible) + \param correctGantryTilt + \param callback + \param preLoadedImageBlock */ static DataNode::Pointer LoadDicomSeries(const StringContainer &filenames, bool sort = true, @@ -569,8 +572,15 @@ namespace mitk /** \brief See LoadDicomSeries! Just a slightly different interface. - If \p preLoadedImageBlock is provided, the reader will only "fake" loading and create appropriate - mitk::Properties. + If \p preLoadedImageBlock is provided, the reader will only "fake" loading and create appropriate mitk::Properties. + + \param filenames + \param node + \param sort + \param load4D + \param correctGantryTilt + \param callback + \param preLoadedImageBlock */ static bool LoadDicomSeries(const StringContainer &filenames, DataNode &node, @@ -897,7 +907,11 @@ namespace mitk /** \brief Feed files into itk::ImageSeriesReader and retrieve a 3D MITK image. + \param correctTilt + \param tiltInfo + \param io \param command can be used for progress reporting + \param preLoadedImageBlock */ template static itk::SmartPointer LoadDICOMByITK(const StringContainer &, diff --git a/Modules/DICOMweb/include/mitkDICOMweb.h b/Modules/DICOMweb/include/mitkDICOMweb.h index ad34d512901..36643d4f6ad 100644 --- a/Modules/DICOMweb/include/mitkDICOMweb.h +++ b/Modules/DICOMweb/include/mitkDICOMweb.h @@ -59,7 +59,7 @@ namespace mitk * * @param filePath the path to a valid DICOM file which should be send * @param studyUID the DICOM study uid - * @param the task to wait for + * @return the task to wait for */ pplx::task SendSTOW(utility::string_t filePath, utility::string_t studyUID); diff --git a/Modules/DataTypesExt/include/mitkApplyDiffImageOperation.h b/Modules/DataTypesExt/include/mitkApplyDiffImageOperation.h index 884dbf7e124..ee25cbea9b0 100644 --- a/Modules/DataTypesExt/include/mitkApplyDiffImageOperation.h +++ b/Modules/DataTypesExt/include/mitkApplyDiffImageOperation.h @@ -55,6 +55,10 @@ namespace mitk public: /** Pass only 2D images here. + \param operationType + \param image + \param diffImage + \param timeStep \param sliceIndex brief Which slice to extract (first one has index 0). \param sliceDimension Number of the dimension which is constant for all pixels of the desired slice (e.g. 0 for axial) diff --git a/Modules/DataTypesExt/include/mitkCellOperation.h b/Modules/DataTypesExt/include/mitkCellOperation.h index 24c08df4b56..87aa1a48c00 100644 --- a/Modules/DataTypesExt/include/mitkCellOperation.h +++ b/Modules/DataTypesExt/include/mitkCellOperation.h @@ -31,10 +31,9 @@ namespace mitk //##Documentation //##@brief constructor //## - //## @param - //## operationType is the type of that operation (see mitkOperation.h; e.g. move or add; Information for - //StateMachine::ExecuteOperation()); - //## cellId: Id of the cell and a vector if needed + //## @param operationType is the type of that operation (see mitkOperation.h; e.g. move or add; Information for StateMachine::ExecuteOperation()); + //## @param cellId Id of the cell and a vector if needed + //## @param vector CellOperation(OperationType operationType, int cellId, Vector3D vector); CellOperation(OperationType operationType, int cellId); diff --git a/Modules/ImageStatistics/itkMultiGaussianImageSource.h b/Modules/ImageStatistics/itkMultiGaussianImageSource.h index 42e428a2abf..794809c8fc7 100644 --- a/Modules/ImageStatistics/itkMultiGaussianImageSource.h +++ b/Modules/ImageStatistics/itkMultiGaussianImageSource.h @@ -54,7 +54,7 @@ To serve as a test tool for ImageStatisticsCalculator, esp. the "hotspot search" \section Generation-of-a-multigauss-image Generation of a multigauss image -A multigauss function consists of the sum of \f$ N \f$ gauss function. The \f$ i \f$-th \linebreak (\f$0 \leq i \leq N \f$) gaussian is described with the following seven parameters (see above): +A multigauss function consists of the sum of \f$ N \f$ gauss function. The \f$ i \f$-th \n (\f$0 \leq i \leq N \f$) gaussian is described with the following seven parameters (see above): - \f$ x_0^{(i)} \f$ is the expectancy value in the \f$ x \f$-Axis - \f$ y_0^{(i)} \f$ is the expectancy value in the \f$ y \f$-Axis - \f$ z_0^{(i)} \f$ is the expectancy value in the \f$ z \f$-Axis diff --git a/Modules/ImageStatistics/mitkImageStatisticsContainerManager.h b/Modules/ImageStatistics/mitkImageStatisticsContainerManager.h index cab786019e2..88de6ebd048 100644 --- a/Modules/ImageStatistics/mitkImageStatisticsContainerManager.h +++ b/Modules/ImageStatistics/mitkImageStatisticsContainerManager.h @@ -43,6 +43,9 @@ namespace mitk @details if more than one StatisticsContainer is found, only the newest (ModifiedTime) is returned @pre Datastorage must point to a valid instance. @pre image must Point to a valid instance. + @param dataStorage + @param image + @param mask @param onlyIfUpToDate Indicates if results should only be returned if the are up to date, thus not older then image and ROI. @param noWIP If noWIP is true, the function only returns valid final result and not just its placeholder (WIP). If noWIP equals false it might also return a WIP, thus the valid result is currently processed/ordered but might not be ready yet. diff --git a/Modules/ImageStatistics/mitkIntensityProfile.h b/Modules/ImageStatistics/mitkIntensityProfile.h index 40600127267..1ecab74dfcd 100644 --- a/Modules/ImageStatistics/mitkIntensityProfile.h +++ b/Modules/ImageStatistics/mitkIntensityProfile.h @@ -84,6 +84,7 @@ namespace mitk /** \brief Compute global maximum of an intensity profile. * * \param[in] intensityProfile An intensity profile. + * \param[out] max The global maximum. * * \return Index of the global maximum. */ @@ -92,6 +93,7 @@ namespace mitk /** \brief Compute global minimum of an intensity profile. * * \param[in] intensityProfile An intensity profile. + * \param[out] min The global minimum. * * \return Index of the global minimum. */ diff --git a/Modules/MapperExt/include/mitkEnhancedPointSetVtkMapper3D.h b/Modules/MapperExt/include/mitkEnhancedPointSetVtkMapper3D.h index 20ac8bd42b6..dab5d786d07 100644 --- a/Modules/MapperExt/include/mitkEnhancedPointSetVtkMapper3D.h +++ b/Modules/MapperExt/include/mitkEnhancedPointSetVtkMapper3D.h @@ -55,7 +55,7 @@ namespace mitk * extended so that point representations are stored in a lookup table, * which is indexed by point data from the rendered PointSet. * - * \warn This mapper requires the PointData container to be the same size + * \warning This mapper requires the PointData container to be the same size * as the point container. * * \sa PointSetVtkMapper3D diff --git a/Modules/ModelFit/include/mitkFormulaParser.h b/Modules/ModelFit/include/mitkFormulaParser.h index fa1c4b92197..6e7eb93d2ac 100644 --- a/Modules/ModelFit/include/mitkFormulaParser.h +++ b/Modules/ModelFit/include/mitkFormulaParser.h @@ -35,7 +35,7 @@ namespace mitk /*! * @brief This class offers the functionality to evaluate simple mathematical formula * strings (e.g. "3.5 + 4 * x * sin(x) - 1 / 2"). - * @details Internally it utilizes the @c boost::spirit framework with the @ref Grammar + * @details Internally it utilizes the @c boost::spirit framework with the Grammar * structure to parse the input string into a valid result number. * Function strings (e.g. @c "sin", @c "tan" or @c "abs") are translated to * actual function calls and variables (e.g. @c "x", @c "myVariable", "amount_") diff --git a/Modules/ModelFit/include/mitkModelFitCmdAppsHelper.h b/Modules/ModelFit/include/mitkModelFitCmdAppsHelper.h index 5cc65983a5a..4d2cd049f27 100644 --- a/Modules/ModelFit/include/mitkModelFitCmdAppsHelper.h +++ b/Modules/ModelFit/include/mitkModelFitCmdAppsHelper.h @@ -32,12 +32,12 @@ namespace mitk /** Helper function that generates the file path that would be used to store an result image. The output path will be determined given the outputPathTemplate (which determines the directory, - the basic file name and the file formate). The output file name is: _.*/ + the basic file name and the file formate). The output file name is: \_\.\*/ MITKMODELFIT_EXPORT std::string generateModelFitResultImagePath(const std::string& outputPathTemplate, const std::string& parameterName); /** Helper function that takes the given image and stores it based on a template path. The real output path will be determined given the outputPathTemplate (which determines the directory, - the basic file name and the file formate). The output file name is: _.*/ + the basic file name and the file formate). The output file name is: \_\.\*/ MITKMODELFIT_EXPORT void storeParameterResultImage(const std::string& outputPathTemplate, const std::string& parameterName, mitk::Image* image, mitk::modelFit::Parameter::Type parameterType = mitk::modelFit::Parameter::ParameterType); /** Helper function that takes the given image, sets its properties according to the fit session and stores it. diff --git a/Modules/ModelFit/include/mitkModelFitParameterValueExtraction.h b/Modules/ModelFit/include/mitkModelFitParameterValueExtraction.h index 48d2f117739..6212b1a88f8 100644 --- a/Modules/ModelFit/include/mitkModelFitParameterValueExtraction.h +++ b/Modules/ModelFit/include/mitkModelFitParameterValueExtraction.h @@ -26,12 +26,18 @@ namespace mitk /** Helper function that gets the voxel value (as double) of an image (given an 3D position and a time step). Function is used in different contexts of model fit view. + @param image + @param position + @param timestep @param noThrow If set to false, function will throw exceptions. If set to true, exceptions will be blocked, an MITK_ERROR will be notified and the return is 0.0.*/ MITKMODELFIT_EXPORT ModelTraitsInterface::ParameterValueType ReadVoxel(const mitk::Image* image, const mitk::Point3D& position, unsigned int timestep = 0, bool noThrow = true); /** Helper function that gets the voxel value (as double) of an image (given an image index and a time step). Function is used in different contexts of model fit view. + @param image + @param index + @param timestep @param noThrow If set to false, function will throw exceptions.If set to true, exceptions will be blocked, an MITK_ERROR will be notified and the return is 0.0. */ MITKMODELFIT_EXPORT ModelTraitsInterface::ParameterValueType ReadVoxel(const mitk::Image* image, const ::itk::Index<3>& index, unsigned int timestep = 0, bool noThrow = true); diff --git a/Modules/ModelFit/include/mitkTimeGridHelper.h b/Modules/ModelFit/include/mitkTimeGridHelper.h index fba0b23e515..eb9c25150cf 100644 --- a/Modules/ModelFit/include/mitkTimeGridHelper.h +++ b/Modules/ModelFit/include/mitkTimeGridHelper.h @@ -28,6 +28,7 @@ namespace mitk MITKMODELFIT_EXPORT ModelBase::ModelResultType InterpolateSignalToNewTimeGrid(const ModelBase::ModelResultType& inputSignal, const ModelBase::TimeGridType& inputGrid, const ModelBase::TimeGridType& outputGrid); /** Super sample passed time grid by a given supersampling rate and interpolates linear in between original time steps. + * @param grid * @param samplingRate Defines how many samples should be generated between to original time steps (including the preceeding time step). E.g. a sampling rate of 1 will just returns the original grid untouched; a sampling rate of 3 will generate to aditional steps between to original steps.*/ MITKMODELFIT_EXPORT ModelBase::TimeGridType GenerateSupersampledTimeGrid(const mitk::ModelBase::TimeGridType& grid, const unsigned int samplingRate); diff --git a/Modules/OpenCVVideoSupport/Commands/mitkGrabCutOpenCVImageFilter.h b/Modules/OpenCVVideoSupport/Commands/mitkGrabCutOpenCVImageFilter.h index 774101d4591..361c0dad685 100644 --- a/Modules/OpenCVVideoSupport/Commands/mitkGrabCutOpenCVImageFilter.h +++ b/Modules/OpenCVVideoSupport/Commands/mitkGrabCutOpenCVImageFilter.h @@ -75,7 +75,7 @@ class MITKOPENCVVIDEOSUPPORT_EXPORT GrabCutOpenCVImageFilter : public AbstractOp * in this method. Instead a worker thread is waken up every time this method is called, * if foreground model points were set before. * - * \param OpenCV image to be segmentated + * \param image OpenCV image to be segmentated * \return false if an empty image was set, true otherwise */ bool OnFilterImage( cv::Mat& image ) override; diff --git a/Modules/OpenIGTLink/mitkIGTLMeasurements.h b/Modules/OpenIGTLink/mitkIGTLMeasurements.h index 598ea28a6f5..82b24b6cfd4 100644 --- a/Modules/OpenIGTLink/mitkIGTLMeasurements.h +++ b/Modules/OpenIGTLink/mitkIGTLMeasurements.h @@ -23,48 +23,6 @@ found in the LICENSE file. namespace mitk { - ///** - //* \brief Is a helper class to make measurments for latency and fps - //* - //* \ingroup OpenIGTLink - //*/ - //class MITKOPENIGTLINK_EXPORT IGTLMeasurementsImplementation : public itk::Object - //{ - //public: - // mitkClassMacroItkParent(IGTLMeasurementsImplementation, itk::Object); - // itkFactorylessNewMacro(Self) - // itkCloneMacro(Self) - - // typedef std::list MeasurementList; - // typedef std::map MeasurementPoints; - - // /** - // * \brief AddMeasurementPoint - // */ - // void AddMeasurement(unsigned int measurementPoint); - // bool ExportData(std::string filename); - - // /** - // * \brief clears all measurements - // */ - // void Reset(); - - // void SetStarted(bool started); - - // void RegisterAsMicroservice(); - // void UnRegisterMicroservice(); - //protected: - // IGTLMeasurementsImplementation(); - // ~IGTLMeasurementsImplementation(); - - // /** \brief */ - // MeasurementPoints m_MeasurementPoints; - - // bool m_IsStarted; - - // us::ServiceRegistration m_ServiceRegistration; - //}; - /** * \brief Is a helper class to make measurments for latency and fps * @@ -78,6 +36,8 @@ namespace mitk { /** * \brief AddMeasurementPoint + * \param measurementPoint + * \param index * \param timestamp Sets the timestamp, if it is 0 the current system time is used. */ void AddMeasurement(unsigned int measurementPoint, unsigned int index, long long timestamp = 0); diff --git a/Modules/RT/include/mitkDoseImageVtkMapper2D.h b/Modules/RT/include/mitkDoseImageVtkMapper2D.h index cb0f7bbdede..e376d228a16 100644 --- a/Modules/RT/include/mitkDoseImageVtkMapper2D.h +++ b/Modules/RT/include/mitkDoseImageVtkMapper2D.h @@ -45,10 +45,6 @@ namespace mitk { /** \brief Mapper to resample and display 2D slices of a 3D image. * - * The following image gives a brief overview of the mapping and the involved parts. - * - * \image html DoseImageVtkMapper2Darchitecture.png - * * First, the image is resliced by means of vtkImageReslice. The volume image * serves as input to the mapper in addition to spatial placement of the slice and a few other * properties such as thick slices. This code was already present in the old version @@ -216,8 +212,6 @@ namespace mitk { /** \brief Generates a plane according to the size of the resliced image in milimeters. * - * \image html texturedPlane.png - * * In VTK a vtkPlaneSource is defined through three points. The origin and two * points defining the axes of the plane (see VTK documentation). The origin is * set to (xMin; yMin; Z), where xMin and yMin are the minimal bounds of the diff --git a/Modules/Segmentation/Algorithms/mitkContourUtils.h b/Modules/Segmentation/Algorithms/mitkContourUtils.h index d9add259f2a..3040e042fa3 100644 --- a/Modules/Segmentation/Algorithms/mitkContourUtils.h +++ b/Modules/Segmentation/Algorithms/mitkContourUtils.h @@ -36,8 +36,11 @@ namespace mitk /** \brief Projects a contour onto an image point by point. Converts from world to index coordinates. + \param slice + \param contourIn3D \param correctionForIpSegmentation adds 0.5 to x and y index coordinates (difference between ipSegmentation and MITK contours) + \param constrainToInside */ ContourModel::Pointer ProjectContourTo2DSlice(Image *slice, Contour *contourIn3D, diff --git a/Modules/Segmentation/Algorithms/mitkImageLiveWireContourModelFilter.h b/Modules/Segmentation/Algorithms/mitkImageLiveWireContourModelFilter.h index e2fd65b0380..1b923b58b27 100644 --- a/Modules/Segmentation/Algorithms/mitkImageLiveWireContourModelFilter.h +++ b/Modules/Segmentation/Algorithms/mitkImageLiveWireContourModelFilter.h @@ -36,7 +36,7 @@ namespace mitk \sa ShortestPathCostFunctionLiveWire The filter is able to create dynamic cost tranfer map and thus use on the fly training. - \Note On the fly training will only be used for next update. + \note On the fly training will only be used for next update. The computation uses the last calculated segment to map cost according to features in the area of the segment. For time resolved purposes use ImageLiveWireContourModelFilter::SetTimestep( unsigned int ) to create the LiveWire @@ -71,7 +71,7 @@ namespace mitk itkGetMacro(EndPoint, mitk::Point3D); /** \brief Create dynamic cost tranfer map - use on the fly training. - \Note On the fly training will be used for next update only. + \note On the fly training will be used for next update only. The computation uses the last calculated segment to map cost according to features in the area of the segment. */ itkSetMacro(UseDynamicCostMap, bool); diff --git a/Modules/Segmentation/Interactions/mitkFeedbackContourTool.h b/Modules/Segmentation/Interactions/mitkFeedbackContourTool.h index f7525aeac67..945c4911fd5 100644 --- a/Modules/Segmentation/Interactions/mitkFeedbackContourTool.h +++ b/Modules/Segmentation/Interactions/mitkFeedbackContourTool.h @@ -72,8 +72,11 @@ namespace mitk /** \brief Projects a contour onto an image point by point. Converts from world to index coordinates. + \param slice + \param contourIn3D \param correctionForIpSegmentation adds 0.5 to x and y index coordinates (difference between ipSegmentation and MITK contours) + \param constrainToInside */ ContourModel::Pointer ProjectContourTo2DSlice(Image *slice, ContourModel *contourIn3D, @@ -83,6 +86,8 @@ namespace mitk /** \brief Projects a slice index coordinates of a contour back into world coordinates. + \param sliceGeometry + \param contourIn2D \param correctionForIpSegmentation subtracts 0.5 to x and y index coordinates (difference between ipSegmentation and MITK contours) */ diff --git a/Modules/SemanticRelations/include/mitkControlPointManager.h b/Modules/SemanticRelations/include/mitkControlPointManager.h index 601ca9c945c..3e13e89dc9e 100644 --- a/Modules/SemanticRelations/include/mitkControlPointManager.h +++ b/Modules/SemanticRelations/include/mitkControlPointManager.h @@ -99,7 +99,7 @@ namespace mitk * If such a control point is found, the 'FindFittingExaminationPeriod'-function with this control point as an argument is used * to actually find the corresponding examination period. * - * @param datanode A data node pointer, whose date should be included in the newly generated control point. + * @param dataNode A data node pointer, whose date should be included in the newly generated control point. * * @return The examination period that contains the given data node. */ diff --git a/Modules/US/USFilters/mitkIGTLMessageToUSImageFilter.h b/Modules/US/USFilters/mitkIGTLMessageToUSImageFilter.h index dfcb9c71ed7..d5419912a76 100644 --- a/Modules/US/USFilters/mitkIGTLMessageToUSImageFilter.h +++ b/Modules/US/USFilters/mitkIGTLMessageToUSImageFilter.h @@ -55,7 +55,7 @@ namespace mitk /** * \brief Copies the data from the next OIGTL message to an mitk::Image. * - * \param img the image to fill with the data from the OIGTL message. + * \param imgVector the image to fill with the data from the OIGTL message. */ void GetNextRawImage(std::vector& imgVector) override; diff --git a/Plugins/org.blueberry.core.jobs/src/berryISchedulingRule.h b/Plugins/org.blueberry.core.jobs/src/berryISchedulingRule.h index 97cd93d78e0..f3c41cd46a4 100644 --- a/Plugins/org.blueberry.core.jobs/src/berryISchedulingRule.h +++ b/Plugins/org.blueberry.core.jobs/src/berryISchedulingRule.h @@ -76,7 +76,7 @@ struct BERRY_JOBS ISchedulingRule: public Object * and must return false when compared to a rule they know * nothing about. * - * @param rule the rule to check for conflicts + * @param myRule the rule to check for conflicts * @return true if the rule is conflicting, and false * otherwise. */ diff --git a/Plugins/org.mitk.core.ext/src/mitkIInputDevice.h b/Plugins/org.mitk.core.ext/src/mitkIInputDevice.h index aacf2b80936..b690331cf9d 100644 --- a/Plugins/org.mitk.core.ext/src/mitkIInputDevice.h +++ b/Plugins/org.mitk.core.ext/src/mitkIInputDevice.h @@ -24,7 +24,7 @@ namespace mitk * An input device provides a method to register and unregister itself. Meaning
* for example adding listeners and instianciate classes necessary to use the input device. * - * @noimplement This interface is not intended to be implemented by clients. + * @note This interface is not intended to be implemented by clients. * @ingroup org_mitk_core_ext */ struct IInputDevice : public berry::Object diff --git a/Plugins/org.mitk.core.ext/src/mitkIInputDeviceRegistry.h b/Plugins/org.mitk.core.ext/src/mitkIInputDeviceRegistry.h index 6606d54f905..820c1625825 100644 --- a/Plugins/org.mitk.core.ext/src/mitkIInputDeviceRegistry.h +++ b/Plugins/org.mitk.core.ext/src/mitkIInputDeviceRegistry.h @@ -31,7 +31,7 @@ namespace mitk *

* * @see mitk::IInputDeviceDescriptor - * @noimplement This interface is not intended to be implemented by clients. + * @note This interface is not intended to be implemented by clients. * @ingroup org_mitk_core_ext */ struct IInputDeviceRegistry diff --git a/Utilities/mbilog/mbilogBackendCout.h b/Utilities/mbilog/mbilogBackendCout.h index e4d290980d3..daba4f6645e 100644 --- a/Utilities/mbilog/mbilogBackendCout.h +++ b/Utilities/mbilog/mbilogBackendCout.h @@ -37,7 +37,7 @@ namespace mbilog * the mbi logging mechanism and a logging message is emitted. The method formats the * logging messages to a normal string (depending on formatting mode) and writes it to std::cout. * - * \param logMessage Logging message. + * \param l Logging message. */ void ProcessMessage(const mbilog::LogMessage &l) override; diff --git a/Utilities/mbilog/mbilogTextBackendBase.h b/Utilities/mbilog/mbilogTextBackendBase.h index be4e072b088..46a4e9bd777 100644 --- a/Utilities/mbilog/mbilogTextBackendBase.h +++ b/Utilities/mbilog/mbilogTextBackendBase.h @@ -40,21 +40,27 @@ namespace mbilog protected: /** \brief Method formats the given LogMessage in the smart/short format and writes it to std::cout. + * \param l * \param threadID Can be set to the threadID where the logging message was emitted. Is 0 by default. */ void FormatSmart(const LogMessage &l, int threadID = 0); /** \brief Method formats the given LogMessage in the full/long format and writes it to std::cout. + * \param l * \param threadID Can be set to the threadID where the logging message was emitted. Is 0 by default. */ void FormatFull(const LogMessage &l, int threadID = 0); /** \brief Method formats the given LogMessage in the smart/short format and writes it to the given std::ostream. + * \param out + * \param l * \param threadID Can be set to the threadID where the logging message was emitted. Is 0 by default. */ void FormatSmart(std::ostream &out, const LogMessage &l, int threadID = 0); /** \brief Method formats the given LogMessage in the full/long format and writes it to the given std::ostream. + * \param out + * \param l * \param threadID Can be set to the threadID where the logging message was emitted. Is 0 by default. */ void FormatFull(std::ostream &out, const LogMessage &l, int threadID = 0);