This class takes two inputs, the first is a vector field, such as the output from a registration force generator. The second is another vector field, such as the gradient of an image. The images must have the same size, and same vector dimensionality (enforced via template parameters). The output is the first field, scaled by the second. If ScaleByComponents is true, the vectors are simply multiplied componentwise. If ScaleByComponents is false, the vectors are simply multiplied by the individual magnitude of the second vector field. More...
Inheritance diagram for itk::ScaleVectorFieldFilter< TScalarType, NDimensions >:
Collaboration diagram for itk::ScaleVectorFieldFilter< TScalarType, NDimensions >:
Public Types | |
| typedef ScaleVectorFieldFilter | Self |
| typedef ImageToImageFilter < Image< Vector< TScalarType, NDimensions >, NDimensions > , Image< Vector< TScalarType, NDimensions >, NDimensions > > | Superclass |
| typedef SmartPointer< Self > | Pointer |
| typedef SmartPointer< const Self > | ConstPointer |
| typedef Vector< TScalarType, itkGetStaticConstMacro(Dimension) > | OutputPixelType |
| typedef Image< OutputPixelType, itkGetStaticConstMacro(Dimension) > | OutputImageType |
| typedef Superclass::InputImageType | InputImageType |
| typedef Superclass::InputImagePointer | InputImagePointer |
| typedef Superclass::InputImageRegionType | InputImageRegionType |
| typedef InputImageType::PixelType | InputImagePixelType |
Public Member Functions | |
| virtual const char * | GetClassName () const |
| itkStaticConstMacro (Dimension, unsigned int, NDimensions) | |
| virtual void | SetImageThatWillBeScaled (const InputImageType *image) |
| virtual void | SetImageThatDeterminesTheAmountOfScaling (const InputImageType *image) |
| virtual void | SetNthInput (unsigned int idx, const InputImageType *) |
| virtual void | SetScaleByComponents (bool _arg) |
| virtual bool | GetScaleByComponents () |
| void | WriteVectorImage (std::string filename) |
Static Public Member Functions | |
| static Pointer | New () |
Protected Member Functions | |
| ScaleVectorFieldFilter () | |
| ~ScaleVectorFieldFilter () | |
| void | PrintSelf (std::ostream &os, Indent indent) const |
| virtual void | BeforeThreadedGenerateData () |
| virtual void | ThreadedGenerateData (const InputImageRegionType &outputRegionForThread, ThreadIdType threadId) |
Protected Attributes | |
| bool | m_ScaleByComponents |
Detailed Description
template<class TScalarType = double, unsigned int NDimensions = 3>
class itk::ScaleVectorFieldFilter< TScalarType, NDimensions >
This class takes two inputs, the first is a vector field, such as the output from a registration force generator. The second is another vector field, such as the gradient of an image. The images must have the same size, and same vector dimensionality (enforced via template parameters). The output is the first field, scaled by the second. If ScaleByComponents is true, the vectors are simply multiplied componentwise. If ScaleByComponents is false, the vectors are simply multiplied by the individual magnitude of the second vector field.
Member Typedef Documentation
template<class TScalarType = double, unsigned int NDimensions = 3>
| typedef SmartPointer<const Self> itk::ScaleVectorFieldFilter< TScalarType, NDimensions >::ConstPointer |
template<class TScalarType = double, unsigned int NDimensions = 3>
| typedef InputImageType::PixelType itk::ScaleVectorFieldFilter< TScalarType, NDimensions >::InputImagePixelType |
template<class TScalarType = double, unsigned int NDimensions = 3>
| typedef Superclass::InputImagePointer itk::ScaleVectorFieldFilter< TScalarType, NDimensions >::InputImagePointer |
template<class TScalarType = double, unsigned int NDimensions = 3>
| typedef Superclass::InputImageRegionType itk::ScaleVectorFieldFilter< TScalarType, NDimensions >::InputImageRegionType |
template<class TScalarType = double, unsigned int NDimensions = 3>
| typedef Superclass::InputImageType itk::ScaleVectorFieldFilter< TScalarType, NDimensions >::InputImageType |
template<class TScalarType = double, unsigned int NDimensions = 3>
| typedef Image< OutputPixelType, itkGetStaticConstMacro(Dimension) > itk::ScaleVectorFieldFilter< TScalarType, NDimensions >::OutputImageType |
template<class TScalarType = double, unsigned int NDimensions = 3>
| typedef Vector< TScalarType, itkGetStaticConstMacro(Dimension) > itk::ScaleVectorFieldFilter< TScalarType, NDimensions >::OutputPixelType |
Standard typedefs.
template<class TScalarType = double, unsigned int NDimensions = 3>
| typedef SmartPointer<Self> itk::ScaleVectorFieldFilter< TScalarType, NDimensions >::Pointer |
template<class TScalarType = double, unsigned int NDimensions = 3>
| typedef ScaleVectorFieldFilter itk::ScaleVectorFieldFilter< TScalarType, NDimensions >::Self |
Standard "Self" typedef.
template<class TScalarType = double, unsigned int NDimensions = 3>
| typedef ImageToImageFilter< Image< Vector<TScalarType, NDimensions>, NDimensions>, Image< Vector<TScalarType, NDimensions>, NDimensions> > itk::ScaleVectorFieldFilter< TScalarType, NDimensions >::Superclass |
Constructor & Destructor Documentation
template<class TScalarType = double, unsigned int NDimensions = 3>
|
protected |
template<class TScalarType = double, unsigned int NDimensions = 3>
|
inlineprotected |
Member Function Documentation
template<class TScalarType = double, unsigned int NDimensions = 3>
|
protectedvirtual |
template<class TScalarType = double, unsigned int NDimensions = 3>
|
virtual |
Run-time type information (and related methods).
template<class TScalarType = double, unsigned int NDimensions = 3>
|
virtual |
template<class TScalarType = double, unsigned int NDimensions = 3>
| itk::ScaleVectorFieldFilter< TScalarType, NDimensions >::itkStaticConstMacro | ( | Dimension | , |
| unsigned | int, | ||
| NDimensions | |||
| ) |
Get the number of dimensions we are working in.
template<class TScalarType = double, unsigned int NDimensions = 3>
|
static |
Method for creation through the object factory.
template<class TScalarType = double, unsigned int NDimensions = 3>
|
protected |
template<class TScalarType = double, unsigned int NDimensions = 3>
|
inlinevirtual |
Set the image that determines the amount of scaling at position 1.
template<class TScalarType = double, unsigned int NDimensions = 3>
|
inlinevirtual |
Set the image that gets scaled at position 0.
template<class TScalarType = double, unsigned int NDimensions = 3>
|
virtual |
We set the input images by number.
template<class TScalarType = double, unsigned int NDimensions = 3>
|
virtual |
If true, we scale componentwise, if false, we scale first image by magnitude of second image.
template<class TScalarType = double, unsigned int NDimensions = 3>
|
protectedvirtual |
template<class TScalarType = double, unsigned int NDimensions = 3>
| void itk::ScaleVectorFieldFilter< TScalarType, NDimensions >::WriteVectorImage | ( | std::string | filename | ) |
Writes image to log file.
Member Data Documentation
template<class TScalarType = double, unsigned int NDimensions = 3>
|
protected |
Scale by components. Defaults to true.
The documentation for this class was generated from the following file:
