1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
|
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: itkSampleToHistogramFilter.h
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) Insight Software Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef __itkSampleToHistogramFilter_h
#define __itkSampleToHistogramFilter_h
#include "itkMacro.h"
#include "itkProcessObject.h"
#include "itkMeasurementVectorTraits.h"
#include "itkSimpleDataObjectDecorator.h"
namespace itk {
namespace Statistics {
/** \class SampleToHistogramFilter
* \brief Computes the Histogram corresponding to a Sample.
*
* This filter produces as output the histogram corresponding to
* the values of a Sample.
*
* \sa Sample, Histogram
*
*/
template < class TSample, class THistogram >
class ITK_EXPORT SampleToHistogramFilter : public ProcessObject
{
public:
/** Standard class typedefs */
typedef SampleToHistogramFilter Self;
typedef ProcessObject Superclass;
typedef SmartPointer< Self > Pointer;
typedef SmartPointer<const Self > ConstPointer;
/** Run-time type information (and related methods) */
itkTypeMacro(SampleToHistogramFilter, ProcessObject);
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** MeasurementVector typedef support */
typedef TSample SampleType;
typedef THistogram HistogramType;
typedef typename SampleType::MeasurementVectorType MeasurementVectorType;
typedef typename MeasurementVectorType::ValueType MeasurementType;
typedef typename HistogramType::SizeType HistogramSizeType;
typedef typename HistogramType::MeasurementType HistogramMeasurementType;
typedef typename HistogramType::MeasurementVectorType HistogramMeasurementVectorType;
/** Type for the data object output */
itkSuperclassTraitMacro( DataObjectPointer )
/** Set/Get the input sample */
virtual void SetInput( const SampleType * sample );
virtual const SampleType * GetInput() const;
/** Get the output Histogram */
const HistogramType * GetOutput() const;
/** Type of DataObjects to use for Size inputs */
typedef SimpleDataObjectDecorator<
HistogramSizeType > InputHistogramSizeObjectType;
/** Type of DataObjects to use for Marginal Scale inputs */
typedef SimpleDataObjectDecorator<
HistogramMeasurementType > InputHistogramMeasurementObjectType;
/** Type of DataObjects to use for Minimum and Maximums values of the
* histogram bins. */
typedef SimpleDataObjectDecorator<
HistogramMeasurementVectorType > InputHistogramMeasurementVectorObjectType;
/** Type of DataObjects to use for AutoMinimumMaximum input */
typedef SimpleDataObjectDecorator< bool > InputBooleanObjectType;
/** Methods for setting and getting the histogram size. The histogram size
* is encapsulated inside a decorator class. For this reason, it is possible
* to set and get the decorator class, but it is only possible to set the
* histogram size by value. This macro declares the methods
* SetHistogramSize(), SetHistogramSizeInput(), GetHistogramSizeInput().
*/
itkSetDecoratedInputMacro( HistogramSize, HistogramSizeType, 1 );
/** Methods for setting and getting the Marginal scale value. The marginal
* scale is used when the type of the measurement vector componets are of
* integer type. */
itkSetDecoratedInputMacro( MarginalScale, HistogramMeasurementType, 2 );
/** Methods for setting and getting the Minimum and Maximum values of the
* histogram bins. */
itkSetDecoratedInputMacro( HistogramBinMinimum, HistogramMeasurementVectorType, 3 );
itkSetDecoratedInputMacro( HistogramBinMaximum, HistogramMeasurementVectorType, 4 );
/** Methods for setting and getting the boolean flag that defines whether the
* minimum and maximum of the histogram are going to be computed
* automatically from the values of the sample */
itkSetDecoratedInputMacro( AutoMinimumMaximum, bool, 5 );
/** Method that facilitates the use of this filter in the internal
* pipeline of another filter. */
virtual void GraftOutput(DataObject *output);
protected:
SampleToHistogramFilter();
virtual ~SampleToHistogramFilter();
void PrintSelf(std::ostream& os, Indent indent) const;
/** Make a DataObject of the correct type to used as the specified
* output. This method
* is automatically called when DataObject::DisconnectPipeline() is
* called.
* \sa ProcessObject
*/
virtual DataObjectPointer MakeOutput(unsigned int idx);
// Where the histogram is actually computed
virtual void GenerateData();
private:
SampleToHistogramFilter(const Self&); //purposely not implemented
void operator=(const Self&); //purposely not implemented
}; // end of class
} // end of namespace Statistics
} // end of namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkSampleToHistogramFilter.txx"
#endif
#endif
|