#include <itkImageSamplerBase.h>
This class is a base class for any image sampler.
(ImageSampler "Random")
Definition at line 42 of file itkImageSamplerBase.h.
Public Types | |
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 | InputImageConstPointer = typename InputImageType::ConstPointer |
using | InputImageIndexType = typename InputImageType::IndexType |
using | InputImagePixelType = typename InputImageType::PixelType |
using | InputImagePointer = typename InputImageType::Pointer |
using | InputImagePointType = typename InputImageType::PointType |
using | InputImagePointValueType = typename InputImagePointType::ValueType |
using | InputImageRegionType = typename InputImageType::RegionType |
using | InputImageRegionVectorType = std::vector<InputImageRegionType> |
using | InputImageSizeType = typename InputImageType::SizeType |
using | InputImageType = TInputImage |
using | MaskConstPointer = typename MaskType::ConstPointer |
using | MaskPointer = typename MaskType::Pointer |
using | MaskType = ImageMaskSpatialObject<Self::InputImageDimension> |
using | MaskVectorType = std::vector<MaskConstPointer> |
using | Pointer = SmartPointer<Self> |
using | Self = ImageSamplerBase |
using | Superclass = VectorContainerSource<VectorDataContainer<std::vcl_size_t, ImageSample<TInputImage>>> |
Public Types inherited from itk::VectorContainerSource< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > > | |
using | ConstPointer |
using | OutputVectorContainerPointer |
using | OutputVectorContainerType |
using | Pointer |
using | Self |
using | Superclass |
Public Member Functions | |
virtual const char * | GetClassName () const |
virtual const InputImageRegionType & | GetCroppedInputImageRegion () |
const InputImageType * | GetInput () |
const InputImageType * | GetInput (unsigned int idx) |
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 |
OutputVectorContainerType * | GetOutput () |
ITK_DISALLOW_COPY_AND_MOVE (ImageSamplerBase) | |
itkStaticConstMacro (InputImageDimension, unsigned int, InputImageType::ImageDimension) | |
DataObject::Pointer | MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override |
virtual bool | SelectingNewSamplesOnUpdateSupported () const |
virtual bool | SelectNewSamplesOnUpdate () |
void | SetInput (const InputImageType *input) |
void | SetInput (unsigned int idx, const InputImageType *input) |
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) |
Public Member Functions inherited from itk::VectorContainerSource< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > > | |
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) | |
DataObjectPointer | MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override |
Static Public Member Functions | |
static Pointer | New () |
Static Public Member Functions inherited from itk::VectorContainerSource< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > > | |
static Pointer | New () |
Protected Member Functions | |
virtual bool | CheckInputImageRegions () |
void | CropInputImageRegion () |
void | GenerateInputRequestedRegion () override |
ImageSamplerBase () | |
virtual bool | IsInsideAllMasks (const InputImagePointType &point) const |
void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | UpdateAllMasks () |
~ImageSamplerBase () override=default | |
Protected Member Functions inherited from itk::VectorContainerSource< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > > | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
VectorContainerSource () | |
~VectorContainerSource () override=default | |
Static Protected Member Functions | |
static std::vector< InputImageRegionType > | SplitRegion (const InputImageRegionType &inputRegion, const vcl_size_t requestedNumberOfSubregions) |
Protected Attributes | |
unsigned long | m_NumberOfSamples { 0 } |
bool | m_UseMultiThread { true } |
Private Attributes | |
InputImageRegionType | m_CroppedInputImageRegion {} |
InputImageRegionType | m_DummyInputImageRegion {} |
InputImageRegionType | m_InputImageRegion {} |
InputImageRegionVectorType | m_InputImageRegionVector {} |
MaskConstPointer | m_Mask { nullptr } |
MaskVectorType | m_MaskVector {} |
unsigned int | m_NumberOfInputImageRegions { 0 } |
unsigned int | m_NumberOfMasks { 0 } |
using itk::ImageSamplerBase< TInputImage >::ConstPointer = SmartPointer<const Self> |
Definition at line 52 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::ImageSampleContainerPointer = typename ImageSampleContainerType::Pointer |
Definition at line 78 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::ImageSampleContainerType = VectorDataContainer<std::vcl_size_t, ImageSampleType> |
Definition at line 77 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::ImageSampleType = ImageSample<InputImageType> |
Other typdefs.
Definition at line 76 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::ImageSampleValueType = typename ImageSampleType::RealType |
Definition at line 83 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::InputImageConstPointer = typename InputImageType::ConstPointer |
Definition at line 68 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::InputImageIndexType = typename InputImageType::IndexType |
Definition at line 80 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::InputImagePixelType = typename InputImageType::PixelType |
Definition at line 70 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::InputImagePointer = typename InputImageType::Pointer |
Definition at line 67 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::InputImagePointType = typename InputImageType::PointType |
Definition at line 81 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::InputImagePointValueType = typename InputImagePointType::ValueType |
Definition at line 82 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::InputImageRegionType = typename InputImageType::RegionType |
Definition at line 69 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::InputImageRegionVectorType = std::vector<InputImageRegionType> |
Definition at line 88 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::InputImageSizeType = typename InputImageType::SizeType |
Definition at line 79 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::InputImageType = TInputImage |
Some Image related typedefs.
Definition at line 66 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::MaskConstPointer = typename MaskType::ConstPointer |
Definition at line 86 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::MaskPointer = typename MaskType::Pointer |
Definition at line 85 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::MaskType = ImageMaskSpatialObject<Self::InputImageDimension> |
Definition at line 84 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::MaskVectorType = std::vector<MaskConstPointer> |
Definition at line 87 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::Pointer = SmartPointer<Self> |
Definition at line 51 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::Self = ImageSamplerBase |
Standard ITK-stuff.
Definition at line 49 of file itkImageSamplerBase.h.
using itk::ImageSamplerBase< TInputImage >::Superclass = VectorContainerSource<VectorDataContainer<std::vcl_size_t, ImageSample<TInputImage>>> |
Definition at line 50 of file itkImageSamplerBase.h.
|
protected |
The constructor.
|
overrideprotecteddefault |
The destructor.
|
protectedvirtual |
Checks if the InputImageRegions are a subregion of the LargestPossibleRegions.
|
protected |
Compute the intersection of the InputImageRegion and the bounding box of the mask.
|
overrideprotected |
GenerateInputRequestedRegion.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::VectorContainerSource< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >.
Reimplemented in elastix::FullSampler< TElastix >, elastix::GridSampler< TElastix >, elastix::MultiInputRandomCoordinateSampler< TElastix >, elastix::RandomCoordinateSampler< TElastix >, elastix::RandomSampler< TElastix >, elastix::RandomSamplerSparseMask< TElastix >, itk::ImageFullSampler< TInputImage >, itk::ImageFullSampler< elx::ImageSamplerBase< TElastix >::InputImageType >, itk::ImageGridSampler< TInputImage >, itk::ImageGridSampler< elx::ImageSamplerBase< TElastix >::InputImageType >, itk::ImageRandomCoordinateSampler< TInputImage >, itk::ImageRandomCoordinateSampler< elx::ImageSamplerBase< TElastix >::InputImageType >, itk::ImageRandomSampler< TInputImage >, itk::ImageRandomSampler< elx::ImageSamplerBase< TElastix >::InputImageType >, itk::ImageRandomSamplerBase< TInputImage >, itk::ImageRandomSamplerBase< elx::ImageSamplerBase< TElastix >::InputImageType >, itk::ImageRandomSamplerSparseMask< TInputImage >, itk::ImageRandomSamplerSparseMask< elx::ImageSamplerBase< TElastix >::InputImageType >, itk::MultiInputImageRandomCoordinateSampler< TInputImage >, and itk::MultiInputImageRandomCoordinateSampler< elx::ImageSamplerBase< TElastix >::InputImageType >.
|
virtual |
Get a handle to the cropped InputImageregion.
const InputImageType * itk::ImageSamplerBase< TInputImage >::GetInput | ( | ) |
Get the input image of this process object.
const InputImageType * itk::ImageSamplerBase< TInputImage >::GetInput | ( | unsigned int | idx | ) |
Get the input image of this process object.
|
inlinevirtual |
Get the first input image region.
Definition at line 172 of file itkImageSamplerBase.h.
|
virtual |
Get the input image regions.
|
inlinevirtual |
Get the first mask.
Definition at line 139 of file itkImageSamplerBase.h.
|
virtual |
Get the masks.
|
virtual |
Get the number of input image regions.
|
virtual |
Get the number of masks.
|
virtual |
OutputVectorContainerType * itk::ImageSamplerBase< TInputImage >::GetOutput | ( | ) |
Get the output Mesh of this process object.
|
protectedvirtual |
IsInsideAllMasks.
itk::ImageSamplerBase< TInputImage >::ITK_DISALLOW_COPY_AND_MOVE | ( | ImageSamplerBase< TInputImage > | ) |
itk::ImageSamplerBase< TInputImage >::itkStaticConstMacro | ( | InputImageDimension | , |
unsigned int | , | ||
InputImageType::ImageDimension | ) |
The input image dimension.
|
override |
Create a valid output.
|
static |
Method for creation through the object factory.
|
overrideprotected |
PrintSelf.
|
inlinevirtual |
Returns whether the sampler supports SelectNewSamplesOnUpdate()
Reimplemented in itk::ImageFullSampler< TInputImage >, itk::ImageFullSampler< elx::ImageSamplerBase< TElastix >::InputImageType >, itk::ImageGridSampler< TInputImage >, and itk::ImageGridSampler< elx::ImageSamplerBase< TElastix >::InputImageType >.
Definition at line 196 of file itkImageSamplerBase.h.
|
virtual |
******************** Other ******************** SelectNewSamplesOnUpdate. When this function is called, the sampler will generate a new sample set after calling Update(). The return bool is false when this feature is not supported by the sampler.
Reimplemented in itk::ImageFullSampler< TInputImage >, itk::ImageFullSampler< elx::ImageSamplerBase< TElastix >::InputImageType >, itk::ImageGridSampler< TInputImage >, and itk::ImageGridSampler< elx::ImageSamplerBase< TElastix >::InputImageType >.
void itk::ImageSamplerBase< TInputImage >::SetInput | ( | const InputImageType * | input | ) |
Set the input image of this process object.
void itk::ImageSamplerBase< TInputImage >::SetInput | ( | unsigned int | idx, |
const InputImageType * | input ) |
Set the input image of this process object.
|
inlinevirtual |
Set the region over which the samples will be taken.
Definition at line 160 of file itkImageSamplerBase.h.
|
virtual |
******************** Regions ******************** Set the region over which the samples will be taken.
|
inlinevirtual |
Set the first mask. NB: the first mask is used to compute a bounding box in which samples are considered.
Definition at line 127 of file itkImageSamplerBase.h.
|
virtual |
Prepare the output. ******************** Masks ******************** Set the masks.
|
virtual |
Set the number of input image regions.
|
virtual |
Set the number of masks.
|
virtual |
Set/Get the number of samples.
Reimplemented in itk::ImageGridSampler< TInputImage >, and itk::ImageGridSampler< elx::ImageSamplerBase< TElastix >::InputImageType >.
|
virtual |
Allows disabling the use of multi-threading, by SetUseMultiThread(false)
.
|
staticprotected |
Splits the input region into subregions, and returns them all.
|
protectedvirtual |
UpdateAllMasks.
|
private |
Definition at line 269 of file itkImageSamplerBase.h.
|
private |
Definition at line 270 of file itkImageSamplerBase.h.
|
private |
Definition at line 265 of file itkImageSamplerBase.h.
|
private |
Definition at line 266 of file itkImageSamplerBase.h.
|
private |
Member variables.
Definition at line 262 of file itkImageSamplerBase.h.
|
private |
Definition at line 263 of file itkImageSamplerBase.h.
|
private |
Definition at line 267 of file itkImageSamplerBase.h.
|
private |
Definition at line 264 of file itkImageSamplerBase.h.
|
protected |
Definition at line 250 of file itkImageSamplerBase.h.
|
protected |
UseMultiThread == true
indicated that the sampler may use multi-threading (if implemented), while UseMultiThread == false
indicates that the sampler should not use multi-threading
Definition at line 254 of file itkImageSamplerBase.h.
Generated on 2024-07-17 for elastix by 1.11.0 (9b424b03c9833626cd435af22a444888fbbb192d) |