Introducing Author and ProcessorState fields to AbstractProcessor

core/pipeline/abstractprocessor.h

@@ -69,6 +69,13 @@ namespace campvis {
             INVALID_PROPERTIES  = 1 << 3    ///< Need to update the properties
         };
 
+        /// Current state of a processor in terms of stability.
+        enum ProcessorState {
+            EXPERIMENTAL,
+            TESTING,
+            STABLE
+        };
+
         /**
          * Creates a AbstractProcessor.
          */
@@ -112,6 +119,18 @@ namespace campvis {
          */
         virtual const std::string getDescription() const = 0;
 
+        /**
+         * Gets the name of the author of this processor. Can be handy if you have questions on how to do XYZ with this processor.
+         * \return  The name of the author of this processor.
+         */
+        virtual const std::string getAuthor() const = 0;
+
+        /**
+         * Gets the current processor state in terms of stability. To be defined by every subclass.
+         * \return  The current processor state in terms of stability.
+         */
+        virtual const ProcessorState getProcessorState() const = 0;
+
         /**
          * Gets the flag whether this processor is currently enabled.
          * \return _enabled

modules/advancedusvis/processors/advancedusfusion.h

@@ -72,6 +72,10 @@ namespace campvis {
         virtual const std::string getName() const { return "AdvancedUsFusion"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Extracts a single slice from the input image and renders it using a transfer function."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::EXPERIMENTAL; };
 
         /// \see AbstractProcessor::process()
         virtual void process(DataContainer& data);

modules/columbia/processors/geometrystrainrenderer.h

@@ -69,6 +69,10 @@ namespace campvis {
         virtual const std::string getName() const { return "GeometryStrainRenderer"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Renders Geometry."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::EXPERIMENTAL; };
 
         virtual void process(DataContainer& data);
 

modules/columbia/processors/imageseriessplitter.h

@@ -61,6 +61,10 @@ namespace campvis {
         virtual const std::string getName() const { return "ImageSeriesSplitter"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Splits an ImageSeries into its single images."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::EXPERIMENTAL; };
 
         DataNameProperty p_inputID;   ///< image ID for input image series
         DataNameProperty p_outputID;   ///< image ID for output image

modules/columbia/processors/strainfiberrenderer.h

@@ -76,6 +76,10 @@ namespace campvis {
         virtual const std::string getName() const { return "StrainFiberRenderer"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Renders Strain Fibers"; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::EXPERIMENTAL; };
 
         virtual void process(DataContainer& data);
 

modules/columbia/processors/strainfibertracker.h

@@ -66,6 +66,10 @@ namespace campvis {
         virtual const std::string getName() const { return "StrainFiberTracker"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Performs a fiber tracking of incomoing strain data."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::EXPERIMENTAL; };
 
         DataNameProperty p_strainId;   ///< image ID for input strain data
         DataNameProperty p_outputID;   ///< image ID for output fiber data

modules/columbia/processors/strainraycaster.h

@@ -61,6 +61,10 @@ namespace campvis {
         virtual const std::string getName() const { return "StrainRaycaster"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Performs a simple volume ray casting."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::EXPERIMENTAL; };
 
         DataNameProperty p_targetImageID;    ///< image ID for output image
         BoolProperty p_enableShadowing;

modules/devil/processors/devilimagereader.h

@@ -78,6 +78,10 @@ namespace campvis {
         virtual const std::string getName() const { return "DevilImageReader"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Reads an image file into the pipeline using the DevIL library."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::EXPERIMENTAL; };
 
         StringProperty p_url;               ///< URL for file to read
         DataNameProperty p_targetImageID;   ///< image ID for read image

modules/io/processors/csvdimagereader.h

@@ -64,6 +64,10 @@ namespace campvis {
         virtual const std::string getName() const { return "CsvdImageReader"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Reads a CSVD to read multiple CSV image files into the pipeline."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::EXPERIMENTAL; };
 
         StringProperty p_url;               ///< URL for file to read
         DataNameProperty p_targetImageID;   ///< image ID for read image

modules/io/processors/ltfimagereader.h

@@ -64,6 +64,10 @@ namespace campvis {
         virtual const std::string getName() const { return "LtfImageReader"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Reads a series of raw images into the pipeline."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::EXPERIMENTAL; };
 
         StringProperty p_url;               ///< URL for file to read
         IVec3Property p_size;               ///< Image size

modules/io/processors/mhdimagereader.h

@@ -65,6 +65,10 @@ namespace campvis {
         virtual const std::string getName() const { return "MhdImageReader"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Reads an MHD image into the pipeline."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::TESTING; };
 
         StringProperty p_url;               ///< URL for file to read
         DataNameProperty p_targetImageID;   ///< image ID for read image

modules/io/processors/rawimagereader.h

@@ -66,6 +66,10 @@ namespace campvis {
         virtual const std::string getName() const { return "RawImageReader"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Reads raw images into the pipeline."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::EXPERIMENTAL; };
 
         StringProperty p_url;               ///< URL for file to read
         IVec3Property p_size;               ///< Image size

modules/io/processors/vtkimagereader.h

@@ -65,7 +65,11 @@ namespace campvis {
         /// \see AbstractProcessor::getName()
         virtual const std::string getName() const { return "VtkImageReader"; };
         /// \see AbstractProcessor::getDescription()
-        virtual const std::string getDescription() const { return "Reads an MHD image into the pipeline."; };
+        virtual const std::string getDescription() const { return "Reads a VTK image into the pipeline."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::EXPERIMENTAL; };
 
         StringProperty p_url;               ///< URL for file to read
         DataNameProperty p_targetImageID;   ///< image ID for read image

modules/itk/processors/itkimagefilter.h

@@ -60,6 +60,10 @@ namespace campvis {
         virtual const std::string getName() const { return "ItkImageFilter"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Creates the gradient volume for the given intensity volume."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::TESTING; };
 
         virtual void process(DataContainer& data);
 

modules/itk/processors/itkimagefilterkernel.h

@@ -60,6 +60,10 @@ namespace campvis {
         virtual const std::string getName() const { return "ItkImageFilterKernel"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Creates the gradient volume for the given intensity volume."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::EXPERIMENTAL; };
 
         virtual void process(DataContainer& data);
 

modules/opencl/processors/clraycaster.h

@@ -74,6 +74,10 @@ namespace campvis {
         virtual const std::string getName() const { return "CLRaycaster"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Proof of concept processor for OpenCL based Volume raycasting."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::EXPERIMENTAL; };
 
         /**
          * Initalizes the Processor, loads and builds the shader.

modules/preprocessing/processors/gradientvolumegenerator.h

@@ -59,6 +59,10 @@ namespace campvis {
         virtual const std::string getName() const { return "GradientVolumeGenerator"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Creates the gradient volume for the given intensity volume."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::EXPERIMENTAL; };
 
         virtual void process(DataContainer& data);
 

modules/preprocessing/processors/imagefilter.h

@@ -60,6 +60,10 @@ namespace campvis {
         virtual const std::string getName() const { return "ImageFilter"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Creates the gradient volume for the given intensity volume."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::EXPERIMENTAL; };
 
         virtual void process(DataContainer& data);
 

modules/preprocessing/processors/lhhistogram.h

@@ -59,6 +59,10 @@ namespace campvis {
         virtual const std::string getName() const { return "LHHistogram"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Creates Lookup volumes vor generation LH-Histograms of volumes as well as the LH histogram."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::EXPERIMENTAL; };
 
         virtual void process(DataContainer& data);
 

modules/randomwalk/processors/confidencemapgenerator.h

@@ -56,6 +56,10 @@ namespace campvis {
         virtual const std::string getName() const { return "ConfidenceMapGenerator"; };
         /// \see AbstractProcessor::getDescription()
         virtual const std::string getDescription() const { return "Creates Confidence Maps for Ultrasound Images."; };
+        /// \see AbstractProcessor::getAuthor()
+        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
+        /// \see AbstractProcessor::getProcessorState()
+        virtual const ProcessorState getProcessorState() const { return AbstractProcessor::TESTING; };
 
         virtual void process(DataContainer& data);