sliceextractor.h 5.2 KB
Newer Older
1
2
// ================================================================================================
// 
schultezub's avatar
schultezub committed
3
// This file is part of the CAMPVis Software Framework.
4
5
// 
// If not explicitly stated otherwise: Copyright (C) 2012, all rights reserved,
schultezub's avatar
schultezub committed
6
//      Christian Schulte zu Berge <christian.szb@in.tum.de>
7
8
9
//      Chair for Computer Aided Medical Procedures
//      Technische Universität München
//      Boltzmannstr. 3, 85748 Garching b. München, Germany
schultezub's avatar
schultezub committed
10
// For a full list of authors and contributors, please refer to the file "AUTHORS.txt".
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
// 
// The licensing of this softare is not yet resolved. Until then, redistribution in source or
// binary forms outside the CAMP chair is not permitted, unless explicitly stated in legal form.
// However, the names of the original authors and the above copyright notice must retain in its
// original state in any case.
// 
// Legal disclaimer provided by the BSD license:
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 
// AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// 
// ================================================================================================

schultezub's avatar
schultezub committed
30
31
32
33
34
#ifndef SLICEEXTRACTOR_H__
#define SLICEEXTRACTOR_H__

#include <string>

35
36
37
#include "tgt/buffer.h"
#include "tgt/vertexarrayobject.h"

38
#include "core/pipeline/abstractprocessordecorator.h"
schultezub's avatar
schultezub committed
39
#include "core/pipeline/visualizationprocessor.h"
40
#include "core/properties/datanameproperty.h"
41
#include "core/properties/floatingpointproperty.h"
schultezub's avatar
schultezub committed
42
#include "core/properties/genericproperty.h"
43
#include "core/properties/optionproperty.h"
44
#include "core/properties/numericproperty.h"
45
#include "core/properties/transferfunctionproperty.h"
schultezub's avatar
schultezub committed
46

47
48
49
50
namespace tgt {
    class Shader;
}

schultezub's avatar
schultezub committed
51
namespace campvis {
52
    class FaceGeometry;
53
54
    class ImageData;

schultezub's avatar
schultezub committed
55
    /**
schultezub's avatar
schultezub committed
56
     * Extracts a slice from a 3D image and renders it into a rendertarget.
schultezub's avatar
schultezub committed
57
     */
58
    class SliceExtractor : public VisualizationProcessor, public HasProcessorDecorators {
schultezub's avatar
schultezub committed
59
    public:
60
61
62
63
64
65
        enum SliceOrientation {
            XY_PLANE = 0,
            XZ_PLANE = 1,
            YZ_PLANE = 2
        };

schultezub's avatar
schultezub committed
66
67
68
        /**
         * Constructs a new SliceExtractor Processor
         **/
69
        SliceExtractor(IVec2Property& canvasSize);
schultezub's avatar
schultezub committed
70
71
72
73
74
75

        /**
         * Destructor
         **/
        virtual ~SliceExtractor();

76
        /// \see AbstractProcessor::init
schultezub's avatar
schultezub committed
77
78
        virtual void init();

79
80
81
        /// \see AbstractProcessor::deinit
        virtual void deinit();

82
83
        /// \see AbstractProcessor::getName()
        virtual const std::string getName() const { return "SliceExtractor"; };
84
85
        /// \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."; };
86
87
88
89
        /// \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; };
90

91
        /// \see AbstractProcessor::process()
schultezub's avatar
schultezub committed
92
        virtual void process(DataContainer& data);
schultezub's avatar
schultezub committed
93

94
95
        DataNameProperty p_sourceImageID;                  ///< image ID for input image
        DataNameProperty p_targetImageID;                  ///< image ID for output image
schultezub's avatar
schultezub committed
96

97
98
        GenericOptionProperty<SliceOrientation> p_sliceOrientation; ///< orientation of the slice to extract
        IntProperty p_xSliceNumber;                         ///< number of the slice in X direction
99
        Vec4Property p_xSliceColor;                         ///< color for x marker
100
        IntProperty p_ySliceNumber;                         ///< number of the slice in Y direction
101
        Vec4Property p_ySliceColor;                         ///< color for y marker
102
        IntProperty p_zSliceNumber;                         ///< number of the slice in Z direction
103
        Vec4Property p_zSliceColor;                         ///< color for z marker
104
        TransferFunctionProperty p_transferFunction;     ///< Transfer function
schultezub's avatar
schultezub committed
105

schultezub's avatar
schultezub committed
106
    protected:
107
        /// adapts the range of the p_xSliceNumber property to the image
108
        void updateProperties(DataHandle img);
109

110
111
        void updateBorderGeometry();

schultezub's avatar
schultezub committed
112
113
        tgt::Shader* _shader;                           ///< Shader for slice rendering

schultezub's avatar
schultezub committed
114
        static const std::string loggerCat_;
115
116
117

    private:
        clock_t _sourceImageTimestamp;
schultezub's avatar
schultezub committed
118
119
120
121
122
    };

}

#endif // SLICEEXTRACTOR_H__