![]() |
Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages |
#include <elxRandomCoordinateSampler.h>
An interpolator based on the itk::ImageRandomCoordinateSampler.
This image sampler randomly samples 'NumberOfSamples' coordinates in the InputImageRegion. If a mask is given, the sampler tries to find samples within the mask. If the mask is very sparse, this may take some time. The RandomCoordinate sampler samples not only positions that correspond to voxels, but also positions between voxels. An interpolator for the fixed image is thus required. A B-spline interpolator is used, the order of which can be specified by the user. Typically, the RandomCoordinate gives a smoother cost function, because the so-called 'grid-effect' is avoided.
This sampler is suitable to used in combination with the NewSamplesEveryIteration parameter (defined in the elx::OptimizerBase).
The parameters used in this class are:
ImageSampler: Select this image sampler as follows:
(ImageSampler "RandomCoordinate")
NumberOfSpatialSamples: The number of image voxels used for computing the metric value and its derivative in each iteration. Must be given for each resolution.
example: (NumberOfSpatialSamples 2048 2048 4000)
The default is 5000.
UseRandomSampleRegion: Defines whether to randomly select a subregion of the image in each iteration. When set to "true", also specify the SampleRegionSize. By setting this option to "true", in combination with the NewSamplesEveryIteration parameter, a "localised" similarity measure is obtained. This can give better performance in case of the presence of large inhomogeneities in the image, for example.
example: (UseRandomSampleRegion "true")
Default: false.
SampleRegionSize: the size of the subregions that are selected when using the UseRandomSampleRegion option. The size should be specified in mm, for each dimension. As a rule of thumb, you may try a value ~1/3 of the image size.
example: (SampleRegionSize 50.0 50.0 50.0)
You can also specify one number, which will be used for all dimensions. Also, you can specify different values for each resolution:
example: (SampleRegionSize 50.0 50.0 50.0 30.0 30.0 30.0)
In this example, in the first resolution 50mm is used for each of the 3 dimensions, and in the second resolution 30mm.
Default: sampleRegionSize[i] = min ( fixedImageSize[i], max_i ( fixedImageSize[i]/3 ) ), with fixedImageSize in mm. So, approximately 1/3 of the fixed image size.
FixedImageBSplineInterpolationOrder: When using a RandomCoordinate sampler, the fixed image needs to be interpolated. This is done using a B-spline interpolator. With this option you can specify the order of interpolation.
example: (FixedImageBSplineInterpolationOrder 0 0 1)
Default value: 1. The parameter can be specified for each resolution.
Definition at line 78 of file elxRandomCoordinateSampler.h.
Public Types | |
using | ConstPointer = itk::SmartPointer< const Self > |
using | CoordRepType = double |
using | DefaultInterpolatorType = BSplineInterpolateImageFunction< InputImageType, CoordRepType, double > |
using | InputImageSpacingType = typename InputImageType::SpacingType |
using | InterpolatorType = InterpolateImageFunction< InputImageType, CoordRepType > |
using | ITKBaseType = typename Superclass2::ITKBaseType |
using | Pointer = itk::SmartPointer< Self > |
using | Self = RandomCoordinateSampler |
using | Superclass1 = itk::ImageRandomCoordinateSampler< typename elx::ImageSamplerBase< TElastix >::InputImageType > |
using | Superclass2 = elx::ImageSamplerBase< TElastix > |
![]() | |
using | ConstPointer = SmartPointer< const Self > |
using | CoordRepType = double |
using | DefaultInterpolatorType = BSplineInterpolateImageFunction< InputImageType, CoordRepType, double > |
using | InputImageSpacingType = typename InputImageType::SpacingType |
using | InterpolatorPointer = typename InterpolatorType::Pointer |
using | InterpolatorType = InterpolateImageFunction< InputImageType, CoordRepType > |
using | Pointer = SmartPointer< Self > |
using | RandomGeneratorPointer = typename RandomGeneratorType::Pointer |
using | RandomGeneratorType = itk::Statistics::MersenneTwisterRandomVariateGenerator |
using | Self = ImageRandomCoordinateSampler |
using | Superclass = ImageRandomSamplerBase< elx::ImageSamplerBase< TElastix >::InputImageType > |
![]() | |
using | ConstPointer = SmartPointer< const Self > |
using | ImageSampleContainerPointer = typename ImageSampleContainerType::Pointer |
using | ImageSampleContainerType = VectorDataContainer< std::vcl_size_t, ImageSampleType > |
using | ImageSampleType = ImageSample< InputImageType > |
using | MaskType = SpatialObject< Self::InputImageDimension > |
using | Pointer = SmartPointer< Self > |
using | Self = ImageRandomSamplerBase |
using | Superclass = ImageSamplerBase< TInputImage > |
![]() | |
using | ConstPointer = SmartPointer< const Self > |
using | ImageSampleContainerPointer = typename ImageSampleContainerType::Pointer |
using | ImageSampleContainerType = VectorDataContainer< std::vcl_size_t, ImageSampleType > |
using | ImageSampleType = ImageSample< InputImageType > |
using | ImageSampleValueType = typename ImageSampleType::RealType |
using | InputImageIndexType = typename InputImageType::IndexType |
using | InputImagePointType = typename InputImageType::PointType |
using | InputImagePointValueType = typename InputImagePointType::ValueType |
using | InputImageRegionVectorType = std::vector< InputImageRegionType > |
using | InputImageSizeType = typename InputImageType::SizeType |
using | MaskConstPointer = typename MaskType::ConstPointer |
using | MaskPointer = typename MaskType::Pointer |
using | MaskType = SpatialObject< Self::InputImageDimension > |
using | MaskVectorType = std::vector< MaskConstPointer > |
using | Pointer = SmartPointer< Self > |
using | Self = ImageSamplerBase |
using | Superclass = ImageToVectorContainerFilter< TInputImage, VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > > |
![]() | |
using | ConstPointer = SmartPointer< const Self > |
using | InputImageConstPointer = typename InputImageType::ConstPointer |
using | InputImagePixelType = typename InputImageType::PixelType |
using | InputImagePointer = typename InputImageType::Pointer |
using | InputImageRegionType = typename InputImageType::RegionType |
using | InputImageType = TInputImage |
using | OutputVectorContainerPointer = typename OutputVectorContainerType::Pointer |
using | OutputVectorContainerType = VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > |
using | Pointer = SmartPointer< Self > |
using | Self = ImageToVectorContainerFilter |
using | Superclass = VectorContainerSource< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > > |
![]() | |
using | ConstPointer = SmartPointer< const Self > |
using | OutputVectorContainerPointer = typename OutputVectorContainerType::Pointer |
using | OutputVectorContainerType = TOutputVectorContainer |
using | Pointer = SmartPointer< Self > |
using | Self = VectorContainerSource |
using | Superclass = ProcessObject |
![]() | |
using | ConstPointer = SmartPointer< const Self > |
using | ImageSampleContainerPointer = typename ImageSampleContainerType::Pointer |
using | ImageSampleContainerType = VectorDataContainer< std::vcl_size_t, ImageSampleType > |
using | ImageSampleType = ImageSample< InputImageType > |
using | ImageSampleValueType = typename ImageSampleType::RealType |
using | InputImageIndexType = typename InputImageType::IndexType |
using | InputImagePointType = typename InputImageType::PointType |
using | InputImagePointValueType = typename InputImagePointType::ValueType |
using | InputImageRegionVectorType = std::vector< InputImageRegionType > |
using | InputImageSizeType = typename InputImageType::SizeType |
using | MaskConstPointer = typename MaskType::ConstPointer |
using | MaskPointer = typename MaskType::Pointer |
using | MaskType = SpatialObject< Self::InputImageDimension > |
using | MaskVectorType = std::vector< MaskConstPointer > |
using | Pointer = SmartPointer< Self > |
using | Self = ImageSamplerBase |
using | Superclass = ImageToVectorContainerFilter< TElastix, VectorDataContainer< std::vcl_size_t, ImageSample< TElastix > > > |
![]() | |
using | ConstPointer = SmartPointer< const Self > |
using | InputImageConstPointer = typename InputImageType::ConstPointer |
using | InputImagePixelType = typename InputImageType::PixelType |
using | InputImagePointer = typename InputImageType::Pointer |
using | InputImageRegionType = typename InputImageType::RegionType |
using | InputImageType = TInputImage |
using | OutputVectorContainerPointer = typename OutputVectorContainerType::Pointer |
using | OutputVectorContainerType = TOutputVectorContainer |
using | Pointer = SmartPointer< Self > |
using | Self = ImageToVectorContainerFilter |
using | Superclass = VectorContainerSource< TOutputVectorContainer > |
Public Member Functions | |
void | BeforeEachResolution () override |
elxClassNameMacro ("RandomCoordinate") | |
virtual const char * | GetClassName () const |
ITK_DISALLOW_COPY_AND_MOVE (RandomCoordinateSampler) | |
itkStaticConstMacro (InputImageDimension, unsigned int, Superclass1::InputImageDimension) | |
![]() | |
virtual const char * | GetClassName () const |
virtual const InputImageSpacingType & | GetSampleRegionSize () |
virtual bool | GetUseRandomSampleRegion () const |
ITK_DISALLOW_COPY_AND_MOVE (ImageRandomCoordinateSampler) | |
itkGetModifiableObjectMacro (Interpolator, InterpolatorType) | |
itkStaticConstMacro (InputImageDimension, unsigned int, Superclass::InputImageDimension) | |
virtual void | SetInterpolator (InterpolatorType *_arg) |
virtual void | SetSampleRegionSize (InputImageSpacingType _arg) |
virtual void | SetUseRandomSampleRegion (bool _arg) |
![]() | |
virtual const char * | GetClassName () const |
ITK_DISALLOW_COPY_AND_MOVE (ImageRandomSamplerBase) | |
itkStaticConstMacro (InputImageDimension, unsigned int, Superclass::InputImageDimension) | |
![]() | |
virtual const char * | GetClassName () const |
virtual const InputImageRegionType & | GetCroppedInputImageRegion () |
virtual const InputImageRegionType & | GetInputImageRegion () const |
virtual const InputImageRegionType & | GetInputImageRegion (unsigned int pos) const |
virtual const MaskType * | GetMask () const |
virtual const MaskType * | GetMask (unsigned int pos) const |
virtual unsigned int | GetNumberOfInputImageRegions () const |
virtual unsigned int | GetNumberOfMasks () const |
virtual unsigned long | GetNumberOfSamples () const |
ITK_DISALLOW_COPY_AND_MOVE (ImageSamplerBase) | |
itkStaticConstMacro (InputImageDimension, unsigned int, InputImageType::ImageDimension) | |
virtual bool | SelectingNewSamplesOnUpdateSupported () const |
virtual bool | SelectNewSamplesOnUpdate () |
virtual void | SetInputImageRegion (const InputImageRegionType _arg) |
virtual void | SetInputImageRegion (const InputImageRegionType _arg, unsigned int pos) |
virtual void | SetMask (const MaskType *_arg) |
virtual void | SetMask (const MaskType *_arg, unsigned int pos) |
virtual void | SetNumberOfInputImageRegions (const unsigned int _arg) |
virtual void | SetNumberOfMasks (const unsigned int _arg) |
virtual void | SetNumberOfSamples (unsigned long _arg) |
virtual void | SetUseMultiThread (bool _arg) |
![]() | |
virtual void | AfterThreadedGenerateData () |
virtual void | BeforeThreadedGenerateData () |
void | GenerateData () override |
virtual const char * | GetClassName () const |
const InputImageType * | GetInput () |
const InputImageType * | GetInput (unsigned int idx) |
OutputVectorContainerType * | GetOutput () |
ITK_DISALLOW_COPY_AND_MOVE (ImageToVectorContainerFilter) | |
DataObject::Pointer | MakeOutput (unsigned int idx) override |
void | SetInput (const InputImageType *input) |
void | SetInput (unsigned int idx, const InputImageType *input) |
virtual unsigned int | SplitRequestedRegion (const ThreadIdType &threadId, const ThreadIdType &numberOfSplits, InputImageRegionType &splitRegion) |
virtual void | ThreadedGenerateData (const InputImageRegionType &inputRegionForThread, ThreadIdType threadId) |
![]() | |
virtual const char * | GetClassName () const |
OutputVectorContainerType * | GetOutput () |
OutputVectorContainerType * | GetOutput (unsigned int idx) |
virtual void | GraftNthOutput (unsigned int idx, DataObject *output) |
virtual void | GraftOutput (DataObject *output) |
ITK_DISALLOW_COPY_AND_MOVE (VectorContainerSource) | |
virtual DataObjectPointer | MakeOutput (unsigned int idx) |
![]() | |
virtual const char * | GetClassName () const |
virtual const InputImageRegionType & | GetCroppedInputImageRegion () |
virtual const InputImageRegionType & | GetInputImageRegion () const |
virtual const InputImageRegionType & | GetInputImageRegion (unsigned int pos) const |
virtual const MaskType * | GetMask () const |
virtual const MaskType * | GetMask (unsigned int pos) const |
virtual unsigned int | GetNumberOfInputImageRegions () const |
virtual unsigned int | GetNumberOfMasks () const |
virtual unsigned long | GetNumberOfSamples () const |
ITK_DISALLOW_COPY_AND_MOVE (ImageSamplerBase) | |
itkStaticConstMacro (InputImageDimension, unsigned int, InputImageType::ImageDimension) | |
virtual bool | SelectingNewSamplesOnUpdateSupported () const |
virtual bool | SelectNewSamplesOnUpdate () |
virtual void | SetInputImageRegion (const InputImageRegionType _arg) |
virtual void | SetInputImageRegion (const InputImageRegionType _arg, unsigned int pos) |
virtual void | SetMask (const MaskType *_arg) |
virtual void | SetMask (const MaskType *_arg, unsigned int pos) |
virtual void | SetNumberOfInputImageRegions (const unsigned int _arg) |
virtual void | SetNumberOfMasks (const unsigned int _arg) |
virtual void | SetNumberOfSamples (unsigned long _arg) |
virtual void | SetUseMultiThread (bool _arg) |
![]() | |
virtual void | AfterThreadedGenerateData () |
virtual void | BeforeThreadedGenerateData () |
void | GenerateData () override |
virtual const char * | GetClassName () const |
const InputImageType * | GetInput () |
const InputImageType * | GetInput (unsigned int idx) |
OutputVectorContainerType * | GetOutput () |
ITK_DISALLOW_COPY_AND_MOVE (ImageToVectorContainerFilter) | |
DataObject::Pointer | MakeOutput (unsigned int idx) override |
void | SetInput (const InputImageType *input) |
void | SetInput (unsigned int idx, const InputImageType *input) |
virtual unsigned int | SplitRequestedRegion (const ThreadIdType &threadId, const ThreadIdType &numberOfSplits, InputImageRegionType &splitRegion) |
virtual void | ThreadedGenerateData (const InputImageRegionType &inputRegionForThread, ThreadIdType threadId) |
Static Public Member Functions | |
static Pointer | New () |
![]() | |
static Pointer | New () |
![]() | |
static Pointer | New () |
![]() | |
static Pointer | New () |
![]() | |
static Pointer | New () |
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION | ThreaderCallback (void *arg) |
![]() | |
static Pointer | New () |
![]() | |
static Pointer | New () |
![]() | |
static Pointer | New () |
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION | ThreaderCallback (void *arg) |
Private Attributes | |
elxOverrideGetSelfMacro | |
Additional Inherited Members | |
![]() | |
using | InputImageContinuousIndexType = typename InterpolatorType::ContinuousIndexType |
![]() | |
InterpolatorPointer | m_Interpolator |
RandomGeneratorPointer | m_RandomGenerator |
InputImageSpacingType | m_SampleRegionSize |
![]() | |
std::vector< double > | m_RandomNumberList |
![]() | |
unsigned long | m_NumberOfSamples { 0 } |
std::vector< ImageSampleContainerPointer > | m_ThreaderSampleContainer |
bool | m_UseMultiThread { false } |
![]() | |
unsigned long | m_NumberOfSamples |
std::vector< ImageSampleContainerPointer > | m_ThreaderSampleContainer |
bool | m_UseMultiThread |
using elastix::RandomCoordinateSampler< TElastix >::ConstPointer = itk::SmartPointer<const Self> |
Definition at line 90 of file elxRandomCoordinateSampler.h.
using itk::ImageRandomCoordinateSampler< TInputImage >::CoordRepType = double |
This image sampler samples the image on physical coordinates and thus needs an interpolator.
Definition at line 82 of file itkImageRandomCoordinateSampler.h.
using itk::ImageRandomCoordinateSampler< TInputImage >::DefaultInterpolatorType = BSplineInterpolateImageFunction<InputImageType, CoordRepType, double> |
Definition at line 85 of file itkImageRandomCoordinateSampler.h.
using itk::ImageRandomCoordinateSampler< TInputImage >::InputImageSpacingType = typename InputImageType::SpacingType |
Definition at line 71 of file itkImageRandomCoordinateSampler.h.
using itk::ImageRandomCoordinateSampler< TInputImage >::InterpolatorType = InterpolateImageFunction<InputImageType, CoordRepType> |
Definition at line 83 of file itkImageRandomCoordinateSampler.h.
using elastix::RandomCoordinateSampler< TElastix >::ITKBaseType = typename Superclass2::ITKBaseType |
Definition at line 135 of file elxRandomCoordinateSampler.h.
using elastix::RandomCoordinateSampler< TElastix >::Pointer = itk::SmartPointer<Self> |
Definition at line 89 of file elxRandomCoordinateSampler.h.
using elastix::RandomCoordinateSampler< TElastix >::Self = RandomCoordinateSampler |
Standard ITK-stuff.
Definition at line 86 of file elxRandomCoordinateSampler.h.
using elastix::RandomCoordinateSampler< TElastix >::Superclass1 = itk::ImageRandomCoordinateSampler<typename elx::ImageSamplerBase<TElastix>::InputImageType> |
Definition at line 87 of file elxRandomCoordinateSampler.h.
using elastix::RandomCoordinateSampler< TElastix >::Superclass2 = elx::ImageSamplerBase<TElastix> |
Definition at line 88 of file elxRandomCoordinateSampler.h.
|
protecteddefault |
The constructor.
|
overrideprotecteddefault |
The destructor.
|
override |
Execute stuff before each resolution:
elastix::RandomCoordinateSampler< TElastix >::elxClassNameMacro | ( | "RandomCoordinate" | ) |
Name of this class. Use this name in the parameter file to select this specific interpolator.
example: (ImageSampler "RandomCoordinate")
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::ImageRandomCoordinateSampler< elx::ImageSamplerBase< TElastix >::InputImageType >.
elastix::RandomCoordinateSampler< TElastix >::ITK_DISALLOW_COPY_AND_MOVE | ( | RandomCoordinateSampler< TElastix > | ) |
elastix::RandomCoordinateSampler< TElastix >::itkStaticConstMacro | ( | InputImageDimension | , |
unsigned int | , | ||
Superclass1::InputImageDimension | |||
) |
The input image dimension.
|
static |
Method for creation through the object factory.
|
private |
Definition at line 152 of file elxRandomCoordinateSampler.h.
Generated on Wed 12 Apr 2023
for elastix by ![]() |
![]() |